|
|
b32b45 |
@subheading Goals
|
|
|
b32b45 |
|
|
|
b32b45 |
The @file{trunk/Manual} directory is the place where files related to
|
|
|
b32b45 |
documentation work line are stored in. The main goal of documentation
|
|
|
b32b45 |
work line is to describe what each directory inside the CentOS Artwork
|
|
|
b32b45 |
Repository is for, the conceptual ideas behind them and, if possible,
|
|
|
b32b45 |
how automation scripts make use of them.
|
|
|
b32b45 |
|
|
|
b32b45 |
@subheading Description
|
|
|
b32b45 |
|
|
|
0134f0 |
The documentation work line exists to describe what each directory
|
|
|
0134f0 |
inside the CentOS Artwork Repository is for, the conceptual ideas
|
|
|
0134f0 |
behind them and, if possible, how automation scripts make use of them.
|
|
|
0134f0 |
|
|
|
0134f0 |
The CentOS Artwork Repository documentation is supported by Texinfo, a
|
|
|
0134f0 |
documentation system that uses a single source file to produce both
|
|
|
0134f0 |
online information and printed output.
|
|
|
0134f0 |
|
|
|
0134f0 |
The repository documentation is organized under @file{trunk/Manual}
|
|
|
0134f0 |
directory and uses the repository directory structre as reference.
|
|
|
0134f0 |
Each directory in the repository has a documentation entry associated
|
|
|
0134f0 |
in the documentation manual. Documentation entries are stored under
|
|
|
0134f0 |
@file{trunk/Manual/Directories} directory and the action itself is
|
|
|
0134f0 |
controlled by the @code{help} functionality of @command{centos-art.sh}
|
|
|
0134f0 |
script.
|
|
|
0134f0 |
|
|
|
0134f0 |
The @code{help} functionality let you create, edit and delete
|
|
|
0134f0 |
documentation entries in a way that you don't need to take care of
|
|
|
0134f0 |
updating menus, nodes and cross reference information inside the
|
|
|
0134f0 |
manual structure; the functionality takes care of it for you.
|
|
|
0134f0 |
However, if you need to write repository documentation that have
|
|
|
0134f0 |
nothing to do with repository directories (e.g., Preface, Introduction
|
|
|
0134f0 |
and similar) you need to do it manually, there is no functionality to
|
|
|
0134f0 |
automate such process yet.
|
|
|
b32b45 |
|
|
|
b32b45 |
@subheading Usage
|
|
|
b32b45 |
|
|
|
b32b45 |
@itemize
|
|
|
b32b45 |
@item @xref{Directories trunk Scripts Functions Help}.
|
|
|
b32b45 |
@end itemize
|
|
|
b32b45 |
|
|
|
b32b45 |
@subheading See also
|
|
|
b32b45 |
|
|
|
b32b45 |
@itemize
|
|
|
b32b45 |
@item @ref{Directories trunk}
|
|
|
b32b45 |
@end itemize
|