diff --git a/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/help.docbook b/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/help.docbook index f867557..f1e8f21 100644 --- a/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/help.docbook +++ b/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/help.docbook @@ -431,30 +431,71 @@ Creating Document Structures - To create new documentation manuals inside &TCAR; use the - following command: + To create new documentation manuals inside &TCAR; you use the + . This option edits existent manuals or + creates new ones. For example, consider you need to create a + documentation manual in texinfo format to describe different + kind of animals. This manual will be named My + Zoo, use one chapter for each animal you want to + describe and sections to cover the description itself. To + create such documentation manual, run the following command: - centos-art help --edit --format="texinfo" "manual:::" + centos-art help --edit --format="texinfo" "my-zoo:::" - 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:::. + In case such documentation manual doesn't exist in the + trunk/Docuementation/Models/Texinfo/ + directory, this command will produce the following output: + +The following documentation manual doesn't exist: +--> trunk/Documentation/Models/Texinfo/My-zoo/en_US/my-zoo.texinfo +Do you want to create it now? [yes/no]: yes +------------------------------------------------------------------ +Enter manual's title: My Zoo +Enter manual's subtitle: Puppet reference +Enter manual's abstract: This manual describes each puppet at home. +------------------------------------------------------------------ + Once the documentation structure has been created this way, the recently created documentation manual is ready to receive new sectioning levels (e.g., parts, chapters, sections, etc.). + For example, to create a new chapter named + Turtles inside My-zoo + documentation manual, run the following command: + + + centos-art help --edit --format="texinfo" "my-zoo::turtles:" + + + +The following documentation chapter doesn't exist: +--> trunk/Documentation/Models/Texinfo/My-zoo/en_US/Turtles +Do you want to create it now? [yes/no]: yes +------------------------------------------------------------------ +Enter chapter's title: Turtles +Creating trunk/Documentation/Models/Texinfo/My-zoo/en_US/Turtles +Creating trunk/Documentation/Models/Texinfo/My-zoo/en_US/Turtles/chapter-menu.texinfo +Creating trunk/Documentation/Models/Texinfo/My-zoo/en_US/Turtles/chapter-nodes.texinfo +Creating trunk/Documentation/Models/Texinfo/My-zoo/en_US/Turtles/chapter.texinfo +Updating trunk/Documentation/Models/Texinfo/My-zoo/en_US/my-zoo-menu.texinfo +Updating trunk/Documentation/Models/Texinfo/My-zoo/en_US/my-zoo-nodes.texinfo +Updating trunk/Documentation/Models/Texinfo/My-zoo/en_US/Turtles/chapter.texinfo +Updating trunk/Documentation/Manuals/Texinfo/My-zoo/en_US/my-zoo.info.bz2 +Updating trunk/Documentation/Manuals/Texinfo/My-zoo/en_US/my-zoo.xhtml.tar.bz2 +Updating trunk/Documentation/Manuals/Texinfo/My-zoo/en_US/my-zoo.xml +Updating trunk/Documentation/Manuals/Texinfo/My-zoo/en_US/my-zoo.docbook +Updating trunk/Documentation/Manuals/Texinfo/My-zoo/en_US/my-zoo.pdf +Updating trunk/Documentation/Manuals/Texinfo/My-zoo/en_US/my-zoo.txt.bz2 + +