diff --git a/Manuals/TCAR-UG/Docbook/Scripts/Bash/render.docbook b/Manuals/TCAR-UG/Docbook/Scripts/Bash/render.docbook index c1d272b..fe12217 100644 --- a/Manuals/TCAR-UG/Docbook/Scripts/Bash/render.docbook +++ b/Manuals/TCAR-UG/Docbook/Scripts/Bash/render.docbook @@ -1,4 +1,240 @@ - The <function>render</function> functionality - ... + + <function>render</function> — Standardize Content Production + + + The render functionality is the interface + the centos-art.sh script provides to + standardize the content production tasks inside the working + copy. + + + centos-art render [OPTIONS] [DIRECTORY] + + + 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. + + + The render functionality accepts the + following options: + + + + + + + + This option supresses all output messages except error + messages. When this option is passed, all confirmation + requests are supressed and a possitive answer is assumed for + them, just as if the option + would have been provided. + + + + + + + + + Assume yes to all confirmation requests. + + + + + + + + + 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. + + + + + + + + + This option supresses all commit and update actions realized + over files, before and after the action itself had took place + over files in the working copy. + + + + + + + + + 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. + + + + + + + + + This option expands the =\ARCHITECTURE=, + 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 + architecture-sepecific contents but no architecture + information can be retrived from the directory path you are + currently rendering. + + + + + + + + + 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. + + + + + + + + + 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. + + + + + + + + + This option lets you apply a command as last-rendition action. + 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. + + + + + + + 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. + + + + Renderable 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. + + + 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, 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. + + + + Direct Production + + ... + + + + + Theme Production + + ... + + + + + + + Rendition Flows + + + Base-Rendition + + ... + + + + + Post-Rendition + + ... + + + + + Last-Rendition + + ... + + + + + Directory-Specific Rendition + + ... + + + +