doc/attributes.adoc

   1 // Common attributes
   2
   3 :wireshark-version: 4.5.0
   4 :stratoshark-version: 0.9.0
   5
   6 // Required for btn, kbd:, and menu: macros.
   7 :experimental:
   8
   9 // We want footers (which include page numbers) in our PDF output but
  10 // not elsewhere, particularly in our man pages.
  11 // We could use the "reproducible" attribute here, but it generates an
  12 // empty black box.
  13 ifndef::backend-pdf[]
  14 :nofooter:
  15 endif::[]
  16
  17 // Create PA4 (210 × 280mm) pages: https://en.wikipedia.org/wiki/Paper_size#PA4_or_L4
  18 // This is the approximate intersection of A4 (210 × 297mm) and U.S. Letter
  19 // (216 × 279mm).
  20 :pdf-page-size: 210mm x 280mm
  21
  22 // Include glyphs for up/down arrows
  23 // We have a custom theme that adds fallback fonts for more symbols,
  24 // like ⌃ and ⌄ (Up Arrowhead and Down Arrowhead), but setting the
  25 // proper directory to look for theme so that it will work for all
  26 // documents is somewhat annoying and done in FindAsciidoctor.cmake
  27 // This built-in theme should be an acceptable fallback when not
  28 // using the CMake target.
  29 :pdf-theme: default-with-fallback-font
  30
  31 //
  32 // URLs
  33 //
  34
  35 // Wireshark top level URLs (sites)
  36 :wireshark-main-url: https://www.wireshark.org/
  37 :wireshark-gitlab-project-url: https://gitlab.com/wireshark/wireshark
  38 :wireshark-qa-url: https://ask.wireshark.org/
  39 :wireshark-foundation-url: https://wiresharkfoundation.org/
  40 :sharkfest-url: https://sharkfest.wireshark.org/
  41 :wireshark-wiki-url: https://wiki.wireshark.org/
  42
  43 // Wireshark secondary URLs (pages)
  44 :wireshark-bugs-url: {wireshark-gitlab-project-url}/-/issues
  45 :wireshark-code-review-url: {wireshark-gitlab-project-url}/-/merge_requests
  46 :wireshark-authors-url: {wireshark-main-url}about.html#authors
  47 :wireshark-code-browse-url: {wireshark-gitlab-project-url}/-/tree/master
  48 :wireshark-code-file-url: {wireshark-gitlab-project-url}/-/blob/master/
  49 :wireshark-commits-url: {wireshark-gitlab-project-url}/-/commits/master
  50 :wireshark-merge-request-url: {wireshark-gitlab-project-url}/-/merge_requests
  51 :wireshark-developers-guide-url: {wireshark-main-url}docs/wsdg_html_chunked/
  52 :wireshark-display-filter-reference-url: {wireshark-main-url}docs/dfref/
  53 :wireshark-download-url: {wireshark-main-url}download.html
  54 :wireshark-faq-url: {wireshark-main-url}faq.html
  55 :wireshark-git-anonhttp-url: https://gitlab.com/wireshark/wireshark.git
  56 :wireshark-git-ssh-url: \git@gitlab.com:wireshark/wireshark.git
  57 :wireshark-mailing-lists-url: {wireshark-main-url}lists/
  58 :wireshark-man-page-url: {wireshark-main-url}docs/man-pages/
  59 :wireshark-snapshots-url: {wireshark-main-url}download/automated/src/
  60 :wireshark-users-guide-url: {wireshark-main-url}docs/wsug_html_chunked/
  61 :wireshark-wiki-moin-import-url: {wireshark-wiki-url}uploads/__moin_import__/attachments/
  62
  63 // External URLs
  64 :tcpdump-main-url: https://www.tcpdump.org/
  65 :pcap-filter-man-page-url: {tcpdump-main-url}manpages/pcap-filter.7.html
  66 :tcpdump-man-page-url: {tcpdump-main-url}manpages/tcpdump.1.html
  67
  68 :npcap-main-url: https://npcap.com/
  69 :npcap-development-url: https://github.com/nmap/npcap
  70 :npcap-license-url: https://raw.githubusercontent.com/nmap/npcap/master/LICENSE
  71 :vcpkg-main-url: https://github.com/Microsoft/vcpkg/
  72
  73 :sysfs-main-url: http://linux-diag.sourceforge.net/Sysfsutils.html
  74 :wikipedia-main-url: https://en.wikipedia.org/wiki/
  75 :pcre2pattern-url: https://www.pcre.org/current/doc/html/pcre2pattern.html
  76
  77 :greenwichmeantime-main-url: https://wwp.greenwichmeantime.com/
  78 :timeanddate-main-url: https://www.timeanddate.com/worldclock/
  79 :ntp-main-url: http://www.ntp.org/
  80
  81 :gplv2-url: https://www.gnu.org/licenses/gpl-2.0.html
  82 :spdx-license-url: https://spdx.org/licenses/
  83
  84 // Email addresses
  85 :at-separator: &#91;AT&#93;
  86 :wireshark-dev-list-email: wireshark-dev{at-separator}wireshark.org
  87 :wsdg-author-email: ulf.lamping{at-separator}web.de
  88 :wsdg-author-email2: graham.bloice{at-separator}trihedral.com
  89
  90 :wsug-author-email: ulf.lamping{at-separator}web.de
  91 :wsug-author-email2: rsharpe{at-separator}ns.aus.com
  92 :wsug-author-email3: hagbard{at-separator}physics.rutgers.edu
  93 :wsug-author-email4: luis{at-separator}ontanon.org
  94
  95 //
  96 // Image formatting
  97 //
  98
  99 // "scaledwidth" only applies to PDF output
 100 :pdf-scaledwidth: scaledwidth="85%"
 101 :screenshot-attrs: scaledwidth="85%"
 102 :medium-screenshot-attrs: scaledwidth="60%"
 103 :small-screenshot-attrs: scaledwidth="35%"
 104 :related-attrs: height=18
 105 // XXX height=22 results in content-height="22px" in the .fo file. Not sure
 106 // how to make scaledwidth take precedence.
 107 :statusbar-attrs: scaledwidth="85%",height=22
 108
 109 :multiplication: ×
 110 :underscore: _
 111 :cmd: ⌘
 112
 113 :missing: Not yet written. If you would like to fix this, see https://gitlab.com/wireshark/wireshark/-/wikis/Development/SubmittingPatches.