Blame Manuals/en/Html/Repository/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
-->
6414c4
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>
4224f4
<title>The CentOS Artwork Repository: 3.43 trunk/Scripts/Bash/Functions/Render/Config</title>
4c79b5
4224f4
<meta name="description" content="The CentOS Artwork Repository: 3.43 trunk/Scripts/Bash/Functions/Render/Config">
4224f4
<meta name="keywords" content="The CentOS Artwork Repository: 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
01b527
[ < ]
01b527
[ > ]
4c79b5
   
4c79b5
[ << ]
4c79b5
[ Up ]
4224f4
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
4224f4
[Index]
4c79b5
[ ? ]
4c79b5
4224f4
01b527
4224f4

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

cb2a5d
300762
01b527
fe989b

3.43.1 Goals

fe989b
4224f4

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

4224f4
pre-rendering configuration scripts.
4224f4

915635
01b527
008ee0

3.43.2 Description

915635
4224f4

Pre-rendering configuration scripts let you customize the way

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

4224f4

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

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

3207df
280c77
4224f4

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

3207df
4224f4

Inside CentOS Artwork Repository, we consider identity entries to all

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

4224f4

Inside identity pre-rendering configuration scripts, image-based

4224f4
pre-rendering configuration scripts look like the following:
4224f4

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

Inside identity pre-rendering configuration scripts, text-based

4224f4
pre-rendering configuration scripts look like the following:
4224f4

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

When using identity pre-rendering configuration scripts, you can

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

3207df
280c77
4224f4

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

4224f4
4224f4

Translation pre-rendering configuration scripts take precedence before

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

4224f4
4224f4
4224f4

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

4224f4
4224f4

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

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

4224f4

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

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

4224f4

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

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

4224f4
ACTIONS[0]='BASE:renderImage'
4224f4
4224f4

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

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

4224f4

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

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

4224f4

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

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

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

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

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

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

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

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

4224f4
info

Note

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

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

4224f4
4224f4

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

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

4224f4
ACTIONS[0]='BASE:renderImage'
4224f4
ACTIONS[1]='POST:renderFormats: xpm jpg tif'
4224f4
ACTIONS[2]='LAST:groupByformat: png xpm jpg tif'
4224f4
4224f4
4224f4
4224f4

3.43.3 Usage

4224f4
4224f4

Use the following commands to administer both identity and translation

4224f4
pre-rendering configuration scripts:
4224f4

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

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

4224f4
configuration script.
4224f4

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

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

4224f4
configuration script.  
4224f4

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

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

4224f4
configuration script.  
4224f4

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

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

4224f4
configuration script.
4224f4

4224f4
4224f4
4224f4
4224f4

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

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

4224f4
4224f4
4c79b5

3.43.4 See also

4c79b5
54b5a5
4224f4
3.36 trunk/Scripts/Bash  
4224f4
4224f4
3.37 trunk/Scripts/Bash/Functions  
4224f4
4224f4
3.42 trunk/Scripts/Bash/Functions/Render  
035049
54b5a5
4c79b5
4c79b5
4c79b5
4224f4
[ < ]
4224f4
[ > ]
4c79b5
   
4c79b5
[ << ]
01b527
[ Up ]
4224f4
[ >> ]
4c79b5
4c79b5

4c79b5
 <font size="-1">
6414c4
  This document was generated on January, 3 2011 using texi2html 1.76.
4c79b5
 </font>
4c79b5
 
4c79b5
4c79b5

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