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
-->
bf28e1
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>
7e35dc
<title>CentOS Artwork Repository: 3.55 trunk/Scripts/Bash/Functions/Render/Config</title>
4c79b5
7e35dc
<meta name="description" content="CentOS Artwork Repository: 3.55 trunk/Scripts/Bash/Functions/Render/Config">
7e35dc
<meta name="keywords" content="CentOS Artwork Repository: 3.55 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
af3979
[ < ]
af3979
[ > ]
4c79b5
   
4c79b5
[ << ]
300762
[ Up ]
af3979
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
af3979
[Index]
4c79b5
[ ? ]
4c79b5
7e35dc
af3979
7e35dc

3.55 trunk/Scripts/Bash/Functions/Render/Config

2dc146
166893
af3979
7e35dc

3.55.1 Goals

2b5e61
7e35dc

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

7e35dc
pre-rendering configuration scripts.
7fa1fb

2b5e61
af3979
7e35dc

3.55.2 Description

c2a1bc
7e35dc

Pre-rendering configuration scripts let you customize the way

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

7e35dc

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

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

c2a1bc
af3979
7e35dc

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

7e35dc
7e35dc

Inside CentOS Artwork Repository, we consider identity entries to all

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

7e35dc

Inside identity pre-rendering configuration scripts, image-based

7e35dc
pre-rendering configuration scripts look like the following:
bf28e1

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

Inside identity pre-rendering configuration scripts, text-based

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

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

When using identity pre-rendering configuration scripts, you can

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

c2a1bc
af3979
7e35dc

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

c2a1bc
7e35dc

Translation pre-rendering configuration scripts take precedence before

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

7e35dc
af3979
7e35dc

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

7e35dc
7e35dc

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

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

7e35dc

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

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

7e35dc

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

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

7e35dc
ACTIONS[0]='BASE:renderImage'
4a9d2a
7e35dc

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

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

7e35dc

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

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

7e35dc

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

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

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

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

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

7e35dc
ACTIONS[0]='BASE:renderImage'
7e35dc
ACTIONS[1]='POST:renderFormats: xpm jpg tif'
4a9d2a
7e35dc

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

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

af3979
info

Note

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

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

bf28e1
7e35dc

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

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

7e35dc
ACTIONS[0]='BASE:renderImage'
7e35dc
ACTIONS[1]='POST:renderFormats: xpm jpg tif'
7e35dc
ACTIONS[2]='LAST:groupByformat: png xpm jpg tif'
2dc146
6ba043
af3979
7e35dc

3.55.3 Usage

b8013f
7e35dc

Use the following commands to administer both identity and translation

7e35dc
pre-rendering configuration scripts:
2dc146

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

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

7e35dc
configuration script.
4a9d2a

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

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

7e35dc
configuration script.  
2dc146

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

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

7e35dc
configuration script.  
4a9d2a

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

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

7e35dc
configuration script.
bf28e1

7e35dc
2dc146
2dc146
7e35dc

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

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

b8013f
af3979
7e35dc

3.55.4 See also

300762
4a9d2a
af3979
3.48 trunk/Scripts/Bash  
7e35dc
af3979
3.49 trunk/Scripts/Bash/Functions  
7e35dc
af3979
3.54 trunk/Scripts/Bash/Functions/Render  
4a9d2a
4a9d2a
bc3531
38bcd9
300762
af3979
[ < ]
af3979
[ > ]
300762
   
300762
[ << ]
af3979
[ Up ]
af3979
[ >> ]
300762
4c79b5

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

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