Blame Manuals/Repository-fs/repository-fs-html/repository-fs_57.html

ee1f37
ee1f37
<html>
ee1f37
ee1f37
ee1f37
Permission is granted to copy, distribute and/or modify this document
ee1f37
under the terms of the GNU Free Documentation License, Version 1.2 or
ee1f37
any later version published by the Free Software Foundation; with no
ee1f37
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
ee1f37
copy of the license is included in the section entitled GNU Free
ee1f37
Documentation License.  
ee1f37
-->
ee1f37
ee1f37
ee1f37
Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
ee1f37
            Karl Berry  <karl@freefriends.org>
ee1f37
            Olaf Bachmann <obachman@mathematik.uni-kl.de>
ee1f37
            and many others.
ee1f37
Maintained by: Many creative people <dev@texi2html.cvshome.org>
ee1f37
Send bugs and suggestions to <users@texi2html.cvshome.org>
ee1f37
ee1f37
-->
ee1f37
<head>
ee1f37
<title>CentOS Artwork Repository: 3.54 trunk/Scripts/Bash/Functions/Render/Config</title>
ee1f37
ee1f37
<meta name="description" content="CentOS Artwork Repository: 3.54 trunk/Scripts/Bash/Functions/Render/Config">
ee1f37
<meta name="keywords" content="CentOS Artwork Repository: 3.54 trunk/Scripts/Bash/Functions/Render/Config">
ee1f37
<meta name="resource-type" content="document">
ee1f37
<meta name="distribution" content="global">
ee1f37
<meta name="Generator" content="texi2html 1.76">
ee1f37
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
ee1f37
<style type="text/css">
ee1f37
ee1f37
@import "/home/centos/artwork/trunk/Identity/Models/Css/Texi2html/common.css";
ee1f37
ee1f37
a.summary-letter {text-decoration: none}
ee1f37
pre.display {font-family: serif}
ee1f37
pre.format {font-family: serif}
ee1f37
pre.menu-comment {font-family: serif}
ee1f37
pre.menu-preformatted {font-family: serif}
ee1f37
pre.smalldisplay {font-family: serif; font-size: smaller}
ee1f37
pre.smallexample {font-size: smaller}
ee1f37
pre.smallformat {font-family: serif; font-size: smaller}
ee1f37
pre.smalllisp {font-size: smaller}
ee1f37
span.sansserif {font-family:sans-serif; font-weight:normal;}
ee1f37
ul.toc {list-style: none}
ee1f37
-->
ee1f37
</style>
ee1f37
ee1f37
ee1f37
</head>
ee1f37
ee1f37
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
ee1f37
ee1f37
ee1f37
[ < ]
ee1f37
[ > ]
ee1f37
   
ee1f37
[ << ]
ee1f37
[ Up ]
ee1f37
[ >> ]
ee1f37
   
ee1f37
   
ee1f37
   
ee1f37
   
ee1f37
[Top]
ee1f37
[Contents]
ee1f37
[Index]
ee1f37
[ ? ]
ee1f37
ee1f37
ee1f37
ee1f37

3.54 trunk/Scripts/Bash/Functions/Render/Config

ee1f37
ee1f37
ee1f37
ee1f37

3.54.1 Goals

ee1f37
ee1f37

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

ee1f37
pre-rendering configuration scripts.
ee1f37

ee1f37
ee1f37
ee1f37

3.54.2 Description

ee1f37
ee1f37

Pre-rendering configuration scripts let you customize the way

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

ee1f37

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

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

ee1f37
ee1f37
ee1f37

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

ee1f37
ee1f37

Inside CentOS Artwork Repository, we consider identity entries to all

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

ee1f37

Inside identity pre-rendering configuration scripts, image-based

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

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

Inside identity pre-rendering configuration scripts, text-based

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

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

When using identity pre-rendering configuration scripts, you can

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

ee1f37
ee1f37
ee1f37

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

ee1f37
ee1f37

Translation pre-rendering configuration scripts take precedence before

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

ee1f37
ee1f37
ee1f37

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

ee1f37
ee1f37

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

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

ee1f37

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

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

ee1f37

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

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

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

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

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

ee1f37

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

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

ee1f37

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

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

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

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

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

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

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

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

ee1f37
info

Note

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

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

ee1f37
ee1f37

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

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

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

3.54.3 Usage

ee1f37
ee1f37

Use the following commands to administer both identity and translation

ee1f37
pre-rendering configuration scripts:
ee1f37

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

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

ee1f37
configuration script.
ee1f37

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

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

ee1f37
configuration script.  
ee1f37

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

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

ee1f37
configuration script.  
ee1f37

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

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

ee1f37
configuration script.
ee1f37

ee1f37
ee1f37
ee1f37
ee1f37

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

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

ee1f37
ee1f37
ee1f37

3.54.4 See also

ee1f37
ee1f37
ee1f37
3.47 trunk/Scripts/Bash  
ee1f37
ee1f37
3.48 trunk/Scripts/Bash/Functions  
ee1f37
ee1f37
3.53 trunk/Scripts/Bash/Functions/Render  
ee1f37
ee1f37
ee1f37
ee1f37
ee1f37
ee1f37
[ < ]
ee1f37
[ > ]
ee1f37
   
ee1f37
[ << ]
ee1f37
[ Up ]
ee1f37
[ >> ]
ee1f37
ee1f37

ee1f37
 <font size="-1">
ee1f37
  This document was generated on February, 27 2011 using texi2html 1.76.
ee1f37
 </font>
ee1f37
 
ee1f37
ee1f37

ee1f37
</body>
ee1f37
</html>