From 393b365664f2322adc2af590cd595056bdb64d0f Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Nov 03 2012 02:52:51 +0000 Subject: Update `Repository/Convenctions/relbdirs.docbook' file. --- diff --git a/Documentation/Models/Docbook/Tcar-ug/Repository/Convenctions/relbdirs.docbook b/Documentation/Models/Docbook/Tcar-ug/Repository/Convenctions/relbdirs.docbook index d9c9474..2aa9dfd 100644 --- a/Documentation/Models/Docbook/Tcar-ug/Repository/Convenctions/relbdirs.docbook +++ b/Documentation/Models/Docbook/Tcar-ug/Repository/Convenctions/relbdirs.docbook @@ -1,121 +1,158 @@ - +
- Repository Path Types + Repository Path Relations In order for automation scripts to produce content inside a working copy of &TCAR;, it is required that all work lines be - related somehow. The relation between work lines is used by - automation scripts to know where to retrive the information - they need to work with (e.g., input files, translation - messages, output locations, etc.). This kind of relation is - built using two path constructions known as master - paths and auxiliar paths. + related somehow. The automation scripts take the relation + between work lines as reference to determine the place the + information they will work with will be retrieve from (e.g., + scalable vector graphics, documentation, translations, etc.), + as well as the place where it will store the final files + produced as result of automation process (e.g., portable + network graphics, documentation ready for printing and reading + online, etc.). + + + In order to implement the relation between work lines it is + required to establish a path name convenction, so we can + conceptually organize different components and relate them one + another using predictable path constructions in a scalable + way. Based on this need, we identify three different path + types inside &TCAR;. These path types are: Output + Paths, Input Paths, and + Auxiliary Paths. - - Master Paths +
+ Output Paths - A master path refers to a directory inside the repository that - contain input files required to produce output files through - automation scripts. Examples of master paths inside the - repository include: + The output paths point to directories inside the working copy + which contain files produced from files inside the input + paths. For example, the following paths are consider as output + paths: - trunk/Identity/Models/Brands + trunk/Identity/Images/Brands/ - trunk/Manuals/Tcar-ug + trunk/Documentation/Manuals/Tcar-ug/ - trunk/Identity/Models/Themes/Default/Distro/5/Anaconda + trunk/Identity/Images/Themes/Modern/2/Distro/5/Anaconda/ - + + Output paths are also known as Render-able + Directories because they are the type of + path you should provide as argument to functionality so as to + produce content through it. + - - Auxiliar Paths +
+
+ Input Paths - An auxiliar path refers to directories inside the repository - considered auxiliar for one single master path. Auxiliar path - can be either for output or localization. Assuming the master - path provides the input information, the auxiliar paths - provide the auxiliar information which describes how and where - that input information must be rendered by automation scripts. - Examples of auxiliar paths inside the repository include: + The input paths point to a directories inside the working copy + which contain files used to produce files inside output paths. + For example, the following paths are considered as input + paths: - + - trunk/Identity/Images/Brands + trunk/Identity/Models/Brands/ + + + + + trunk/Documentation/Models/Tcar-ug/ - trunk/Manuals/Tcar-ug/es_ES + trunk/Identity/Models/Themes/Default/Distro/5/Anaconda/ + +
+ +
+ Auxiliary Paths + + + The auxiliary paths point to directories inside the working + copy which contain files used to create modified instances of + inside input paths which are use in turn to produce files + inside output paths. For example, the following paths are + considered as auxiliary paths: + + + - trunk/Locales/Manuals/Tcar-ug/es_ES + trunk/Identity/Images/Brands/ - trunk/Identity/Images/Themes/Flame/3/Distro/5/Anaconda/es_ES + trunk/Locales/Documentation/Models/Docbook/Tcar-ug/es_ES/ - trunk/Locales/Identity/Models/Default/Distro/5/Anaconda/es_ES + trunk/Locales/Identity/Models/Themes/Default/Distro/5/Anaconda/es_ES/ - + - The relationship between master and auxiliar paths is built by - combining the second directory level of master paths with - directories in the second directory level of repository - layout. In the second directory level of repository layout, - the Identity, Manuals and Scripts directories are always - used to create the master paths and the output auxiliar paths. - The Locales directory, - on the other hand, is always used to create localization - auxiliar paths for all the master paths available under - Identity, Manuals and Scripts directories. + The relationship between input, output and auxiliary paths is + created by combining the second directory level of input paths + with the second directory level in the repository directory + layout. In the repository directory layout, the second level + includes the trunk/Identity, trunk/Documentation and trunk/Scripts directories. These + directories are always used to create input and output paths. + The trunk/Locales + directory, on the other hand, is always used to create + auxiliary paths only for input paths available under Identity, Documentation and Scripts directories. For example, if the LANG environment variable is set to es_ES.UTF-8 and you execute - the render functionality of + the functionality of centos-art.sh script with the trunk/Manuals/Tcar-ug master - path as argument, it will produce &TCARUG; in Spanish language - using translation messages from - trunk/Locales/Manuals/Tcar-ug/es_ES - auxiliar path and would save final documentation output files - under trunk/Manuals/Tcar-ug/es_ES - auxiliar path. + class="directory">trunk/Documentation/Manuals/Docbook/Tcar-ug/ + input path as argument, it will produce &TCARUG; in Spanish + language using translation messages from + trunk/Locales/Documentation/Models/Docbook/Tcar-ug/es_ES/ + auxiliary path and would save final documentation files under + trunk/Documentation/Manuals/Docbook/Tcar-ug/es_ES/ + output path. - +
- +