Blame Automation/Manuals/centos-art.sh-render.asciidoc

Alain Reguera Delgado 2e37b0
centos-art.sh-render(1)
Alain Reguera Delgado 2e37b0
=======================
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
Name
Alain Reguera Delgado 2e37b0
----
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
centos-art.sh-render - Standardize production tasks based on
Alain Reguera Delgado 2e37b0
configuration files.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
Synopsis
Alain Reguera Delgado 2e37b0
--------
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
+centos-art.sh render [OPTIONS] [DIRECTORY ...]+
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
Description
Alain Reguera Delgado 2e37b0
-----------
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
When you execute the *render* module, it looks for configuration files
Alain Reguera Delgado 2e37b0
inside the +DIRECTORY+ specified in the command-line and processes
Alain Reguera Delgado 2e37b0
them in the order they were found. When no +DIRECTORY+ is specified to
Alain Reguera Delgado 2e37b0
*centos-art.sh* script, the *render* module looks for configuration
Alain Reguera Delgado 2e37b0
files inside the current directory it was executed from.  If no
Alain Reguera Delgado 2e37b0
configuration file is found, the *render* module will end its
Alain Reguera Delgado 2e37b0
execution with an error message.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
Options
Alain Reguera Delgado 2e37b0
-------
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
The *render* module accepts the following options:
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
*--help*::
Alain Reguera Delgado 2e37b0
    This option shows the *render* module's documentation (this page).
Alain Reguera Delgado 2e37b0
*--version*::
Alain Reguera Delgado 2e37b0
    This option shows the *render* module's name and version.
Alain Reguera Delgado 2e37b0
*--filter="REGEX"*::
Alain Reguera Delgado 2e37b0
    This option reduces the number of section blocks inside
Alain Reguera Delgado 2e37b0
    configuration files the *render* module will take for processing.
Alain Reguera Delgado 2e37b0
    +REGEX+ is a regular expression pattern matching one or more
Alain Reguera Delgado 2e37b0
    section names inside the configuration files found under
Alain Reguera Delgado 2e37b0
    +DIRECTORY+.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
Configuration Files
Alain Reguera Delgado 2e37b0
-------------------
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
The configuration files are regular files with the +.conf+ extension.
Alain Reguera Delgado 2e37b0
The name of configuration files is frequently chosen for helping you
Alain Reguera Delgado 2e37b0
to remember what the configuration files are for and, in some cases,
Alain Reguera Delgado 2e37b0
for producing section blocks in specific order.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
The format used in configuration files use section blocks in the form
Alain Reguera Delgado 2e37b0
+[section-name]+. Each section block ends when the next section block
Alain Reguera Delgado 2e37b0
begins or at the end of the file. Section blocks contain one or more
Alain Reguera Delgado 2e37b0
variable definitions in the form +option = "value"+.  In the specific
Alain Reguera Delgado 2e37b0
case of *render* module, the +section-name+ is an alphanumeric value
Alain Reguera Delgado 2e37b0
and points to the final file or directory you want to save the
Alain Reguera Delgado 2e37b0
processing results in. The configuration variables describe how to
Alain Reguera Delgado 2e37b0
produce the file or directory specified as +section-name+.  Name
Alain Reguera Delgado 2e37b0
values in the +section-name+ don't accept variables or any kind of
Alain Reguera Delgado 2e37b0
expansion in it, but configuration values do.  Commentaries are
Alain Reguera Delgado 2e37b0
introduced by using the +#+ character at the beginning of lines.
Alain Reguera Delgado 2e37b0
Commentaries defined this way are excluded from processing so you can
Alain Reguera Delgado 2e37b0
use them freely.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
The configuration files are processed from top to bottom. This is very
Alain Reguera Delgado 2e37b0
important aspect to consider in situations where you need to grantee
Alain Reguera Delgado 2e37b0
an specific content production priority inside a configuration file
Alain Reguera Delgado 2e37b0
(e.g., you have several files in a configuration file and need to
Alain Reguera Delgado 2e37b0
produce some of them before others). So, section blocks set first in
Alain Reguera Delgado 2e37b0
the configuration file are processed first and section blocks set
Alain Reguera Delgado 2e37b0
later are processed later.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
The configuration files can be divided in separated configuration
Alain Reguera Delgado 2e37b0
files to produce section blocks with an specific priority.  For
Alain Reguera Delgado 2e37b0
example, if you have the file +render.conf+, you can divide its
Alain Reguera Delgado 2e37b0
content in +render-1.conf+, +render-2.conf+ to produce section blocks
Alain Reguera Delgado 2e37b0
inside +render-1.conf+ first and +render-2.conf+ later. This sort of
Alain Reguera Delgado 2e37b0
division is very useful when the configuration file begins to grow, or
Alain Reguera Delgado 2e37b0
you want to control the order in which specific groups of files are
Alain Reguera Delgado 2e37b0
produced inside +DIRECTORY+.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
To describe final files production, the *render* module's accepts the
Alain Reguera Delgado 2e37b0
following configuration variables inside configuration files:
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
*render-type*::
Alain Reguera Delgado 2e37b0
    Optional. This variable specifies the sort of content rendition
Alain Reguera Delgado 2e37b0
    the *render* module will perform. This variable can take one of
Alain Reguera Delgado 2e37b0
    the following values: +archive+, +asciidoc+, +compress+, +direct+,
Alain Reguera Delgado 2e37b0
    +palette+, and +svg+. When this variable is not present in the
Alain Reguera Delgado 2e37b0
    configuration file or has not a value set, the *render* module
Alain Reguera Delgado 2e37b0
    tries to determine the sort of rendition to perform based on the
Alain Reguera Delgado 2e37b0
    first file path passed through *render-from* variable.
Alain Reguera Delgado 2e37b0
*render-from*::
Alain Reguera Delgado 2e37b0
    Required. This variable specifies the file name of the source file
Alain Reguera Delgado 2e37b0
    (design model) used to produce the final file specified in the
Alain Reguera Delgado 2e37b0
    section line. This option can receive absolute paths and relative
Alain Reguera Delgado 2e37b0
    paths.  Absolute paths begin with a slash (+/+) character while
Alain Reguera Delgado 2e37b0
    relative paths begin with the dot slash (+./+) characters or no
Alain Reguera Delgado 2e37b0
    character at all.
