revision: ensure full index
[git] / Documentation / asciidoc.conf
1 ## linkgit: macro
2 #
3 # Usage: linkgit:command[manpage-section]
4 #
5 # Note, {0} is the manpage section, while {target} is the command.
6 #
7 # Show Git link as: <command>(<section>); if section is defined, else just show
8 # the command.
9
10 [macros]
11 (?su)[\\]?(?P<name>linkgit):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
12
13 [attributes]
14 asterisk=&#42;
15 plus=&#43;
16 caret=&#94;
17 startsb=&#91;
18 endsb=&#93;
19 backslash=&#92;
20 tilde=&#126;
21 apostrophe=&#39;
22 backtick=&#96;
23 litdd=&#45;&#45;
24
25 ifdef::backend-docbook[]
26 [linkgit-inlinemacro]
27 {0%{target}}
28 {0#<citerefentry>}
29 {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
30 {0#</citerefentry>}
31 endif::backend-docbook[]
32
33 ifdef::backend-docbook[]
34 ifdef::doctype-manpage[]
35 # The following two small workarounds insert a simple paragraph after screen
36 [listingblock]
37 <example><title>{title}</title>
38 <literallayout class="monospaced">
39 |
40 </literallayout><simpara></simpara>
41 {title#}</example>
42
43 [verseblock]
44 <formalpara{id? id="{id}"}><title>{title}</title><para>
45 {title%}<literallayout{id? id="{id}"}>
46 {title#}<literallayout>
47 |
48 </literallayout>
49 {title#}</para></formalpara>
50 {title%}<simpara></simpara>
51 endif::doctype-manpage[]
52 endif::backend-docbook[]
53
54 ifdef::doctype-manpage[]
55 ifdef::backend-docbook[]
56 [header]
57 template::[header-declarations]
58 <refentry>
59 <refmeta>
60 <refentrytitle>{mantitle}</refentrytitle>
61 <manvolnum>{manvolnum}</manvolnum>
62 <refmiscinfo class="source">{mansource}</refmiscinfo>
63 <refmiscinfo class="version">{manversion}</refmiscinfo>
64 <refmiscinfo class="manual">{manmanual}</refmiscinfo>
65 </refmeta>
66 <refnamediv>
67   <refname>{manname}</refname>
68   <refpurpose>{manpurpose}</refpurpose>
69 </refnamediv>
70 endif::backend-docbook[]
71 endif::doctype-manpage[]
72
73 ifdef::backend-xhtml11[]
74 [attributes]
75 git-relative-html-prefix=
76 [linkgit-inlinemacro]
77 <a href="{git-relative-html-prefix}{target}.html">{target}{0?({0})}</a>
78 endif::backend-xhtml11[]