989a23960ad39516b4313a5eb3bd878f0c777775
[metze/wireshark/wip.git] / docbook / asciidoc.conf
1 # AsciiDoc configuration for Wireshark
2
3 [replacements]
4
5 # Yes, these are fake macros.
6 # We should probably replace some or all of them with attributes.
7 wireshark-version:\[\]=1.99.8
8 wireshark-major-minor-version:\[\]=1.99
9
10 wireshark-authors-url:\[\]=https://www.wireshark.org/about.html#authors
11 wireshark-bugs-site:\[\]=https://bugs.wireshark.org/
12 wireshark-code-browse-url:\[\]=https://code.wireshark.org/review/gitweb?p=wireshark.git
13 wireshark-code-review-url:\[\]=https://code.wireshark.org/review
14 wireshark-dev-list-email:\[\]=wireshark-dev[AT]wireshark.org
15 wireshark-developers-guide-url:\[\]=https://www.wireshark.org/docs/
16 wireshark-download-page:\[\]=https://www.wireshark.org/download.html
17 wireshark-display-filter-reference:\[\]=https://www.wireshark.org/docs/dfref/
18 wireshark-man-page-reference:\[\]=https://www.wireshark.org/docs/man-pages/
19 wireshark-faq-url:\[\]=https://www.wireshark.org/faq.html
20 wireshark-git-anonhttp-url:\[\]=https://code.wireshark.org/review/wireshark
21 wireshark-git-http-url:\[\]=https://your.username@code.wireshark.org/review/wireshark
22 wireshark-git-ssh-url:\[\]=ssh://your.username@code.wireshark.org:29418/wireshark
23 wireshark-buildbot-url:\[\]=https://buildbot.wireshark.org/trunk/waterfall
24 wireshark-mailing-lists-url:\[\]=https://www.wireshark.org/lists/
25 wireshark-qa-url:\[\]=https://ask.wireshark.org/
26 wireshark-users-guide-url:\[\]=https://www.wireshark.org/docs/
27 wireshark-web-site:\[\]=https://www.wireshark.org/
28 wireshark-wiki-site:\[\]=https://wiki.wireshark.org/
29
30 tcpdump-web-site:\[\]=http://www.tcpdump.org/
31 tcpdump-man-page-url:\[\]=http://www.tcpdump.org/manpages/tcpdump.1.html
32 pcap-filter-man-page-url:\[\]=http://www.tcpdump.org/manpages/pcap-filter.7.html
33
34 winpcap-web-site:\[\]=https://www.winpcap.org/
35 winpcap-download-page:\[\]=https://www.winpcap.org/install/
36
37 wikipedia-web-site:\[\]=https://en.wikipedia.org/wiki/
38 sysfs-web-site:\[\]=http://linux-diag.sourceforge.net/Sysfsutils.html
39 greenwichmeantime-web-site:\[\]=http://wwp.greenwichmeantime.com/
40 timeanddate-web-site:\[\]=http://www.timeanddate.com/worldclock/
41 ntp-web-site:\[\]=http://www.ntp.org/
42
43 # Make a document attribute after we fully convert to AsciiDoc
44 wsdg-author-email:\[\]=ulf.lamping[AT]web.de
45 wsdg-author-email2:\[\]=graham.bloice[AT]trihedral.com
46
47 wsug-author-email:\[\]=ulf.lamping[AT]web.de
48 wsug-author-email2:\[\]=rsharpe[AT]ns.aus.com
49 wsug-author-email3:\[\]=hagbard[AT]physics.rutgers.edu
50 wsug-author-email4:\[\]=luis[AT]ontanon.org
51
52 gpl-url:\[\]=https://www.gnu.org/licenses/gpl-2.0.html
53
54 [macros]
55
56 # bugs.wireshark.org link
57 # ws-buglink:<dddd>[<bug text>]
58 # Default bug text is "Bug".
59 # Examples: ws-buglink:5000[] ws-buglink:4000[Wireshark bug number]
60 (?su)(?<!\w)[\\]?(?P<name>ws-buglink):(?P<target>\d+)\[(?P<attrlist>.*?)(?<!\\)\]=
61
62 # www.wireshark.org/security link
63 # ws-salink:<dddd-dd>[<advisory text>]
64 # Default advisory text is "".
65 # Examples: ws-salink:2013-32[] ws-salink:2013-12[Security advisory]
66 (?su)(?<!\w)[\\]?(?P<name>ws-salink):(?P<target>\d{4}-\d{2,3})\[(?P<attrlist>.*?)(?<!\\)\]=
67
68 # CVE ID link
69 # cve-idlink:<dddd-dddd>[]
70 # Example: cve-idlink:2013:0001
71 (?su)(?<!\w)[\\]?(?P<name>cve-idlink):(?P<target>\d{4}-\d+)\[\]=
72
73
74 ifdef::backend-docbook45[]
75
76 [ws-buglink-inlinemacro]
77 <ulink url="https://bugs.wireshark.org/bugzilla/show_bug.cgi?id={target}">{0=Bug} {target}</ulink>
78
79 [ws-salink-inlinemacro]
80 <ulink url="https://www.wireshark.org/security/wnpa-sec-{target}.html">{0=}wnpa-sec-{target}</ulink>
81
82 [cve-idlink-inlinemacro]
83 <ulink url="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-{target}">CVE-{target}</ulink>
84
85 endif::backend-docbook45[]
86
87
88 ifdef::backend-html4,backend-html5,backend-xhtml11[]
89
90 [ws-buglink-inlinemacro]
91 <a href="https://bugs.wireshark.org/bugzilla/show_bug.cgi?id={target}">{0=Bug} {target}</a>
92
93 [ws-salink-inlinemacro]
94 <a href="https://www.wireshark.org/security/wnpa-sec-{target}.html">{0=}wnpa-sec-{target}</a>
95
96 [cve-idlink-inlinemacro]
97 <a href="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-{target}">CVE-{target}</a>
98
99 endif::backend-html4,backend-html5,backend-xhtml11[]
100
101
102 # Given a list of items, sort and comma-separate them. Blank lines are stripped.
103 # Case is ignored. For example,
104 #
105 # --sort-and-group--
106 # One
107 # two
108 # red
109 #
110 # blue
111 # Fish
112 #
113 # --sort-and-group--
114 #
115 # produces
116 #
117 #     blue, Fish, One, red, two
118 [blockdef-sort-and-group]
119 delimiter=^--sort-and-group--$
120 style=default
121 filter=sort --ignore-case
122 default-style=template="paragraph",filter='sort --ignore-case | sed -e "s/,//g" | sed -e "/^$/d" -e "$ s/^/and /" -e "$ ! s/$/,/"'