Blame Manuals/Repository/repository-html/repository_59.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>
7fa1fb
<title>CentOS Artwork Repository: 3.56 trunk/Scripts/Bash/Functions/Render/Config</title>
4c79b5
7fa1fb
<meta name="description" content="CentOS Artwork Repository: 3.56 trunk/Scripts/Bash/Functions/Render/Config">
7fa1fb
<meta name="keywords" content="CentOS Artwork Repository: 3.56 trunk/Scripts/Bash/Functions/Render/Config">
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
7fa1fb
[ < ]
7fa1fb
[ > ]
4c79b5
   
4c79b5
[ << ]
300762
[ Up ]
7fa1fb
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
7fa1fb
[Index]
4c79b5
[ ? ]
4c79b5
7fa1fb
7fa1fb
7fa1fb

3.56 trunk/Scripts/Bash/Functions/Render/Config

38bcd9
c9b54d
7fa1fb
63f275

3.56.1 Goals

54b5a5
7fa1fb

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

7fa1fb
pre-rendering configuration scripts.
4a9d2a

4c79b5
7fa1fb
63f275

3.56.2 Description

5fb024
7fa1fb

Pre-rendering configuration scripts let you customize the way

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

7fa1fb

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

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

7fa1fb
7fa1fb
7fa1fb

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

7fa1fb
7fa1fb

Inside CentOS Artwork Repository, we consider identity entries to all

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

7fa1fb

Inside identity pre-rendering configuration scripts, image-based

7fa1fb
pre-rendering configuration scripts look like the following:
4a9d2a

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

Inside identity pre-rendering configuration scripts, text-based

7fa1fb
pre-rendering configuration scripts look like the following:
4a9d2a

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

When using identity pre-rendering configuration scripts, you can

7fa1fb
extend both image-based and text-based pre-rendering configuration
7fa1fb
scripts using image-based and text-based post-rendering actions,
7fa1fb
respectively. 
4a9d2a

7fa1fb
7fa1fb
7fa1fb

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

7fa1fb
7fa1fb

Translation pre-rendering configuration scripts take precedence before

7fa1fb
default translation rendering action. Translation pre-rendering
7fa1fb
actions are useful when default translation rendering action do not
7fa1fb
fit itself to translation entry rendering requirements.
4a9d2a

2dc146
7fa1fb
7fa1fb

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

7fa1fb
7fa1fb

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

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

7fa1fb

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

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

7fa1fb

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

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

7fa1fb
ACTIONS[0]='BASE:renderImage'
2dc146
7fa1fb

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

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

7fa1fb

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

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

7fa1fb

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

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

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

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

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

7fa1fb
ACTIONS[0]='BASE:renderImage'
7fa1fb
ACTIONS[1]='POST:renderFormats: xpm jpg tif'
7bbd70
7fa1fb

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

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

7fa1fb
info

Note

See section trunk/Scripts/Bash/Functions/Render, to know more

7fa1fb
about possible values for <samp>`BASE'</samp>, <samp>`POST'</samp> and <samp>`LAST'</samp>
7fa1fb
action definitions.
2b5e61

2b5e61
7fa1fb

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

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

7fa1fb
ACTIONS[0]='BASE:renderImage'
7fa1fb
ACTIONS[1]='POST:renderFormats: xpm jpg tif'
7fa1fb
ACTIONS[2]='LAST:groupByformat: png xpm jpg tif'
7fa1fb
5fb024
2dc146
54b5a5

3.56.3 Usage

54b5a5
7fa1fb

Use the following commands to administer both identity and translation

7fa1fb
pre-rendering configuration scripts:
7fa1fb

4a9d2a
7fa1fb
<samp>`centos-art config --create='path/to/dir/''</samp>
7fa1fb
7fa1fb

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

7fa1fb
configuration script.
2b5e61

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

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

7fa1fb
configuration script.  
7fa1fb

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

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

7fa1fb
configuration script.  
2b5e61

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

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

7fa1fb
configuration script.
7fa1fb

7fa1fb
7fa1fb
7fa1fb
7fa1fb

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

7fa1fb
directory path under <tt>`trunk/Identity'</tt> or
7fa1fb
<tt>`trunk/Translations'</tt> structures only. 
4a9d2a

4a9d2a
2dc146
300762

3.56.4 See also

300762
4a9d2a
7fa1fb
3.49 trunk/Scripts/Bash  
7fa1fb
7fa1fb
3.50 trunk/Scripts/Bash/Functions  
4a9d2a
7fa1fb
3.55 trunk/Scripts/Bash/Functions/Render  
4a9d2a
4a9d2a
081970
081970
300762
2dc146
[ < ]
2dc146
[ > ]
300762
   
300762
[ << ]
7fa1fb
[ Up ]
7fa1fb
[ >> ]
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>