Alain Reguera Delgado 2e37b0
*locale-from*::
Alain Reguera Delgado 2e37b0
    Optional. This variable specifies the absolute path to the
Alain Reguera Delgado 2e37b0
    +messages.po+ file used as reference to produce localized versions
Alain Reguera Delgado 2e37b0
    of the final files.
Alain Reguera Delgado 2e37b0
+
Alain Reguera Delgado 2e37b0
When this variable is provided, the files you specified in the
Alain Reguera Delgado 2e37b0
*render-from* variable must be XML-based files (e.g., SVG, DocBook).
Alain Reguera Delgado 2e37b0
The localization of source files will take place when the current
Alain Reguera Delgado 2e37b0
locale information of your terminal session is different to English
Alain Reguera Delgado 2e37b0
(e.g., +LANG=es_ES.UTF-8+).
Alain Reguera Delgado 2e37b0
+
Alain Reguera Delgado 2e37b0
Localized versions of the final file will be stored in a
Alain Reguera Delgado 2e37b0
locale-specific directory placed at the same level of the related
Alain Reguera Delgado 2e37b0
configuration file.
Alain Reguera Delgado 2e37b0
+
Alain Reguera Delgado 2e37b0
This variable accepts more than one value. If you pass more than one
Alain Reguera Delgado 2e37b0
translation file through *locale-from* variable, the first file in the
Alain Reguera Delgado 2e37b0
list will always contain the source file translatable strings and the
Alain Reguera Delgado 2e37b0
rest will be considered as shared translations files. Example of
Alain Reguera Delgado 2e37b0
shared translation files include files containing licenses
Alain Reguera Delgado 2e37b0
translations. Shared translation files won't be initiated or updated
Alain Reguera Delgado 2e37b0
by *render* module.
Alain Reguera Delgado 2e37b0
+
Alain Reguera Delgado 2e37b0
To initiate new +messages.po+ files or update existent ones, you need
Alain Reguera Delgado 2e37b0
to use the *locale* module of *centos-art.sh* script.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
[[using-paths]]
Alain Reguera Delgado 2e37b0
Using Paths
Alain Reguera Delgado 2e37b0
~~~~~~~~~~~
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
When you provide absolute paths inside configuration files, there
Alain Reguera Delgado 2e37b0
isn't confusion about the location where the file is or should be.
Alain Reguera Delgado 2e37b0
However, it introduces rigidity to directory structures inside the
Alain Reguera Delgado 2e37b0
working copy when it is necessary to move directories from one place
Alain Reguera Delgado 2e37b0
to another inside the working copy.  To eliminate this mobility
Alain Reguera Delgado 2e37b0
restrictions, relative paths can be used to create modular directory
Alain Reguera Delgado 2e37b0
structures.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
When you use relative paths inside configuration files, paths are
Alain Reguera Delgado 2e37b0
relative to the location where the configuration file is stored in.
Alain Reguera Delgado 2e37b0
This way it is possible to move whole directory structures without
Alain Reguera Delgado 2e37b0
touching the configuration file and still have a render-able
Alain Reguera Delgado 2e37b0
structures inside the working copy.  However, relative paths get
Alain Reguera Delgado 2e37b0
limited in situations where the production process needs files outside
Alain Reguera Delgado 2e37b0
the directory where the configuration file is stored in. In such
Alain Reguera Delgado 2e37b0
cases, a combination of relative and absolute paths is the solution to
Alain Reguera Delgado 2e37b0
apply.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
When we need to use absolute paths to several files in the same
Alain Reguera Delgado 2e37b0
directory (e.g., we are combining them all to produce a new image) but
Alain Reguera Delgado 2e37b0
outside the current directory the configuration file is stored in, it
Alain Reguera Delgado 2e37b0
is possible to use a list of absolute paths one beside another
Alain Reguera Delgado 2e37b0
separated by space or we can use path expansion which is shorter and
Alain Reguera Delgado 2e37b0
easier to read.  Path expansion is interpreted when you enclose a list
Alain Reguera Delgado 2e37b0
of file names in curly brackets using comma as separator without
Alain Reguera Delgado 2e37b0
spaces (e.g., +/some/dir/{file1,file2,file3}+). In order for path
Alain Reguera Delgado 2e37b0
expansion to work correctly, all the file names you put inside the
Alain Reguera Delgado 2e37b0
curly brackets' list must exist in the location specified first.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
[[using-environment-variables]]
Alain Reguera Delgado 2e37b0
Using Environment Variables
Alain Reguera Delgado 2e37b0
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
The configuration files let you to use environment variables inside
Alain Reguera Delgado 2e37b0
them. This might be very useful in situation where you need to provide
Alain Reguera Delgado 2e37b0
absolute paths based on specific information (e.g., the current locale
Alain Reguera Delgado 2e37b0
information).  Some of the most important environment variables used
Alain Reguera Delgado 2e37b0
by *centos-art.sh* script -and its configuration files- are described
Alain Reguera Delgado 2e37b0
below:
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
+TCAR_BASEDIR+::
Alain Reguera Delgado 2e37b0
    This variable contains the absolute path to your repository's
Alain Reguera Delgado 2e37b0
    working copy. The value of this variable is defined as read-only
Alain Reguera Delgado 2e37b0
    inside *centos-art.sh* script and cannot be modified later. As a
Alain Reguera Delgado 2e37b0
    matter of convenience, users make use of their +~/.bash_profile+
Alain Reguera Delgado 2e37b0
    file to define this variable there and, this way, skip the
Alain Reguera Delgado 2e37b0
    sometimes annoyance absolute path questioning the *centos-art.sh*
Alain Reguera Delgado 2e37b0
    script does in order to know the absolute path of the working copy
Alain Reguera Delgado 2e37b0
    it is going to work with.
Alain Reguera Delgado 2e37b0
+
Alain Reguera Delgado 2e37b0
Whenever you set absolute paths inside configuration files to refer
Alain Reguera Delgado 2e37b0
locations inside your working copy, it is necessary that you use the
Alain Reguera Delgado 2e37b0
+TCAR_BASEDIR+ environment variable in front of each path definition
Alain Reguera Delgado 2e37b0
you set.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
+LANG+::
Alain Reguera Delgado 2e37b0
    This variable contains the environment's current locale
Alain Reguera Delgado 2e37b0
    information.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
