Blame Identity/Manual/repository-xhtml/repository_76.xhtml

728c6d
728c6d
728c6d
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
728c6d
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
728c6d
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
728c6d
632e8b
<head>
ed9de5
<title>CentOS Artwork Repository: 2.69 The trunk/Scripts/Functions/Render/Config Directory</title>
632e8b
728c6d
    <meta name="description" content="CentOS Artwork Repository: 2.69 The trunk/Scripts/Functions/Render/Config Directory" />
728c6d
    <meta name="keywords" content="CentOS Artwork Repository: 2.69 The trunk/Scripts/Functions/Render/Config Directory" />
728c6d
    <meta name="resource-type" content="document" />
728c6d
    <meta name="distribution" content="global" />
728c6d
    <meta name="generator" content="texi2html 1.76" />
728c6d
    <meta name="copyright" content="2009-2011 Alain Reguera Delgado" />
632e8b
728c6d
    <link href="/home/centos/artwork/trunk/Identity/Manual/repository.css" rel="stylesheet" type="text/css" media="screen projection"/>
632e8b
632e8b
</head>
632e8b
728c6d
<body>
632e8b
728c6d
728c6d
728c6d
728c6d
728c6d
    
728c6d
    Start page body definitions.
728c6d
    -->
728c6d
728c6d
    
728c6d
728c6d
        
632e8b
ed9de5
[ < ]
ed9de5
[ > ]
632e8b
   
1075b9
[ << ]
1075b9
[ Up ]
ed9de5
[ >> ]
632e8b
   
632e8b
   
632e8b
   
632e8b
   
1075b9
[Top]
1075b9
[Contents]
ed9de5
[Index]
1075b9
[ ? ]
632e8b
ed9de5
ed9de5
ed9de5

2.69 The <tt>`trunk/Scripts/Functions/Render/Config'</tt> Directory

632e8b
728c6d

ed9de5
52772c

2.69.1 Goals

632e8b
ed9de5

The <tt>`trunk/Scripts/Bash/Config'</tt> directory exists to oraganize

ed9de5
pre-rendering configuration scripts.
ed9de5

728c6d

ed9de5
52772c

2.69.2 Description

06d106
ed9de5

Pre-rendering configuration scripts let you customize the way

ed9de5
centos-art.sh script renders identity and translation
ed9de5
repository entries.  Pre-rendering configuration scripts are
ed9de5
<tt>`render.conf.sh'</tt> files with render_loadConfig function
ed9de5
definition inside. 
ed9de5

ed9de5

There is one <tt>`render.conf.sh'</tt> file for each pre-rendering

ed9de5
configuration entry. Pre-rendering configuration entries can be based
ed9de5
both on identity and translation repository entires.  Pre-rendering
ed9de5
configuration entries are required for each identity entry, but not
ed9de5
for translation entries. 
ed9de5

728c6d

ed9de5
ed9de5

2.69.2.1 The <tt>`render.conf.sh'</tt> identity model

ed9de5
ed9de5

Inside CentOS Artwork Repository, we consider identity entries to all

ed9de5
directories under <tt>`trunk/Identity'</tt> directory. Identity entries can be
ed9de5
image-based or text-based. When you render image-based identity
ed9de5
entries you need to use image-based pre-rendering configuration
ed9de5
scripts. Likewise, when you render text-based identity entries you
ed9de5
need to use text-based pre-rendering configuration scripts.
ed9de5

ed9de5

Inside identity pre-rendering configuration scripts, image-based

ed9de5
pre-rendering configuration scripts look like the following:
ed9de5

ed9de5
#!/bin/bash
ed9de5
ed9de5
function render_loadConfig {
ed9de5
ed9de5
    # Define rendering actions.
ed9de5
    ACTIONS[0]='BASE:renderImage'
ed9de5
    ACTIONS[1]='POST:renderFormats: tif xpm pdf ppm'
ed9de5
ed9de5
}
ed9de5
ed9de5

Inside identity pre-rendering configuration scripts, text-based

