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
-->
27dad7
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>
3f9ae1
<title>The CentOS Artwork Repository: 3.44 trunk/Scripts/Bash/Functions/Render/Config</title>
4c79b5
3f9ae1
<meta name="description" content="The CentOS Artwork Repository: 3.44 trunk/Scripts/Bash/Functions/Render/Config">
3f9ae1
<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
3f9ae1
[ < ]
3f9ae1
[ > ]
4c79b5
   
4c79b5
[ << ]
4c79b5
[ Up ]
3f9ae1
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
3f9ae1
[Index]
4c79b5
[ ? ]
4c79b5
3f9ae1
3f9ae1
3f9ae1

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

008ee0
ef356a
3f9ae1
54b5a5

3.44.1 Goals

54b5a5
3f9ae1

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

3f9ae1
pre-rendering configuration scripts.
63f275

008ee0
3f9ae1
54b5a5

3.44.2 Description

54b5a5
3f9ae1

Pre-rendering configuration scripts let you customize the way

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

3f9ae1

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

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

3f9ae1
3f9ae1
3f9ae1

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

3f9ae1
3f9ae1

Inside CentOS Artwork Repository, we consider identity entries to all

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

3f9ae1

Inside identity pre-rendering configuration scripts, image-based

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

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

Inside identity pre-rendering configuration scripts, text-based

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

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

When using identity pre-rendering configuration scripts, you can

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

3f9ae1
3f9ae1
3f9ae1

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

3f9ae1
3f9ae1

Translation pre-rendering configuration scripts take precedence before

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

0d952c
3f9ae1
3f9ae1

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

3f9ae1
3f9ae1

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

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

3f9ae1

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

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

3f9ae1

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

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

3f9ae1
ACTIONS[0]='BASE:renderImage'
035049
3f9ae1

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

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

3f9ae1

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

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

3f9ae1

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

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

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

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

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

3f9ae1
ACTIONS[0]='BASE:renderImage'
3f9ae1
ACTIONS[1]='POST:renderFormats: xpm jpg tif'
27dad7
3f9ae1

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

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

3f9ae1
info

Note

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

3f9ae1
about possible values for <samp>`BASE'</samp>, <samp>`POST'</samp> and <samp>`LAST'</samp>
3f9ae1
action definitions.
1d1bf4

1d1bf4
3f9ae1

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

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

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

3.44.3 Usage

008ee0
3f9ae1

Use the following commands to administer both identity and translation

3f9ae1
pre-rendering configuration scripts:
3f9ae1

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

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

3f9ae1
configuration script.
1d1bf4

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

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

3f9ae1
configuration script.  
3f9ae1

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

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

3f9ae1
configuration script.  
1d1bf4

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

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

3f9ae1
configuration script.
3f9ae1

3f9ae1
3f9ae1
3f9ae1
3f9ae1

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

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

63f275
01b527
4c79b5

3.44.4 See also

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

4c79b5
 <font size="-1">
27dad7
  This document was generated on January, 6 2011 using texi2html 1.76.
4c79b5
 </font>
4c79b5
 
4c79b5
4c79b5

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