From c2b04e48b78d933c372246e1344c9d0c06749337 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Sep 22 2011 06:22:32 +0000 Subject: Update `Manuals/Production/maintaining-structure.docbook'. --- diff --git a/Manuals/Tcar-ug/Manuals/Production/maintaining-structure.docbook b/Manuals/Tcar-ug/Manuals/Production/maintaining-structure.docbook index 03a0a34..fcd7d83 100644 --- a/Manuals/Tcar-ug/Manuals/Production/maintaining-structure.docbook +++ b/Manuals/Tcar-ug/Manuals/Production/maintaining-structure.docbook @@ -1,10 +1,99 @@ - + + Maintaining Document Structure + - Most maintaining tasks related to documentation manuals - written through Texinfo documentation format are standardized - by the help functionality of - centos-art.sh script, as described in . + This section describes the steps you should follow to maintain + documentation structures like that one described in . + + + Editing Document Structure + + + + + centos-art help --edit "tcar-fs::trunk" + + + + This command creates the base structure for the + trunk chapter and opens its main definition + file with your favorite text editor so you can update the + chapter introduction. This very same procedure is used to + create branches and tags + chapters, just be sure to change the chapter field + accordingly. + + + + + + + centos-art help --edit "tcar-fs::trunk:identity" + + + + This command creates the identity section + inside the trunk chapter. If the chapter + doesn't exist it will be created first. In this command, the + identity section refers to trunk/Identity directory inside + &TCAR;. In order to document other directories, follow the + same procedure but using minus signs to separate directories. + For example, to document the trunk/Identity/Models/Themes + directory you should use the + tcar-fs::trunk:identity-models-themes + documentation entry. + + + + + In the very specific case of + TCAR-FS manual, it is also possible + to refer chapters and sections using a path/to/dir format. + For example, the reference + tcar-fs::trunk:identity-models-themes + can be also specified as trunk/Identity/Models/Themes, + in case you feel more confortable with it than the former + one. + + + + + + + + + Copying Document Structure + + ... + + + + + Deleting Document Structure + + ... + + + + + Renaming Document Structure + + ... + + + + + Updating Document Structure + + ... + + +