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