+TCAR_SCRIPT_LANG_LL+::
Alain Reguera Delgado 2e37b0
    This variable contains the language part of the current locale
Alain Reguera Delgado 2e37b0
    information. For instance, if the current locale is
Alain Reguera Delgado 2e37b0
    ``en_US.UTF-8'', the value of this variable would be ``en''.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
+TCAR_SCRIPT_LANG_CC+::
Alain Reguera Delgado 2e37b0
    This variable contains the country part of the current locale
Alain Reguera Delgado 2e37b0
    information. For instance, if the current locale is
Alain Reguera Delgado 2e37b0
    ``en_US.UTF-8'', the value of this variable would be ``US''.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
+TCAR_SCRIPT_LANG_LC+::
Alain Reguera Delgado 2e37b0
    This variable contains the current locale information in ll_CC
Alain Reguera Delgado 2e37b0
    format (e.g., es_ES).
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
+HOME+::
Alain Reguera Delgado 2e37b0
    This variable contains the absolute path to current user's home
Alain Reguera Delgado 2e37b0
    directory.  The value of this variable is set by the operating
Alain Reguera Delgado 2e37b0
    system when the user opens a terminal session.
Alain Reguera Delgado 2e37b0
+
Alain Reguera Delgado 2e37b0
Whenever you need to set user-specific absolute paths inside
Alain Reguera Delgado 2e37b0
configuration files, use this variable.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
[[rendering-files-directly]]
Alain Reguera Delgado 2e37b0
Rendering Image Files From Other Image Files
Alain Reguera Delgado 2e37b0
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
To render image files from other image files, the *render-type*
Alain Reguera Delgado 2e37b0
variable must be set to ``images'' and one or more image files must be
Alain Reguera Delgado 2e37b0
provided in the *render-from* variable. When the *render* module finds
Alain Reguera Delgado 2e37b0
a section block with this characteristics, it applies the value of
Alain Reguera Delgado 2e37b0
*command* variable to all files found in *render-from* variable to
Alain Reguera Delgado 2e37b0
produce the final file specified in the section name. 
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
When the *command* variable is not specified, the ``/usr/bin/convert
Alain Reguera Delgado 2e37b0
-append'' command is used as default.  This command takes all the
Alain Reguera Delgado 2e37b0
images passed through *render-from* and appends them from top to
Alain Reguera Delgado 2e37b0
bottom and saves the result in the file you specified in the section
Alain Reguera Delgado 2e37b0
name.  When you render files this way, the order in which you define
Alain Reguera Delgado 2e37b0
source files through *render-from* may affect the final result based
Alain Reguera Delgado 2e37b0
in the *command* you provided.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
The ``images'' rendition type provides an interface for external image
Alain Reguera Delgado 2e37b0
manipulation programs, like ImageMagick and NetPbm. You can use these
Alain Reguera Delgado 2e37b0
programs to manipulate images in great detail through the
Alain Reguera Delgado 2e37b0
command-line.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
[[rendering-archives]]
Alain Reguera Delgado 2e37b0
Rendering Archives
Alain Reguera Delgado 2e37b0
~~~~~~~~~~~~~~~~~~
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
When the *render-type* variable is set to +archive+, the *render*
Alain Reguera Delgado 2e37b0
module takes the list of files set through *render-from* variable and
Alain Reguera Delgado 2e37b0
applies the value of *command* to them all in order to produce the
Alain Reguera Delgado 2e37b0
final file specified in the section line. When the command variable is
Alain Reguera Delgado 2e37b0
not specified, the +/bin/tar --remove-files -czf+ command is used as
Alain Reguera Delgado 2e37b0
default.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
[[rendering-image-files]]
Alain Reguera Delgado 2e37b0
Rendering Image Files
Alain Reguera Delgado 2e37b0
~~~~~~~~~~~~~~~~~~~~~
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
When the *render-type* variable is set to +svg+, the section block is
Alain Reguera Delgado 2e37b0
interpreted for rendering image files. When rendering image files, the
Alain Reguera Delgado 2e37b0
*render-from* variable must point to a SVG files (either compressed or
Alain Reguera Delgado 2e37b0
uncompressed). The following following complementary variables are
Alain Reguera Delgado 2e37b0
also accepted:
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
*render-flow*::
Alain Reguera Delgado 2e37b0
    Optional. This variable specifies the rendition flow to follow
Alain Reguera Delgado 2e37b0
    when transforming SVG files into PNG images. This variable can
Alain Reguera Delgado 2e37b0
    take either +base+ or +extended+ as value. The +base+ rendition
Alain Reguera Delgado 2e37b0
    flow takes one SVG file and produces just one PNG image for it.
Alain Reguera Delgado 2e37b0
    The +extended+ value applies the +base+ rendition flow and then
Alain Reguera Delgado 2e37b0
    transform the final PNG image to different heights, formats,
Alain Reguera Delgado 2e37b0
    foreground colors and background colors. By default, when this
Alain Reguera Delgado 2e37b0
    variable is not set, the +base+ rendition flow is used.
Alain Reguera Delgado 2e37b0
*export-id*::
Alain Reguera Delgado 2e37b0
    Optional. This variable specifies the export id you want to use as
Alain Reguera Delgado 2e37b0
    reference to produce PNG images from SVG files. The export-id is
Alain Reguera Delgado 2e37b0
    an attribute you specified as unique value to an objects inside
Alain Reguera Delgado 2e37b0
    the SVG file in order to export that object only but not the rest
Alain Reguera Delgado 2e37b0
    in the SVG file. If this variable is not provided or it is empty,
Alain Reguera Delgado 2e37b0
    the drawing area of the SVG file is used as reference to produce
Alain Reguera Delgado 2e37b0
    the final PNG image.
Alain Reguera Delgado 2e37b0
*heights*::
Alain Reguera Delgado 2e37b0
    Optional. This variable is available only for +extended+ rendition
Alain Reguera Delgado 2e37b0
    flow and specifies the different image heights you want to create
Alain Reguera Delgado 2e37b0
    copies of the final PNG image. The values specified in this
Alain Reguera Delgado 2e37b0
    variable are separated by white space and should be understandable
Alain Reguera Delgado 2e37b0
    by ImageMagick tool set. When this variable is not provided, the
Alain Reguera Delgado 2e37b0
    *render* module will create copies of final PNG image for several
