wireshark/docbook/attributes.adoc

103 lines
4.0 KiB
Plaintext
Raw Normal View History

// Common attributes
2022-08-15 22:32:07 +00:00
:wireshark-version: 4.1.0
:logray-version: 0.9.0
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
// Required for btn, kbd:, and menu: macros.
:experimental:
// Don't add a "Last updated" footer to our man pages.
// We could use the "reproducible" attribute here, but it generates an
// empty black box.
:nofooter:
Switch from AsciiDoc to Asciidoctor. Switch the markup text processor for files in the docbook directory from AsciiDoc to Asciidoctor. Asciidoctor has several useful features (such as direct PDF output) and is actively developed. It's written in Ruby but that dependency can be sidestepped with AsciidoctorJ, a self-contained bundle that only depends on the JRE. The current toolchain targets require Python, AsciiDoc, DocBook XML, DocBook XSL, Java, FOP, xsltproc, lynx, and the HTMLHelp compiler: HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL Chunked HTML: AsciiDoc → DocBook XML → xsltproc + DocBook XSL PDF: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → FOP HTMLHelp: AsciiDoc → DocBook XML → xsltproc + DocBook XSL → HHC This change removes the AsciiDoc and FOP requirements and adds either AsciidoctorJ or Asciidoctor + Ruby: HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL Chunked HTML: Asciidoctor → DocBook XML → xsltproc + DocBook XSL PDF: Asciidoctor HTMLHelp: Asciidoctor → DocBook XML → xsltproc + DocBook XSL → HHC Ideally we could generate all of these using AsciidoctorJ, Java, and lynx. Unfortunately we're not there yet. The release notes depend on several macros (ws-buglink, ws-salink, cve-idlink, sort-and-group). Add Asciidoctor (Ruby) equivalents. Remove the BUILD_xxx_GUIDES CMake options and add various output targets automatically. This means that you have to build the various documentation targets explicitly. Change-Id: I31930677a656b99b1c6839bb6c33a13db951eb9a Reviewed-on: https://code.wireshark.org/review/25668 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs <gerald@wireshark.org>
2017-10-19 22:03:55 +00:00
// Create PA4 (210 × 280mm) pages: https://en.wikipedia.org/wiki/Paper_size#PA4_or_L4
// This is the approximate intersection of A4 (210 × 297mm) and U.S. Letter
// (216 × 279mm).
:pdf-page-size: 210mm x 280mm
// Include glyphs for up/down arrows
:pdf-theme: default-with-fallback-font
//
// URLs
//
// Wireshark top level URLs (sites)
:wireshark-main-url: https://www.wireshark.org/
2021-12-31 20:47:01 +00:00
:wireshark-bugs-url: https://gitlab.com/wireshark/wireshark/-/issues
:wireshark-code-review-url: https://gitlab.com/wireshark/wireshark/-/merge_requests
:wireshark-qa-url: https://ask.wireshark.org/
:wireshark-wiki-url: https://gitlab.com/wireshark/wireshark/wikis/
:wireshark-gitlab-project-url: https://gitlab.com/wireshark/wireshark
// Wireshark secondary URLs (pages)
:wireshark-authors-url: {wireshark-main-url}about.html#authors
:wireshark-code-browse-url: https://gitlab.com/wireshark/wireshark/tree/master
:wireshark-code-file-url: https://gitlab.com/wireshark/wireshark/blob/master/
2021-12-31 20:47:01 +00:00
:wireshark-commits-url: https://gitlab.com/wireshark/wireshark/-/commits/master
:wireshark-merge-request-url: https://gitlab.com/wireshark/wireshark/merge_requests
:wireshark-developers-guide-url: {wireshark-main-url}docs/wsdg_html_chunked/
:wireshark-display-filter-reference-url: {wireshark-main-url}docs/dfref/
:wireshark-download-url: {wireshark-main-url}download.html
:wireshark-faq-url: {wireshark-main-url}faq.html
:wireshark-git-anonhttp-url: https://gitlab.com/wireshark/wireshark.git
:wireshark-git-ssh-url: \git@gitlab.com:wireshark/wireshark.git
:wireshark-mailing-lists-url: {wireshark-main-url}lists/
:wireshark-man-page-url: {wireshark-main-url}docs/man-pages/
:wireshark-snapshots-url: {wireshark-main-url}download/automated/src/
:wireshark-users-guide-url: {wireshark-main-url}docs/wsug_html_chunked/
2020-10-21 18:59:39 +00:00
:wireshark-wiki-moin-import-url: {wireshark-wiki-url}uploads/__moin_import__/attachments/
// External URLs
:tcpdump-main-url: https://www.tcpdump.org/
:pcap-filter-man-page-url: {tcpdump-main-url}manpages/pcap-filter.7.html
:tcpdump-man-page-url: {tcpdump-main-url}manpages/tcpdump.1.html
:npcap-main-url: https://npcap.com/
:npcap-development-url: https://github.com/nmap/npcap
:npcap-license-url: https://raw.githubusercontent.com/nmap/npcap/master/LICENSE
:vcpkg-main-url: https://github.com/Microsoft/vcpkg/
:sysfs-main-url: http://linux-diag.sourceforge.net/Sysfsutils.html
:wikipedia-main-url: https://en.wikipedia.org/wiki/
:pcre2pattern-url: https://www.pcre.org/current/doc/html/pcre2pattern.html
:greenwichmeantime-main-url: https://wwp.greenwichmeantime.com/
:timeanddate-main-url: https://www.timeanddate.com/worldclock/
:ntp-main-url: http://www.ntp.org/
:gplv2-url: https://www.gnu.org/licenses/gpl-2.0.html
:spdx-license-url: https://spdx.org/licenses/
// Email addresses
:at-separator: &#91;AT&#93;
:wireshark-dev-list-email: wireshark-dev{at-separator}wireshark.org
:wsdg-author-email: ulf.lamping{at-separator}web.de
:wsdg-author-email2: graham.bloice{at-separator}trihedral.com
:wsug-author-email: ulf.lamping{at-separator}web.de
:wsug-author-email2: rsharpe{at-separator}ns.aus.com
:wsug-author-email3: hagbard{at-separator}physics.rutgers.edu
:wsug-author-email4: luis{at-separator}ontanon.org
//
// Image formatting
//
// "scaledwidth" only applies to PDF output
:pdf-scaledwidth: scaledwidth="85%"
:screenshot-attrs: scaledwidth="85%"
:medium-screenshot-attrs: scaledwidth="60%"
:small-screenshot-attrs: scaledwidth="35%"
:related-attrs: height=18
// XXX height=22 results in content-height="22px" in the .fo file. Not sure
// how to make scaledwidth take precedence.
:statusbar-attrs: scaledwidth="85%",height=22
:multiplication: ×
:underscore: _
:cmd: ⌘
:missing: Not yet written. If you would like to fix this, see https://gitlab.com/wireshark/wireshark/-/wikis/Development/SubmittingPatches.