Blame Manuals/Tcar-ug/Manuals.docbook
|
|
933061 |
<part id="doc">
|
|
|
460d3e |
|
|
|
460d3e |
<title>Documentation</title>
|
|
|
460d3e |
|
|
|
460d3e |
<partintro>
|
|
|
e68d9f |
<para>
|
|
|
163dee |
&TCAR; documentation work line is implemented through
|
|
|
163dee |
documentation manuals. Documentation manuals are
|
|
|
364b72 |
implemented through different documentation formats
|
|
|
364b72 |
provided inside &TC;; (e.g.,
|
|
|
364b72 |
<application>Docbook</application>,
|
|
|
364b72 |
<application>Texinfo</application>,
|
|
|
364b72 |
<application>LaTeX</application>, etc.). Structuring
|
|
|
364b72 |
tasks related to documentation systems (e.g., creating,
|
|
|
364b72 |
editing, deleting, copying, renaming, etc.) are
|
|
|
364b72 |
standardized through <quote>documentation backends</quote>
|
|
|
364b72 |
inside the <command>centos-art.sh</command> script.
|
|
|
364b72 |
Documentation backends encapsulate the specificities of
|
|
|
364b72 |
each documentation formats and are made available to you
|
|
|
364b72 |
through the help functionality, as described
|
|
|
364b72 |
in <xref linkend="scripts-bash-help" />. This way, people
|
|
|
163dee |
documenting don't need to deal with structuring tasks like
|
|
|
163dee |
creating files, updating menus, nodes, cross references
|
|
|
163dee |
and be aware of where to put the files.
|
|
|
e68d9f |
</para>
|
|
|
460d3e |
|
|
|
e68d9f |
</partintro>
|
|
|
460d3e |
|
|
|
e68d9f |
&manuals-texinfo;
|
|
|
e68d9f |
&manuals-docbook;
|
|
|
460d3e |
|
|
|
460d3e |
</part>
|