Skip to content

Commit dd9dba4

Browse files
committed
put the revision info section where it belongs
1 parent f1291a7 commit dd9dba4

File tree

1 file changed

+69
-69
lines changed

1 file changed

+69
-69
lines changed

xml/docu_styleguide.structure.xml

Lines changed: 69 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -89,75 +89,6 @@
8989
</tbody>
9090
</tgroup>
9191
</table>
92-
<section xml:id="sec-revinfo">
93-
<title>Revision information</title>
94-
<para>Every HTML file generated from our XML sources must include at least
95-
one revision date. Revision dates signal content freshness to human
96-
readers, search engines and LLMs.</para>
97-
98-
<para>Every chapter, part or book that is included in our builds contains a
99-
revision history. For product documentation up to SLE 15 SP7, this revision
100-
history typically consists of a single revision entry with an empty
101-
description. The revision date is updated in place every time
102-
the content undergoes a significant change.</para>
103-
104-
<para>Starting with SLE 16 releases, product documentation includes
105-
a complete revision history with several dates and descriptions.
106-
Follow the instructions in <xref linkend="sec-revhistory" />.</para>
107-
108-
<para>To determine whether a change you made warrants a revision date, use this table:</para>
109-
<informaltable>
110-
<tgroup cols="2">
111-
<colspec colnum="1" colname="c1" colwidth="4.25*" />
112-
<colspec colnum="3" colname="c3" colwidth="1*" />
113-
<thead>
114-
<row>
115-
<entry>Change</entry>
116-
<entry>Change revision date?</entry>
117-
</row>
118-
</thead>
119-
<tbody>
120-
<row>
121-
<entry>Added a new feature or deleted an obsolete one</entry>
122-
<entry>Yes</entry>
123-
</row>
124-
<row>
125-
<entry>Fixed a broken link</entry>
126-
<entry>Yes</entry>
127-
</row>
128-
<row>
129-
<entry>Metadata fix (new description, change in product name and/or version, ...)</entry>
130-
<entry>Yes</entry>
131-
</row>
132-
<row>
133-
<entry>Typo and grammar fixes, editorial reviews</entry>
134-
<entry>No</entry>
135-
</row>
136-
<row>
137-
<entry>Formatting changes</entry>
138-
<entry>No</entry>
139-
</row>
140-
</tbody>
141-
</tgroup>
142-
</informaltable>
143-
<example xml:id="ex-revinfo-source">
144-
<title>Revision information example (source)</title>
145-
<screen>
146-
&lt;revhistory xml:id="rh-use-rootid"&gt;
147-
&lt;revision&gt;&lt;date&gt;YYYY-MM-DD&lt;/date&gt;
148-
&lt;revdescription /&gt;
149-
&lt;/revision&gt;
150-
&lt;/revhistory&gt;</screen>
151-
</example>
152-
<example xml:id="ex-revinfo-output">
153-
<title>Revision history example (output)</title>
154-
<revhistory xml:id="rh-use-rootid">
155-
<revision><date>2025-12-14</date>
156-
<revdescription />
157-
</revision>
158-
</revhistory>
159-
</example>
160-
</section>
16192
<section xml:id="sec-admonition">
16293
<title>Admonitory and advisory paragraphs</title>
16394
<para>
@@ -3329,6 +3260,75 @@ There are less than 4 GB of space available on the selected partition.</screen>
33293260
<xref linkend="sec-cross-reference"/> and <xref linkend="sec-link"/>.
33303261
</para>
33313262
</section>
3263+
<section xml:id="sec-revinfo">
3264+
<title>Revision information</title>
3265+
<para>Every HTML file generated from our XML sources must include at least
3266+
one revision date. Revision dates signal content freshness to human
3267+
readers, search engines and LLMs.</para>
3268+
3269+
<para>Every chapter, part or book that is included in our builds contains a
3270+
revision history. For product documentation up to SLE 15 SP7, this revision
3271+
history typically consists of a single revision entry with an empty
3272+
description. The revision date is updated in place every time
3273+
the content undergoes a significant change.</para>
3274+
3275+
<para>Starting with SLE 16 releases, product documentation includes
3276+
a complete revision history with several dates and descriptions.
3277+
Follow the instructions in <xref linkend="sec-revhistory" />.</para>
3278+
3279+
<para>To determine whether a change you made warrants a revision date, use this table:</para>
3280+
<informaltable>
3281+
<tgroup cols="2">
3282+
<colspec colnum="1" colname="c1" colwidth="4.25*" />
3283+
<colspec colnum="3" colname="c3" colwidth="1*" />
3284+
<thead>
3285+
<row>
3286+
<entry>Change</entry>
3287+
<entry>Change revision date?</entry>
3288+
</row>
3289+
</thead>
3290+
<tbody>
3291+
<row>
3292+
<entry>Added a new feature or deleted an obsolete one</entry>
3293+
<entry>Yes</entry>
3294+
</row>
3295+
<row>
3296+
<entry>Fixed a broken link</entry>
3297+
<entry>Yes</entry>
3298+
</row>
3299+
<row>
3300+
<entry>Metadata fix (new description, change in product name and/or version, ...)</entry>
3301+
<entry>Yes</entry>
3302+
</row>
3303+
<row>
3304+
<entry>Typo and grammar fixes, editorial reviews</entry>
3305+
<entry>No</entry>
3306+
</row>
3307+
<row>
3308+
<entry>Formatting changes</entry>
3309+
<entry>No</entry>
3310+
</row>
3311+
</tbody>
3312+
</tgroup>
3313+
</informaltable>
3314+
<example xml:id="ex-revinfo-source">
3315+
<title>Revision information example (source)</title>
3316+
<screen>
3317+
&lt;revhistory xml:id="rh-use-rootid"&gt;
3318+
&lt;revision&gt;&lt;date&gt;YYYY-MM-DD&lt;/date&gt;
3319+
&lt;revdescription /&gt;
3320+
&lt;/revision&gt;
3321+
&lt;/revhistory&gt;</screen>
3322+
</example>
3323+
<example xml:id="ex-revinfo-output">
3324+
<title>Revision history example (output)</title>
3325+
<revhistory xml:id="rh-use-rootid">
3326+
<revision><date>2025-12-14</date>
3327+
<revdescription />
3328+
</revision>
3329+
</revhistory>
3330+
</example>
3331+
</section>
33323332
<section xml:id="sec-table">
33333333
<title>Tables</title>
33343334
<para>

0 commit comments

Comments
 (0)