Turned style guide into book (#297)

* Turned style guide into book * Updated changelog * Change sect1 to chapter in xml files * Adapt DOCTYPE to root element name --------- Co-authored-by: Tom Schraitle <toms@suse.de>
SUSE · May 22, 2024 · 65a1c29 · 65a1c29
1 parent 1a606e9
commit 65a1c29
Show file tree

Hide file tree

Showing 14 changed files with 241 additions and 211 deletions.
diff --git a/xml/MAIN.styleguide.xml b/xml/MAIN.styleguide.xml
@@ -2,18 +2,18 @@
 <?xml-stylesheet href="urn:x-suse:xslt:profiling:docbook50-profile.xsl"
  type="text/xml" 
   title="Profiling step"?>
-<!DOCTYPE article
+<!DOCTYPE book
 [
   <!ENTITY % entities SYSTEM "entity-decl.ent">
     %entities;
 ]>
-<article version="5.2" xml:lang="en" xml:id="art-styleguide"
+<book version="5.2" xml:lang="en" xml:id="art-styleguide"
   xmlns="http://docbook.org/ns/docbook"
   xmlns:xi="http://www.w3.org/2001/XInclude"
   xmlns:xlink="http://www.w3.org/1999/xlink"
   xmlns:its="http://www.w3.org/2005/11/its"
   xmlns:dm="urn:x-suse:ns:docmanager">
- <title>SUSE Documentation Style Guide<phrase condition="changes"> (with changelog)</phrase></title>
+ <title>SUSE Documentation Style Guide</title>
  <info>  
   <!-- TODO: provide a listing of possible and validatable meta entry values. Maybe in our geekodoc repo? -->
   <!-- add author's e-mail -->
@@ -80,4 +80,4 @@
  <xi:include href="docu_styleguide.terminology.xml"/>
  <xi:include href="docu_styleguide.contributors.xml"/>
  <xi:include href="gfdl.xml"/>
-</article>
+</book>
diff --git a/xml/docu_styleguide.asciidoc.xml b/xml/docu_styleguide.asciidoc.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE sect1
+<!DOCTYPE chapter 
 [
   <!ENTITY % entities SYSTEM "entity-decl.ent">
     %entities;
 ]>
-<sect1 xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="sec-asciidoc">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="sec-asciidoc">
  <title>Working with AsciiDoc</title>
 
  <para>To create documentation in the AsciiDoc format, 
@@ -52,4 +52,4 @@
  </itemizedlist>
 
 
-</sect1>
+</chapter>
diff --git a/xml/docu_styleguide.changes.xml b/xml/docu_styleguide.changes.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE appendix
+<!DOCTYPE revhistory
 [
   <!ENTITY % entities SYSTEM "entity-decl.ent">
     %entities;
@@ -13,6 +13,36 @@
  </para>-->
 
  <!-- Add new versions to the beginning of the list. -->
+ <revision xml:id="sec-change-2024-05">
+  <date>2024-05</date>
+  <revdescription>
+   <itemizedlist>
+    <listitem>
+      <para>Updated the <quote>Entities</quote> subsection in 
+        <quote>Managing documents</quote>: common types of entities and their 
+        use cases, the Doc Kit repository that maintains official generic entities,
+        creating custom entities, and entity files.</para>
+    </listitem>
+    <listitem>
+     <para>Updated the <quote>Prompts</quote> subsection in <quote>Structure 
+      and markup</quote> with clearer info on using prompts and prompt entities 
+      (always specify regular or elevated privileges).</para>
+    </listitem>
+    <listitem>
+     <para>Terminology update: flash disk → flash drive, in sync with TermWeb.</para>
+    </listitem>
+    <listitem>
+      <para><quote>Language</quote> and <quote>Terminology</quote> updated with 
+      info about TermWeb that is now fully launched and available to all SUSE employees.</para>
+     </listitem>
+     <listitem>
+     <para>The style guide changed its structure to the three-column layout with clearly 
+     featured subsections.</para>
+    </listitem>
+    </itemizedlist>
+  </revdescription>
+ </revision>
+
  <revision xml:id="sec-change-2024-02">
   <date>2024-02</date>
   <revdescription>

diff --git a/xml/docu_styleguide.content.xml b/xml/docu_styleguide.content.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE sect1
+<!DOCTYPE chapter
 [
   <!ENTITY % entities SYSTEM "entity-decl.ent">
     %entities;
 ]>
-<sect1 xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="sec-content">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="sec-content">
  <title>Documentation content</title>
 
  <para>
@@ -35,4 +35,4 @@
   </listitem>
  </itemizedlist>
 
-</sect1>
+</chapter>