Merge branch 'cc/cherry-pick-series'
[git.git] / Documentation / asciidoc.conf
blob87a90f2c3fd48bbb593a2cef135310f88d87e4b4
1 ## linkgit: macro
3 # Usage: linkgit:command[manpage-section]
5 # Note, {0} is the manpage section, while {target} is the command.
7 # Show GIT link as: <command>(<section>); if section is defined, else just show
8 # the command.
10 [macros]
11 (?su)[\\]?(?P<name>linkgit):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
13 [attributes]
14 asterisk=&#42;
15 plus=&#43;
16 caret=&#94;
17 startsb=&#91;
18 endsb=&#93;
19 tilde=&#126;
20 backtick=&#96;
22 ifdef::backend-docbook[]
23 [linkgit-inlinemacro]
24 {0%{target}}
25 {0#<citerefentry>}
26 {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
27 {0#</citerefentry>}
28 endif::backend-docbook[]
30 ifdef::backend-docbook[]
31 ifndef::git-asciidoc-no-roff[]
32 # "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this.
33 # v1.72 breaks with this because it replaces dots not in roff requests.
34 [listingblock]
35 <example><title>{title}</title>
36 <literallayout>
37 ifdef::doctype-manpage[]
38 &#10;.ft C&#10;
39 endif::doctype-manpage[]
41 ifdef::doctype-manpage[]
42 &#10;.ft&#10;
43 endif::doctype-manpage[]
44 </literallayout>
45 {title#}</example>
46 endif::git-asciidoc-no-roff[]
48 ifdef::git-asciidoc-no-roff[]
49 ifdef::doctype-manpage[]
50 # The following two small workarounds insert a simple paragraph after screen
51 [listingblock]
52 <example><title>{title}</title>
53 <literallayout>
55 </literallayout><simpara></simpara>
56 {title#}</example>
58 [verseblock]
59 <formalpara{id? id="{id}"}><title>{title}</title><para>
60 {title%}<literallayout{id? id="{id}"}>
61 {title#}<literallayout>
63 </literallayout>
64 {title#}</para></formalpara>
65 {title%}<simpara></simpara>
66 endif::doctype-manpage[]
67 endif::git-asciidoc-no-roff[]
68 endif::backend-docbook[]
70 ifdef::doctype-manpage[]
71 ifdef::backend-docbook[]
72 [header]
73 template::[header-declarations]
74 <refentry>
75 <refmeta>
76 <refentrytitle>{mantitle}</refentrytitle>
77 <manvolnum>{manvolnum}</manvolnum>
78 <refmiscinfo class="source">Git</refmiscinfo>
79 <refmiscinfo class="version">{git_version}</refmiscinfo>
80 <refmiscinfo class="manual">Git Manual</refmiscinfo>
81 </refmeta>
82 <refnamediv>
83   <refname>{manname}</refname>
84   <refpurpose>{manpurpose}</refpurpose>
85 </refnamediv>
86 endif::backend-docbook[]
87 endif::doctype-manpage[]
89 ifdef::backend-xhtml11[]
90 [linkgit-inlinemacro]
91 <a href="{target}.html">{target}{0?({0})}</a>
92 endif::backend-xhtml11[]