help Standardize constructions tasks inside &TCAR; help Standardize documentation tasks inside &TCAR;. centos-art help --help --quiet --answer-yes --sync-changes --search="KEYWORD" --edit --read --update --copy --delete --rename MANUAL:PART:CHAPTER:SECTION LOCATION The help functionality exists to create and maintain documentation manuals inside &TCAR;. The documentation structure and format implemented by help functionality are described in and , respectively. The documentation entry identifies the specific file you want to work with inside a documentation manual. The help functionality recognizes documentation entries in the following two formats: Path style This format uses paths to represent the documentation entries you want to work with. This format assumes you are using the first path component as chapter and the rest of the path as section identifier both inside tcar-fs documentation manual as parent documentation structure. The field related to the part sectioning structure in the documentation entry (the second field) is assumed empty, as well. For example, if you want to document the directory trunk/Scripts/Bash/Functions/Help, then you can do it with the following command: centos-art help --edit trunk/Scripts/Bash/Functions/Help Colon style This format uses colons to represent the documentation entries you want to work with. In this format, the whole documentation entry is divided in fields using colon as separator character. Documentation entries written this way use each field to specify manual, part, chapter and section identifiers (in this order). The section identifier can use a path style or hyphen style to separate components. For example, if you want to document the directory trunk/Scripts/Bash/Functions/Help, then you can do it with any of the following commands: centos-art help --edit tcar-fs::trunk:Scripts/Bash/Functions/Help centos-art help --edit tcar-fs::trunk:scripts-bash-functions-help The documentation manual name specified in the first field of a colon style documentation entry, must match the name the name of the directory where the documentation manual is stored in. By default documentation manuals are written in trunk/Documentation/Models/Texinfo or trunk/Documentation/Models/Docbook directories, based on whether they are written in Texinfo or Docbook documentation format. The match relation between the manual name you provide in the documentation entry and the related directory name inside &TCAR; is case insensitive. The same is true for all other documentation entry fields. From these documentation entry formats, the colon style provides more flexibility than path style does. You can use documentation entries written in colon style to create and maintain different documentation manuals, including the tcar-fs documentation manual. This is something you cannot do with documentation entries written in path style because they confine all documentation actions to tcar-fs documentation manual. The help functionality provides support for the following documentation formats: Texinfo (See ) To create new documentation manuals inside &TCAR; use the following command: centos-art help --edit "manual-name" The first time you execute this command, you will be prompted to enter manual specific information like document format, document title, document subtitle, document author, etc. Once this information has been collected the help functionality performs some repository verifications and creates the manual source files inside the manual's directory name you specified as manual-name. When you create new documentation manuals, take care of the locale information you are currently using. This information is generally set in the LANG environment variable and is used by the help functionality of centos-art.sh script to define the language of new documentation manual and the document template used to build it, as well. Once the documentation structure has been created this way, the recently created documentation manual is ready to receive new chapters and sections. centos-art help --edit "tcar-fs::trunk" This command edits the trunk chapter documentation entry. Here is where you can define the chapter introduction. This very same procedure is used to create branches and tags chapters, just be sure to change the chapter field accordingly. If the related manual or chapter itself don't exist in the documentation structure, centos-art.sh script creates them in their respective hierarchical order (i.e., the manual structure first, and the chapter structure later). centos-art help --edit "tcar-fs::trunk:Identity" This command edits the trunk/Identity documentation entry inside The CentOS Artwork Repository File System documentation manual. When you edit documentation for a directory which related chapter doesn't exist, centos-art.sh script creates the related chapter first and then proceed to create the related documentaiton entry. In order to document deeper directory levels, you need to refer the directory you want to document by using a path-style or a hyphen-style format as documentation entry. For example, to edit the documentation related to the trunk/Identity/Models/Themes directory, you can use any of the following documentation entries: tcar-fs::trunk:identity-models-themes tcar-fs::trunk:Identity/Models/Themes trunk/Identity/Models/Themes ... ... ... ... The centos-art help command accepts common options described in and the following specific options: --answer-yes Assume yes to all confirmation requests. --sync-changes Synchronizes available changes between the working copy and the central repository. --search="KEYWORD" This option looks for KEYWORD inside the manual specified in the documentation entry and display related information you to read. --edit Edit documentation entry related to path specified by DOCENTRY parameter. The DOCENTRY parameter must point to any directory inside the working copy. When more than one DOCENTRY 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 Read documentation entry specified by DOCENTRY path. This option is used internally by centos-art.sh script to refer documentation based on errors, so you can know more about them and the causes that could have provoked them. --update Update output files rexporting them from the specified backend source files. --copy Duplicate documentation entries inside the working copy. When documentation entries are copied, it is required to pass two non-option parameters in the command-line. The first non-option parameter is considered the source location and the second one the target location. Both source location and target location must point to a directory under the working copy. --delete Delete documentation entries specified by DOCENTRY inside the working copy. It is possible to delete more than one documentation entry by specifying more DOCENTRY parameters in the command-line. --rename Rename documentation entries inside the working copy. When documentation entries are renamed, it is required to pass only two non-option parameters to the command-line. The first non-option parameter is considered the source location and the second one the target location. Both source location and target location must point to a directory under the working copy. When documentation entries are removed (e.g., through --delete or --rename options), the help functionality takes care of updating nodes, menus and cross refentrys related to documentation entries in order to keep the manual structure in a consistent state. None. ... The following people have worked in this functionality: Alain Reguera Delgado <alain.reguera@gmail.com>, =COPYRIGHT_YEAR_LIST= Copyright © =COPYRIGHT_YEAR_LIST= The CentOS Project This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.