diff --git a/Manuals/Repository/Docbook/Introduction/Repoconvs/layout.docbook b/Manuals/Repository/Docbook/Introduction/Repoconvs/layout.docbook index c186014..bb15c27 100644 --- a/Manuals/Repository/Docbook/Introduction/Repoconvs/layout.docbook +++ b/Manuals/Repository/Docbook/Introduction/Repoconvs/layout.docbook @@ -1,6 +1,6 @@ - Layout + The Repository Layout &TCAR; is supported by 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 is used by automation scripts - to know where to retrive the information they need to work - with (e.g., design model, translation messages, output - locations, etc.). This kind of relation is built using two - path constructions named master paths and - auxiliar paths. + 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. - + + + + Master Paths + - The master path points only to directories that contain source - files (e.g., SVG files) required to produce output base - content (e.g., PNG files) through automation scripts. Each - master path inside the repository may have several auxiliar - paths associated, but auxiliar paths can only have one master - path associated. + 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: + + + + + trunk/Identity/Models/Brands + + + + + trunk/Manuals/Repository/Docbook + + + + + trunk/Identity/Models/Themes/Default/Distro/5/Anaconda + + + - + + + + + Auxiliar paths + - Master paths used for producing images through SVG rendition - are organized under trunk/Identity/Models directory - structure and the auxiliar paths under trunk/Identity/Images, trunk/Locales and trunk/Manuals directory - structures. + An auxiliar path refers a directory inside the repository + considered auxiliar for the 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 is rendered by automation scripts. Examples of + auxiliar paths inside the repository include: + + + + + trunk/Identity/Images/Brands + + + + + trunk/Manuals/Repository/Docbook/es_ES + + + + + trunk/Locales/Manuals/Repository/Docbook/es_ES + + + + + trunk/Identity/Images/Themes/Flame/3/Distro/5/Anaconda/es_ES + + + + + trunk/Locales/Identity/Models/Default/Distro/5/Anaconda/es_ES + + + + - + + + + - Auxiliar paths can point either to directories or files. When - an auxiliar path points to a directory, that directory - contains information that modifies somehow the content - produced from master paths (e.g., translation messages) or - provides the output information required to know where the - content produced from the master path should be stored. When - an auxiliar path points to a file, that file has no other - purpose but to document the master path it refers to. + 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. + + + For example, if the LANG environment variable + is set to es_ES.UTF-8 and you execute the + render functionality of + centos-art.sh script with the trunk/Manuals/Repository/Docbook + master path as argument, it will produce &TCARUG; in Spanish + language using translation messages from trunk/Locales/Manuals/Repository/Docbook/es_ES + auxiliar path and saving output files inside trunk/Manuals/Repository/Docbook/es_ES + auxiliar path. + - Auxiliar paths should never be modified under any reason but - to satisfy the relationship with the master path. Liberal - change of auxiliar paths may suppress the conceptual idea they - were initially created for; and certainly, automation scripts - may stop working as expected. + To better understand what each directory inside the repository + means, read . - - - The relationship between auxiliar paths and master paths is - built by combining the master path and the second level - directory structures of the repository. The master path is - considered the path identifier and the repository second level - directory structure is considered the common part of the path - where the path identifier is appended to. So, if we have the - master path trunk/Identity/Models/Brands, - we'll end up having, at least, the trunk/Identity/Images/Brands - auxiliar path for storing output files and, optionally, one - path under trunk/Manuals for storing - documentation and one path under trunk/Locales for storing - localizations. - diff --git a/Manuals/Repository/Docbook/Introduction/Repoconvs/worklines.docbook b/Manuals/Repository/Docbook/Introduction/Repoconvs/worklines.docbook index 42403f9..b04524c 100644 --- a/Manuals/Repository/Docbook/Introduction/Repoconvs/worklines.docbook +++ b/Manuals/Repository/Docbook/Introduction/Repoconvs/worklines.docbook @@ -14,11 +14,11 @@ - Graphic Design + Visual Identity (trunk/Identity) In the production cycle, the first step takes place through - graphic design and is focused on preparing design models for + graphic design. It is focused on preparing design models for all the visual manifestation &TCP; is made of. Here, graphic designers describe the visual characteristics of each visual manifestation (e.g., image dimensions, position of text in the @@ -36,7 +36,7 @@ - Localization + Localization (trunk/L10n) The second step in the production cycle is to localize @@ -55,7 +55,7 @@ - Documentation + Documentation (trunk/Manuals) The third step in the production cycle is to document &TCAR;, @@ -71,7 +71,7 @@ - Automation + Automation (trunk/Scripts) The fourth step in the production cycle is to automate