Prepare for the new TRD stylesheets

[tomschr]

Situation

Soon we will have some new TRD stylesheets. To use the full potential, we need to change or add some metadata.

Proposed solution

• Correct the list of authors. If you have more than one author, put them all into an <authorgroup> element. The order matters (first come, first displayed):

  <authorgroup>
     <author>
        <personname>
           <firstname>Tux</firstname>
           <surname>Penguin</surname>
           <affiliation>
              <jobtitle>Chief Cuteness Officer</jobtitle>
              <orgname>SUSE</orgname>
           </affiliation>
        </personname>
     </author>
    <!-- ... add more ... -->
  </authorgroup>

• If you wish, add some company logos with <cover> and <mediaobject>. The logos should be added to the imagesdirectory.

  <cover>
     <mediaobject>
         <imagedata fileref="..." width="4em"/>
     </mediaobject>
     <!-- add more, if needed -->
  </cover>
  

• If you have logos, add the width of your logos (in <cover>). If you leave it out, the logos could potentially grow too big. Start with:

  <imagedata fileref="..." width="4em"/>
  

• Add one or more platform meta information. This should contain the platform where this paper applies (for example, SLES 15 SP5). If you don't need it, leave it out:

  <meta name="platform">...</meta>
  

• Add one element for series meta information (should contain "Technical Reference Documentation"):

  <meta name="series">...</meta>
  

  I would recommend to add a placeholder to avoid typos (for example, {trd}). That could be done in common/adoc/common_docinfo_vars.adoc I suppose with:

  :trd: Technical Reference Documentation
  

• Add category meta information (something like Systems Management, Edge, SAP etc.):

  <meta name="category">...</meta>
  

• Add type meta information (something like "Getting Started", "Reference Implementation" etc.):

  <meta name="type">...</meta>
  

• If feasible, shorten titles and add possible subtitles. This will improve our SEO ratings.

• Keep your fingers crossed. 😉