doc/source/en/TortoiseGit/git_doc.patch

   1 Generating git docbook documentation:
   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
  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 aea8627..5a920b6 100644
  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,6 +32,49 @@ 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?article}{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 +<article lang="{lang=en}" id="{doctitle}">
  73 +<articleinfo>
  74 +template::[docinfo]
  75 +<indexterm>
  76 +<primary>{doctitle}</primary>
  77 +</indexterm>
  78 +</articleinfo>
  79 +
  80 +[linkgit-inlinemacro]
  81 +{0%{target}}
  82 +<xref linkend="{target}({0})" />
  83 +
  84 +[link-inlinemacro]
  85 +{0%{target}}
  86 +<link linkend="{target}">{0}</link>
  87 +
  88 +[sect1]
  89 +<simplesect{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
  90 +<title>{title}</title>
  91 +|
  92 +</simplesect>
  93 +
  94 +[literal-inlinemacro]
  95 +# Inline literal.
  96 +<emphasis>{passtext}</emphasis>
  97 +
  98 +[quotes]
  99 +ifdef::no-inline-literal[]
 100 +`=literal
 101 +endif::no-inline-literal[]
 102 +
 103 +endif::doctype-article[]
 104 +endif::backend-docbook[]
 105 +
 106 +ifdef::backend-docbook[]
 107  ifndef::git-asciidoc-no-roff[]
 108  # "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this.
 109  # v1.72 breaks with this because it replaces dots not in roff requests.
 110 diff --git a/Documentation/user-manual.conf b/Documentation/user-manual.conf
 111 index 339b309..d422ae4 100644
 112 --- a/Documentation/user-manual.conf
 113 +++ b/Documentation/user-manual.conf
 114 @@ -7,15 +7,44 @@ startsb=&#91;
 115  endsb=&#93;
 116  tilde=&#126;
 117
 118 +[header]
 119 +template::[header-declarations]
 120 +
 121 +<article lang="{lang=en}">
 122 +<articleinfo>
 123 +template::[docinfo]
 124 +</articleinfo>
 125 +
 126  [linkgit-inlinemacro]
 127 -<ulink url="{target}.html">{target}{0?({0})}</ulink>
 128 +<xref linkend="{target}{0?({0})}" />
 129 +
 130 +[sect1]
 131 +<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
 132 +<title>{title}</title>
 133 +|
 134 +</section>
 135
 136 -ifdef::backend-docbook[]
 137 -# "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this.
 138  [listingblock]
 139  <example><title>{title}</title>
 140  <literallayout>
 141 +ifdef::doctype-manpage[]
 142 +&#10;.ft C&#10;
 143 +endif::doctype-manpage[]
 144  |
 145 +ifdef::doctype-manpage[]
 146 +&#10;.ft&#10;
 147 +endif::doctype-manpage[]
 148  </literallayout>
 149  {title#}</example>
 150 -endif::backend-docbook[]
 151 +endif::git-asciidoc-no-roff[]
 152 +
 153 +ifdef::git-asciidoc-no-roff[]
 154 +ifdef::doctype-manpage[]
 155 +# The following two small workarounds insert a simple paragraph after screen
 156 +[listingblock]
 157 +<example><title>{title}</title>
 158 +<literallayout>
 159 +|
 160 +</literallayout><simpara></simpara>
 161 +{title#}</example>
 162 +endif::doctype-manpage[]
 163 diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
 164 index 1b94207..49a0a9c 100644
 165 --- a/Documentation/user-manual.txt
 166 +++ b/Documentation/user-manual.txt
 167 @@ -1,5 +1,5 @@
 168  Git User's Manual (for version 1.5.3 or newer)
 169 -______________________________________________
 170 +==============================================
 171
 172
 173  Git is a fast distributed revision control system.