Merge branch 'nk/config-local-doc'
[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 ifndef::git-asciidoc-no-roff[]
35 # "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this.
36 # v1.72 breaks with this because it replaces dots not in roff requests.
37 [listingblock]
38 <example><title>{title}</title>
39 <literallayout class="monospaced">
40 ifdef::doctype-manpage[]
41 &#10;.ft C&#10;
42 endif::doctype-manpage[]
43 |
44 ifdef::doctype-manpage[]
45 &#10;.ft&#10;
46 endif::doctype-manpage[]
47 </literallayout>
48 {title#}</example>
49 endif::git-asciidoc-no-roff[]
50
51 ifdef::git-asciidoc-no-roff[]
52 ifdef::doctype-manpage[]
53 # The following two small workarounds insert a simple paragraph after screen
54 [listingblock]
55 <example><title>{title}</title>
56 <literallayout class="monospaced">
57 |
58 </literallayout><simpara></simpara>
59 {title#}</example>
60
61 [verseblock]
62 <formalpara{id? id="{id}"}><title>{title}</title><para>
63 {title%}<literallayout{id? id="{id}"}>
64 {title#}<literallayout>
65 |
66 </literallayout>
67 {title#}</para></formalpara>
68 {title%}<simpara></simpara>
69 endif::doctype-manpage[]
70 endif::git-asciidoc-no-roff[]
71 endif::backend-docbook[]
72
73 ifdef::doctype-manpage[]
74 ifdef::backend-docbook[]
75 [header]
76 template::[header-declarations]
77 <refentry>
78 <refmeta>
79 <refentrytitle>{mantitle}</refentrytitle>
80 <manvolnum>{manvolnum}</manvolnum>
81 <refmiscinfo class="source">Git</refmiscinfo>
82 <refmiscinfo class="version">{git_version}</refmiscinfo>
83 <refmiscinfo class="manual">Git Manual</refmiscinfo>
84 </refmeta>
85 <refnamediv>
86   <refname>{manname}</refname>
87   <refpurpose>{manpurpose}</refpurpose>
88 </refnamediv>
89 endif::backend-docbook[]
90 endif::doctype-manpage[]
91
92 ifdef::backend-xhtml11[]
93 [attributes]
94 git-relative-html-prefix=
95 [linkgit-inlinemacro]
96 <a href="{git-relative-html-prefix}{target}.html">{target}{0?({0})}</a>
97 endif::backend-xhtml11[]