ed9de5
pre-rendering configuration scripts look like the following:
ed9de5

ed9de5
#!/bin/bash
ed9de5
ed9de5
function render_loadConfig {
ed9de5
ed9de5
    # Define rendering actions.
ed9de5
    ACTIONS[0]='BASE:renderText'
ed9de5
    ACTIONS[1]='POST:formatText: --width=70 --uniform-spacing'
ed9de5
ed9de5
}
ed9de5
ed9de5

When using identity pre-rendering configuration scripts, you can

ed9de5
extend both image-based and text-based pre-rendering configuration
ed9de5
scripts using image-based and text-based post-rendering actions,
ed9de5
respectively. 
ed9de5

728c6d

ed9de5
ed9de5

2.69.2.2 The <tt>`render.conf.sh'</tt> translation model

ed9de5
ed9de5

Translation pre-rendering configuration scripts take precedence before

ed9de5
default translation rendering action. Translation pre-rendering
ed9de5
actions are useful when default translation rendering action do not
ed9de5
fit itself to translation entry rendering requirements.
ed9de5

728c6d

ed9de5
ed9de5

2.69.2.3 The <tt>`render.conf.sh'</tt> rendering actions

ed9de5
ed9de5

Inside both image-based and text-based identity pre-rendering

ed9de5
configuration scripts, we use the <samp>`ACTIONS'</samp> array variable to
ed9de5
define the way centos-art.sh script performs identity
ed9de5
rendering.  Identity rendering is organized by one <samp>`BASE'</samp> action,
ed9de5
and optional <samp>`POST'</samp> and <samp>`LAST'</samp> rendering actions.
ed9de5

ed9de5

The <samp>`BASE'</samp> action specifies what kind of rendering does the

ed9de5
centos-art.sh script will perform with the files related to
ed9de5
the pre-rendering configuration script. The <samp>`BASE'</samp> action is
ed9de5
required. Possible values to <samp>`BASE'</samp> action are either
ed9de5
<samp>`renderImage'</samp> or <samp>`renderText'</samp> only.
ed9de5

ed9de5

To specify the <samp>`BASE'</samp> action you need to set the <samp>`BASE:'</samp>

ed9de5
string followed by one of the possible values. For example, if you
ed9de5
want to render images, consider the following definition of
ed9de5
<samp>`BASE'</samp> action:
ed9de5

ed9de5
ACTIONS[0]='BASE:renderImage'
ed9de5
ed9de5

Only one <samp>`BASE'</samp> action must be specified. If more than one

ed9de5
<samp>`BASE'</samp> action is specified, the last one is used. If no
ed9de5
<samp>`BASE'</samp> action is specified at all, an error is triggered and the
ed9de5
centos-art.sh script ends its execution.
ed9de5

ed9de5

The <samp>`POST'</samp> action specifies which action to apply for

ed9de5
each file rendered (at the rendering time). This action is optional.
ed9de5
You can set many different <samp>`POST'</samp> actions to apply many different
ed9de5
actions over the same already rendered file. Possible values to
ed9de5
<samp>`POST'</samp> action are <samp>`renderFormats'</samp>, <samp>`renderSyslinux'</samp>,
ed9de5
<samp>`renderGrub'</samp>, etc. 
ed9de5

ed9de5

To specify the <samp>`POST'</samp> action, you need to use set the

ed9de5
<samp>`POST:'</samp> followed by the function name of the action you want to
ed9de5
perform.  The exact form depends on your needs. For example, consider
ed9de5
the following example to produce <samp>`xpm'</samp>, <samp>`jpg'</samp>, and
ed9de5
<samp>`tif'</samp> images, based on already rendered <samp>`png'</samp> image, and
ed9de5
also organize the produced files in directories named as their own
ed9de5
extensions:
ed9de5

ed9de5
ACTIONS[0]='BASE:renderImage'
ed9de5
ACTIONS[1]='POST:renderFormats: xpm jpg tif'
ed9de5
ACTIONS[2]='POST:groupByFormat: png xpm jpg tif'
ed9de5
ed9de5

