Documentation: Rename link macros
[stgit] / Documentation / asciidoc.conf
1 [attributes]
2 asterisk=*
3 plus=+
4 caret=^
5 startsb=[
6 endsb=]
7 tilde=~
8
9 ifdef::backend-docbook[]
10 ifndef::docbook-xsl-172[]
11 # "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this.
12 # v1.72 breaks with this because it replaces dots not in roff requests.
13 [listingblock]
14 <example><title>{title}</title>
15 <literallayout>
16 ifdef::doctype-manpage[]
17 &#10;.ft C&#10;
18 endif::doctype-manpage[]
19 |
20 ifdef::doctype-manpage[]
21 &#10;.ft&#10;
22 endif::doctype-manpage[]
23 </literallayout>
24 {title#}</example>
25 endif::docbook-xsl-172[]
26 endif::backend-docbook[]
27
28 ifdef::doctype-manpage[]
29 ifdef::backend-docbook[]
30 [header]
31 template::[header-declarations]
32 <refentry>
33 <refmeta>
34 <refentrytitle>{mantitle}</refentrytitle>
35 <manvolnum>{manvolnum}</manvolnum>
36 <refmiscinfo class="source">StGit</refmiscinfo>
37 <refmiscinfo class="version">{stgit_version}</refmiscinfo>
38 <refmiscinfo class="manual">StGit Manual</refmiscinfo>
39 </refmeta>
40 <refnamediv>
41 <refname>{manname}</refname>
42 <refpurpose>{manpurpose}</refpurpose>
43 </refnamediv>
44 endif::backend-docbook[]
45 endif::doctype-manpage[]
46
47 ## htmllink: macro
48 #
49 # Usage: htmllink:url[text]
50
51 ifdef::backend-docbook[]
52 [htmllink-inlinemacro]
53 {0}
54 endif::backend-docbook[]
55
56 ifdef::backend-xhtml11[]
57 [htmllink-inlinemacro]
58 <a href="{target}">{0}</a>
59 endif::backend-xhtml11[]
60
61 ## manlink: macro
62 #
63 # Usage: manlink:command[manpage-section]
64 #
65 # Note, {0} is the manpage section, while {target} is the command.
66 #
67 # Show link as: <command>(<section>); if section is defined, else just
68 # show the command.
69
70 ifdef::backend-docbook[]
71 [manlink-inlinemacro]
72 {0%{target}}
73 {0#<citerefentry>}
74 {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
75 {0#</citerefentry>}
76 endif::backend-docbook[]
77
78 ifdef::backend-xhtml11[]
79 [manlink-inlinemacro]
80 <a href="{target}.html">{target}{0?({0})}</a>
81 endif::backend-xhtml11[]
82
83 ## linkstg: macro
84 #
85 # Usage: linkstg:command[]
86 #
87 # Show StGit link as: stg-<command>(1) in man pages, stg <command> in
88 # html.
89
90 ifdef::backend-docbook[]
91 [linkstg-inlinemacro]
92 <citerefentry>
93 <refentrytitle>stg-{target}</refentrytitle><manvolnum>1</manvolnum>
94 </citerefentry>
95 endif::backend-docbook[]
96
97 ifdef::backend-xhtml11[]
98 [linkstg-inlinemacro]
99 <a href="stg-{target}.html">stg {target}</a>
100 endif::backend-xhtml11[]
101
102 ## linkstgsub: macro
103 #
104 # Usage: linkstgsub:command[]
105 #
106 # Show StGit link as: <command>.
107
108 ifdef::backend-docbook[]
109 [linkstgsub-inlinemacro]
110 {target}
111 endif::backend-docbook[]
112
113 ifdef::backend-xhtml11[]
114 [linkstgsub-inlinemacro]
115 <a href="stg-{target}.html">{target}</a>
116 endif::backend-xhtml11[]