Name
----

The help functionlity is part of centos-art.sh script and standardizes documentation tasks inside the working copy of CentOS Artwork Repository.

Synopsis
--------

centos-art help [OPTIONS] path/to/dir ...

The path/to/dir parameter specifies what directory structure inside the working copy of CentOS Artwork Repository you want to process.

The help functionality of centos-art.sh script accepts the following options:

--quiet

     Supress all output messages except error messages.  When this option is passed, all confirmation requests are supressed as well and a possitive answer is assumed for them, just as if the --answer-yes option had been provided.

--answer-yes

     Assume `yes' to all confirmation requests.

--dont-commit-changes

     Supress all commit and update actions realized over files, before and after the action itself had took place over files in the working copy.

--search="STRING"

     Go to node pointed by index entry STRING.

--edit "path/to/dir"

     Edit documentation entry related to path specified by path/to/dir.

     The path/to/dir must point to any directory inside the repository. When more than one path/to/dir are passed as non-option arguments to the centos-art.sh script command-line, they are queued for further edition.  The edition itself takes place through your default text editor (e.g., the one you specified in the EDITOR environment variable) and the text editor opens one file at time (i.e., the queue of files to edit is not loaded in the text editor.).

--read "path/to/dir"

     Read documentation entry specified by file/to/dir path, using info command. This option is useful to read the repository manual on text-based terminals. This option is also used internally by centos-art.sh script to print out the reference you can follow to know more about an error message.

--update

     Update output files rexporting them from Texinfo source files.

--copy "path/to/file.texi" "path/to/dir"

     Duplicate documentation entries under trunk/Manual directory structure.

     When documentation entries are copied, it is possible to pass more than one Texinfo file as source location. In this case, they all and their dependent files will be copied into the target location. The target location must be a directory and passed as last non-option argument in the command-line.

--delete "path/to/file.texi"

     Delete documentation entries under trunk/Manual directory structure.

     When documentation entries are deleted, all cross references that point to the deleted documentation entry will be rebuilt to remove Texinfo markup and remark the fact that it had been removed indeed from the repository.

--rename "path/to/file.texi" "path/to/file.texi"

     Rename documentation entries under trunk/Manual directory structure.

When documentation entries are removed (e.g., through --delete or --rename options), the centos-art.sh script takes care of updating nodes, menus and cross references related to documentation entries in order to keep the manual structure in a correct state.

Description
-----------

The CentOS Project corporate identity is organized through directories in The CentOS Artwork Repository. Each directory inside the repository responds to conceptual ideas and uses files to get the implementation of those ideas.  The help functionality of centos-art.sh script uses this directory layout as reference to document the conceptual ideas it is based on. Each directory inside the repository can be documented, in order to provide the explanation of what it is for and how automation scripts use it.

     Caution When the repository directory layout changes, the documentation layout related must be changed as well in order for both locations to be consistent in their paths. Otherwise, you may end up having documentation entries that point to unexistent directories in the repository.

Files inside the repository are not documented. The only exception to this rule are files under trunk/Manual directory, the place where documentation source files are stored in. Inside this location you can refer .texi files for direct actions using the help functionality of centos-art.sh script. File actions, in this location, are also used to manage specific parts of the manual which have no association outside trunk/Manual directory (e.g., Preface, Introduction, etc.).

The manual structure (see Directories trunk Manual) is supported by GNU Texinfo, a documentation system that can produce both online information and a printed manual from a single source. The help functionality is an interface you can use to control the source files in the manual structure.

The manual output is produced from Texinfo files and stored in trunk/Manual on different formats including Info, PDF, XHTML, XML and TXT.

Whatever your prefered language be, you'll always edit documentation entries in English language and so will be the output produced from them, when you use the help functionality of centos-art.sh script. However, you can achieve the manual localization to your prefered language by applying the locale functionality of centos-art.sh script (see Directories trunk Scripts Functions Locale) to any of the XML-based English outputs supported by centos-art.sh script (e.g., XHTML and Docbook) to produce portable objects for your prefered language and the render functionality of centos-art.sh script (see Directories trunk Scripts Functions Render) to produce the translated version of the output XHTML files taken in first place. The translated version is produced in the same format of the file taken as reference to build the portable objects. XHTML format in this case.

Examples
--------

centos-art help --edit trunk/Identity

     This command edits the documentation entry related to trunk/Identity directory.

centos-art help --read trunk/Identity

     This command reads the doumentation entry related to trunk/Identity directory in info format.

Author
------

Written by Alain Reguera Delgado.

Reporting bugs
--------------

Report bugs to centos-artwork@centos.org mailing list.

Copyright
---------

Copyright ©  2009, 2010, 2011 The CentOS Project.

This is free software.  You may redistribute copies of it under the terms of the GNU General Public License (see GNU General Public License).  There is NO WARRANTY, to the extent permitted by law.

See also
--------

  * Directories trunk Scripts Functions

  * Directories trunk Scripts

  * Directories trunk