diff --git a/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/render.docbook b/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/render.docbook index 4aab985..020e10d 100644 --- a/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/render.docbook +++ b/Documentation/Models/Docbook/Tcar-ug/Scripts/Bash/render.docbook @@ -3,7 +3,7 @@ render - Standardize rendition tasks inside &TCAR; + Standardize rendition tasks inside &TCAR;. @@ -13,74 +13,113 @@ - - - The DIRECTORY parameter specifies the - directory path, inside the working copy of &TCAR;, where the - files you want to process are stored in. This paramter can be - provided more than once in order to process more than one - directory path in a single command execution. When this - parameter is not provided, the current directory path where - the command was called from is used instead. - + + centos-art + render + -h|--help + -q|--quiet + --filter="REGEX" + --answer-yes + --dont-dirspecific + --releasever="RELEASEVER" + --basearch="BASEARCH" + --post-rendition="COMMAND" + --last-rendition="COMMAND" + --theme-model="MODELNAME" + --with-brands + --sync-changes + LOCATION + Description - Inside the working copy of &TCAR;, rendition tasks take place - inside renderable directories. The rendition itself is - performed through a serie of rendition flows named - base-rendition, post-rendition, last-rendition and - directory-specific rendition. + The render functionality exists to render + final image and documentation files from their respective + source files. + + Render-able directories + - Renderable directories are convenctional locations inside the - working copy where you can find source files, output files and - auxiliar files. Source files are used to produce output files. - Auxiliar files are used to modify the way output files are - produced from source files (e.g., to produce localized - output). Auxiliar files are optionals. + Inside the working copy of &TCAR;, render-able directories are + conventional locations inside the working copy where you can + find output files, produced from source files and optionally + auxiliary files. Auxiliary files are optionally used to modify + the way output files are produced from source files (e.g., to + produce localized output). Inside render-able directories the + rendition process is performed through different rendition + flows known as base-rendition, post-rendition, last-rendition + and directory-specific rendition. + - Renderable directories are made of several directories but - only the output dirctory path is passed to - render functionality as - DIRECTORY parameter in the command-line. - The directories related to source and auxiliar files are - automatically constructed based on a directory organization - convenction. This way, the render - functionality collects all the information it needs to work - with. + Inside the working copy of &TCAR;, the following directory + structures are considered render-able directories: + + + + trunk/Identity/Images/ + — This directory structure organizes final image files + in different formats. It also includes source files for + producing the backgrounds of themes. Related design models for + all these files are under trunk/Identity/Models/ directory + structure. + + + + Don't move any source file related to theme backgrounds from + render-able directories to theme design models directory + structure. The source files related to theme backgrounds are + specific to each theme and cannot be shared among different + themes. The directory structure related to theme design models + is reserved for files shared by all themes. + + + + - Inside the working copy, renderable directories are divided in - two categories in a way differences between them can be - preserved. These categories are named direct - production and theme production. These - categories provide the file organization convenction the - render functionality needs, to produce - content based on rendition flows. + trunk/Documentation/Manuals/ + — This directory structure organizes final documentation + files. Design models for all these files are organized under + trunk/Documentation/Models/ + directory structure. + + - Direct Production - Theme Production - Base Rendition Flow - Post Rendition Flow - Last Rendition Flow - Directory-Specific Rendition Flow - - Function Specific Environment + + Base-Rendition Flow + + ... + + + + + Post-Rendition Flow ... + + Last-Rendition Flow + + ... + + + + Usage @@ -110,18 +149,18 @@ - + This option reduces the list of files to process inside - DIRECTORY using REGEX as - pattern. You can use this option to control the amount of - files you want to render. The deeper you go into the - directory structure the more specific you'll be about the - files you want to render. When you cannot go deeper into the - directory structure through DIRECTORY - specification, use this option to reduce the list of files - therein. + LOCATION using + REGEX as REGUEX + using REGEX as files you want to render. + The deeper you go into the directory structure the more + specific you'll be about the files you want to render. When + you cannot go deeper into the directory structure through + LOCATION specification, use this + option to reduce the list of files therein. @@ -137,28 +176,28 @@ - + This option expands the =\RELEASE=, =\MAJOR_RELEASE=, and =\MINOR_RELEASE= translation makers based on - NUMBER value. Notice that translation - markers here were escaped using a backslash (\) - in order to prevent their expansion. Use this option when you - need to produce release-specific contents, but no release - information can be retrived from the directory path you are - currently rendering. + NUMBER value. Notice that + translation markers here were escaped using a backslash + (\) in order to prevent their expansion. Use this + option when you need to produce release-specific contents, but + no release information can be retrived from the directory path + you are currently rendering. - + This option expands the =\ARCHITECTURE=, - translation makers based on ARHC value. + translation makers based on ARHC value. Notice that translation markers here were escaped using a backslash (\) in order to prevent their expansion. Use this option when you need to produce @@ -170,38 +209,43 @@ - + This option specifies the name of theme model you want to use when producing theme artistic motifs. By default, if this option is not provided, the Default theme model is used as reference to produce theme artistic motifs. - To know what values does the NAME variable - can have, run ls - ~/artwork/trunk/Identity/Models/Themes command. + To know what values can be passed as + MODELNAME, run the following + command: + + + ls ${TCAR_WORKDIR}/trunk/Identity/Models/Themes + + - + This option lets you apply a command as post-rendition action. - In this case, the COMMAND represents the - command-line you want to execute in order to perform in-place - modifications to base-rendition output. + In this case, the COMMAND + represents the command-line you want to execute in order to + perform in-place modifications to base-rendition output. - + This option lets you apply a command as last-rendition action. - In this case, the COMMAND argument + In this case, the COMMAND argument represents the command string you want to execute in order to perform in-place modifications to base-rendition, post-rendition and directory-specific rendition outputs. @@ -211,11 +255,29 @@ + + Examples + + ... + + + + + Bugs + + To report bugs related to this function, please create a new + ticket here + refering the specific problems you found in it. For example, + it would be useful if you copy and paste any error output from + centos-art.sh script. + + + Authors - The following people have worked in the - render functionality: + The following people have worked in this functionality: