|
|
128f6a |
@subheading Goals
|
|
|
eac0cb |
|
|
|
98134a |
The @file{trunk/Scripts/Functions/Help/Backends/Texinfo} directory
|
|
|
98134a |
structure organizes the `texinfo' backend used by @code{help}
|
|
|
98134a |
functionality to manage the repository documentation manual
|
|
|
98134a |
(@pxref{Directories trunk Manuals}).
|
|
|
0ab861 |
|
|
|
128f6a |
@subheading Description
|
|
|
eac0cb |
|
|
|
98134a |
The @code{texinfo} backend is supported by GNU Texinfo, a
|
|
|
98134a |
documentation system that can produce both online information and a
|
|
|
29cc50 |
printed manual from a single source. The @code{texinfo} backend is an
|
|
|
29cc50 |
interface the @command{centos-art.sh} script uses to control the
|
|
|
29cc50 |
frequent documenting tasks (e.g., reading, editing, update output
|
|
|
29cc50 |
files, etc.) in the source files of a Texinfo documentation manual
|
|
|
29cc50 |
structure.
|
|
|
98134a |
|
|
|
98134a |
The @code{texinfo} backend takes the repository documentation manual
|
|
|
29cc50 |
in texinfo format as input and produces Info, Pdf, XML, Xhtml and Txt
|
|
|
29cc50 |
output files in the @file{trunk/Manuals/Texinfo/$LANG} directory
|
|
|
29cc50 |
structure, where @var{$LANG} represents the language of the manual.
|
|
|
98134a |
The Info, Pdf and Txt output files are produced through
|
|
|
98134a |
@command{makeinfo} command and the Xhtml output through
|
|
|
29cc50 |
@command{texi2html} command. Using the @command{makeinfo} command it
|
|
|
29cc50 |
is also possible to output the repository documentation manual in
|
|
|
29cc50 |
Docbook format, however, the output produced by @command{makeinfo}
|
|
|
29cc50 |
command seems to have some malformations, so the @samp{docbook}
|
|
|
7d215c |
backend is considered instead (@pxref{Directories trunk Scripts
|
|
|
7d215c |
Functions Help Backends Docbook}).
|
|
|
29cc50 |
|
|
|
29cc50 |
When producing Xhtml output, through @command{texi2html} command, the
|
|
|
29cc50 |
output customization is controlled by common and specific
|
|
|
29cc50 |
configuration files. Common configuration files are stored in
|
|
|
29cc50 |
@file{trunk/Manuals/Texinfo} and include @file{repository.css},
|
|
|
29cc50 |
@file{repository-init.pl} and @file{repository.sed}. Specific
|
|
|
29cc50 |
configuration files, on the other hand, are stored inside
|
|
|
29cc50 |
backend-specific directories (e.g.,
|
|
|
29cc50 |
@file{trunk/Scripts/Functions/Help/Backends/Texinfo/Templates/$LANG})
|
|
|
29cc50 |
and includes @file{repository-init.pl}, @file{repository.conf},
|
|
|
29cc50 |
@file{repository.sed}.
|
|
|
29cc50 |
|
|
|
29cc50 |
When writting texinfo files, produced by @samp{texinfo} backend, the
|
|
|
29cc50 |
way absolute paths are defined is important. Absolute paths
|
|
|
29cc50 |
definitions (e.g., through `@@include' and `@@image') must be set from
|
|
|
29cc50 |
@file{trunk/} directory structure on. This is necessary because the
|
|
|
29cc50 |
documentation manual is exported using @file{@var{$HOME}/artwork}
|
|
|
29cc50 |
directory structure as base.
|
|
|
98134a |
|
|
|
98134a |
Internationalization of repository documentation manual is performed
|
|
|
98134a |
trough document templates and the @env{LANG} environment variable.
|
|
|
98134a |
There is one repository documentation manual for each locale specified
|
|
|
98134a |
by @env{LANG} environment variable. When no template is available for
|
|
|
98134a |
a specific language, the @code{en_US} templates are used as reference.
|
|
|
98134a |
|
|
|
98134a |
Each repository documentation manual written in language other than
|
|
|
98134a |
English, must include the @samp{@@documentlanguage} and
|
|
|
98134a |
@samp{@@documentencoding} directives in the main document file (e.g.,
|
|
|
98134a |
@file{repository.texinfo}) to provide the language and encoding
|
|
|
98134a |
information respectively. The language information can be any value
|
|
|
98134a |
specified by ISO-639 language code standard and the ecoding
|
|
|
98134a |
informormation can be either @samp{US-ASCII}, @samp{ISO-8859-1},
|
|
|
98134a |
@samp{ISO-8859-15} or @samp{ISO-8859-2}.
|
|
|
98134a |
|
|
|
98134a |
The encoding information is required in order for Txt and Info outputs
|
|
|
98134a |
to show special characters, defined through Texinfo special way of
|
|
|
98134a |
accentuation (e.g., @samp{@@'a}, @samp{@@~n}, etc.), correctly. In
|
|
|
98134a |
this specific case, to read both Txt and Info files, it is required
|
|
|
98134a |
that the terminal you are performing the reading action (e.g.,
|
|
|
98134a |
@command{gnome-terminal}) be encoded with the same value you specified
|
|
|
98134a |
inside the repository documentation manual. Otherwise, special
|
|
|
98134a |
characters may not look as expected.
|
|
|
98134a |
|
|
|
98134a |
Using Texinfo special way of accentuation is also required for
|
|
|
98134a |
@command{texi2html} command to transform special characters to HTML
|
|
|
98134a |
entities (e.g., @samp{á}, @samp{ñ}, etc.). In the Pdf
|
|
|
98134a |
output, special characters are printed well most of times with some
|
|
|
98134a |
exceptions (e.g., the @samp{@@'i} don't replaces the dot over the
|
|
|
98134a |
letter with the accentuation, but put the accentuation over it.).
|
|
|
128f6a |
|
|
|
4d2b0a |
@subheading Usage
|
|
|
128f6a |
|
|
|
0ab861 |
@itemize
|
|
|
0ab861 |
@item ...
|
|
|
0ab861 |
@end itemize
|
|
|
0ab861 |
|
|
|
4d2b0a |
@subheading See also
|
|
|
0ab861 |
|
|
|
0ab861 |
@itemize
|
|
|
5a37f9 |
@item @ref{Directories trunk Scripts Functions Help Backends}
|
|
|
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
|