doc/source/en/TortoiseGit/git_doc.patch

   1 Generating git docbook documentation: (done on Debian SID)
   2 - Clone git
   3 - apply patch
   4 - change (system/global) asciidoc.conf
   5   - comment:
   6     (?su)(?<!\w)[\\]?(?P<name>http|https|ftp|file|irc|mailto|callto|image|link|anchor|xref|indexterm):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
   7     lsquo=&#8216;
   8     rsquo=&#8217;
   9     ldquo=&#8220;
  10     rdquo=&#8221;
  11     (^-- )=&#8212;&#8201;
  12     (\n-- )|( -- )|( --\n)=&#8201;&#8212;&#8201;
  13     (\w)--(\w)=\1&#8212;\2
  14     (\w)'(\w)=\1&#8217;\2
  15 - make xml
  16 - take *.xml files (skip git-tools.xml)
  17 - after generation change everyday.xml: article-id to everyday
  18
  19 diff --git a/Documentation/Makefile b/Documentation/Makefile
  20 index 9ad6a6a..adfe07a 100644
  21 --- a/Documentation/Makefile
  22 +++ b/Documentation/Makefile
  23 @@ -165,6 +165,8 @@ html: $(DOC_HTML)
  24
  25  $(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf
  26
  27 +xml: cmd-list.perl $(MAN_XML) user-manual.xml everyday.xml
  28 +
  29  man: man1 man5 man7
  30  man1: $(DOC_MAN1)
  31  man5: $(DOC_MAN5)
  32 @@ -257,13 +259,13 @@ manpage-base-url.xsl: manpage-base-url.xsl.in
  33
  34  %.xml : %.txt
  35         $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
  36 -       $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \
  37 +       $(ASCIIDOC) -b docbook -d article -f asciidoc.conf \
  38                 $(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $< && \
  39         mv $@+ $@
  40
  41  user-manual.xml: user-manual.txt user-manual.conf
  42         $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
  43 -       $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d book -o $@+ $< && \
  44 +       $(ASCIIDOC) $(ASCIIDOC_EXTRA) -b docbook -d article -o $@+ $< && \
  45         mv $@+ $@
  46
  47  technical/api-index.txt: technical/api-index-skel.txt \
  48 diff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf
  49 index 1273a85..5223c99
  50 --- a/Documentation/asciidoc.conf
  51 +++ b/Documentation/asciidoc.conf
  52 @@ -9,6 +9,7 @@
  53
  54  [macros]
  55  (?su)[\\]?(?P<name>linkgit):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
  56 +(?su)(?<!\w)[\\]?(?P<name>link):\S*?#(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
  57
  58  [attributes]
  59  asterisk=&#42;
  60 @@ -31,12 +32,94 @@ ifdef::backend-docbook[]
  61  endif::backend-docbook[]
  62
  63  ifdef::backend-docbook[]
  64 +[header-declarations]
  65 +<?xml version="1.0" encoding="{encoding}"?>
  66 +<!DOCTYPE {doctype-article?sect2}{doctype-book?book}{doctype-manpage?refentry} PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
  67 +
  68 +ifdef::doctype-article[]
  69 +[header]
  70 +template::[header-declarations]
  71 +
  72 +<sect2 lang="{lang=en}" id="{doctitle}">
  73 +template::[docinfo]
  74 +<indexterm>
  75 +<primary>{doctitle}</primary>
  76 +</indexterm>
  77 +
  78 +[footer]
  79 +</sect2>
  80 +
  81 +[callout-inlinemacro]
  82 +# Callout.
  83 +<co id="{docname}_{coid}"/>
  84 +
  85 +[listtags-callout]
  86 +list=<calloutlist{id? id="{docname}_{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>{title?<title>{title}</title>}|</calloutlist>
  87 +item=<callout arearefs="{docname}_{coids}">|</callout>
  88 +text=<para>|</para>
  89 +
  90 +# [[id,text]]
  91 +[anchor2-inlinemacro]
  92 +<anchor id="{doctitle}_{1}" xreflabel="{2=[{1}]}"/>
  93 +# [[[id]]]
  94 +[anchor3-inlinemacro]
  95 +<anchor id="{doctitle}_{1}" xreflabel="[{1}]"/>[{1}]
  96 +# <<id,text>>
  97 +[xref2-inlinemacro]
  98 +<link linkend="{doctitle}_{1}">{2}</link>
  99 +{2%}<xref linkend="{doctitle}_{1}"/>
 100 +
 101 +[appendix]
 102 +<sect3{id? id="{doctitle}_{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
 103 +<title>{title}</title>
 104 +|
 105 +</sect3>
 106 +
 107 +[linkgit-inlinemacro]
 108 +{0%{target}}
 109 +<xref linkend="{target}({0})" />
 110 +
 111 +[link-inlinemacro]
 112 +{0%{target}}
 113 +<link linkend="{target}">{0}</link>
 114 +
 115 +[sect1]
 116 +<simplesect{id? id="{doctitle}_{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
 117 +<title>{title}</title>
 118 +|
 119 +</simplesect>
 120 +
 121 +[sect2]
 122 +<section{id? id="{doctitle}_{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
 123 +<title>{title}</title>
 124 +|
 125 +</section>
 126 +
 127 +[sect3]
 128 +<section{id? id="{doctitle}_{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
 129 +<title>{title}</title>
 130 +|
 131 +</section>
 132 +
 133 +[literal-inlinemacro]
 134 +# Inline literal.
 135 +<emphasis>{passtext}</emphasis>
 136 +
 137 +[quotes]
 138 +ifdef::no-inline-literal[]
 139 +`=literal
 140 +endif::no-inline-literal[]
 141 +
 142 +endif::doctype-article[]
 143 +endif::backend-docbook[]
 144 +
 145 +ifdef::backend-docbook[]
 146  ifndef::git-asciidoc-no-roff[]
 147  # "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this.
 148  # v1.72 breaks with this because it replaces dots not in roff requests.
 149  [listingblock]
 150  <example><title>{title}</title>
 151 -<literallayout class="monospaced">
 152 +<literallayout>
 153  ifdef::doctype-manpage[]
 154  &#10;.ft C&#10;
 155  endif::doctype-manpage[]
 156 @@ -53,7 +136,7 @@ ifdef::doctype-manpage[]
 157  # The following two small workarounds insert a simple paragraph after screen
 158  [listingblock]
 159  <example><title>{title}</title>
 160 -<literallayout class="monospaced">
 161 +<literallayout>
 162  |
 163  </literallayout><simpara></simpara>
 164  {title#}</example>
 165 diff --git a/Documentation/user-manual.conf b/Documentation/user-manual.conf
 166 index d87294d..704f2cc
 167 --- a/Documentation/user-manual.conf
 168 +++ b/Documentation/user-manual.conf
 169 @@ -7,15 +7,53 @@ startsb=&#91;
 170  endsb=&#93;
 171  tilde=&#126;
 172
 173 +[header]
 174 +template::[header-declarations]
 175 +
 176 +<sect2 lang="{lang=en}" id="git_user-manual">
 177 +template::[docinfo]
 178 +
 179  [linkgit-inlinemacro]
 180 -<ulink url="{target}.html">{target}{0?({0})}</ulink>
 181 +<xref linkend="{target}{0?({0})}" />
 182 +
 183 +# [[id,text]]
 184 +[anchor2-inlinemacro]
 185 +<anchor id="{doctitle}_{1}" xreflabel="{2=[{1}]}"/>
 186 +# [[[id]]]
 187 +[anchor3-inlinemacro]
 188 +<anchor id="{doctitle}_{1}" xreflabel="[{1}]"/>[{1}]
 189 +# <<id,text>>
 190 +[xref2-inlinemacro]
 191 +<link linkend="{doctitle}_{1}">{2}</link>
 192 +{2%}<xref linkend="{doctitle}_{1}"/>
 193 +
 194 +[sect1]
 195 +<section{id? id="{doctitle}_{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
 196 +<title>{title}</title>
 197 +|
 198 +</section>
 199
 200 -ifdef::backend-docbook[]
 201 -# "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this.
 202  [listingblock]
 203  <example><title>{title}</title>
 204 -<literallayout class="monospaced">
 205 +<literallayout>
 206 +ifdef::doctype-manpage[]
 207 +&#10;.ft C&#10;
 208 +endif::doctype-manpage[]
 209  |
 210 +ifdef::doctype-manpage[]
 211 +&#10;.ft&#10;
 212 +endif::doctype-manpage[]
 213  </literallayout>
 214  {title#}</example>
 215 -endif::backend-docbook[]
 216 +endif::git-asciidoc-no-roff[]
 217 +
 218 +ifdef::git-asciidoc-no-roff[]
 219 +ifdef::doctype-manpage[]
 220 +# The following two small workarounds insert a simple paragraph after screen
 221 +[listingblock]
 222 +<example><title>{title}</title>
 223 +<literallayout>
 224 +|
 225 +</literallayout><simpara></simpara>
 226 +{title#}</example>
 227 +endif::doctype-manpage[]
 228 diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
 229 index 1b94207..49a0a9c 100644
 230 --- a/Documentation/user-manual.txt
 231 +++ b/Documentation/user-manual.txt
 232 @@ -1,5 +1,5 @@
 233  Git User's Manual (for version 1.5.3 or newer)
 234 -______________________________________________
 235 +==============================================
 236
 237
 238  Git is a fast distributed revision control system.