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 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.
Output Paths
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:
Identity/Images/Brands/
Documentation/Manuals/Tcar-ug/
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.
Input Paths
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:
Identity/Models/Brands/
Documentation/Models/Tcar-ug/
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:
Identity/Images/Brands/
Locales/Documentation/Models/Docbook/Tcar-ug/es_ES/
Locales/Identity/Models/Themes/Default/Distro/5/Anaconda/es_ES/
The relationship between input, output and auxiliary paths is
created by combining the first directory level of input paths
with the first directory level in the repository directory
layout. In the repository directory layout, the first level
includes the Identity,
Documentation and
Scripts directories.
These directories are always used to create input and output
paths. The 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 functionality of
centos-art.sh script with the Documentation/Manuals/Docbook/Tcar-ug/
input path as argument, it will produce &TCARUG; in Spanish
language using translation messages from
Locales/Documentation/Models/Docbook/Tcar-ug/es_ES/
auxiliary path and would save final documentation files under
Documentation/Manuals/Docbook/Tcar-ug/es_ES/
output path.