Changes between Version 9 and Version 10 of UserManual


Ignore:
Timestamp:
Apr 1, 2011, 6:26:49 PM (9 years ago)
Author:
nschle85
Comment:

started explaining howto edit the manual

Legend:

Unmodified
Added
Removed
Modified
  • UserManual

    v9 v10  
    5959ant
    6060}}}
    61 The generated manuals can be found in OUTPUT.
    62  
     61The generated manuals can be found in OUTPUT.
     62== Edit the manual ==
     63This section describes how to edit the manual.
     64==== What is DocBook ====
     65The whole manual is written in XML files (DocBook XML). The different manuals are generated by XSL Transformations (DocBook XSL). But what does it mean ?
     66
     67The content of our manual is located in XML files. The different target types of manuals like PDF, HTML are provided by XSL Style Sheets. DocBook distinguishes strictly between content and layout. So the concept is a little bit comparable to LaTex. The output could be generated by the XSL Style Sheets provided by DocBook XSL but we decided to change the output a little bit so that it becomes the typical SHR corporate design. Changing the style of output can be done in an so called DocBook XSL customization layer. This concept is comparable to bitbake layers.
     68
     69For the beginning or adding content it is not necessary to know something about XSL style sheets or customization layers.
     70=== Understanding the repository structure ===
     71{{{
     72~/GIT-SHR-DOCS/shr-docs/docbook$ ls
     73build.xml  configurations  external  OUTPUT  readme.txt  src
     74}}}
     75
     76build.xml
     77configurations
     78external
     79OUTPUT
     80readme.txt
     81src
     82
     83
     84
     85