aboutsummaryrefslogtreecommitdiffstats
path: root/docbook/asciidoc.conf
blob: c658adc399ca8e5953dc96dffaa760e262ba249f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# AsciiDoc configuration for Wireshark

[attributes]

wireshark-version=2.3.0

# "scaledwidth" only applies to PDF output
pdf-scaledwidth=scaledwidth="85%"
screenshot-attrs=scaledwidth="85%"
small-screenshot-attrs=scaledwidth="35%"
toolbar-icon-attrs=height=24,width=24
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

[replacements]

# Most of these are fake macros.
# We should probably replace some or all of them with attributes.

wireshark-authors-url:\[\]=https://www.wireshark.org/about.html#authors
wireshark-bugs-site:\[\]=https://bugs.wireshark.org/
wireshark-code-browse-url:\[\]=https://code.wireshark.org/review/gitweb?p=wireshark.git
wireshark-code-review-url:\[\]=https://code.wireshark.org/review
wireshark-dev-list-email:\[\]=wireshark-dev[AT]wireshark.org
wireshark-developers-guide-url:\[\]=https://www.wireshark.org/docs/
wireshark-download-page:\[\]=https://www.wireshark.org/download.html
wireshark-display-filter-reference:\[\]=https://www.wireshark.org/docs/dfref/
wireshark-man-page-reference:\[\]=https://www.wireshark.org/docs/man-pages/
wireshark-faq-url:\[\]=https://www.wireshark.org/faq.html
wireshark-git-anonhttp-url:\[\]=https://code.wireshark.org/review/wireshark
wireshark-git-http-url:\[\]=https://your.username@code.wireshark.org/review/wireshark
wireshark-git-ssh-url:\[\]=ssh://your.username@code.wireshark.org:29418/wireshark
wireshark-buildbot-url:\[\]=https://buildbot.wireshark.org/trunk/waterfall
wireshark-mailing-lists-url:\[\]=https://www.wireshark.org/lists/
wireshark-qa-url:\[\]=https://ask.wireshark.org/
wireshark-snapshots-url:\[\]=https://www.wireshark.org/download/automated/src/
wireshark-users-guide-url:\[\]=https://www.wireshark.org/docs/
wireshark-web-site:\[\]=https://www.wireshark.org/
wireshark-wiki-site:\[\]=https://wiki.wireshark.org/

tcpdump-web-site:\[\]=http://www.tcpdump.org/
tcpdump-man-page-url:\[\]=http://www.tcpdump.org/manpages/tcpdump.1.html
pcap-filter-man-page-url:\[\]=http://www.tcpdump.org/manpages/pcap-filter.7.html

winpcap-web-site:\[\]=https://www.winpcap.org/
winpcap-download-page:\[\]=https://www.winpcap.org/install/

wikipedia-web-site:\[\]=https://en.wikipedia.org/wiki/
sysfs-web-site:\[\]=http://linux-diag.sourceforge.net/Sysfsutils.html
greenwichmeantime-web-site:\[\]=http://wwp.greenwichmeantime.com/
timeanddate-web-site:\[\]=http://www.timeanddate.com/worldclock/
ntp-web-site:\[\]=http://www.ntp.org/

# Make a document attribute after we fully convert to AsciiDoc
wsdg-author-email:\[\]=ulf.lamping[AT]web.de
wsdg-author-email2:\[\]=graham.bloice[AT]trihedral.com

wsug-author-email:\[\]=ulf.lamping[AT]web.de
wsug-author-email2:\[\]=rsharpe[AT]ns.aus.com
wsug-author-email3:\[\]=hagbard[AT]physics.rutgers.edu
wsug-author-email4:\[\]=luis[AT]ontanon.org

gpl-url:\[\]=https://www.gnu.org/licenses/gpl-2.0.html

[macros]

# bugs.wireshark.org link
# ws-buglink:<dddd>[<bug text>]
# Default bug text is "Bug".
# Examples: ws-buglink:5000[] ws-buglink:4000[Wireshark bug number]
(?su)(?<!\w)[\\]?(?P<name>ws-buglink):(?P<target>\d+)\[(?P<attrlist>.*?)(?<!\\)\]=

# www.wireshark.org/security link
# ws-salink:<dddd-dd>[<advisory text>]
# Default advisory text is "".
# Examples: ws-salink:2013-32[] ws-salink:2013-12[Security advisory]
(?su)(?<!\w)[\\]?(?P<name>ws-salink):(?P<target>\d{4}-\d{2,3})\[(?P<attrlist>.*?)(?<!\\)\]=

# CVE ID link
# cve-idlink:<dddd-dddd>[]
# Example: cve-idlink:2013:0001
(?su)(?<!\w)[\\]?(?P<name>cve-idlink):(?P<target>\d{4}-\d+)\[\]=


ifdef::backend-docbook45[]

[ws-buglink-inlinemacro]
<ulink url="https://bugs.wireshark.org/bugzilla/show_bug.cgi?id={target}">{0=Bug} {target}</ulink>

[ws-salink-inlinemacro]
<ulink url="https://www.wireshark.org/security/wnpa-sec-{target}.html">{0=}wnpa-sec-{target}</ulink>

[cve-idlink-inlinemacro]
<ulink url="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-{target}">CVE-{target}</ulink>

endif::backend-docbook45[]


ifdef::backend-html4,backend-html5,backend-xhtml11[]

[ws-buglink-inlinemacro]
<a href="https://bugs.wireshark.org/bugzilla/show_bug.cgi?id={target}">{0=Bug} {target}</a>

[ws-salink-inlinemacro]
<a href="https://www.wireshark.org/security/wnpa-sec-{target}.html">{0=}wnpa-sec-{target}</a>

[cve-idlink-inlinemacro]
<a href="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-{target}">CVE-{target}</a>

endif::backend-html4,backend-html5,backend-xhtml11[]


# Given a list of items, sort and comma-separate them. Blank lines are stripped.
# Case is ignored. For example,
#
# --sort-and-group--
# One
# two
# red
#
# blue
# Fish
#
# --sort-and-group--
#
# produces
#
#     blue, Fish, One, red, two
[blockdef-sort-and-group]
delimiter=^--sort-and-group--$
style=default
filter=sort --ignore-case
default-style=template="paragraph",filter='sort --ignore-case | sed -e "s/,//g" | sed -e "/^$/d" -e "$ s/^/and /" -e "$ ! s/$/,/" -e "1 s/^and //"'