From 4bdef7a1949aa248c70f46436ea99da04aaea7d1 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Sep 19 2011 18:50:37 +0000 Subject: Update `Manuals/Formats/texinfo.docbook'. --- diff --git a/Manuals/Tcar-ug/Manuals/Formats/texinfo.docbook b/Manuals/Tcar-ug/Manuals/Formats/texinfo.docbook index 2492547..9660560 100644 --- a/Manuals/Tcar-ug/Manuals/Formats/texinfo.docbook +++ b/Manuals/Tcar-ug/Manuals/Formats/texinfo.docbook @@ -3,14 +3,20 @@ Texinfo Documentation Format - This section describes how the Texinfo documentation format is - implemented inside the help functionality - of centos-art.sh script to produce - documentation manuals inside &TCAR;. More information about - Texinfo documentation system itself can be found by running - the info texinfo command. + This section describes the implementation of Texinfo + documentation format inside the help + functionality of centos-art.sh script. More + information about Texinfo documentation system itself can be + found by running the info texinfo command. + + Introduction + + ... + + + Texinfo Document Structure @@ -153,9 +159,10 @@ trunk/Scripts/Bash/Functions/Help/Texinfo/Templates help functionality when new chapters are created inside the documentation manual. When chapters are created for first time, they come without any introduction. If - you want to update the chapter information inside your - documentation manual, update the chapter related file inside - the documentation manual, not the template used to create it. + you want to add/update any information inside the chapter + definition, edit the related chapter file inside the + documentation manual you are working on, not the template file + used to create it. @@ -209,7 +216,7 @@ trunk/Scripts/Bash/Functions/Help/Texinfo/Templates - There are other files that aren't related to manual's source + There are other files which aren't related to manual's source files, but to manual's output files. Such files are described below and can be found both inside and outside the language-specific directories so you can control common and @@ -218,6 +225,45 @@ trunk/Scripts/Bash/Functions/Help/Texinfo/Templates + manual.texinfo + + + This file can be found inside the language-specific directory + and contains the manual's main definitions (e.g., document + title, document language, document authors, copyright notice, + etc.). + + + + + + manual-menu.texinfo + + + ... + + + + + + manual-nodes.texinfo + + + ... + + + + + + manual-index.texinfo + + + ... + + + + + manual-init.pl @@ -250,14 +296,6 @@ trunk/Scripts/Bash/Functions/Help/Texinfo/Templates texinfo-4.8-14.el5) doesn't have an internal command to build them. - - - In the future, this file could be removed in the sake of - setting XHTML output transformations inside the Texi2html - initialization script (manual-init.pl) - itself. - - @@ -265,16 +303,24 @@ trunk/Scripts/Bash/Functions/Help/Texinfo/Templates manual.conf - ... + This file contains the initial configuration of documentation + manuals written in Texinfo format. When the documentation + manual is created for first time, this file is copied into the + documentation manual target directory so you can customize + specific information like menu order, title styles and + templates assignment. More details about the content of this + file can be found in . + - Texinfo document template + Texinfo document templates - Texinfo document template + Texinfo document templates trunk/Scripts/Bash/Functions/Help/Texinfo/Templates @@ -308,10 +354,10 @@ trunk/Scripts/Bash/Functions/Help/Texinfo/Templates Inside the directory structure of Texinfo document templates, the Chapters directory organizes chapter specific models used to create and maintain - both chapter and sections inside manuals. On the other hand, - the Licenses directory - organizes the license information linked from all manuals. - Notice the license information is not copied into + both chapter and sections files inside manuals. On the other + hand, the Licenses + directory organizes the license information linked from all + manuals. Notice the license information is not copied into documentation manuals when they are created, but refered from this location where they are maintained. This configuration permites that all documentation manuals written in Texinfo @@ -322,7 +368,7 @@ trunk/Scripts/Bash/Functions/Help/Texinfo/Templates - + Texinfo Document Configuration ...