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 (?P<name>linkman):(?P<target>\w+)\[(?P<attrlist>\d+)]=
  13 (?P<name>linkstgsub):(?P<target>\w+)\[]=
  14 (?P<name>linkstg):(?P<target>\w+)\[]=
  15
  16 [attributes]
  17 asterisk=&#42;
  18 plus=&#43;
  19 caret=&#94;
  20 startsb=&#91;
  21 endsb=&#93;
  22 backslash=&#92;
  23 tilde=&#126;
  24 apostrophe=&#39;
  25 backtick=&#96;
  26 litdd=&#45;&#45;
  27
  28 ifdef::backend-docbook[]
  29 [linkgit-inlinemacro]
  30 {0%{target}}
  31 {0#<citerefentry>}
  32 {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
  33 {0#</citerefentry>}
  34 endif::backend-docbook[]
  35
  36 ifdef::backend-docbook[]
  37 ifndef::stgit-asciidoc-no-roff[]
  38 # "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this.
  39 # v1.72 breaks with this because it replaces dots not in roff requests.
  40 [listingblock]
  41 <example><title>{title}</title>
  42 <literallayout class="monospaced">
  43 ifdef::doctype-manpage[]
  44 &#10;.ft C&#10;
  45 endif::doctype-manpage[]
  46 |
  47 ifdef::doctype-manpage[]
  48 &#10;.ft&#10;
  49 endif::doctype-manpage[]
  50 </literallayout>
  51 {title#}</example>
  52 endif::stgit-asciidoc-no-roff[]
  53
  54 ifdef::stgit-asciidoc-no-roff[]
  55 ifdef::doctype-manpage[]
  56 # The following two small workarounds insert a simple paragraph after screen
  57 [listingblock]
  58 <example><title>{title}</title>
  59 <literallayout class="monospaced">
  60 |
  61 </literallayout><simpara></simpara>
  62 {title#}</example>
  63
  64 [verseblock]
  65 <formalpara{id? id="{id}"}><title>{title}</title><para>
  66 {title%}<literallayout{id? id="{id}"}>
  67 {title#}<literallayout>
  68 |
  69 </literallayout>
  70 {title#}</para></formalpara>
  71 {title%}<simpara></simpara>
  72 endif::doctype-manpage[]
  73 endif::stgit-asciidoc-no-roff[]
  74 endif::backend-docbook[]
  75
  76 ifdef::doctype-manpage[]
  77 ifdef::backend-docbook[]
  78 [header]
  79 template::[header-declarations]
  80 <refentry>
  81 <refmeta>
  82 <refentrytitle>{mantitle}</refentrytitle>
  83 <manvolnum>{manvolnum}</manvolnum>
  84 <refmiscinfo class="source">{mansource}</refmiscinfo>
  85 <refmiscinfo class="version">{manversion}</refmiscinfo>
  86 <refmiscinfo class="manual">{manmanual}</refmiscinfo>
  87 </refmeta>
  88 <refnamediv>
  89   <refname>{manname}</refname>
  90   <refpurpose>{manpurpose}</refpurpose>
  91 </refnamediv>
  92 endif::backend-docbook[]
  93 endif::doctype-manpage[]
  94
  95 ifdef::backend-xhtml11,backend-html5[]
  96 [attributes]
  97 git-relative-html-prefix=
  98 [linkgit-inlinemacro]
  99 # <a href="{git-relative-html-prefix}{target}.html">{target}{0?({0})}</a>
 100 <a href="https://git-scm.com/docs/{target}">{target}{0?({0})}</a>
 101 endif::backend-xhtml11,backend-html5[]
 102
 103 ## linkman: macro
 104 #
 105 # Usage: linkman:command[manpage-section]
 106 #
 107 # Note, {0} is the manpage section, while {target} is the command.
 108 #
 109 # Show link as: <command>(<section>); if section is defined, else just
 110 # show the command.
 111
 112 ifdef::backend-docbook[]
 113 [linkman-inlinemacro]
 114 {0%{target}}
 115 {0#<citerefentry>}
 116 {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
 117 {0#</citerefentry>}
 118 endif::backend-docbook[]
 119
 120 ifdef::backend-xhtml11,backend-html5[]
 121 [linkman-inlinemacro]
 122 <a href="{target}.html">{target}{0?({0})}</a>
 123 endif::backend-xhtml11,backend-html5[]
 124
 125 ## linkstg: macro
 126 #
 127 # Usage: linkstg:command[]
 128 #
 129 # Show StGit link as: stg-<command>(1) in man pages, stg <command> in
 130 # html.
 131
 132 ifdef::backend-docbook[]
 133 [linkstg-inlinemacro]
 134 <citerefentry>
 135   <refentrytitle>stg-{target}</refentrytitle><manvolnum>1</manvolnum>
 136 </citerefentry>
 137 endif::backend-docbook[]
 138
 139 ifdef::backend-xhtml11,backend-html5[]
 140 [linkstg-inlinemacro]
 141 <a href="stg-{target}.html">stg {target}</a>
 142 endif::backend-xhtml11,backend-html5[]
 143
 144 ## linkstgsub: macro
 145 #
 146 # Usage: linkstgsub:command[]
 147 #
 148 # Show StGit link as: <command>.
 149
 150 ifdef::backend-docbook[]
 151 [linkstgsub-inlinemacro]
 152 {target}
 153 endif::backend-docbook[]
 154
 155 ifdef::backend-xhtml11,backend-html5[]
 156 [linkstgsub-inlinemacro]
 157 <a href="stg-{target}.html">{target}</a>
 158 endif::backend-xhtml11,backend-html5[]