diff --git a/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/help.docbook b/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/help.docbook index 85333a5..dd25eb6 100644 --- a/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/help.docbook +++ b/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/help.docbook @@ -172,7 +172,7 @@ information is used as reference to build the absolute path of documentation entry, so you always have to provide it in order to reach the documentation entry you want to work with. - Possible values for this option are shown in in . @@ -238,6 +238,17 @@ environment variable) one file at a time (i.e., the queue of files to edit is not loaded in the text editor.). + + When parent components inside documentation entries doesn't + exist (e.g., you try to create a section for a documentation + manual that doesn't exist), the help + functionality will create all documentation parent structures + considering the documentation format constraints and the + following document structure hierarchy order: documentation + manual first, parts second, + chapters third and sections + lastly. + @@ -281,20 +292,91 @@ - Duplicate documentation entries inside the working copy. + Duplicate documentation entries inside the working copy using + version control. - 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. + When you duplicate documentation entries through this option, + you should pass only two documentation entries in the command + line. The first one is considered the source location and + should point to a file under version control inside the + working copy. The second one is considered the target location + and should point either to the same structural level the + source points to or a direct parent level based on source + location, as described below. + + + + + + "manual:part:chapter:section-1" "manual:part:chapter:section-2" + + + Duplicates section-1 as + section-2 inside the same + chapter, + part and + manual. + + "manual:part:chapter-1:" "manual:part:chapter-2:" + + + Duplicates chapter-1 as + chapter-2 inside the same + part and + manual. + + + + + + + "manual:part-1::" "manual:part-2::" + + + Duplicates part-1 as + part-2 inside the same + manual. + + + + + + + "manual-1:::" "manual-2:::" + + + Duplicates manual-1 as + manual-2 inside trunk/Documentation/Models/${FLAG_FORMAT}/ + directory, where ${FLAG_FORMAT} is the name of the format + passed as option with the first letter in uppercase and the + rest in lowercase. + + + + + + + When you copy documentation entries through this option, all + structuring sections inside the one copied will be also + copied. For example, if you copy a documentation manual that + is made of parts, chapters and sections, the duplicated manual + will contain all those parts, chapters and sections, as well. + The same is true for lower sectioning structures. Thus, you + can be more specific in the documentation entry to reduce the + amount of content to duplicate. + + + + + + @@ -344,7 +426,7 @@ - centos-art help --edit "manual:::" + centos-art help --edit --format="texinfo" "manual:::" @@ -355,7 +437,7 @@ help functionality performs some repository verifications and creates the manual source files inside the manual's directory name you specified as - manual. + manual:::. @@ -373,7 +455,7 @@ - centos-art help --edit "manual:part:chapter:section" + centos-art help --edit --format="texinfo" "manual:part:chapter:section" @@ -389,7 +471,7 @@ - centos-art help --copy "manual:part:chapter:section" "manual:part:chapter:section" + centos-art help --copy --format="texinfo" "manual:part:chapter:section" "manual:part:chapter:section" @@ -403,7 +485,7 @@ To delete one documentation entry, use the following command: - centos-art help --delete "manual:part:chapter:section" + centos-art help --delete --format="texinfo" "manual:part:chapter:section" ... @@ -417,7 +499,7 @@ - centos-art help --copy "manual:part:chapter:section" "manual:part:chapter:section" + centos-art help --copy --format="texinfo" "manual:part:chapter:section" "manual:part:chapter:section" @@ -433,7 +515,7 @@ - centos-art help --update-structure "manual:part:chapter:section" + centos-art help --update-structure --format="texinfo" "manual:part:chapter:section" @@ -449,7 +531,7 @@ - centos-art help --update-output "manual:::" + centos-art help --update-output --format="texinfo" "manual:::"