Alain Reguera Delgado 2e37b0
    standard heights.
Alain Reguera Delgado 2e37b0
*formats*::
Alain Reguera Delgado 2e37b0
    Optional. This variable is available only for +extended+ rendition
Alain Reguera Delgado 2e37b0
    flow and specifies the different image formats you want to create
Alain Reguera Delgado 2e37b0
    copies of the final PNG image. The values specified in this
Alain Reguera Delgado 2e37b0
    variable are separated by white space and should be supported by
Alain Reguera Delgado 2e37b0
    ImageMagick tool set.  When this variable is not provided or set
Alain Reguera Delgado 2e37b0
    in the configuration file, the *render* module will create copies
Alain Reguera Delgado 2e37b0
    of final PNG image for several standard formats.
Alain Reguera Delgado 2e37b0
+
Alain Reguera Delgado 2e37b0
[TIP]
Alain Reguera Delgado 2e37b0
To see the list of possible image formats supported by ImageMagick
Alain Reguera Delgado 2e37b0
tool set, run the following command: *+identify -list format+*.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
*fgcolors*::
Alain Reguera Delgado 2e37b0
    Optional. This variable is available only for +extended+ rendition
Alain Reguera Delgado 2e37b0
    flow and specifies the different foreground colors you want to
Alain Reguera Delgado 2e37b0
    create copies of the final PNG image. To do this, the image you
Alain Reguera Delgado 2e37b0
    want to copy should be rendered with black color (000000) so the
Alain Reguera Delgado 2e37b0
    color replacement can be performed. The values specified in this
Alain Reguera Delgado 2e37b0
    variable are separated by white space and should be understandable
Alain Reguera Delgado 2e37b0
    by ImageMagick tool set. When this variable is not provided the
Alain Reguera Delgado 2e37b0
    black foreground (+000000+) is used.
Alain Reguera Delgado 2e37b0
*bgcolors*::
Alain Reguera Delgado 2e37b0
    Optional. This variable is available only for +extended+ rendition
Alain Reguera Delgado 2e37b0
    flow and specifies the different background colors you want to
Alain Reguera Delgado 2e37b0
    create copies of the final PNG image. This variable uses
Alain Reguera Delgado 2e37b0
    Inkscape's _--export-background_ and _--export-background-opacity_
Alain Reguera Delgado 2e37b0
    options to control the background information of final PNG images.
Alain Reguera Delgado 2e37b0
    Possible values to this variable take the form +XXXXXX-X+, where
Alain Reguera Delgado 2e37b0
    the first six +X+ represent a color in hexadecimal format and the
Alain Reguera Delgado 2e37b0
    final +X+ might be 1 or 0. 1 for full opacity and 0 for full
Alain Reguera Delgado 2e37b0
    transparency.  Intermediate values between 0 and 1 (e.g., 0.55)
Alain Reguera Delgado 2e37b0
    can be given to control the background opacity. When this variable
Alain Reguera Delgado 2e37b0
    is not provided, white background full transparency (+ffffff-0+)
Alain Reguera Delgado 2e37b0
    is used as default value.
Alain Reguera Delgado 2e37b0
*command*::
Alain Reguera Delgado 2e37b0
    Optional. This variable specifies the command used to modify the
Alain Reguera Delgado 2e37b0
    production of final images. During the rendition process, images
Alain Reguera Delgado 2e37b0
    are produced inside a temporal directory, and later moved to its
Alain Reguera Delgado 2e37b0
    final location using the command specified as value in this
Alain Reguera Delgado 2e37b0
    variable. When this variable is not specified, it can take one of
Alain Reguera Delgado 2e37b0
    two values based on the amount of files passed through
Alain Reguera Delgado 2e37b0
    *render-from* variable.  When just one file is passed through the
Alain Reguera Delgado 2e37b0
    *render-from* variable, the default value for this variable is
Alain Reguera Delgado 2e37b0
    +/bin/cp+, but when there are reference to more than one file, the
Alain Reguera Delgado 2e37b0
    value of this option is +/usr/bin/convert +append+ which combines
Alain Reguera Delgado 2e37b0
    all images into the final images.
Alain Reguera Delgado 2e37b0
*comment*::
Alain Reguera Delgado 2e37b0
    Optional. This variable contains a sentence describing the image
Alain Reguera Delgado 2e37b0
    you are creating. This information is written in the +comment+
Alain Reguera Delgado 2e37b0
    field of PNG images. When this variable is empty, no comment
Alain Reguera Delgado 2e37b0
    information will be written to the final PNG image files.
Alain Reguera Delgado 2e37b0
*brand*::
Alain Reguera Delgado 2e37b0
    Optional. This variable describes the branding information applied
Alain Reguera Delgado 2e37b0
    to final images. The value of this variable has the form
Alain Reguera Delgado 2e37b0
    +FILENAME:GEOMETRY+, where +FILENAME+ is the absolute path to the
Alain Reguera Delgado 2e37b0
    PNG image you want to apply as brand and, +GEOMETRY+ takes the
Alain Reguera Delgado 2e37b0
    form +xHEIGHT+X+Y+. In order to apply brand information to final
Alain Reguera Delgado 2e37b0
    images correctly, the brand images files you want to apply must be
Alain Reguera Delgado 2e37b0
    available. In case they don't exist the *render* module ends its
Alain Reguera Delgado 2e37b0
    execution with an error message.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
[[rendering-images-with-reduced-number-of-colros]]
Alain Reguera Delgado 2e37b0
Rendering Images With Reduced Number Of Colors
Alain Reguera Delgado 2e37b0
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
When the *render-type* variable is set to +palette+, the section block
Alain Reguera Delgado 2e37b0
where this variable was defined is interpreted for producing images
Alain Reguera Delgado 2e37b0
with a reduced number of colors. In these cases, the *render-from*
Alain Reguera Delgado 2e37b0
variable must point to an image file. The following complementary
Alain Reguera Delgado 2e37b0
variables are also accepted:
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
*palette-gpl*::
Alain Reguera Delgado 2e37b0
    Required. This variable addresses the palette of colors that will
Alain Reguera Delgado 2e37b0
    be use for reducing colors. Generally, the palette of color file
Alain Reguera Delgado 2e37b0
    ends with the +.gpl+ extension and is stored in the same directory
Alain Reguera Delgado 2e37b0
    of the configuration file. This file can be produced by GIMP and
