Appendix A. How is the Unofficial SuSE FAQ done ?

While trying to produce Unofficial SuSE FAQ document, I wanted to make my life easier especially after James Ogley's suggestion of what should be included in this FAQ and how they should be related

SuSE 7.2 Pro edition included all the software that was used in prepearing this collection of FAQ into a book format. In addition to TeX related packages the following were also used

docbktls-0.60.4-34
docbook_3-3.1-56
docbook_4-4.1-55
docbook-dsssl-stylesheets-1.73-1
docbook-xsl-stylesheets-1.42-1
jade_dsl-1.2.1-331
jadetex-3.10-2
openjade-1.3-232
    


main-directory 
     \________html
       \______mirror
         \_____pdf
           \____text
            \____dsl/xsl
             \_______entity
                  \_______topic1-dir
                    \_______topic2-dir
                     \_____chapters-dir
                       \ _____sections-dir
                 	 \ ____templates-dir
     

My initial idea was to keep <qandaentry> format files in their respective topic directories, use them in <sect1> formated files placed in sections-dir and then create <chapter> formated files in chapter directory.

Finally in the main directory I was planning to have the Book format file.

Hence my entity directory would keep the includes files which would describe the files relationship.

Example A-1. includes.inc

Here is what I have in the main includes file


<!-- DEFINE BASIC THINGS -->
<!ENTITY editor SYSTEM "common/editor.sgml">
<!ENTITY mail SYSTEM "common/faq_maillist.sgml">
<!ENTITY intro SYSTEM "common/faq_abstract.sgml">
<!ENTITY license SYSTEM "common/fdl.txt">
<!ENTITY book_info SYSTEM "common/book_info.sgml">

<!-- DEFINE SECTIONS -->

<!ENTITY % sections_inc SYSTEM "sections.inc">%sections_inc;


<!-- DEFINE SECTION INCLUDES -->

<!ENTITY % apache_inc SYSTEM "apache.inc">%apache_inc;
<!ENTITY % install_inc SYSTEM "install.inc">%install_inc;
<!ENTITY % kernel_inc SYSTEM "kernel.inc">%kernel_inc;
<!ENTITY % common_inc SYSTEM "common.inc">%common_inc;
<!ENTITY % sound_inc SYSTEM "sound.inc">%sound_inc;
<!ENTITY % sysadmin_inc SYSTEM "genadmin.inc">%sysadmin_inc;

<!-- DEFINE CHAPTERS -->

Example A-2. sections.inc

This is from the sections.inc which is called from includes.inc


<!--Sect1 Includes -->

<!ENTITY sect_apache SYSTEM "sections/sect_apache.sgml">
<!ENTITY sect_kernel SYSTEM "sections/sect_kernel.sgml">
<!ENTITY sect_install SYSTEM "sections/sect_install.sgml">
<!ENTITY sect_common SYSTEM "sections/sect_common.sgml">
<!ENTITY sect_sound_alsa SYSTEM "sections/sect_sound_alsa.sgml">
......
........
<!-- Sect2 includes -->

<!ENTITY sect2_afterstep SYSTEM "sections/sect2_afterstep.sgml">
<!ENTITY sect2_kde SYSTEM "sections/sect2_kde.sgml">
<!ENTITY sect2_gnome SYSTEM "sections/sect2_gnome.sgml">
............

Consequently, the main file is like this

Example A-3. How the Book is layed out

<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.1//EN"[
<!ENTITY % entities SYSTEM "includes/includes.ent">%entities;
]
>
<book 
&intro;
&abstract;
&chapter;
.....
&chapter10;
&license;
</book>

Copyright 2002-2003 Togan Muftuoglu