Blame Manuals/Repository/repository-html/repository_59.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>
bf28e1
<title>CentOS Artwork Repository: 3.56 trunk/Scripts/Bash/Functions/Render/Config</title>
4c79b5
bf28e1
<meta name="description" content="CentOS Artwork Repository: 3.56 trunk/Scripts/Bash/Functions/Render/Config">
bf28e1
<meta name="keywords" content="CentOS Artwork Repository: 3.56 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
bf28e1
[ < ]
bf28e1
[ > ]
4c79b5
   
4c79b5
[ << ]
300762
[ Up ]
bf28e1
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
bf28e1
[Index]
4c79b5
[ ? ]
4c79b5
bf28e1
bf28e1
bf28e1

3.56 trunk/Scripts/Bash/Functions/Render/Config

38bcd9
c9b54d
bf28e1
63f275

3.56.1 Goals

54b5a5
bf28e1

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

bf28e1
pre-rendering configuration scripts.
4a9d2a

4c79b5
bf28e1
63f275

3.56.2 Description

5fb024
bf28e1

Pre-rendering configuration scripts let you customize the way

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

bf28e1

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

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

bf28e1
bf28e1
bf28e1

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

bf28e1
bf28e1

Inside CentOS Artwork Repository, we consider identity entries to all

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

bf28e1

Inside identity pre-rendering configuration scripts, image-based

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

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

Inside identity pre-rendering configuration scripts, text-based

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

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

When using identity pre-rendering configuration scripts, you can

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

bf28e1
bf28e1
bf28e1

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

bf28e1
bf28e1

Translation pre-rendering configuration scripts take precedence before

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

2dc146
bf28e1
bf28e1

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

bf28e1
bf28e1

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

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

bf28e1

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

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

bf28e1

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

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

bf28e1
ACTIONS[0]='BASE:renderImage'
2dc146
bf28e1

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

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

bf28e1

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

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

bf28e1

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

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

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

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

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

bf28e1
ACTIONS[0]='BASE:renderImage'
bf28e1
ACTIONS[1]='POST:renderFormats: xpm jpg tif'
7fa1fb
bf28e1

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

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

bf28e1
info

Note

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

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

c2a1bc
bf28e1

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

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

bf28e1
ACTIONS[0]='BASE:renderImage'
bf28e1
ACTIONS[1]='POST:renderFormats: xpm jpg tif'
bf28e1
ACTIONS[2]='LAST:groupByformat: png xpm jpg tif'
bf28e1
5fb024
2dc146
54b5a5

3.56.3 Usage

54b5a5
bf28e1

Use the following commands to administer both identity and translation

bf28e1
pre-rendering configuration scripts:
bf28e1

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

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

bf28e1
configuration script.
c2a1bc

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

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

bf28e1
configuration script.  
bf28e1

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

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

bf28e1
configuration script.  
c2a1bc

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

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

bf28e1
configuration script.
bf28e1

bf28e1
bf28e1
bf28e1
bf28e1

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

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

4a9d2a
2dc146
300762

3.56.4 See also

300762
4a9d2a
bf28e1
3.49 trunk/Scripts/Bash  
bf28e1
bf28e1
3.50 trunk/Scripts/Bash/Functions  
4a9d2a
bf28e1
3.55 trunk/Scripts/Bash/Functions/Render  
4a9d2a
4a9d2a
081970
081970
300762
2dc146
[ < ]
2dc146
[ > ]
300762
   
300762
[ << ]
bf28e1
[ Up ]
bf28e1
[ >> ]
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>