Alain Reguera Delgado 2e37b0
    provides an optimized set of colors for the specific image you
Alain Reguera Delgado 2e37b0
    provided in the *render-from* variable.
Alain Reguera Delgado 2e37b0
+
Alain Reguera Delgado 2e37b0
To find the optimized set of colors, you need to open the image
Alain Reguera Delgado 2e37b0
specified in *render-from* in GIMP, reduce its colors to the desired
Alain Reguera Delgado 2e37b0
number using GIMP's Indexed feature and, then, create a new palette by
Alain Reguera Delgado 2e37b0
importing it from the indexed image file. Once you have the palette
Alain Reguera Delgado 2e37b0
this way, you need to edit it using the Palettes dialog to add the
Alain Reguera Delgado 2e37b0
hexadecimal value of each color in the palette to the comment field,
Alain Reguera Delgado 2e37b0
so you have a palette file similar to the following:
Alain Reguera Delgado 2e37b0
+
Alain Reguera Delgado 2e37b0
----------------------------------------------------------------------
Alain Reguera Delgado 2e37b0
GIMP Palette
Alain Reguera Delgado 2e37b0
Name: Syslinux-Default
Alain Reguera Delgado 2e37b0
Columns: 16
Alain Reguera Delgado 2e37b0
#
Alain Reguera Delgado 2e37b0
 32  76 141 204c8d
Alain Reguera Delgado 2e37b0
 37  82 146 255292
Alain Reguera Delgado 2e37b0
 52  94 153 345e99
Alain Reguera Delgado 2e37b0
 73 110 162 496ea2
Alain Reguera Delgado 2e37b0
 91 124 172 5b7cac
