Blame Manuals/Repository/centos-art.sh-html/repository_46.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
-->
492287
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>
492287
<title>centos-art.sh: 3.43 trunk/Scripts/Bash/Functions/Render/Config</title>
4c79b5
492287
<meta name="description" content="centos-art.sh: 3.43 trunk/Scripts/Bash/Functions/Render/Config">
492287
<meta name="keywords" content="centos-art.sh: 3.43 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
13b177
[ < ]
13b177
[ > ]
4c79b5
   
4c79b5
[ << ]
4c79b5
[ Up ]
13b177
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
13b177
[Index]
4c79b5
[ ? ]
4c79b5
ec5f63
13b177
ec5f63

3.43 trunk/Scripts/Bash/Functions/Render/Config

cb2a5d
300762
13b177
fe989b

3.43.1 Goals

fe989b
ec5f63

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

ec5f63
pre-rendering configuration scripts.
ec5f63

915635
13b177
008ee0

3.43.2 Description

915635
ec5f63

Pre-rendering configuration scripts let you customize the way

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

ec5f63

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

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

1d1bf4
13b177
ec5f63

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

1d1bf4
ec5f63

Inside CentOS Artwork Repository, we consider identity entries to all

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

ec5f63

Inside identity pre-rendering configuration scripts, image-based

ec5f63
pre-rendering configuration scripts look like the following:
ec5f63

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

Inside identity pre-rendering configuration scripts, text-based

ec5f63
pre-rendering configuration scripts look like the following:
ec5f63

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

When using identity pre-rendering configuration scripts, you can

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

1d1bf4
13b177
ec5f63

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

ec5f63
ec5f63

Translation pre-rendering configuration scripts take precedence before

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

ec5f63
13b177
ec5f63

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

ec5f63
ec5f63

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

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

ec5f63

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

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

ec5f63

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

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

ec5f63
ACTIONS[0]='BASE:renderImage'
ec5f63
ec5f63

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

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

ec5f63

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

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

ec5f63

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

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

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

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

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

ec5f63
ACTIONS[0]='BASE:renderImage'
ec5f63
ACTIONS[1]='POST:renderFormats: xpm jpg tif'
ec5f63
ec5f63

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

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

5cee2c
info

Note

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

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

ec5f63
ec5f63

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

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

ec5f63
ACTIONS[0]='BASE:renderImage'
ec5f63
ACTIONS[1]='POST:renderFormats: xpm jpg tif'
ec5f63
ACTIONS[2]='LAST:groupByformat: png xpm jpg tif'
ec5f63
ec5f63
13b177
ec5f63

3.43.3 Usage

ec5f63
ec5f63

Use the following commands to administer both identity and translation

ec5f63
pre-rendering configuration scripts:
ec5f63

ec5f63
ec5f63
<samp>`centos-art config --create='path/to/dir/''</samp>
ec5f63
ec5f63

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

ec5f63
configuration script.
ec5f63

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

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

ec5f63
configuration script.  
ec5f63

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

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

ec5f63
configuration script.  
ec5f63

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

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

ec5f63
configuration script.
ec5f63

ec5f63
ec5f63
ec5f63
ec5f63

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

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

ec5f63
13b177
4c79b5

3.43.4 See also

4c79b5
54b5a5
5cee2c
3.36 trunk/Scripts/Bash  
ec5f63
5cee2c
3.37 trunk/Scripts/Bash/Functions  
ec5f63
5cee2c
3.42 trunk/Scripts/Bash/Functions/Render  
035049
54b5a5
4c79b5
4c79b5
4c79b5
13b177
[ < ]
13b177
[ > ]
4c79b5
   
4c79b5
[ << ]
13b177
[ Up ]
13b177
[ >> ]
4c79b5
4c79b5

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

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