Blame Manuals/en/Html/Repository/repository_48.html

4c79b5
4c79b5
<html>
09d4f2
09d4f2
09d4f2
The CentOS Artwork Repository exists to organize and automate The
09d4f2
CentOS Project corporate visual identity (, to
09d4f2
start on).
4c79b5
6c4982
Copyright C 2009, 2010 Alain Reguera Delgado. All rights
4c79b5
reserved.
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
-->
008ee0
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>
54b5a5
<title>CentOS Artwork Repository: 3.45 trunk/Scripts/Bash/Functions/Render/Config</title>
4c79b5
54b5a5
<meta name="description" content="CentOS Artwork Repository: 3.45 trunk/Scripts/Bash/Functions/Render/Config">
54b5a5
<meta name="keywords" content="CentOS Artwork Repository: 3.45 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
008ee0
[ < ]
008ee0
[ > ]
4c79b5
   
4c79b5
[ << ]
4c79b5
[ Up ]
54b5a5
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
54b5a5
[Index]
4c79b5
[ ? ]
4c79b5
54b5a5
008ee0
54b5a5

3.45 trunk/Scripts/Bash/Functions/Render/Config

5fb024
4c79b5
008ee0
6aec21

3.45.1 Goals

4c79b5
54b5a5

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

54b5a5
pre-rendering configuration scripts.
54b5a5

c9b54d
008ee0
efa7b7

3.45.2 Description

2c8180
54b5a5

Pre-rendering configuration scripts let you customize the way

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

54b5a5

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

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

2c8180
008ee0
54b5a5

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

c9b54d
54b5a5

Inside CentOS Artwork Repository, we consider identity entries to all

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

54b5a5

Inside identity pre-rendering configuration scripts, image-based

54b5a5
pre-rendering configuration scripts look like the following:
54b5a5

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

Inside identity pre-rendering configuration scripts, text-based

54b5a5
pre-rendering configuration scripts look like the following:
54b5a5

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

When using identity pre-rendering configuration scripts, you can

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

2c8180
008ee0
54b5a5

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

54b5a5
54b5a5

Translation pre-rendering configuration scripts take precedence before

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

54b5a5
54b5a5
54b5a5

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

54b5a5
54b5a5

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

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

54b5a5

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

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

54b5a5

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

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

54b5a5
ACTIONS[0]='BASE:renderImage'
54b5a5
54b5a5

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

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

54b5a5

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

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

54b5a5

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

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

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

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

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

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

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

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

54b5a5
info

Note

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

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

54b5a5
54b5a5

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

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

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

3.45.3 Usage

54b5a5
54b5a5

Use the following commands to administer both identity and translation

54b5a5
pre-rendering configuration scripts:
54b5a5

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

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

54b5a5
configuration script.
54b5a5

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

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

54b5a5
configuration script.  
54b5a5

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

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

54b5a5
configuration script.  
54b5a5

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

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

54b5a5
configuration script.
54b5a5

54b5a5
54b5a5
54b5a5
54b5a5

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

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

54b5a5
54b5a5
300762

3.45.4 See also

4c79b5
2c8180
54b5a5
3.38 trunk/Scripts/Bash  
54b5a5
54b5a5
3.39 trunk/Scripts/Bash/Functions  
54b5a5
54b5a5
3.44 trunk/Scripts/Bash/Functions/Render  
2c8180
2c8180
4c79b5
4c79b5
4c79b5
54b5a5
[ < ]
54b5a5
[ > ]
4c79b5
   
4c79b5
[ << ]
008ee0
[ Up ]
54b5a5
[ >> ]
4c79b5
4c79b5

4c79b5
 <font size="-1">
008ee0
  This document was generated on December, 2 2010 using texi2html 1.76.
4c79b5
 </font>
4c79b5
 
4c79b5
4c79b5

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