Alain Reguera Delgado 2e37b0
108 136 180 6c88b4
Alain Reguera Delgado 2e37b0
120 146 186 7892ba
Alain Reguera Delgado 2e37b0
131 158 193 839ec1
Alain Reguera Delgado 2e37b0
255 255 255 ffffff
Alain Reguera Delgado 2e37b0
146 170 200 92aac8
Alain Reguera Delgado 2e37b0
162 182 209 a2b6d1
Alain Reguera Delgado 2e37b0
183 199 219 b7c7db
Alain Reguera Delgado 2e37b0
204 216 230 ccd8e6
Alain Reguera Delgado 2e37b0
221 229 238 dde5ee
Alain Reguera Delgado 2e37b0
235 241 245 ebf1f5
Alain Reguera Delgado 2e37b0
246 251 254 f6fbfe
Alain Reguera Delgado 2e37b0
----------------------------------------------------------------------
Alain Reguera Delgado 2e37b0
+
Alain Reguera Delgado 2e37b0
{asciidoc-br}
Alain Reguera Delgado 2e37b0
+
Alain Reguera Delgado 2e37b0
Now that the palette has been created, you can set a path to
Alain Reguera Delgado 2e37b0
*palette-gpl* variable. Even you can set path of *palette-gpl* from
Alain Reguera Delgado 2e37b0
GIMP's palettes directory (+~/.gimp-x.x/palettes/+), it is much more
Alain Reguera Delgado 2e37b0
preferable that you copy the palette file from that location to the
Alain Reguera Delgado 2e37b0
configuration file's DIRECTORY inside the repository and put it under
Alain Reguera Delgado 2e37b0
version control, so others can take benefit of it.  The palette file
Alain Reguera Delgado 2e37b0
is an integral part of color specific image reduction so it must be
Alain Reguera Delgado 2e37b0
near the configuration file you use for such actions.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
Rendering Documentation Files
Alain Reguera Delgado 2e37b0
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
To render documentation files, the *render-type* variable must be set
Alain Reguera Delgado 2e37b0
to ``asciidoc'' and the *render-from* variable must point to an
Alain Reguera Delgado 2e37b0
Asciidoc file. When the *render* module finds this information in a
Alain Reguera Delgado 2e37b0
section block, it takes the asciidoc file as source and transforms it
Alain Reguera Delgado 2e37b0
into a docbook file using the *asciidoc* program. The docbook file is
Alain Reguera Delgado 2e37b0
created temporarily for further format transformations and removed
Alain Reguera Delgado 2e37b0
later, once the final format has been rendered.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
When the *render* module creates the intermediate docbook file, it
Alain Reguera Delgado 2e37b0
considers the current locale information of your environment (e.g., by
Alain Reguera Delgado 2e37b0
reading the LANG environment variable). In case the current locale
Alain Reguera Delgado 2e37b0
information is different to English (e.g., the value of LANG
Alain Reguera Delgado 2e37b0
environment variable doesn't begin with the ``en'' characters), the
Alain Reguera Delgado 2e37b0
docbook file will be localized based on the translation file specified
Alain Reguera Delgado 2e37b0
in the *locale-from* variable, before applying further format
Alain Reguera Delgado 2e37b0
transformations to it. This way, further format transformations from
Alain Reguera Delgado 2e37b0
the temporarily docbook file will end up being localized as well. If
Alain Reguera Delgado 2e37b0
the *locale-from* variable is not present in the section block, the
Alain Reguera Delgado 2e37b0
intermediate docbook file won't be localized which make the final
Alain Reguera Delgado 2e37b0
result to be not localized either.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
When you set the *render-type* variable to ``asciidoc'', the section
Alain Reguera Delgado 2e37b0
blocks need to have the *render-flow* variable set to ``article'',
Alain Reguera Delgado 2e37b0
``book'' or ``manpage''.  This information defines the way the
Alain Reguera Delgado 2e37b0
intermediate docbook file is produced from the asciidoc file and, by
Alain Reguera Delgado 2e37b0
extension, the possible final results, too.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
When *render-flow* variable is set to ``article'' or ``book'', it is
Alain Reguera Delgado 2e37b0
possible to produce final files in ``xhtml'' format but not in
Alain Reguera Delgado 2e37b0
``manpage'' format. This is because man pages require a specific
Alain Reguera Delgado 2e37b0
document structure that both articles and books don't need to have.
Alain Reguera Delgado 2e37b0
When producing articles and books in XHTML format, you can use the
Alain Reguera Delgado 2e37b0
*render-page* variable to control whether to produce the entire book
Alain Reguera Delgado 2e37b0
or article in just one file (``single'') or in separate files linked
Alain Reguera Delgado 2e37b0
one another (``chunks'').
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
When *render-flow* variable is set to ``manpage'' it is possible to
Alain Reguera Delgado 2e37b0
set the *formats* variable to either ``manpage'' or ``xhtml'' in order
Alain Reguera Delgado 2e37b0
to render the docbook file as man page or XHTML format, respectively.
Alain Reguera Delgado 2e37b0
The final files produced this way are stored in the +man${MANSECT}/+
Alain Reguera Delgado 2e37b0
or +htmlman${MANSECT}+ directories based on the format you choose. If
Alain Reguera Delgado 2e37b0
you are producing man pages to a language different to English, these
Alain Reguera Delgado 2e37b0
directories would be +${LANG}/man${MANSECT}/+ and
Alain Reguera Delgado 2e37b0
+${LANG}/htmlman${MANSECT}+, instead.  The structure of these paths is
Alain Reguera Delgado 2e37b0
required in order for *man* command to find the man pages in different
Alain Reguera Delgado 2e37b0
locales. The value of the man's volume section can be set using the
Alain Reguera Delgado 2e37b0
*mansect* variable. If this variable is not set, the value of man's
Alain Reguera Delgado 2e37b0
volume section will be 1.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
When *render-flow* variable is not set, the ``article'' value is used
Alain Reguera Delgado 2e37b0
as default value.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
When the *formats* variable has the ``xhtml'' value, you need to set
Alain Reguera Delgado 2e37b0
the *images-from* and *styles-from* variables inside the related
Alain Reguera Delgado 2e37b0
section block, no matter what the value of *render-flow* would be. The
Alain Reguera Delgado 2e37b0
value of *images-from* and *styles-from* variables must point to a
Alain Reguera Delgado 2e37b0
directory, inside the working copy, containing the share images and
Alain Reguera Delgado 2e37b0
CSS files used by XHTML documents, respectively.  If none of these two
Alain Reguera Delgado 2e37b0
variables are set the directories
Alain Reguera Delgado 2e37b0
+${TCAR_BASEDIR}/Artworks/Icons/Webenv+ and
Alain Reguera Delgado 2e37b0
+${TCAR_BASEDIR}/Artworks/Webenv/Docbook/1.69.1/Css+ will be used for
Alain Reguera Delgado 2e37b0
them.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
When the *formats* variable is not set, the ``xhtml'' value is used as
Alain Reguera Delgado 2e37b0
default value.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
Localization Files
Alain Reguera Delgado 2e37b0
------------------
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
When the current locale code you are using in your terminal's session
Alain Reguera Delgado 2e37b0
is not English, the *render* module uses localization files specified
Alain Reguera Delgado 2e37b0
by *locale-from* variable to produce final versions of source files
Alain Reguera Delgado 2e37b0
for your current locale information.  Localization files are created
Alain Reguera Delgado 2e37b0
and edited through *locale* module.  Thus, in order for you to produce
Alain Reguera Delgado 2e37b0
localized content you need to create the localization files through
Alain Reguera Delgado 2e37b0
*locale* module first and then run the *render* module.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
To know more about localization files, see *locale* module's
Alain Reguera Delgado 2e37b0
documentation.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
Examples
Alain Reguera Delgado 2e37b0
--------
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
Here are some practical configuration examples you can use as
Alain Reguera Delgado 2e37b0
reference to create your own configuration files.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
----------------------------------------------------------------------
Alain Reguera Delgado 2e37b0
[Xhtml-single]
Alain Reguera Delgado 2e37b0
render-type     = "asciidoc"
Alain Reguera Delgado 2e37b0
render-flow     = "article"
Alain Reguera Delgado 2e37b0
render-from     = "corporate.asciidoc"
Alain Reguera Delgado 2e37b0
locale-from     = "${TCAR_SCRIPT_LANG_LC}/messages.po"
Alain Reguera Delgado 2e37b0
images-from     = "${TCAR_BASEDIR}/Artworks/Icons/Webenv"
Alain Reguera Delgado 2e37b0
styles-from     = "${TCAR_BASEDIR}/Artworks/Webenv/Docbook/1.69.1/Css"
Alain Reguera Delgado 2e37b0
formats         = "xhtml"
Alain Reguera Delgado 2e37b0
render-page     = "single"
Alain Reguera Delgado 2e37b0
----------------------------------------------------------------------
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
{asciidoc-br}
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
When the *render* module reads this configuration file, it initiates
Alain Reguera Delgado 2e37b0
the +asscidoc+ module which in turn initiates the +xhtml+ module for
Alain Reguera Delgado 2e37b0
transforming the +corporate.asciidoc+ file into +corporate.docbook+ file
Alain Reguera Delgado 2e37b0
using +article+ as document type and
Alain Reguera Delgado 2e37b0
+${TCAR_SCRIPT_LANG_LC}/messages.po+ as source for localization. As
Alain Reguera Delgado 2e37b0
result, the *render* module produces the
Alain Reguera Delgado 2e37b0
+${TCAR_SCRIPTS_LANG_LC}/Xhtml-single/index.html+ file, using the same
Alain Reguera Delgado 2e37b0
directory of the configuration file as base directory.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
----------------------------------------------------------------------
Alain Reguera Delgado 2e37b0
[centos-artwork.png]
Alain Reguera Delgado 2e37b0
render-from = "${TCAR_BASEDIR}/Artworks/Brands/Types/Webenv/centos.org/{centos,artwork}.svgz"
Alain Reguera Delgado 2e37b0
formats     = "xpm pdf jpg tif"
Alain Reguera Delgado 2e37b0
heights     = "16 20 22 24 32 36 38 40 48 64 72 78 96 112 124 128 148 164 196 200 512"
Alain Reguera Delgado 2e37b0
fgcolors    = "000000 ffffff"
Alain Reguera Delgado 2e37b0
bgcolors    = "ffffff-0"
Alain Reguera Delgado 2e37b0
command     = "/usr/bin/convert +append"
Alain Reguera Delgado 2e37b0
----------------------------------------------------------------------
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
{asciidoc-br}
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
When the *render* module reads this configuration file, it takes the
Alain Reguera Delgado 2e37b0
+centos.svgz+ and +artwork.svgz+ files as source to produce the
Alain Reguera Delgado 2e37b0
+centos.png+ and +artwork.png+ files considering the first value in
Alain Reguera Delgado 2e37b0
the list of heights, background, foreground colors specified in the
Alain Reguera Delgado 2e37b0
configuration file.  Then, it combines the results horizontally to
Alain Reguera Delgado 2e37b0
create the +centos-artwork.png+ file. Later, the +centos-artwork.png+
Alain Reguera Delgado 2e37b0
file is converted to produce one image file for each image format
Alain Reguera Delgado 2e37b0
specified in the configuration file. At this point, all the process
Alain Reguera Delgado 2e37b0
repeats again but for the next height and color values in the list.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
{asciidoc-br}
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
----------------------------------------------------------------------
Alain Reguera Delgado 2e37b0
[syslinux-splash.png]
Alain Reguera Delgado 2e37b0
render-from     = "${TCAR_BASEDIR}/Artworks/Themes/Models/Distro/5/Syslinux/syslinux-splash.svgz"
Alain Reguera Delgado 2e37b0
brand           = "${TCAR_BASEDIR}/Artworks/Brands/Types/Default/Images/ffffff/ffffff-0/48/centos.png:x48+20+232"
Alain Reguera Delgado 2e37b0
brand           = "${TCAR_BASEDIR}/Artworks/Brands/Types/Numbers/Images/ffffff/ffffff-0/96/5.png:x96+300+184"
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
[syslinux-splash.lss]
Alain Reguera Delgado 2e37b0
render-from     = "syslinux-splash.png"
Alain Reguera Delgado 2e37b0
render-type     = "palette"
Alain Reguera Delgado 2e37b0
palette-gpl     = "colors.gpl"
Alain Reguera Delgado 2e37b0
----------------------------------------------------------------------
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
{asciidoc-br}
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
When the *render* module reads this configuration file, 
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
----------------------------------------------------------------------
Alain Reguera Delgado 2e37b0
[screenshot.png]
Alain Reguera Delgado 2e37b0
render-type     = "svg"
Alain Reguera Delgado 2e37b0
render-from     = "${TCAR_BASEDIR}/Artworks/Themes/Models/Distro/5/Gdm/screenshot.svgz"
Alain Reguera Delgado 2e37b0
render-flow     = "base"
Alain Reguera Delgado 2e37b0
brand           = "${TCAR_BASEDIR}/Artworks/Brands/Symbols/Default/Images/ffffff/ffffff-0/16/centos.png:x16+5+5"
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
[800x600.tar.gz]
Alain Reguera Delgado 2e37b0
render-type     = "archive"
Alain Reguera Delgado 2e37b0
render-from     = "${TCAR_BASEDIR}/Artworks/Themes/Motifs/${MOTIF}/Backgrounds/Images/800x600-final.png:background.png"
Alain Reguera Delgado 2e37b0
render-from     = "${TCAR_BASEDIR}/Artworks/Themes/Models/Distro/5/Gdm/GdmGreeterTheme.desktop"
Alain Reguera Delgado 2e37b0
render-from     = "${TCAR_BASEDIR}/Artworks/Themes/Models/Distro/5/Gdm/GdmGreeterTheme.xml"
Alain Reguera Delgado 2e37b0
render-from     = "${TCAR_BASEDIR}/Artworks/Themes/Models/Distro/5/Gdm/icon-language.png"
Alain Reguera Delgado 2e37b0
render-from     = "${TCAR_BASEDIR}/Artworks/Themes/Models/Distro/5/Gdm/icon-reboot.png"
Alain Reguera Delgado 2e37b0
render-from     = "${TCAR_BASEDIR}/Artworks/Themes/Models/Distro/5/Gdm/icon-session.png"
Alain Reguera Delgado 2e37b0
render-from     = "${TCAR_BASEDIR}/Artworks/Themes/Models/Distro/5/Gdm/icon-shutdown.png"
Alain Reguera Delgado 2e37b0
render-from     = "screenshot.png"
Alain Reguera Delgado 2e37b0
command         = "/bin/tar -czf"
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
[1360x768.tar.gz]
Alain Reguera Delgado 2e37b0
render-type     = "archive"
Alain Reguera Delgado 2e37b0
render-from     = "${TCAR_BASEDIR}/Artworks/Themes/Motifs/${MOTIF}/Backgrounds/Images/1360x768-final.png:background.png"
Alain Reguera Delgado 2e37b0
render-from     = "${TCAR_BASEDIR}/Artworks/Themes/Models/Distro/5/Gdm/GdmGreeterTheme.desktop"
Alain Reguera Delgado 2e37b0
render-from     = "${TCAR_BASEDIR}/Artworks/Themes/Models/Distro/5/Gdm/GdmGreeterTheme.xml"
Alain Reguera Delgado 2e37b0
render-from     = "${TCAR_BASEDIR}/Artworks/Themes/Models/Distro/5/Gdm/icon-language.png"
Alain Reguera Delgado 2e37b0
render-from     = "${TCAR_BASEDIR}/Artworks/Themes/Models/Distro/5/Gdm/icon-reboot.png"
Alain Reguera Delgado 2e37b0
render-from     = "${TCAR_BASEDIR}/Artworks/Themes/Models/Distro/5/Gdm/icon-session.png"
Alain Reguera Delgado 2e37b0
render-from     = "${TCAR_BASEDIR}/Artworks/Themes/Models/Distro/5/Gdm/icon-shutdown.png"
Alain Reguera Delgado 2e37b0
render-from     = "screenshot.png"
Alain Reguera Delgado 2e37b0
command         = "/bin/tar --remove-files -czf"
Alain Reguera Delgado 2e37b0
----------------------------------------------------------------------
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
{asciidoc-br}
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
When the *render* module reads this configuration file, 
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
Bugs
Alain Reguera Delgado 2e37b0
----
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
The *render* module has some issues I would like you to be aware of.
Alain Reguera Delgado 2e37b0
Mainly, to see if you could help me find better solutions for them ;)
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
Rendering Images With Reduced Number Of Colors
Alain Reguera Delgado 2e37b0
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
The process implemented to reduce image colors through GIMP's palettes
Alain Reguera Delgado 2e37b0
involves too much user intervention compared with ImageMagick's
Alain Reguera Delgado 2e37b0
--colors option that reduces image colors instantly without user
Alain Reguera Delgado 2e37b0
intervention. Nevertheless, the procedure of reducing color through
Alain Reguera Delgado 2e37b0
GIMP's palettes provides more quality to final images than
Alain Reguera Delgado 2e37b0
ImageMagic's --colors option does. Also, using GIMP's palettes let us
Alain Reguera Delgado 2e37b0
create LSS images from PNG images using the same exact information we
Alain Reguera Delgado 2e37b0
used to reduce colors on PNG images. This is very important in order
Alain Reguera Delgado 2e37b0
to have the same result in both image types.  Because of these reasons
Alain Reguera Delgado 2e37b0
I prefer GIMP's palettes procedure against others methods like it is
Alain Reguera Delgado 2e37b0
the case of ImageMagick's for producing images with reduced number of
Alain Reguera Delgado 2e37b0
colors.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
Rendering PDF Files From Localized Docbook Files
Alain Reguera Delgado 2e37b0
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
Even it is possible to produce PDF files from Docbook files using
Alain Reguera Delgado 2e37b0
current applications inside CentOS-5, there are some production issues
Alain Reguera Delgado 2e37b0
when we use localized docbook files as source to produce localized PDF
Alain Reguera Delgado 2e37b0
files that made me not to implement them as part of *centos-art.sh*
Alain Reguera Delgado 2e37b0
script by now.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
- When using the XML(DocBook)->XML(FO)->PDF transformation chain, the
Alain Reguera Delgado 2e37b0
  result produced by _docbook-style-xsl-1.69.1-5.1_ and
