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

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

008ee0
2dc146
2b5e61
2b5e61

3.55.1 Goals

2dc146
2b5e61

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

2b5e61
pre-rendering configuration scripts.
fa7cae

2dc146
2b5e61
2b5e61

3.55.2 Description

166893
2b5e61

Pre-rendering configuration scripts let you customize the way

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

2b5e61

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

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

166893
2b5e61
2b5e61

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

2b5e61
2b5e61

Inside CentOS Artwork Repository, we consider identity entries to all

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

2b5e61

Inside identity pre-rendering configuration scripts, image-based

2b5e61
pre-rendering configuration scripts look like the following:
7bbd70

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

Inside identity pre-rendering configuration scripts, text-based

2b5e61
pre-rendering configuration scripts look like the following:
fa7cae

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

When using identity pre-rendering configuration scripts, you can

2b5e61
extend both image-based and text-based pre-rendering configuration
2b5e61
scripts using image-based and text-based post-rendering actions,
2b5e61
respectively. 
7bbd70

166893
2b5e61
2b5e61

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

166893
2b5e61

Translation pre-rendering configuration scripts take precedence before

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

2b5e61
2b5e61
2b5e61

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

2b5e61
2b5e61

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

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

2b5e61

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

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

2b5e61

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

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

2b5e61
ACTIONS[0]='BASE:renderImage'
4a9d2a
2b5e61

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

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

2b5e61

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

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

2b5e61

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

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

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

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

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

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

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

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

2b5e61
info

Note

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

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

7bbd70
2b5e61

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

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

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

3.55.3 Usage

b8013f
2b5e61

Use the following commands to administer both identity and translation

2b5e61
pre-rendering configuration scripts:
2dc146

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

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

2b5e61
configuration script.
4a9d2a

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

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

2b5e61
configuration script.  
2dc146

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

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

2b5e61
configuration script.  
4a9d2a

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

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

2b5e61
configuration script.
7bbd70

2b5e61
2dc146
2dc146
2b5e61

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

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

b8013f
2b5e61
2b5e61

3.55.4 See also

300762
4a9d2a
2b5e61
3.48 trunk/Scripts/Bash  
2b5e61
2b5e61
3.49 trunk/Scripts/Bash/Functions  
2b5e61
2b5e61
3.54 trunk/Scripts/Bash/Functions/Render  
4a9d2a
4a9d2a
bc3531
38bcd9
300762
2b5e61
[ < ]
2b5e61
[ > ]
300762
   
300762
[ << ]
2b5e61
[ Up ]
2b5e61
[ >> ]
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>