Blame Manuals/Repository/repository-html/repository_58.html

4c79b5
4c79b5
<html>
ccb7a3
4c79b5
4c79b5
Permission is granted to copy, distribute and/or modify this document
4c79b5
under the terms of the GNU Free Documentation License, Version 1.2 or
4c79b5
any later version published by the Free Software Foundation; with no
4c79b5
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
4c79b5
copy of the license is included in the section entitled GNU Free
4c79b5
Documentation License.  
4c79b5
-->
acd47b
4c79b5
4c79b5
Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
4c79b5
            Karl Berry  <karl@freefriends.org>
4c79b5
            Olaf Bachmann <obachman@mathematik.uni-kl.de>
4c79b5
            and many others.
4c79b5
Maintained by: Many creative people <dev@texi2html.cvshome.org>
4c79b5
Send bugs and suggestions to <users@texi2html.cvshome.org>
4c79b5
4c79b5
-->
4c79b5
<head>
7bbd70
<title>CentOS Artwork Repository: 3.55 trunk/Scripts/Bash/Functions/Render</title>
4c79b5
7bbd70
<meta name="description" content="CentOS Artwork Repository: 3.55 trunk/Scripts/Bash/Functions/Render">
7bbd70
<meta name="keywords" content="CentOS Artwork Repository: 3.55 trunk/Scripts/Bash/Functions/Render">
4c79b5
<meta name="resource-type" content="document">
4c79b5
<meta name="distribution" content="global">
4c79b5
<meta name="Generator" content="texi2html 1.76">
4c79b5
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4c79b5
<style type="text/css">
4c79b5
1e9202
@import "/home/centos/artwork/trunk/Identity/Models/Css/Texi2html/common.css";
4c79b5
4c79b5
a.summary-letter {text-decoration: none}
4c79b5
pre.display {font-family: serif}
4c79b5
pre.format {font-family: serif}
4c79b5
pre.menu-comment {font-family: serif}
4c79b5
pre.menu-preformatted {font-family: serif}
4c79b5
pre.smalldisplay {font-family: serif; font-size: smaller}
4c79b5
pre.smallexample {font-size: smaller}
4c79b5
pre.smallformat {font-family: serif; font-size: smaller}
4c79b5
pre.smalllisp {font-size: smaller}
4c79b5
span.sansserif {font-family:sans-serif; font-weight:normal;}
4c79b5
ul.toc {list-style: none}
4c79b5
-->
4c79b5
</style>
4c79b5
4c79b5
4c79b5
</head>
4c79b5
4c79b5
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
4c79b5
300762
7bbd70
[ < ]
7bbd70
[ > ]
4c79b5
   
4c79b5
[ << ]
300762
[ Up ]
7bbd70
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
7bbd70
[Index]
4c79b5
[ ? ]
4c79b5
7bbd70
7bbd70
7bbd70

3.55 trunk/Scripts/Bash/Functions/Render

008ee0
7bbd70

The render functionality exists to produce both identity and

7bbd70
translation files on different levels of information (i.e., different
7bbd70
languages, release numbers, architectures, etc.).
7bbd70

7bbd70

The render functionality relies on "renderable directory

7bbd70
structures" to produce files. Renderable directory structures can be
7bbd70
either "identity directory structures" or "translation directory
7bbd70
structures" with special directories inside.
2dc146

2dc146
7bbd70
7bbd70

3.55.1 Renderable identity directory structures

2dc146
7bbd70

Renderable identity directory structures are the starting point of

7bbd70
identity rendition. Whenever we want to render a component of CentOS
7bbd70
corporate visual identity, we need to point <tt>`centos-art.sh'</tt> to a
7bbd70
renderable identity directory structure. If such renderable identity
7bbd70
directory structure doesn't exist, then it is good time to create it. 
7bbd70

7bbd70

Inside the working copy, one renderable identity directory structures

7bbd70
represents one visual manifestation of CentOS corporate visual
7bbd70
identity, or said differently, each visual manifestation of CentOS
7bbd70
corporate visual identity should have one renderable identity
7bbd70
directory structure.
fa7cae

7bbd70

Inside renderable identity directory structures, <tt>`centos-art.sh'</tt>

7bbd70
can render both image-based and text-based files. Specification of
7bbd70
whether a renderable identity directory structure produces image-based
7bbd70
or text-based content is a configuration action that takes place in
7bbd70
the pre-rendition configuration script of that renderable identity
7bbd70
directory structure.
7bbd70

7bbd70

Inside renderable identity directory structures, content production is

7bbd70
organized in different configurations. A content production
7bbd70
configuration is a unique combination of the components that make an
7bbd70
identity directory structure renderable. One content production
7bbd70
configuration does one thing only (e.g., to produce untranslated
7bbd70
images), but it can be extended (e.g., adding translation files) to
7bbd70
achieve different needs (e.g., to produce translated images).
fa7cae

2dc146
7bbd70
7bbd70

3.55.1.1 Design template without translation

166893
7bbd70

The design template without translation configuration is based on a

7bbd70
renderable identity directory structure with an empty translation
7bbd70
directory structure. In this configuration, one design template
7bbd70
produces one untranslated file. Both design templates and final
7bbd70
untranslated files share the same file name, but they differ one
7bbd70
another in file-type and file-extension.
7bbd70

7bbd70

For example, to produce images without translations (there is no much

7bbd70
use in producing text-based files without translations), consider the
7bbd70
following configuration:
7bbd70

7bbd70
7bbd70
One renderable identity directory structure:
7bbd70
7bbd70

In this example we used <tt>`Identity/Path/To/Dir'</tt> as the identity

7bbd70
component we want to produce untranslated images for.  Identity
7bbd70
components can be either under <tt>`trunk/'</tt> or <tt>`branches/'</tt>
7bbd70
directory structure.
7bbd70

7bbd70

The identity component (i.e., <tt>`Identity/Path/To/Dir'</tt>, in this

7bbd70
case) is also the bond component we use to connect the identity
7bbd70
directory structures with their respective auxiliar directories (i.e.,
7bbd70
translation directory structres and pre-rendition configuration
7bbd70
structures).  The bond component is the path convenction that
7bbd70
<tt>`centos-art.sh'</tt> uses to know where to look for related
7bbd70
translations, configuration scripts and whatever auxiliar thing a
7bbd70
renderable directory structure may need to have.
7bbd70

7bbd70
      | The bond component
7bbd70
      |----------------->|
7bbd70
trunk/Identity/Path/To/Dir  <-- Renderable identity directory structure.
7bbd70
|-- Tpl                     <-- Design template directory.
7bbd70
|   `-- file.svg            <-- Design template file.
7bbd70
`-- Img                     <-- Directory used to store final files.
7bbd70
    `-- file.png            <-- Final image-based file produced from
7bbd70
                                design template file.
7bbd70
7bbd70

Inside design template directory, design template files are based on

7bbd70
SVG (Scalable Vector Graphics) and use the extension
7bbd70
.svg.  Design template files can be organized using several
7bbd70
directory levels to create a simple but extensible configuration,
7bbd70
specially if translated images are not required.
7bbd70

7bbd70

In order for SVG (Scalable Vector Graphics) files to be

7bbd70
considered "design template" files, they should be placed under the
7bbd70
design template directory and to have set a CENTOSARTWORK
7bbd70
object id inside.
fa7cae

7bbd70

The CENTOSARTWORK word itself is a convenction name we use to

7bbd70
define which object/design area, inside a design template, the
7bbd70
<tt>`centos-art.sh'</tt> script will use to export as
7bbd70
PNG (Portable Network Graphic) image at rendition time.
7bbd70
Whithout such object id specification, the <tt>`centos-art.sh'</tt> script
7bbd70
cannot know what object/design area you (as designer) want to export
7bbd70
as PNG (Portable Network Graphic) image file.
fa7cae

7bbd70
info

Note

At rendition time, the content of <tt>`Img/'</tt> directory

7bbd70
structure is produced by <tt>`centos-art.sh'</tt> automatically.
7bbd70

166893
7bbd70

When a renderable identity directory structure is configured to

7bbd70
produce image-based content, <tt>`centos-art.sh'</tt> produces
7bbd70
PNG (Portable Network Graphics) files with the .png
7bbd70
extension. Once the base image format has been produced, it is
7bbd70
possible for <tt>`centos-art.sh'</tt> to use it in order to automatically
7bbd70
create other image formats that may be needed (see section trunk/Scripts/Bash/Functions/Render/Config).
7bbd70

7bbd70

Inside the working copy, you can find an example of "design template

7bbd70
without translation" configuration at <tt>`trunk/Identity/Models/'</tt>.
7bbd70

7bbd70

See section trunk/Identity, for more information.

7bbd70

7bbd70
7bbd70
One translation directory structure:
7bbd70
7bbd70

In order for an identity entry to be considered an identity renderable

7bbd70
directory structure, it should have a translation entry. The content
7bbd70
of the translation entry is relevant to determine how to process the
7bbd70
identity renderable directory entry.
7bbd70

7bbd70

If the translation entry is empty (i.e., there is no file inside it),

7bbd70
<tt>`centos-art.sh'</tt> interprets the identity renderable directory
7bbd70
structure as a "design templates without translation" configuration.
7bbd70

7bbd70
                   | The bond component
7bbd70
                   |----------------->|
7bbd70
trunk/Translations/Identity/Path/To/Dir
7bbd70
`-- (empty)
7bbd70
7bbd70

If the translation entry is not empty, <tt>`centos-art.sh'</tt> can

7bbd70
interpret the identity renderable directory structure as one of the
7bbd70
following configurations: "design template with translation
7bbd70
(one-to-one)" or "design template with translation (optimized)".
7bbd70
Which one of these configurations is used depends on the value
7bbd70
assigned to the matching list (MATCHINGLIST) variable in the
7bbd70
pre-rendition configuration script of the renderable identity
7bbd70
directory structure we are producing images for.
7bbd70

7bbd70

If the matching list variable is empty (as it is by default), then

7bbd70
"design template with translation (one-to-one)" configuration is
7bbd70
used. In this configuration it is required that both design templates
7bbd70
and translation files have the same file names. This way, one
7bbd70
translation files is applied to one design template, to produce
7bbd70
one translated image.
7bbd70

7bbd70

If the matching list variable is not empty (because you redefine it in

7bbd70
the pre-rendition configuration script), then "design template with
7bbd70
translation (optimized)" configuration is used instead. In this
7bbd70
configuration, design templates and translation files don't need to
7bbd70
have the same names since such name relationship between them is
7bbd70
specified in the matching list properly.
7bbd70

7bbd70

-- Removed(xref:trunk Translations) --, for more information.

7bbd70

7bbd70
7bbd70
One pre-rendition configuration script:
7bbd70
7bbd70

In order to make an identity directory structure renderable, a

7bbd70
pre-rendition configuration script should exist for it.  The
7bbd70
pre-rendition configuration script specifies what type of rendition
7bbd70
does <tt>`centos-art.sh'</tt> will perform over the identity directory
7bbd70
structure and how does it do that.
7bbd70

7bbd70
                                           | The bond component
7bbd70
                                           |----------------->|
7bbd70
trunk/Scripts/Bash/Functions/Render/Config/Identity/Path/To/Dir
7bbd70
`-- render.conf.sh
7bbd70
7bbd70

In this configuration the pre-rendition configuration script

7bbd70
(<tt>`render.conf.sh'</tt>) would look like the following:
7bbd70

7bbd70
function render_loadConfig {
2dc146
7bbd70
    # Define rendition actions.
2dc146
    ACTIONS[0]='BASE:renderImage'
2dc146
2dc146
}
4a9d2a
7bbd70

Since translation directory structure is empty, <tt>`centos-art.sh'</tt>

7bbd70
assumes a "design template without translation" configuration to
7bbd70
produce untranslated images.
4a9d2a

7bbd70

To produce untranslated images, <tt>`centos-art.sh'</tt> takes one design

7bbd70
template and creates one temporal instance from it.  Later,
7bbd70
<tt>`centos-art.sh'</tt> uses the temporal design template instance as
7bbd70
source file to export the final untranslated image. The action of
7bbd70
exporting images from SVG (Scalable Vector Graphics) to
7bbd70
PNG (Portable Network Graphics) is possible thanks to
7bbd70
Inkscape's command-line interface and the CENTOSARTWORK object
7bbd70
id we previously set inside design templates.
7bbd70

7bbd70
centos-art.sh render --identity=trunk/Identity/Path/To/Dir
7bbd70
-------------------------------------------------
7bbd70
0 | Execute centos-art.sh on renderable identity directory structure.
7bbd70
--v----------------------------------------------
7bbd70
trunk/Identity/Path/To/Dir/Tpl/file.svg
7bbd70
-------------------------------------------------
7bbd70
1 | Create instance from design template.
7bbd70
--v----------------------------------------------
7bbd70
/tmp/centos-art.sh-a07e824a-5953-4c21-90ae-f5e8e9781f5f-file.svg
7bbd70
-------------------------------------------------
7bbd70
2 | Render untranslated image from design template instance.
7bbd70
--v----------------------------------------------
7bbd70
trunk/Identity/NewDir/Img/file.png
7bbd70
-------------------------------------------------
7bbd70
3 | Remove design template instance.
166893
7bbd70

Finally, when the untranslated image has been created, the temporal

7bbd70
design template instance is removed. At this point,
7bbd70
<tt>`centos-art.sh'</tt> takes the next design template and repeats the
7bbd70
whole production flow once again (design template by design template),
7bbd70
until all design templates be processed.
fa7cae

7bbd70

See section trunk/Scripts/Bash/Functions/Render/Config, for more

7bbd70
information.
7bbd70

7bbd70
4a9d2a
2dc146
7bbd70
7bbd70

3.55.1.2 Design template with translation (one-to-one)

7bbd70
7bbd70

Producing untranslated images is fine in many cases, but not always.

7bbd70
Sometimes it is required to produce images in different languages and
7bbd70
that is something that untrasnlated image production cannot achieve.
7bbd70
However, if we fill its empty translation entry with translation files
7bbd70
(one for each design template) we extend the production flow from
7bbd70
untranslated image production to translated image production.
7bbd70

7bbd70

In order for <tt>`centos-art.sh'</tt> to produce images correctly, each

7bbd70
design template should have one translation file and each translation
7bbd70
file should have one design template.  Otherwise, if there is a
7bbd70
missing design template or a missing translation file,
7bbd70
<tt>`centos-art.sh'</tt> will not produce the final image related to the
7bbd70
missing component.
7bbd70

7bbd70

In order for <tt>`centos-art.sh'</tt> to know which is the relation

7bbd70
between translation files and design templates the translation
7bbd70
directory structure is taken as reference.  For example, the
7bbd70
<tt>`trunk/Translations/Identity/Path/To/Dir/file.sed'</tt> translation
7bbd70
file does match <tt>`trunk/Identity/Path/To/Dir/Tpl/file.svg'</tt> design
7bbd70
template, but it doesn't match
7bbd70
<tt>`trunk/Identity/Path/To/Dir/File.svg'</tt> or
7bbd70
<tt>`trunk/Identity/Path/To/Dir/Tpl/File.svg'</tt> or
7bbd70
<tt>`trunk/Identity/Path/To/Dir/Tpl/SubDir/file.svg'</tt> design
7bbd70
templates.
4a9d2a

7bbd70

The pre-rendition configuration script used to produce untranslated

7bbd70
images is the same we use to produce translated images. There is no
7bbd70
need to modify it. So, as we are using the same pre-rendition
7bbd70
configuration script, we can say that translated image production is
7bbd70
somehow an extended/improved version of untranslated image production.
7bbd70

7bbd70
info

Note

If we use no translation file in the translation entry

7bbd70
(i.e., an empty directory), <tt>`centos-art.sh'</tt> assumes the
7bbd70
untranslated image production. If we fill the translation entry with
7bbd70
translation files, <tt>`centos-art.sh'</tt> assumes the translated image
7bbd70
production.  
7bbd70

166893
7bbd70

To produce final images, <tt>`centos-art.sh'</tt> applies one translation

7bbd70
file to one design template and produce a translated design template
7bbd70
instance. Later, <tt>`centos-art.sh'</tt> uses the translated template
7bbd70
instance to produce the translated image. Finally, when the translated
7bbd70
image has been produced, <tt>`centos-art.sh'</tt> removes the translated
7bbd70
design template instance. This production flow is repeated for each
7bbd70
translation file available in the translatio entry. 
7bbd70

7bbd70
centos-art.sh render --identity=trunk/Identity/Path/To/Dir
7bbd70
-------------------------------------------------
7bbd70
0 | Execute centos-art.sh on directory structure.
7bbd70
--v----------------------------------------------
7bbd70
trunk/Translations/Identity/Path/To/Dir/file.sed
7bbd70
-------------------------------------------------
7bbd70
1 | Apply translation to design template.
7bbd70
--v----------------------------------------------
7bbd70
trunk/Identity/Path/To/Dir/Tpl/file.svg
7bbd70
-------------------------------------------------
7bbd70
2 | Create design template instance.
7bbd70
--v----------------------------------------------
7bbd70
/tmp/centos-art.sh-a07e824a-5953-4c21-90ae-f5e8e9781f5f-file.svg
7bbd70
-------------------------------------------------
7bbd70
3 | Render PNG image from template instance.
7bbd70
--v----------------------------------------------
7bbd70
trunk/Identity/NewDir/Img/file.png
7bbd70
-------------------------------------------------
7bbd70
4 | Remove design template instance.
7bbd70
166893
7bbd70
7bbd70

3.55.1.3 Design template with translation (optimized)

7bbd70
7bbd70

Producing translated images satisfies almost all our production images

7bbd70
needs, but there is still a pitfall in them. In order to produce
7bbd70
translated images as in the "one-to-one" configuration describes
7bbd70
previously, it is required that one translation file has one design
7bbd70
template. That's useful in many cases, but what would happen if we
7bbd70
need to apply many different translation files to the same design
7bbd70
template?  Should we have to duplicate the same design template file
7bbd70
for each translation file, in order to satisfy the "one-to-one"
7bbd70
relation? What if we need to assign translation files to design
7bbd70
templates arbitrarily?
4a9d2a

7bbd70

Certenly, that's something the "one-to-one" configuration cannot

7bbd70
handle.  So, that's why we had to "optimize" it. The optimized
7bbd70
configuration consists on using a matching list (MATCHINGLIST)
7bbd70
variable that specifies the relationship between translation files and
7bbd70
design templates in an arbitrary way. Using such matching list between
7bbd70
translation files and design templates let us use as many assignment
7bbd70
combinations as translation files and design templates we are working
7bbd70
with.
fa7cae

7bbd70

The MATCHINGLIST variable is set in the pre-rendition

7bbd70
configuration script of the component we want to produce images for.
7bbd70
By default, the MATCHINGLIST variable is empty which means no
7bbd70
matching list is used. Otherwise, if MATCHINGLIST variable has a
7bbd70
value different to empty value then, <tt>`centos-art.sh'</tt> interprets
7bbd70
the matching list in order to know how translation files are applied
7bbd70
to design templates.
fa7cae

7bbd70

For example, consider the following configuration:

7bbd70

7bbd70
7bbd70
One entry under <tt>`trunk/Identity/'</tt>:
7bbd70
7bbd70

In this configuration we want to produce three images using a

7bbd70
paragraph-based style, controlled by <tt>`paragraph.svg'</tt> design
7bbd70
template; and one image using a list-based style, controlled by
7bbd70
<tt>`list.svg'</tt> design template.
7bbd70

7bbd70
trunk/Identity/Path/To/Dir
7bbd70
|-- Tpl
7bbd70
|   |-- paragraph.svg
7bbd70
|   `-- list.svg
7bbd70
`-- Img
7bbd70
    |-- 01-welcome.png
7bbd70
    |-- 02-donate.png
7bbd70
    |-- 03-docs.png
7bbd70
    `-- 04-support.png
4a9d2a
7bbd70
7bbd70
One entry under <tt>`trunk/Translations/'</tt>:
7bbd70
7bbd70

In order to produce translated images we need to have one translation

7bbd70
file for each translated image we want to produce. Notice how
7bbd70
translation names do match final image file names, but how translation
7bbd70
names do not match design template names. When we use matching list
7bbd70
there is no need for translation files to match the names of design
7bbd70
templates, such name relation is set inside the matching list itself.
7bbd70

7bbd70
trunk/Translations/Identity/Path/To/Dir
7bbd70
|-- 01-welcome.sed
7bbd70
|-- 02-donate.sed
7bbd70
|-- 03-docs.sed
7bbd70
`-- 04-support.sed
2dc146
7bbd70
7bbd70
One entry under <tt>`trunk/trunk/Scripts/Bash/Functions/Render/Config/'</tt>:
7bbd70
7bbd70

In order to produce different translated images using specific design

7bbd70
templates, we need to specify the relation between translation files
7bbd70
and design templates in a way that <tt>`centos-art.sh'</tt> could know
7bbd70
exactly what translation file to apply to what design template. This
7bbd70
relation between translation files and design templates is set using
7bbd70
the matching list MATCHINGLIST variable inside the pre-rendition
7bbd70
configuration script of the component we want to produce images for.  
7bbd70

7bbd70
trunk/Scripts/Bash/Functions/Render/Config/Identity/Path/To/Dir
7bbd70
`-- render.conf.sh
4a9d2a
7bbd70

In this configuration the pre-rendition configuration script

7bbd70
(<tt>`render.conf.sh'</tt>) would look like the following:
166893

7bbd70
function render_loadConfig {
7bbd70
7bbd70
    # Define rendition actions.
7bbd70
    ACTIONS[0]='BASE:renderImage'
7bbd70
7bbd70
    # Define matching list.
7bbd70
    MATCHINGLIST="\
7bbd70
    paragraph.svg:\
7bbd70
        01-welcome.sed\
7bbd70
        02-donate.sed\
7bbd70
        04-support.sed
7bbd70
    list.svg:\
7bbd70
        03-docs.sed
7bbd70
    "
7bbd70
7bbd70
}
2dc146
7bbd70

As result, <tt>`centos-art.sh'</tt> will produce <tt>`01-welcome.png'</tt>,

7bbd70
<tt>`02-donate.png'</tt> and <tt>`04-support.png'</tt> using the
7bbd70
paragraph-based design template, but <tt>`03-docs.png'</tt> using the
7bbd70
list-based design template.
7bbd70

7bbd70
6ba043
b8013f
7bbd70
7bbd70

3.55.1.4 Design template with translation (optimized+flexibility)

7bbd70
7bbd70

In the production models we've seen so far, there are design templates

7bbd70
to produce untranslated images and translation files which combiend
7bbd70
with design templates produce translated images. That may seems like
7bbd70
all our needs are covered, doesn't it? Well, it almost does.
7bbd70

7bbd70

Generally, we use design templates to define how final images will

7bbd70
look like. Generally, each renderable directory structure has one
7bbd70
<tt>`Tpl/'</tt> directory where we organize design templates for that
7bbd70
identity component. So, we can say that there is only one unique
7bbd70
design template definition for each identity component; or what is the
7bbd70
same, said differently, identity components can be produced in one way
7bbd70
only, the way its own design template directory specifies.  This is
7bbd70
not enough for theme production. It is a limitation, indeed.
7bbd70

7bbd70

Initially, to create one theme, we created one renderable directory

7bbd70
structure for each theme component. When we found ourselves with many
7bbd70
themes, and components inside them, it was obvious that the same
7bbd70
design model was duplicated inside each theme. As design models were
7bbd70
independently one another, if we changed one theme's design model,
7bbd70
that change was useless to other themes. So, in order to reuse design
7bbd70
model changes, we unified design models into one common directory
7bbd70
structure.
7bbd70

7bbd70

With design models unified in a common structure, another problem rose

7bbd70
up. As design models also had the visual style of theme components,
7bbd70
there was no difference between themes, so there was no apparent need
7bbd70
to have an independent theme directory structure for each different
7bbd70
theme.  So, it was also needed to separate visual styles from design
7bbd70
models.
7bbd70

7bbd70

At this point there are two independent worklines: one directory

7bbd70
structure to store design models (the final image characteristics
7bbd70
[i.e., dimensions, translation markers, etc.]) and one directory
7bbd70
structure to store visual styles (the final image visual style [i.e.,
7bbd70
the image look and feel]).  So, it is possible to handle both
7bbd70
different design models and different visual styles independtly one
7bbd70
another and later create combinations among them using
7bbd70
<tt>`centos-art.sh'</tt>. 
7bbd70

7bbd70

For example, consider the following configuration:

2dc146

4a9d2a
7bbd70
One entry under <tt>`trunk/Identity/Themes/Models/'</tt>:
2dc146
7bbd70

The design model entry exists to organize design model files (similar

7bbd70
to design templates). Both design models and design templates are very
7bbd70
similar; they both should have the CENTOSARTWORK export id
7bbd70
present to identify the exportation area, translation marks, etc.
7bbd70
However, design models do use dynamic backgrounds inclusion while
7bbd70
design templates don't.
7bbd70

7bbd70
                        THEMEMODEL | | The bond component
7bbd70
                             |<----| |--------------------->|
7bbd70
trunk/Identity/Themes/Models/Default/Distro/Anaconda/Progress/
7bbd70
|-- paragraph.svg
7bbd70
`-- list.svg
7bbd70
7bbd70

Inisde design models, dynamic backgrounds are required in order for

7bbd70
different artistic motifs to reuse common design models. Firstly, in
7bbd70
order to create dynamic backgrounds inside design models, we import a
7bbd70
bitmap to cover design model's background and later, update design
7bbd70
model's path information to replace fixed values to dynamic values.
4a9d2a

2dc146
7bbd70
One entry under <tt>`trunk/Identity/Themes/Motifs/'</tt>:
2dc146
7bbd70

The artistic motif entry defines the visual style we want to produce

7bbd70
images for, only. Final images (i.e., those built from combining both
7bbd70
design models and artistic motif backrounds) are not stored here, but
7bbd70
under branches directory structure. In the artistic motif entry, we
7bbd70
only define those images that cannot be produced automatically by
7bbd70
<tt>`centos-art.sh'</tt> (e.g., Backgrounds, Color information,
7bbd70
Screenshots, etc.).
2dc146

7bbd70
                  Artistic motif name | | Artistic motif backgrounds
7bbd70
                             |<-------| |-------->|
7bbd70
trunk/Identity/Themes/Motifs/TreeFlower/Backgrounds/
7bbd70
|-- Img
7bbd70
|   |-- Png
7bbd70
|   |   |-- 510x300.png
7bbd70
|   |   `-- 510x300-final.png
7bbd70
|   `-- Jpg
7bbd70
|       |-- 510x300.jpg
7bbd70
|       `-- 510x300-final.jpg
7bbd70
|-- Tpl
7bbd70
|   `-- 510x300.svg
7bbd70
`-- Xcf
7bbd70
    `-- 510x300.xcf
7bbd70
2dc146
7bbd70
One entry under <tt>`trunk/Translations/'</tt>:
2dc146
7bbd70

The translation entry specifies, by means of translation files, the

7bbd70
language-specific information we want to produce image for. When we
7bbd70
create the translation entry we don't use the name of neither design
7bbd70
model nor artistic motif, just the design model component we want to
7bbd70
produce images for.
4a9d2a

7bbd70
                                   | The bond component
7bbd70
                                   |--------------------->|
7bbd70
trunk/Translations/Identity/Themes/Distro/Anaconda/Progress/
7bbd70
`-- 5
7bbd70
    |-- en
7bbd70
    |   |-- 01-welcome.sed
7bbd70
    |   |-- 02-donate.sed
7bbd70
    |   `-- 03-docs.sed
7bbd70
    `-- es
7bbd70
        |-- 01-welcome.sed
7bbd70
        |-- 02-donate.sed
7bbd70
        `-- 03-docs.sed
7bbd70
2dc146
7bbd70
One entry under <tt>`trunk/Scripts/Bash/Functions/Render/Config/'</tt>:
2dc146
7bbd70

There is one pre-rendition configuration script for each theme

7bbd70
component. So, each time a theme component is rendered, its
7bbd70
pre-rendition configuration script is evaluated to teach
7bbd70
<tt>`centos-art.sh'</tt> how to render the component.
fa7cae

7bbd70
trunk/Scripts/Bash/Functions/Render/Config/Identity/Themes/Distro/Anaconda/Progress/
7bbd70
`-- render.conf.sh
7bbd70
7bbd70

In this configuration the pre-rendition configuration script

7bbd70
(<tt>`render.conf.sh'</tt>) would look like the following:
7bbd70

7bbd70
function render_loadConfig {
7bbd70
7bbd70
    # Define rendition actions.
7bbd70
    ACTIONS[0]='BASE:renderImage'
7bbd70
7bbd70
    # Define matching list.
7bbd70
    MATCHINGLIST="\
7bbd70
    paragraph.svg:\
7bbd70
        01-welcome.sed\
7bbd70
        02-donate.sed
7bbd70
    list.svg:\
7bbd70
        03-docs.sed
7bbd70
        "
7bbd70
7bbd70
    # Deifne theme model.
7bbd70
    THEMEMODEL='Default'
7bbd70
7bbd70
}
7bbd70
2dc146
2dc146
7bbd70

The production flow of "optimize+flexibility" configuration…

7bbd70

7bbd70
7bbd70

3.55.2 Renderable translation directory structures

7bbd70
7bbd70

Translation directory structures are auxiliar structures of renderable

7bbd70
identity directory structures. There is one translation directory
7bbd70
structure for each renderable identity directory structure.  Inside
7bbd70
translation directory structures we organize translation files used by
7bbd70
renderable identity directory structures that produce translated
7bbd70
images. Renderable identity directory structures that produce
7bbd70
untranslated images don't use translation files, but they do use a
7bbd70
translation directory structure, an empty translation directory
7bbd70
structure, to be precise.
7bbd70

7bbd70

In order to aliviate production of translation file, we made

7bbd70
translation directory structures renderable adding a template
7bbd70
(<tt>`Tpl/'</tt>) directory structure to handle common content inside
7bbd70
translation files.  This way, we work on translation templates and
7bbd70
later use <tt>`centos-art.sh'</tt> to produce specific translation files
7bbd70
(based on translation templates) for different information (e.g.,
7bbd70
languages, release numbers, architectures, etc.).  
7bbd70

7bbd70

If for some reason, translation files get far from translation

7bbd70
templates and translation templates become incovenient to produce such
7bbd70
translation files then, care should be taken to avoid replacing the
7bbd70
content of translation files with the content of translation templates
7bbd70
when <tt>`centos-art.sh'</tt> is executed to produce translation files
7bbd70
from translation templates.
7bbd70

7bbd70

Inside renderable translation directory structures,

7bbd70
<tt>`centos-art.sh'</tt> can produce text-based files only.
4a9d2a

b8013f
7bbd70
7bbd70

3.55.3 Copying renderable directory structures

7bbd70
7bbd70

A renderable layout is formed by design models, design images,

7bbd70
pre-rendition configuration scripts and translations files. This way,
7bbd70
when we say to duplicate rendition stuff we are saying to duplicate
7bbd70
these four directory structures (i.e., design models, design images,
7bbd70
pre-rendition configuration scripts, and related translations files).
7bbd70

7bbd70

When we duplicate directories, inside `trunk/Identity' directory

7bbd70
structure, we need to be aware of renderable layout described above
7bbd70
and the source location used to perform the duplication action.  The
7bbd70
source location is relevant to centos-art.sh script in order to
7bbd70
determine the required auxiliar information inside directory
7bbd70
structures that need to be copied too (otherwise we may end up with
7bbd70
orphan directory structures unable to be rendered, due the absence of
7bbd70
required information).
7bbd70

7bbd70

In order for a renderable directory structure to be valid, the new

7bbd70
directory structure copied should match the following conditions:
7bbd70

7bbd70
    7bbd70
  1. To have a unique directory structure under
  2. 7bbd70
    <tt>`trunk/Identity'</tt>, organized by any one of the above
    7bbd70
    organizational designs above.
    7bbd70
    7bbd70
  3. To have a unique directory structure under
  4. 7bbd70
    <tt>`trunk/Translations'</tt> to store translation files.
    7bbd70
    7bbd70
  5. To have a unique directory structure under
  6. 7bbd70
    <tt>`trunk/Scripts/Bash/Functions/Render/Config'</tt> to set pre-rendition
    7bbd70
    configuration script.
    7bbd70
    7bbd70
    7bbd70

    As convenction, the render_doCopy function uses

    7bbd70
    <tt>`trunk/Identity'</tt> directory structure as source location.  Once
    7bbd70
    the <tt>`trunk/Identity'</tt> directory structure has been specified and
    7bbd70
    verified, the related path information is built from it and copied
    7bbd70
    automatically to the new location specified by FLAG_TO variable.
    7bbd70

    7bbd70

    Design templates + No translation:

    7bbd70

    7bbd70

    Command:

    7bbd70
    - centos-art render -copy=trunk/Identity/Path/To/Dir -to=trunk/Identity/NewPath/To/Dir
    7bbd70

    7bbd70

    Sources:

    7bbd70
    - trunk/Identity/Path/To/Dir
    7bbd70
    - trunk/Translations/Identity/Path/To/Dir
    7bbd70
    - trunk/Scripts/Bash/Functions/Render/Config/Identity/Path/To/Dir
    7bbd70

    7bbd70

    Targets:

    7bbd70
    - trunk/Identity/NewPath/To/Dir
    7bbd70
    - trunk/Translations/Identity/NewPath/To/Dir
    7bbd70
    - trunk/Scripts/Bash/Functions/Render/Config/Identity/NewPath/To/Dir
    7bbd70

    7bbd70

    Renderable layout 2:

    7bbd70

    7bbd70

    Command:

    7bbd70
    - centos-art render -copy=trunk/Identity/Themes/Motifs/TreeFlower \
    7bbd70
                        -to=trunk/Identity/Themes/Motifs/NewPath/To/Dir
    7bbd70

    7bbd70

    Sources:

    7bbd70
    - trunk/Identity/Themes/Motifs/TreeFlower
    7bbd70
    - trunk/Translations/Identity/Themes
    7bbd70
    - trunk/Translations/Identity/Themes/Motifs/TreeFlower
    7bbd70
    - trunk/Scripts/Bash/Functions/Render/Config/Identity/Themes
    7bbd70
    - trunk/Scripts/Bash/Functions/Render/Config/Identity/Themes/Motifs/TreeFlower
    7bbd70

    7bbd70

    Targets:

    7bbd70
    - trunk/Identity/Themes/Motifs/NewPath/To/Dir
    7bbd70
    - trunk/Translations/Identity/Themes
    7bbd70
    - trunk/Translations/Identity/Themes/Motifs/NewPath/To/Dir
    7bbd70
    - trunk/Scripts/Bash/Functions/Render/Config/Identity/Themes
    7bbd70
    - trunk/Scripts/Bash/Functions/Render/Config/Identity/Themes/Motifs/NewPath/To/Dir
    7bbd70

    7bbd70

    Notice that design models are not included in source or target

    7bbd70
    locations. This is intentional. In "Renderable layout 2", design
    7bbd70
    models live by their own, they just exist, they are there, available
    7bbd70
    for any artistic motif to use. By default `Themes/Models/Default'
    7bbd70
    design model directory structure is used, but other design models
    7bbd70
    directory structures (under Themes/Models/) can be created and used
    7bbd70
    changing the value of THEMEMODEL variable inside the pre-rendition
    7bbd70
    configuration script of the artistic motif source location you want to
    7bbd70
    produce.
    7bbd70

    7bbd70

    Notice how translations and pre-rendition configuration scripts may

    7bbd70
    both be equal in source and target. This is because such structures
    7bbd70
    are common to all artistic motifs (the default values to use when no
    7bbd70
    specific values are provided).
    7bbd70

    7bbd70

    - The common directory structures are not copied or deleted. We cannot

    7bbd70
      copy a directory structure to itself.
    7bbd70

    7bbd70

    - The common directory structures represent the default value to use

    7bbd70
      when no specific translations and/or pre-rendition configuration
    7bbd70
      script are provided inside source location.
    7bbd70

    7bbd70

    - The specific directory structures, if present, are both copiable and

    7bbd70
      removable. This is, when you perform a copy or delete action from
    7bbd70
      source, that source specific auxiliar directories are transfered in
    7bbd70
      the copy action to a new location (that specified by FLAG_TO
    7bbd70
      variable).
    7bbd70

    7bbd70

    - When translations and/or pre-rendition configuration scripts are

    7bbd70
      found inside the source directory structure, the centos-art.sh
    7bbd70
      script loads common auxiliar directories first and later specific
    7bbd70
      auxiliar directories.  This way, identity rendition of source
    7bbd70
      locations can be customized idividually over the base of common
    7bbd70
      default values.
    7bbd70

    7bbd70

    - The specific auxiliar directories are optional.

    7bbd70

    7bbd70

    - The common auxiliar directories should be present always. This is,

    7bbd70
      in order to provide the information required by render functionality
    7bbd70
      (i.e., to make it functional in the more basic level of its
    7bbd70
      existence).
    7bbd70

    7bbd70

    Notice how the duplication process is done from `trunk/Identity' on,

    7bbd70
    not the oposite. If you try to duplicate a translation structure (or
    7bbd70
    similar auxiliar directory structures like pre-rendition configuration
    7bbd70
    scripts), the `trunk/Identity' for that translation is not created.
    7bbd70
    This limitation is impossed by the fact that many `trunk/Identity'
    7bbd70
    directory structures may reuse/share the same translation directory
    7bbd70
    structure. We cannot delete one translation (or similar) directory
    7bbd70
    structures while a related `trunk/Identity/' directory structure is
    7bbd70
    still in need of it.
    7bbd70

    7bbd70

    The `render_doCopy' functionality does duplicate directory structures

    7bbd70
    directly involved in rendition process only. Once such directories
    7bbd70
    have been duplicated, the functionality stops thereat. 
    7bbd70

    7bbd70
    7bbd70
    7bbd70

    3.55.4 Usage

    7bbd70
    7bbd70
      7bbd70
    • ...
    • 7bbd70
      7bbd70
      7bbd70
      7bbd70
      7bbd70

      3.55.5 See also

      300762
      4a9d2a
      7bbd70
      3.56 trunk/Scripts/Bash/Functions/Render/Config  
      4a9d2a
      4a9d2a
      bc3531
      38bcd9
      300762
      7bbd70
      [ < ]
      7bbd70
      [ > ]
      300762
         
      300762
      [ << ]
      7bbd70
      [ Up ]
      7bbd70
      [ >> ]
      300762
      4c79b5

      4c79b5
       <font size="-1">
      acd47b
        This document was generated on February, 26 2011 using texi2html 1.76.
      4c79b5
       </font>
      4c79b5
       
      4c79b5
      4c79b5

      4c79b5
      </body>
      4c79b5
      </html>