Blob Blame History Raw
@subheading Goals

The @file{trunk/Scripts/Functions/Help/Backends} directory organizes
documentation backends used by @code{help} functionality of
@command{centos-art.sh} script.

@subheading Description

Documentation backends are organized inside directories. There is one
directory for each documentation backend. Inside backend directories,
documentation actions are implemented by mean of shell functions.
There is one shell function for each documentation action (e.g.,
reading, editing, updating output, etc.) and auxiliar shell functions
to backup documentation actions.

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

The following documentation backends are available:

@itemize
@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

@itemize
@item @ref{Directories trunk Scripts Functions Help} 
@item @ref{Directories trunk Scripts Functions} 
@item @ref{Directories trunk Scripts} 
@item @ref{Directories trunk}
@end itemize