diff --git a/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/help.docbook b/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/help.docbook index b7c795a..0b003be 100644 --- a/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/help.docbook +++ b/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/help.docbook @@ -1,65 +1,216 @@ -
+ - Standardizing Documentation Tasks + + help + + Standardize constructions tasks inside &TCAR; + + + + + help + Standardize documentation tasks inside &TCAR;. + + + + + help + + --help + --quiet + --answer-yes + --sync-changes + --search="KEYWORD" + --edit + --read + --update + --copy + --delete + --rename + + + MANUAL:PART:CHAPTER:SECTION + LOCATION + + + + + + + Description - The help functionality is the interface - the centos-art.sh script provides to - standardize frequent documentation tasks, based on specific - documentation formats, as described in . + The help functionality exists to create + and maintain documentation structures inside &TCAR;. The + documentation structure and documentation format implemented + by this functionality is described in and + , respectively. - - Syntax + + Documentation Entry Format + + ... + + - centos-art help [OPTIONS] [DOCENTRY] + + New Document Structures + + To create new documentation manuals inside &TCAR; use the + following command: + + + + centos-art help --edit "manual-name" + - The DOCENTRY parameter specifies the - documentation entry you want to process. It can be provided - one or more times in the form - MANUAL:PART:CHAPTER:SECTION or - MANUAL::CHAPTER:SECTION based on whether the - manual documentation backend you are using supports - structuring through parts or not. When - DOCENTRY parameter is not provided, - &TCAR; Repository File System documentation - manual is used as default value. + 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. - To determine the documentation format to use, when new - documentation manuals are created and no configuration file is - available, the help functionality request - you to enter one of the supported documentation formats and - then, uses it to create the documentation manual. Once the - documentation manual is created, the document configuration - file is available inside the manual directory structure and - used to retrive the document format information, instead. + 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. - - - Options - The help functionality accepts the - following options: + Once the documentation structure has been created this way, + the recently created documentation manual is ready to receive + new chapters and sections. + - - - + + Editing Document Structures + + + 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: + + - Supress all output messages except error messages. When this - option is passed, all confirmation requests are supressed and - a possitive answer is assumed for them, just as if the - option would have been provided. + tcar-fs::trunk:identity-models-themes - + + + tcar-fs::trunk:Identity/Models/Themes + + + + + trunk/Identity/Models/Themes + + + + This last format assummes you are using the + trunk chapter inside tcar-fs + documentation manual as parent documentation structure. The + field related to the part sectioning structure in the + documentatin entry (second field) is assumed empty, as well. + + + + + + + + + Copying Document Structure + + ... + + + + + Deleting Document Structure + + ... + + + + + Renaming Document Structure + + ... + + + + + Updating Document Structure + + ... + + + + + + Options + + The centos-art help command accepts common + options described in and the following + specific options: + + + @@ -187,31 +338,30 @@ When documentation entries are removed (e.g., through or options), the help functionality takes - care of updating nodes, menus and cross sections related to + care of updating nodes, menus and cross refentrys related to documentation entries in order to keep the manual structure in a consistent state. - + - - Description + + Examples - ... + None. - + - - Function Specific Environment + + Bugs ... - + - + Authors - The following people have worked in the - help functionality: + The following people have worked in this functionality: @@ -220,9 +370,9 @@ - + - + License @@ -249,6 +399,6 @@ Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - + -
+