diff --git a/Manuals/Texinfo/en_US/Directories/trunk/Scripts/Functions/Help/Backends.texinfo b/Manuals/Texinfo/en_US/Directories/trunk/Scripts/Functions/Help/Backends.texinfo index 524f1af..9fee6c1 100755 --- a/Manuals/Texinfo/en_US/Directories/trunk/Scripts/Functions/Help/Backends.texinfo +++ b/Manuals/Texinfo/en_US/Directories/trunk/Scripts/Functions/Help/Backends.texinfo @@ -1,7 +1,7 @@ @subheading Goals -The @file{trunk/Scripts/Functions/Help/Backends} directory structure -organizes documentation backends used by @code{help} functionality of +The @file{trunk/Scripts/Functions/Help/Backends} directory organizes +documentation backends used by @code{help} functionality of @command{centos-art.sh} script. @subheading Description @@ -13,15 +13,15 @@ There is one shell function for each documentation action (e.g., reading, editing, updating output, etc.) and auxiliar shell functions to backup documentation actions. -Documentation backends make use of template files to build -documentation manuals in different languages. Template files are -stored in @file{Templates/LANG} directory, where @var{LANG} is a -variable containing the locale information of the documentation manual -(e.g., en_US, es_ES, fr_FR, de_DE, etc.). Each time a new -documentation entry is created for the repository, a template is taken -from here to initiate the section structure and give order to it. The -specific organization of documentation structure depends on the -backend itself. +Documentation backends define document structure and document language +through templates. Templates are organized in the @file{Templates} +directory which is located inside the backend directory. Templates are +used when new documentation manuals are created and later, when new +documentation entries are created inside it. They provide the model +required to create both structure and sections of that structure +inside the manual. There is one documentation manual for each locale +code and one documentation entry inside the manual for each directory +inside the repositroy. Inside backend directories, shell functions must have the same structure in their names. The name structure used by shell functions @@ -49,6 +49,37 @@ trunk/Scripts/Functions/Help/Backends `-- ... @end verbatim +The repository documentation entries are organized as sections inside +a chapter named @samp{The repository directories}. Each section +contains three subsections (e.g., Goals, Description, Usage and See +also) and optionally one or more subsubsections inside them to +describe what the related repository directory is for. The first three +section are created in blank for you to fill with information, but the +last one is created automatically and contains a list of links to +previous sections. + +The relation between template files and repository paths is set in the +@file{repository.conf} file. In this file all lines begining with +@code{#} are considered comments. Both comments and empty lines are +removed before evaluation so only configuration lines will be +evaluated. Configuration lines must be in the form @samp{template = +"path-regex"}, where @samp{template} is the relative path to section +template and @samp{"path-regex"} a regular expression describing the +path information you want to apply the template on. Configuration +files look like the following: + +@verbatim +# This file defines the relation between section templates and +# repository paths. Here you can customize the section template of +# specific directories inside the repository. The first match wins. +# ---------------------------------------------------------------------- +# $Id: repository.conf 3222 2011-06-04 19:35:00Z al $ +# ---------------------------------------------------------------------- + +Directories/section-functions.texinfo = "(trunk|branches|tags)/Scripts/Functions/[[:alnum:]]+\.texinfo$" +Directories/section.texinfo = "(trunk|branches|tags).*\.texinfo$" +@end verbatim + @subheading Usage @itemize