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

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

3f9ae1
008ee0
166893
166893

3.55.1 Goals

008ee0
166893

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

166893
pre-rendering configuration scripts.
2dc146

2dc146
166893
166893

3.55.2 Description

2dc146
166893

Pre-rendering configuration scripts let you customize the way

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

166893

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

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

2dc146
166893
166893

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

166893
166893

Inside CentOS Artwork Repository, we consider identity entries to all

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

166893

Inside identity pre-rendering configuration scripts, image-based

166893
pre-rendering configuration scripts look like the following:
fa7cae

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

Inside identity pre-rendering configuration scripts, text-based

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

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

When using identity pre-rendering configuration scripts, you can

166893
extend both image-based and text-based pre-rendering configuration
166893
scripts using image-based and text-based post-rendering actions,
166893
respectively. 
fa7cae

4a9d2a
166893
166893

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

2dc146
166893

Translation pre-rendering configuration scripts take precedence before

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

166893
166893
166893

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

166893
166893

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

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

166893

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

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

166893

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

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

166893
ACTIONS[0]='BASE:renderImage'
4a9d2a
166893

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

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

166893

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

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

166893

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

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

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

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

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

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

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

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

166893
info

Note

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

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

fa7cae
166893

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

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

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

3.55.3 Usage

b8013f
166893

Use the following commands to administer both identity and translation

166893
pre-rendering configuration scripts:
2dc146

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

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

166893
configuration script.
4a9d2a

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

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

166893
configuration script.  
2dc146

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

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

166893
configuration script.  
4a9d2a

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

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

166893
configuration script.
fa7cae

166893
2dc146
2dc146
166893

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

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

b8013f
166893
166893

3.55.4 See also

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