Skip to content

Commit f932966

Browse files
committed
Updated Style Guide for AsciiDoc
1 parent 3a6e4b3 commit f932966

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

xml/MAIN.styleguide.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
<xi:include href="docu_styleguide.taglist.xml" outputformat="db"/>
6060
<xi:include href="docu_styleguide.manage.xml"/>
6161
<xi:include href="docu_styleguide.xmlformat.xml" outputformat="db"/>
62-
<xi:include href="docu_styleguide.smartdocs.xml"/>
62+
<xi:include href="docu_styleguide.smartdocs.xml" outputformat="db"/>
6363
<xi:include href="docu_styleguide.terminology.xml"/>
6464
<xi:include href="docu_styleguide.contributors.xml"/>
6565
<xi:include href="gfdl.xml"/>

xml/docu_styleguide.structure.xml

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3262,19 +3262,23 @@ There are less than 4 GB of space available on the selected partition.</screen>
32623262
</section>
32633263
<section xml:id="sec-revinfo">
32643264
<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>
3265+
<para>Every HTML file generated from our documentation sources must include
3266+
at least one revision date. Revision dates signal content freshness to human
3267+
readers, search engines and LLMs.</para>
32683268

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>
3269+
<para>Every chapter, part or book that is included in our builds contains a
3270+
revision history. <phrase outputformat="db">For product documentation up to
3271+
SLE 15 SP7, this revision history typically consists of a single revision
3272+
entry with an empty description.</phrase><phrase outputformat="db">For
3273+
documentation written in AsciiDoc, the revision date is the value of the
3274+
<literal>:revdate:</literal> attribute, such as <literal>:revdate:
3275+
2025-07-31</literal>.</phrase> The revision date is updated in place every
3276+
time the content undergoes a significant change.</para>
32743277

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+
<para outputformat="db">Starting with SLE 16 releases, product
3279+
documentation includes a complete revision history with several dates and
3280+
descriptions. Follow the instructions in <xref linkend="sec-revhistory"
3281+
/>.</para>
32783282

32793283
<para>To determine whether a change you made warrants a revision date, use this table:</para>
32803284
<informaltable>

0 commit comments

Comments
 (0)