Alain Reguera Delgado 2e37b0
  _passivetex-1.25-5.1.1_ doesn't render heading boxes very well on
Alain Reguera Delgado 2e37b0
  page's top and page's bottom.  The text put inside these boxes seem
Alain Reguera Delgado 5d9dcb
  to have not enough space in their respective areas.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
- Tried using _dblatex-0.2.8-2.el5_ but didn't work for localized docbook files
Alain Reguera Delgado 2e37b0
  (i.e., those who has the +lang="lang"+ string in their root
Alain Reguera Delgado 2e37b0
  element). If you just remove the language specification string it
Alain Reguera Delgado 2e37b0
  just work. We need the language specification in order for internal
Alain Reguera Delgado 2e37b0
  document strings like +Abstract+ and +Table of contents+ to be
Alain Reguera Delgado 2e37b0
  automatically translated. When the language specific attribute is
Alain Reguera Delgado 2e37b0
  present in the root element, dblatex outputs the following:
Alain Reguera Delgado 2e37b0
+
Alain Reguera Delgado 2e37b0
----------------------------------------------------------------------
Alain Reguera Delgado 2e37b0
Build the listings...
Alain Reguera Delgado 2e37b0
XSLT stylesheets DocBook -  LaTeX 2e (0.2.8)
Alain Reguera Delgado 2e37b0
===================================================
Alain Reguera Delgado 2e37b0
Processing Revision History 
Alain Reguera Delgado 2e37b0
Build 2912-corporate.docbook.pdf
Alain Reguera Delgado 2e37b0
This is pdfeTeX, Version 3.141592-1.21a-2.2 (Web2C 7.5.4)
Alain Reguera Delgado 2e37b0
entering extended mode
Alain Reguera Delgado 2e37b0
pdflatex failed
Alain Reguera Delgado 2e37b0
/usr/share/texmf/tex/latex/dblatex/docbook.sty:160: No counter 'chapter' defined.
Alain Reguera Delgado 2e37b0
/usr/share/texmf/tex/latex/dblatex/docbook.sty:160: leading text: \newfloat{example}{htb}{loe}[chapter]
Alain Reguera Delgado 2e37b0
/usr/share/texmf/tex/latex/dblatex/docbook.sty:164: No counter 'chapter' defined.
Alain Reguera Delgado 2e37b0
/usr/share/texmf/tex/latex/dblatex/docbook.sty:164: leading text: \newfloat{dbequation}{htb}{loe}[chapter]
Alain Reguera Delgado 2e37b0
2912-corporate.docbook_tmp.tex:62: Illegal parameter number in definition of \@the@H@page.
Alain Reguera Delgado 2e37b0
2912-corporate.docbook_tmp.tex:62: leading text: \maketitle
Alain Reguera Delgado 2e37b0
2912-corporate.docbook_tmp.tex:62: Illegal parameter number in definition of \@the@H@page.
Alain Reguera Delgado 2e37b0
2912-corporate.docbook_tmp.tex:62: leading text: \maketitle
Alain Reguera Delgado 2e37b0
2912-corporate.docbook_tmp.tex:62: Illegal parameter number in definition of \@the@H@page.
Alain Reguera Delgado 2e37b0
2912-corporate.docbook_tmp.tex:62: leading text: \maketitle
Alain Reguera Delgado 2e37b0
Error: pdflatex compilation failed
Alain Reguera Delgado 2e37b0
----------------------------------------------------------------------
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
Reporting Bugs
Alain Reguera Delgado 2e37b0
--------------
Alain Reguera Delgado 2e37b0
Report bugs on the *automation* category of *centos-artwork* project
Alain Reguera Delgado 2e37b0
at the https://centos.org.cu/bugs/[The CentOS Bugs] website.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
Author
Alain Reguera Delgado 2e37b0
------
Alain Reguera Delgado 2e37b0
Written by mailto:al@centos.org.cu[Alain Reguera Delgado], 2009-2013
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
Copyright
Alain Reguera Delgado 2e37b0
---------
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
Copyright (C) 2009-2013 The CentOS Project
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
This program is free software; you can redistribute it and/or modify
Alain Reguera Delgado 2e37b0
it under the terms of the GNU General Public License as published by
Alain Reguera Delgado 2e37b0
the Free Software Foundation; either version 2 of the License, or (at
Alain Reguera Delgado 2e37b0
your option) any later version.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
This program is distributed in the hope that it will be useful, but
Alain Reguera Delgado 2e37b0
WITHOUT ANY WARRANTY; without even the implied warranty of
Alain Reguera Delgado 2e37b0
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Alain Reguera Delgado 2e37b0
General Public License for more details.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
You should have received a copy of the GNU General Public License
Alain Reguera Delgado 2e37b0
along with this program; if not, write to the Free Software
Alain Reguera Delgado 2e37b0
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Alain Reguera Delgado 2e37b0
Alain Reguera Delgado 2e37b0
// vim: set syntax=asciidoc: