Skip to content

Commit

Permalink
Updated revhistory example output
Browse files Browse the repository at this point in the history
  • Loading branch information
dariavladykina committed Nov 8, 2023
1 parent ace0583 commit c5e1b25
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions xml/docu_styleguide.smartdocs.xml
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,8 @@ ultrashort description for social media, max. 55 chars</meta>
<example xml:id="ex-revhistory-source">
<title>Revision history example (source)</title>
<screen>
&lt;revision&gt;&lt;date&gt;2024-11-13&lt;/date&gt;
&lt;revhistory xml:id="rh-USE_ROOTID"&gt;
&lt;revision&gt;&lt;date&gt;2024-11-13&lt;/date&gt;
&lt;revdescription&gt;
&lt;itemizedlist&gt;
&lt;listitem&gt;&lt;para&gt;Added sections to resolve issue &lt;uri&gt;bsc#12345&lt;/uri&gt;:&lt;/para&gt;
Expand All @@ -380,8 +381,10 @@ ultrashort description for social media, max. 55 chars&lt;/meta>
</example>
<example xml:id="ex-revhistory-output">
<title>Revision history example (output)</title>
<para>2024-11-13</para>
<itemizedlist>
<revhistory xml:id="rh-USE_ROOTID">
<revision><date>2024-11-13</date>
<revdescription>
<itemizedlist>
<listitem><para>Added sections to resolve issue <uri>bsc#12345</uri>:</para>
<itemizedlist>
<listitem><para>New section on foo</para></listitem>
Expand All @@ -390,8 +393,13 @@ ultrashort description for social media, max. 55 chars&lt;/meta>
</listitem>
<listitem><para>Removed section on <quote>foo foo</quote></para></listitem>
</itemizedlist>
</revdescription>
</revision>
</revhistory>
</example>
<para>Find more detailed recommendations for adding information to your
revision history in the assembly template, under the <tag class="emptytag">revhistory</tag> tag.</para>
revision history in the assembly template of the <link
xlink:href="https://github.com/SUSE/doc-modular/tree/main/templates">doc-modular
repository</link>.</para>
</sect2>
</sect1>

0 comments on commit c5e1b25

Please sign in to comment.