summaryrefslogtreecommitdiff
path: root/www/hs-gitit/files/patch-data_markupHelp_DocBook
blob: d246b8f7f45d1ba6ee848f90a77fed5972690f08 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
--- data/markupHelp/DocBook.orig	2023-07-10 15:44:20 UTC
+++ data/markupHelp/DocBook
@@ -0,0 +1,122 @@
+~~~~~~~~
+
+<section id="docbook">
+ <title>Using DocBook</title>
+ <simpara>
+  As DocBook is an XML format, opening and closing tags
+  must match (&lt;tag&gt;...&lt;/tag&gt;).
+ </simpara>
+ <section id="inline">
+  <title>Text Formatting</title>
+  <simpara>
+   A simple paragraph.
+  </simpara>
+  <para>
+   A complex paragraph may contain blocks.
+  </para>
+  <simpara>
+   italics: <emphasis>italics</emphasis>,
+   bold: <emphasis role="strong">bold</emphasis>,
+   strikeout: <emphasis role="strikethrough">strikeout</emphasis>,
+   inline code snippets: <literal>inline code</literal>.
+  </simpara>
+  <simpara>
+   Links:
+   <ulink url="http://foo.bar/baz">external</ulink>,
+   <ulink url="Pagename">internal Wiki Link</ulink>.
+  </simpara>
+  <simpara>
+   Inserting an image:
+   <inlinemediaobject>
+    <alt>folder</alt>
+    <imageobject>
+     <imagedata fileref="/img/icons/folder.png" />
+    </imageobject>
+   </inlinemediaobject>
+  </simpara>
+ </section>
+ <section id="blocks">
+  <title>Text Blocks</title>
+  <para>
+   Quotation:
+   <blockquote>
+    <simpara>
+     A quotation set off from the main text.
+    </simpara>
+   </blockquote>
+  </para>
+  <para>
+   Code listing:
+   <programlisting>
+#!/bin/sh -e
+echo &quot;Hello world&quot;
+   </programlisting>
+  </para>
+ </section>
+ <section id="lists">
+  <title>Lists</title>
+  <para>
+   Simple list:
+   <itemizedlist spacing="compact">
+    <listitem>
+     <simpara>
+      first
+     </simpara>
+    </listitem>
+    <listitem>
+     <simpara>
+      second
+     </simpara>
+    </listitem> 
+   </itemizedlist>
+   Numbered list:
+   <orderedlist spacing="compact">
+    <listitem>
+     <simpara>
+      first
+     </simpara>
+    </listitem>
+    <listitem>
+     <simpara>
+      second
+     </simpara>
+    </listitem> 
+   </orderedlist>
+   Definition list:
+   <variablelist>
+    <varlistentry>
+     <term>
+      DocBook
+     </term>
+     <listitem>
+      <simpara>
+       A sophisticated XML format.
+      </simpara>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term>
+      orange
+     </term>
+     <listitem>
+      <simpara>
+       A healthy fruit.
+      </simpara>
+     </listitem>
+     <listitem>
+      <simpara>
+       A warm colour.
+      </simpara>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </section>
+</section>
+ 
+~~~~~~~~
+
+Further reading:
+[DocBook 5: The Definitive Guide](https://tdg.docbook.org/tdg/5.0/docbook.html),
+which includes the
+[List of DocBook elements](https://tdg.docbook.org/tdg/5.0/chunk-part-d64e8789.html).