From a658b86427c00aa63711dfc5454e3beaa9fa07bb Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Jun 03 2011 14:39:57 +0000 Subject: Update repository documentation manual. --- diff --git a/Manuals/Texinfo/en_US/Directories/trunk/Scripts/Functions/Help.texinfo b/Manuals/Texinfo/en_US/Directories/trunk/Scripts/Functions/Help.texinfo index 5e4f108..ec7ed42 100644 --- a/Manuals/Texinfo/en_US/Directories/trunk/Scripts/Functions/Help.texinfo +++ b/Manuals/Texinfo/en_US/Directories/trunk/Scripts/Functions/Help.texinfo @@ -36,11 +36,11 @@ after the action itself had took place over files in the working copy. Specifies the documentation system used as backend to manage the repository documentation manual. When this option is not provided, the -@samp{texinfo} documentation system is used as default backend. +@samp{texinfo} backend (@pxref{Directories trunk Scripts Functions +Help Backends Texinfo}) is used as default documentation system. -To know more about available documentation backends and their -characteristics, @pxref{Directories trunk Scripts Functions Help -Backends}. +To know more about documentation backends and their characteristics, +@pxref{Directories trunk Scripts Functions Help Backends}. @item --search="STRING" 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 d8e7bb1..d12d5b3 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,19 +1,64 @@ @subheading Goals -@itemize -@item ... -@end itemize +The @file{trunk/Scripts/Functions/Help/Backends} directory structure +organizes documentation backends used by @code{help} functionality of +@command{centos-art.sh} script. @subheading Description -@itemize -@item ... -@end itemize +Documentation backends are organized inside directories. There is one +directory for each documentation backend available. Inside these +directories, actions related to documentation are implemented by mean +of shell functions. There is one shell function for each documentation +action (e.g., reading, editing, updating output, etc.). Optionally, +other shell functions might be added to backup documentation actions +functionalities. + +Documentation backends use template files to build language-specific +documentation manual. Template files related to documentation backends +are stored in a directory name @file{Templates/LANG} inside the +backend directory. In this location, @var{LANG} is a variable +containing the locale information the documentation manual is built on +(e.g., en_US, es_ES, fr_FR, de_DE, etc.). Inside the +@file{Template/LANG} directory, it is organized the documentation +structure used as base to build new language-specific documentation +manuals (e.g., 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. + +Inside backend directories, shell functions must have the same +structure in their names. The name structure used by shell functions +here is: @code{suffix_funcname.sh}, were @code{suffix} is the name of +the directory backend in lowercase and @code{funcname} is the name of +the function. Assuming, both @samp{texinfo} and @samp{docbook} +backends have been already implemented, they must have a structure +similar to the following: + +@verbatim +trunk/Scripts/Functions/Help/Backends +|-- Docbook +| |-- Templates +| | |-- en_US +| | `-- ... +| |-- docbook_editEntry.sh +| |-- docbook_updateOutputFiles.sh +| `-- ... +`-- Texinfo + |-- Templates + | |-- en_US + | `-- ... + |-- texinfo_editEntry.sh + |-- texinfo_updateOutputFiles.sh + `-- ... +@end verbatim @subheading Usage @itemize -@item ... +@item @ref{Directories trunk Scripts Functions Help Backends Texinfo} +@item @ref{Directories trunk Scripts Functions Help Backends Docbook} +@item @ref{Directories trunk Scripts Functions Help Backends Linuxdoc} @end itemize @subheading See also @@ -25,4 +70,3 @@ @item @ref{Directories trunk Scripts} @item @ref{Directories trunk} @end itemize -