diff --git a/Documentation/Models/Docbook/Tcar-ug/Manuals/Formats/intro.docbook b/Documentation/Models/Docbook/Tcar-ug/Manuals/Formats/intro.docbook index ef79d1a..f3d96f4 100644 --- a/Documentation/Models/Docbook/Tcar-ug/Manuals/Formats/intro.docbook +++ b/Documentation/Models/Docbook/Tcar-ug/Manuals/Formats/intro.docbook @@ -8,10 +8,9 @@ have their own specifications and requirements to create and maintain documentation manuals written through them. Inside &TCAR;, the functionality - provides an interface where documentation format - specifications have been already considered for you to be able - of creating and maintaining documentation manuals without - needing to take care of those underlaying structuring tasks. + provides the interface you use to create and maintain + documentation manuals without needing to take care the + underlaying structuring tasks. diff --git a/Documentation/Models/Docbook/Tcar-ug/Manuals/Formats/texinfo.docbook b/Documentation/Models/Docbook/Tcar-ug/Manuals/Formats/texinfo.docbook index d1aa203..801ec4b 100644 --- a/Documentation/Models/Docbook/Tcar-ug/Manuals/Formats/texinfo.docbook +++ b/Documentation/Models/Docbook/Tcar-ug/Manuals/Formats/texinfo.docbook @@ -70,17 +70,17 @@ Texinfo document structure - Manuals/${MANUAL_NAME} + Documentation/Models/Texinfo/${MANUAL_NAME} `-- ${LANG} - |-- ${CHAPTER_NAME} - | |-- chapter-menu.texinfo - | |-- chapter-nodes.texinfo - | |-- chapter.texinfo + |-- ${CHAPTER_NAME}/ | `-- ${SECTION_NAME}.texinfo - |-- Licenses - | |-- chapter-menu.texinfo - | |-- chapter-nodes.texinfo - | `-- chapter.texinfo + |-- ${CHAPTER_NAME}-menu.texinfo + |-- ${CHAPTER_NAME}-nodes.texinfo + |-- ${CHAPTER_NAME}.texinfo + |-- Licenses -> Documentation/Models/Texinfo/Default/${LANG}/Licenses + |-- Licenses-menu.texinfo -> Documentation/Models/Texinfo/Default/${LANG}/Licenses-menu.texinfo + |-- Licenses-nodes.texinfo -> Documentation/Models/Texinfo/Default/${LANG}/Licenses-nodes.texinfo + |-- Licenses.texinfo -> Documentation/Models/Texinfo/Default/${LANG}/Licenses.texinfo |-- ${MANUAL_NAME}.conf |-- ${MANUAL_NAME}-index.texinfo |-- ${MANUAL_NAME}-menu.texinfo @@ -96,7 +96,7 @@ support part sectioning inside documentation manuals, so neither the functionality does. Nevertheless, you can create several documentation - manuals and considered them as part of a bigger documentation + manuals and consider them as part of a bigger documentation manual to workaround this issue. @@ -253,7 +253,7 @@ - chapter.texinfo + Chapters.texinfo This file contains Texinfo's main chapter definition used @@ -277,7 +277,7 @@ - chapter-menu.texinfo + Chapters-menu.texinfo This file is part of Texinfo's main chapter definition and @@ -293,7 +293,7 @@ - chapter-nodes.texinfo + Chapters-nodes.texinfo This file is part of Texinfo's main chapter definition and @@ -303,7 +303,7 @@ chapter. The node definition of documentation entries is automatically created from the menu definition of documentation entries (see - chapter-menu.texinfo file above), once it + Chapters-menu.texinfo file above), once it has been updated from Texinfo source files. @@ -408,16 +408,17 @@ Documentation/Models/Texinfo/Default/ |-- ${LANG}/ | |-- Chapters/ -| | |-- chapter-menu.texinfo -| | |-- chapter-nodes.texinfo -| | |-- chapter.texinfo -| | `-- section.texinfo +| | |-- section.texinfo +| | `-- section-functions.texinfo +| |-- Chapters-menu.texinfo +| |-- Chapters-nodes.texinfo +| |-- Chapters.texinfo | |-- Licenses/ | | |-- GFDL.texinfo -| | |-- GPL.texinfo -| | |-- chapter-menu.texinfo -| | |-- chapter-nodes.texinfo -| | `-- chapter.texinfo +| | `-- GPL.texinfo +| |-- Licenses-menu.texinfo +| |-- Licenses-nodes.texinfo +| |-- Licenses.texinfo | |-- manual-index.texinfo | |-- manual-init.pl | |-- manual-menu.texinfo @@ -436,18 +437,24 @@ Documentation/Models/Texinfo/Default/ Inside the directory structure of Texinfo document templates, the Chapters directory - organizes chapter specific models used to create and maintain - both chapter and sections files inside manuals. On the other - hand, the Licenses - directory organizes the license information linked from all - manuals. Notice the license information is not copied into - documentation manuals when they are created, but refered from - this location where they are maintained. This configuration - permites that all documentation manuals written in Texinfo - format inside &TCAR; do use the same license information and - if a change is committed to the license files, such changes be - immediatly propagated to documentation manuals the next time - their output files be updated. + stores section specific models used to create and maintain + section files inside manuals. File names beginning with + Chapters, at the same level of Chapters directory, are used to + create chapter specific files inside manuals. + + + + The Licenses directory + organizes the license information linked from all manuals. + Notice the license information is not copied into + documentation manuals when they are created, but referred from + models location where they are maintained. This configuration + permits all documentation manuals written in Texinfo format + inside &TCAR; to use the same license information. This way, + if a change is committed to license files, it will be + immediately propagated to all documentation manuals the next + time their output files be updated. @@ -455,8 +462,8 @@ Documentation/Models/Texinfo/Default/ Document Expansions The document expansions are special constructions the functionality uses to generate - content dynamically inside Texinfo source files. + linkend="scripts-bash-help" /> functionality provides to + generate content dynamically inside Texinfo source files. @@ -747,7 +754,7 @@ option_name = "option_value" information set by @documentlanguage is ignored in Info and HTML output, but cosidered by Tex program to redefine various English words used in the PDF output (e.g., - Chapter, Index, + Chapters, Index, See, and so on) based on the current language set in. diff --git a/Documentation/Models/Docbook/Tcar-ug/Repository/History/2012.docbook b/Documentation/Models/Docbook/Tcar-ug/Repository/History/2012.docbook index 7313ad9..28b8fae 100644 --- a/Documentation/Models/Docbook/Tcar-ug/Repository/History/2012.docbook +++ b/Documentation/Models/Docbook/Tcar-ug/Repository/History/2012.docbook @@ -428,17 +428,4 @@ Identity/Images/Brands/Logos/ffffff/ffffff-0/78/centos-artwork.xmp - - Update DocBook Physical Divisions - - The main purpose of this update is changing the main physical - division of DocBook documents from entities to XInclude. This - change affects both and - functionalities. - - - ... - - - diff --git a/Documentation/Models/Docbook/Tcar-ug/Repository/History/2013.docbook b/Documentation/Models/Docbook/Tcar-ug/Repository/History/2013.docbook index 8eba393..9a00cfd 100644 --- a/Documentation/Models/Docbook/Tcar-ug/Repository/History/2013.docbook +++ b/Documentation/Models/Docbook/Tcar-ug/Repository/History/2013.docbook @@ -16,19 +16,70 @@ possibilities began to appear. + + On April 9th, I begin a training on how to manage small + enterprises. This training take place in Reina's church, + specifically in a centre called La Anunciata. + This training demanded me attention, so the few hours I was + dedicating to &TCAR; at nights were reduced even more. + + + + On May 14th, the work at Reina's church ends for me and I have + to return to Cienfuegos city. It was not possible to conclude + the training on business management. I tried to take advantage + of the situation dedicating more work and study hours to + &TCAR; and the related automation scripts once again. At this + point I consider a Git+Gitolite+Gitweb infrastructure for + &TCAR; and start working on it in my workstation. This, in + order to implement a new work flow for &TCAR; based on Git + version control. + + - Update Version Control Back-end + Update Version Control Environment + + The function environment related to version control tasks was + renamed from svn to in order to handle both + Subversion and + Git working copies of &TCAR;. This + change prepares the centos-art.sh script to + follow the suggestion of a complete migration from + Subversion to + Git, at some point. + + - The version control system functionality was renamed from - svn to in order to handle both Subversion and Git working copies - of &TCAR;. This change prepares the - centos-art.sh script to follow the - suggestion of a complete migration of version control system - from Subversion to Git for &TCAR;, at some point. + Because the Subversion + infrastructure is the one in place right now and it is the one + with most artwork history, it will be + Subversion the version control + system we are using as default in + centos-art.sh. However this will surely + change as soon as a Git + infrastructure be approved for &TCAR; and everything could be + moved there. + + Add <filename>centos-art.conf</filename> file + + Based on the need of supporting more than one application to + handle version control tasks, it was added the + centos-art.conf file into the Scripts/Bash directory. This file + exists to customize specific behaviours of + centos-art.sh script once it has been + executed (e.g., what kind of application will be used as + default for doing version control, or even if the actions + related to version control will be performed or not). + + + + diff --git a/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/environment.docbook b/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/environment.docbook index b3a3523..fbbcfd9 100644 --- a/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/environment.docbook +++ b/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/environment.docbook @@ -26,26 +26,30 @@ -+----------------------------------------------------------+ -| Shell environment | -+---|-------------------|-----------------|----------------+ -. |-- TCAR_WORKDIR |-- TCAR_BRAND |-- EDITOR . -. |-- LANG |-- HOME |-- PATH . -. `-- centos-art.sh `-- TMPDIR `-- ... . -. +---|--------------------------------------------+ . -. | Command environment | . -. +---|---------------|----------------|-----------+ . -. . |-- CLI_NAME |-- CLI_VERSION `-- ... . . -. . |-- CLI_FUNCDIR `-- CLI_BASEDIR . . -. . | +---------------------------------------+ . . -. . +--| Common functions environment | . . -. . +--|------------------------------------+ . . -. . . | +-------------------------------+ . . . -. . . +--| Specific function environment | . . . -. . . +-------------------------------+ . . . -. . ......................................... . . -. .................................................. . -............................................................ ++-----------------------------------------------------+ +| Shell environment | ++---|-------------------|-----------------|-----------+ +. |-- TCAR_WORKDIR |-- TCAR_BRAND |-- EDITOR . +. |-- LANG |-- HOME |-- PATH . +. `-- centos-art.sh `-- TMPDIR `-- ... . +. +---|-----------------------------------------+ . +. | Command environment | . +. +---|---------------|----------------|--------+ . +. . |-- CLI_NAME |-- CLI_VERSION `-- ... . . +. . |-- CLI_FUNCDIR `-- CLI_BASEDIR . . +. . `-- cli() . . +. . +---|-----------------------------------+ . . +. . | Common functions environment | . . +. . +---|------------------------|----------+ . . +. . . |-- cli_printMessage() |-- ... . . . +. . . |-- cli_getFilesList() |-- ... . . . +. . . `-- render() `-- ... . . . +. . . +---|---------------------------+ . . . +. . . | Specific function environment | . . . +. . . +-------------------------------+ . . . +. . ......................................... . . +. ............................................... . +....................................................... @@ -371,31 +375,98 @@ Specific function environments, on the other hand, are stored in the Scripts/Bash/Functions/${CLI_FUNCDIRNAM}/${CLI_FUNCNAME}.sh - file, where CLI_FUNCDIRNAME is the first - argument passed to centos-art.sh script with the first letter - in uppercase but the rest in lowercase and - CLI_FUNCNAME is the first argument passed - to centos-art.sh script with all letters in lowercase. - Specific functionalities are exported after common - functionalities, so specific environment functionalities - aren't available inside common environment functionalities. - - - - In , - render, help and - locale are all specific environment - functions while cli_printMessage and - cli_getFilesList are common environment - functions. + file, where: + + + + + CLI_FUNCDIRNAME + + + Is the first argument passed to + centos-art.sh script with the first letter + in uppercase but the rest in lowercase. For example, + Render, Locale and + Help are all possible values to this + variable. + + + + + + CLI_FUNCNAME + + + Is the first argument passed to + centos-art.sh script with all letters in + lowercase. For example, render, + locale and help are all + possible values to this variable. + + + + + + + Specific functions environment can be written in just one file + or in several files inside the same directory. Using one file + to write specific functions environment is rarely seen inside + the centos-art.sh script but it could + happen in situations where the need you want to solve can be + written in a few lines inside just one file. On the other + hand, if you find yourself writing a too long file, it is + convenient to logically divide it into several files. This + logical division takes place using functions, which indeed + create other environments where you can create and express + your solutions. + + + + The order in which individual files are exported and executed + inside the specific functions environments depends in the way + each developer write the Scripts/Bash/Functions/${CLI_FUNCDIRNAM}/${CLI_FUNCNAME}.sh + file. This is the main file inside the specific function + environment and controls the kind of logical division you + implement to organize the solution you need. As file name + convention, the following structure for new specific functions + environment is proposed: + + + +Scripts/Bash/Functions/${CLI_FUNCDIRNAM}/ +|-- ${CLI_FUNCNAME}.sh +`-- ${CLI_FUNCNAME}_verbSubject.sh + + + + Specific functions environment is exported after common + functions environment does, so it is not possible for specific + functions environment to be available inside the common + functions environment, nor inside other specific functions + environment, different to the one been passed as first + argument to the centos-art.sh script + command-line. + + Although, it is possible for you to call the + centos-art.sh script to itself + through the cli_runFnEnvironment + common function environment. + + In , + render is a specific function environment + while cli_printMessage and + cli_getFilesList are common function + environments. - Both specific and common environment functions exist to + Both specific and common function environments exist to standardize frequent tasks inside &TCAR;. The following sections will describe which these frequent tasks are and the - way they are standardized using specific and common - environment functions. + way they are standardized using specific and common function + environments. diff --git a/Documentation/Models/Docbook/Tcar-ug/tcar-ug.docbook b/Documentation/Models/Docbook/Tcar-ug/tcar-ug.docbook index db69d82..b0a19c9 100644 --- a/Documentation/Models/Docbook/Tcar-ug/tcar-ug.docbook +++ b/Documentation/Models/Docbook/Tcar-ug/tcar-ug.docbook @@ -30,6 +30,7 @@ 2010 2011 2012 + 2013 &TCP;. All rights reserved.