diff --git a/Manual/Directories/trunk/Manual.texi b/Manual/Directories/trunk/Manual.texi index 91e1dcc..7c11b22 100644 --- a/Manual/Directories/trunk/Manual.texi +++ b/Manual/Directories/trunk/Manual.texi @@ -8,22 +8,72 @@ how automation scripts make use of them. @subheading Description -@subsubheading Files +The repository documentation manual is made of the following files: + @table @file + @item repository.css + +This file controls the visual style for XHTML output files of +repository documentation manual. + @item repository-index.texi + +This file controls the index definition for source files of repository +documentation manual. + @item repository.info.bz2 + +This file provides the Info output of repository documentation manual. + @item repository-init.pl + +This file provides the initialization script of @command{texi2html}, +the program used by @command{centos-art.sh} script to produce the +XHTML output of repository documentation manual. + @item repository-menu.texi + +This file controls the menu definition of chapters for source files of +repository documentation manual. + @item repository-node.texi + +This file controls the node definition of chapters for source files of +repository documentation manual. + @item repository.pdf + +This file provides the PDF output of repository documentation manual. + @item repository.sed + +This file provides post-transformations for XHTML output files. In +this file is where XHTML definitions for admonitions are set in. + @item repository.texi + +This is the source file of repository documentation manual where +the manual structure initialization is set. +manual. + @item repository.txt.bz2 + +This file provides the TXT output of repository documentation manual. + @item repository.xhtml.bz2 + +This file provides the XHTML output of repository documentation +manual. + @item repository.xml + +This file provides the XML output of repository documentation manual. + @end table -@subsubheading Directories + +The repository documentation manual is made of the following +directories: @itemize @item @xref{Directories trunk Manual Directories}. diff --git a/Manual/Directories/trunk/Scripts/Functions/Help.texi b/Manual/Directories/trunk/Scripts/Functions/Help.texi index 34fa724..215ee1e 100644 --- a/Manual/Directories/trunk/Scripts/Functions/Help.texi +++ b/Manual/Directories/trunk/Scripts/Functions/Help.texi @@ -128,10 +128,10 @@ The manual structure (@pxref{Directories trunk Manual}) is supported by GNU Texinfo, a documentation system that can produce both online information and a printed manual from a single source. The @code{help} functionality is an interface you can use to control the source files -in the manual structure. +in the manual structure. -The manual output files is produced from Texinfo files and stored in -@file{trunk/Manual} on different formats including Info, Pdf, XHTML, +The manual output is produced from Texinfo files and stored in +@file{trunk/Manual} on different formats including Info, PDF, XHTML, XML and TXT. Whatever your prefered language be, you'll always edit documentation diff --git a/Manual/repository.info.bz2 b/Manual/repository.info.bz2 index bb7f917..d42185b 100644 Binary files a/Manual/repository.info.bz2 and b/Manual/repository.info.bz2 differ diff --git a/Manual/repository.pdf b/Manual/repository.pdf index d736099..0c3e147 100644 Binary files a/Manual/repository.pdf and b/Manual/repository.pdf differ diff --git a/Manual/repository.txt.bz2 b/Manual/repository.txt.bz2 index 7c1ce3d..21e9579 100644 Binary files a/Manual/repository.txt.bz2 and b/Manual/repository.txt.bz2 differ diff --git a/Manual/repository.xhtml.tar.bz2 b/Manual/repository.xhtml.tar.bz2 index c17362b..11a0d50 100644 Binary files a/Manual/repository.xhtml.tar.bz2 and b/Manual/repository.xhtml.tar.bz2 differ diff --git a/Manual/repository.xml b/Manual/repository.xml index 02435ac..6be325e 100644 --- a/Manual/repository.xml +++ b/Manual/repository.xml @@ -2492,24 +2492,82 @@ priority=10 Goals The trunk/Manual directory is the place where files related to documentation work line are stored in. The main goal of documentation work line is to describe what each directory inside the CentOS Artwork Repository is for, the conceptual ideas behind them and, if possible, how automation scripts make use of them. Description - Files + The repository documentation manual is made of the following files: repository.css + + This file controls the visual style for XHTML output files of repository documentation manual. + + + repository-index.texi + + This file controls the index definition for source files of repository documentation manual. + + + repository.info.bz2 + + This file provides the Info output of repository documentation manual. + + + repository-init.pl + + This file provides the initialization script of texi2html, the program used by centos-art.sh script to produce the XHTML output of repository documentation manual. + + + repository-menu.texi + + This file controls the menu definition of chapters for source files of repository documentation manual. + + + repository-node.texi + + This file controls the node definition of chapters for source files of repository documentation manual. + + + repository.pdf + + This file provides the PDF output of repository documentation manual. + + + repository.sed + + This file provides post-transformations for XHTML output files. In this file is where XHTML definitions for admonitions are set in. + + + repository.texi + + This is the source file of repository documentation manual where the manual structure initialization is set. manual. + + + repository.txt.bz2 + + This file provides the TXT output of repository documentation manual. + + + repository.xhtml.bz2 + + This file provides the XHTML output of repository documentation manual. + + + repository.xml + + This file provides the XML output of repository documentation manual. +
- Directories + The repository documentation manual is made of the following directories: @@ -3030,7 +3088,7 @@ centos-art locale --edit trunk/Scripts Files inside the repository are not documented. The only exception to this rule are files under trunk/Manual directory, the place where documentation source files are stored in. Inside this location you can refer .texi files for direct actions using the help functionality of centos-art.sh script. File actions, in this location, are also used to manage specific parts of the manual which have no association outside trunk/Manual directory (e.g., Preface, Introduction, etc.). The manual structure (see Directories trunk Manual) is supported by GNU Texinfo, a documentation system that can produce both online information and a printed manual from a single source. The help functionality is an interface you can use to control the source files in the manual structure. - The manual output files is produced from Texinfo files and stored in trunk/Manual on different formats including Info, Pdf, XHTML, XML and TXT. + The manual output is produced from Texinfo files and stored in trunk/Manual on different formats including Info, PDF, XHTML, XML and TXT. Whatever your prefered language be, you'll always edit documentation entries in English language and so will be the output produced from them, when you use the help functionality of centos-art.sh script. However, you can achieve the manual localization to your prefered language by applying the locale functionality of centos-art.sh script (see Directories trunk Scripts Functions Locale) to any of the XML-based English outputs supported by centos-art.sh script (e.g., XHTML and Docbook) to produce portable objects for your prefered language and the render functionality of centos-art.sh script (see Directories trunk Scripts Functions Render) to produce the translated version of the output XHTML files taken in first place. The translated version is produced in the same format of the file taken as reference to build the portable objects. XHTML format in this case. Examples