|
 |
0ab861 |
@subheading Goals
|
|
|
0ab861 |
|
|
|
a658b8 |
The @file{trunk/Scripts/Functions/Help/Backends} directory structure
|
|
|
a658b8 |
organizes documentation backends used by @code{help} functionality of
|
|
|
a658b8 |
@command{centos-art.sh} script.
|
|
|
0ab861 |
|
|
|
0ab861 |
@subheading Description
|
|
|
0ab861 |
|
|
|
a658b8 |
Documentation backends are organized inside directories. There is one
|
|
|
a658b8 |
directory for each documentation backend available. Inside these
|
|
|
a658b8 |
directories, actions related to documentation are implemented by mean
|
|
|
a658b8 |
of shell functions. There is one shell function for each documentation
|
|
|
a658b8 |
action (e.g., reading, editing, updating output, etc.). Optionally,
|
|
|
a658b8 |
other shell functions might be added to backup documentation actions
|
|
|
a658b8 |
functionalities.
|
|
|
a658b8 |
|
|
|
a658b8 |
Documentation backends use template files to build language-specific
|
|
|
a658b8 |
documentation manual. Template files related to documentation backends
|
|
|
a658b8 |
are stored in a directory name @file{Templates/LANG} inside the
|
|
|
a658b8 |
backend directory. In this location, @var{LANG} is a variable
|
|
|
a658b8 |
containing the locale information the documentation manual is built on
|
|
|
a658b8 |
(e.g., en_US, es_ES, fr_FR, de_DE, etc.). Inside the
|
|
|
a658b8 |
@file{Template/LANG} directory, it is organized the documentation
|
|
|
a658b8 |
structure used as base to build new language-specific documentation
|
|
|
a658b8 |
manuals (e.g., each time a new documentation entry is created for the
|
|
|
a658b8 |
repository, a template is taken from here to initiate the section
|
|
|
a658b8 |
structure and give order to it). The specific organization of
|
|
|
a658b8 |
documentation structure depends on the backend itself.
|
|
|
a658b8 |
|
|
|
a658b8 |
Inside backend directories, shell functions must have the same
|
|
|
a658b8 |
structure in their names. The name structure used by shell functions
|
|
|
a658b8 |
here is: @code{suffix_funcname.sh}, were @code{suffix} is the name of
|
|
|
a658b8 |
the directory backend in lowercase and @code{funcname} is the name of
|
|
|
a658b8 |
the function. Assuming, both @samp{texinfo} and @samp{docbook}
|
|
|
a658b8 |
backends have been already implemented, they must have a structure
|
|
|
a658b8 |
similar to the following:
|
|
|
a658b8 |
|
|
|
a658b8 |
@verbatim
|
|
|
a658b8 |
trunk/Scripts/Functions/Help/Backends
|
|
|
a658b8 |
|-- Docbook
|
|
|
a658b8 |
| |-- Templates
|
|
|
a658b8 |
| | |-- en_US
|
|
|
a658b8 |
| | `-- ...
|
|
|
a658b8 |
| |-- docbook_editEntry.sh
|
|
|
a658b8 |
| |-- docbook_updateOutputFiles.sh
|
|
|
a658b8 |
| `-- ...
|
|
|
a658b8 |
`-- Texinfo
|
|
|
a658b8 |
|-- Templates
|
|
|
a658b8 |
| |-- en_US
|
|
|
a658b8 |
| `-- ...
|
|
|
a658b8 |
|-- texinfo_editEntry.sh
|
|
|
a658b8 |
|-- texinfo_updateOutputFiles.sh
|
|
|
a658b8 |
`-- ...
|
|
|
a658b8 |
@end verbatim
|
|
|
0ab861 |
|
|
|
0ab861 |
@subheading Usage
|
|
|
0ab861 |
|
|
|
0ab861 |
@itemize
|
|
|
a658b8 |
@item @ref{Directories trunk Scripts Functions Help Backends Texinfo}
|
|
|
a658b8 |
@item @ref{Directories trunk Scripts Functions Help Backends Docbook}
|
|
|
a658b8 |
@item @ref{Directories trunk Scripts Functions Help Backends Linuxdoc}
|
|
|
0ab861 |
@end itemize
|
|
|
0ab861 |
|
|
|
0ab861 |
@subheading See also
|
|
|
0ab861 |
|
|
|
0ab861 |
@itemize
|
|
|
0ab861 |
|
|
|
0ab861 |
@item @ref{Directories trunk Scripts Functions Help}
|
|
|
0ab861 |
@item @ref{Directories trunk Scripts Functions}
|
|
|
0ab861 |
@item @ref{Directories trunk Scripts}
|
|
|
0ab861 |
@item @ref{Directories trunk}
|
|
|
0ab861 |
@end itemize
|