From 39d073a2cd502574ad32f1c7e876aefac2e99411 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Sep 22 2011 06:22:28 +0000 Subject: Update `Manuals/Production/implementing-structure.docbook'. --- diff --git a/Manuals/Tcar-ug/Manuals/Production/implementing-structure.docbook b/Manuals/Tcar-ug/Manuals/Production/implementing-structure.docbook index abc98bf..0f34347 100644 --- a/Manuals/Tcar-ug/Manuals/Production/implementing-structure.docbook +++ b/Manuals/Tcar-ug/Manuals/Production/implementing-structure.docbook @@ -1,84 +1,53 @@ + Implementing Document Structure - To create a manual like the one described in , - you need to use the help functionality of - centos-art.sh script as it is described in - the following list of commands: + This section describes the steps you should follow to + implement document structures like that one described in . + + + + Creating Document Structure + + + To create new documentation manuals inside &TCAR; you need to + use the help functionality of + centos-art.sh script, as shown in the + following command: - + centos-art help --edit "manual-name" - - - centos-art help --edit "tcar-fs" - - - This command creates the base structure of - TCAR-FS manual and opens its main - definition file with your favorite text editor so you can - update manual's definition values like title, subtitle, - author, etc. + 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. - - - - - 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. + 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. - - - - - 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. + Once the documentation structure has been created this way, + the recently created documentation manual is ready to receive + new chapters and sections as it is described in . - - - - 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. - - - - - + +