Blame Manuals/en/Html/Repository/repository_47.html

4c79b5
4c79b5
<html>
6414c4
09d4f2
6414c4
Copyright C 2009, 2010, 2011  Alain Reguera Delgado
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
-->
92fb7f
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>
aaa0e9
<title>The CentOS Artwork Repository: 3.44 trunk/Scripts/Bash/Functions/Render/Config</title>
4c79b5
aaa0e9
<meta name="description" content="The CentOS Artwork Repository: 3.44 trunk/Scripts/Bash/Functions/Render/Config">
aaa0e9
<meta name="keywords" content="The CentOS Artwork Repository: 3.44 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
4c79b5
aaa0e9
[ < ]
aaa0e9
[ > ]
4c79b5
   
4c79b5
[ << ]
4c79b5
[ Up ]
aaa0e9
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
aaa0e9
[Index]
4c79b5
[ ? ]
4c79b5
aaa0e9
aaa0e9
aaa0e9

3.44 trunk/Scripts/Bash/Functions/Render/Config

008ee0
ef356a
aaa0e9
54b5a5

3.44.1 Goals

54b5a5
aaa0e9

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

aaa0e9
pre-rendering configuration scripts.
63f275

008ee0
aaa0e9
54b5a5

3.44.2 Description

54b5a5
aaa0e9

Pre-rendering configuration scripts let you customize the way

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

aaa0e9

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

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

aaa0e9
aaa0e9
aaa0e9

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

aaa0e9
aaa0e9

Inside CentOS Artwork Repository, we consider identity entries to all

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

aaa0e9

Inside identity pre-rendering configuration scripts, image-based

aaa0e9
pre-rendering configuration scripts look like the following:
63f275

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

Inside identity pre-rendering configuration scripts, text-based

aaa0e9
pre-rendering configuration scripts look like the following:
0151ba

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

When using identity pre-rendering configuration scripts, you can

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

aaa0e9
aaa0e9
aaa0e9

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

aaa0e9
aaa0e9

Translation pre-rendering configuration scripts take precedence before

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

0d952c
aaa0e9
aaa0e9

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

aaa0e9
aaa0e9

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

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

aaa0e9

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

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

aaa0e9

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

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

aaa0e9
ACTIONS[0]='BASE:renderImage'
035049
aaa0e9

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

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

aaa0e9

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

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

aaa0e9

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

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

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

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

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

aaa0e9
ACTIONS[0]='BASE:renderImage'
aaa0e9
ACTIONS[1]='POST:renderFormats: xpm jpg tif'
280c77
aaa0e9

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

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

aaa0e9
info

Note

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

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

4224f4
aaa0e9

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

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

aaa0e9
ACTIONS[0]='BASE:renderImage'
aaa0e9
ACTIONS[1]='POST:renderFormats: xpm jpg tif'
aaa0e9
ACTIONS[2]='LAST:groupByformat: png xpm jpg tif'
aaa0e9
e37211
01b527
008ee0

3.44.3 Usage

008ee0
aaa0e9

Use the following commands to administer both identity and translation

aaa0e9
pre-rendering configuration scripts:
aaa0e9

63f275
aaa0e9
<samp>`centos-art config --create='path/to/dir/''</samp>
aaa0e9
aaa0e9

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

aaa0e9
configuration script.
4224f4

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

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

aaa0e9
configuration script.  
aaa0e9

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

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

aaa0e9
configuration script.  
4224f4

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

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

aaa0e9
configuration script.
aaa0e9

aaa0e9
aaa0e9
aaa0e9
aaa0e9

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

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

63f275
01b527
4c79b5

3.44.4 See also

4c79b5
2c8180
aaa0e9
3.37 trunk/Scripts/Bash  
aaa0e9
aaa0e9
3.38 trunk/Scripts/Bash/Functions  
63f275
aaa0e9
3.43 trunk/Scripts/Bash/Functions/Render  
2c8180
2c8180
4c79b5
4c79b5
4c79b5
01b527
[ < ]
01b527
[ > ]
4c79b5
   
4c79b5
[ << ]
aaa0e9
[ Up ]
aaa0e9
[ >> ]
4c79b5
4c79b5

4c79b5
 <font size="-1">
92fb7f
  This document was generated on January, 5 2011 using texi2html 1.76.
4c79b5
 </font>
4c79b5
 
4c79b5
4c79b5

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