In the previous example, file organization takes place at the moment

ed9de5
of rendering, just after producing the <samp>`png'</samp> base file and before
ed9de5
going to the next file in the list of files to render. If you don't
ed9de5
want to organized the produced files in directories named as their own
ed9de5
extensions, just remove the <samp>`POST:groupByFormat'</samp> action line:
ed9de5

ed9de5
ACTIONS[0]='BASE:renderImage'
ed9de5
ACTIONS[1]='POST:renderFormats: xpm jpg tif'
ed9de5
ed9de5

The <samp>`LAST'</samp> action specifies which actions to apply once the last

ed9de5
file in the list of files to process has been rendered. The
ed9de5
<samp>`LAST'</samp> action is optional. Possible values for <samp>`LAST'</samp>
ed9de5
actions may be <samp>`groupByFormat'</samp>, <samp>`renderGdmTgz'</samp>, etc.
ed9de5

728c6d
Info

Note

-- Removed(xref:trunk Scripts Bash Functions Render) --, to know more

ed9de5
about possible values for <samp>`BASE'</samp>, <samp>`POST'</samp> and <samp>`LAST'</samp>
ed9de5
action definitions.
ed9de5

06d106
ed9de5

To specify the <samp>`LAST'</samp> action, you need to set the <samp>`LAST:'</samp>

ed9de5
string followed by the function name of the action you want to
ed9de5
perform.  For example, consider the following example if you want to
ed9de5
render all files first and organize them later:
ed9de5

ed9de5
ACTIONS[0]='BASE:renderImage'
ed9de5
ACTIONS[1]='POST:renderFormats: xpm jpg tif'
ed9de5
ACTIONS[2]='LAST:groupByformat: png xpm jpg tif'
ed9de5
728c6d

ed9de5
52772c

2.69.3 Usage

06d106
ed9de5

Use the following commands to administer both identity and translation

ed9de5
pre-rendering configuration scripts:
ed9de5

ed9de5
ed9de5
<samp>`centos-art config --create='path/to/dir/''</samp>
ed9de5
ed9de5

Use this command to create <samp>`path/to/dir'</samp> related pre-rendering

ed9de5
configuration script.
ed9de5

ed9de5
ed9de5
<samp>`centos-art config --edit='path/to/dir/''</samp>
ed9de5
ed9de5

Use this command to edit <samp>`path/to/dir'</samp> related pre-rendering

ed9de5
configuration script.  
ed9de5

ed9de5
ed9de5
<samp>`centos-art config --read='path/to/dir/''</samp>
ed9de5
ed9de5

Use this command to read <samp>`path/to/dir'</samp> related pre-rendering

ed9de5
configuration script.  
ed9de5

ed9de5
ed9de5
<samp>`centos-art config --remove='path/to/dir/''</samp>
ed9de5
ed9de5

Use this command to remove <samp>`path/to/dir'</samp> related pre-rendering

ed9de5
configuration script.
ed9de5

ed9de5
ed9de5
632e8b
ed9de5

In the commands above, <samp>`path/to/dir'</samp> refers to one renderable

ed9de5
directory path under <tt>`trunk/Identity'</tt> or
ed9de5
<tt>`trunk/Translations'</tt> structures only. 
ed9de5

728c6d

ed9de5
52772c

2.69.4 See also

632e8b
ed9de5
ed9de5
2.60 The <tt>`trunk/Scripts'</tt> Directory  
ed9de5
ed9de5
632e8b
728c6d

632e8b
ed9de5
[ < ]
ed9de5
[ > ]
632e8b
   
1075b9
[ << ]
ed9de5
[ Up ]
ed9de5
[ >> ]
632e8b
632e8b
728c6d
            
728c6d
            The content of left column ends here.
728c6d
            -->
728c6d
            

728c6d
728c6d
        
728c6d
728c6d
    
728c6d
728c6d
    
728c6d
    Start page footer definitions.
728c6d
    -->
728c6d
    

728c6d
728c6d
728c6d
632e8b
</body>
728c6d
632e8b
</html>