Blame Manual/repository-html/repository_63.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
-->
406f69
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>
063806
<title>CentOS Artwork Repository: 2.59 The trunk/Scripts/Bash/Cli/Functions/Render/Config Directory</title>
ee1f37
063806
<meta name="description" content="CentOS Artwork Repository: 2.59 The trunk/Scripts/Bash/Cli/Functions/Render/Config Directory">
063806
<meta name="keywords" content="CentOS Artwork Repository: 2.59 The trunk/Scripts/Bash/Cli/Functions/Render/Config Directory">
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
063806
[ < ]
063806
[ > ]
ee1f37
   
063806
[ << ]
063806
[ Up ]
063806
[ >> ]
ee1f37
   
ee1f37
   
ee1f37
   
ee1f37
   
56a476
[Top]
56a476
[Contents]
063806
[Index]
56a476
[ ? ]
ee1f37
063806
063806
063806

2.59 The <tt>`trunk/Scripts/Bash/Cli/Functions/Render/Config'</tt> Directory

ee1f37
b130a0
063806
063806

2.59.1 Goals

7ba52f
063806

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

063806
pre-rendering configuration scripts.
b130a0

b130a0
063806
063806

2.59.2 Description

063806
063806

Pre-rendering configuration scripts let you customize the way

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

063806

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

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

7ba52f
063806
063806

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

7ba52f
063806

Inside CentOS Artwork Repository, we consider identity entries to all

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

063806

Inside identity pre-rendering configuration scripts, image-based

063806
pre-rendering configuration scripts look like the following:
b9dbd3

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

Inside identity pre-rendering configuration scripts, text-based

063806
pre-rendering configuration scripts look like the following:
b9dbd3

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

When using identity pre-rendering configuration scripts, you can

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

063806
063806
063806

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

063806
063806

Translation pre-rendering configuration scripts take precedence before

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

063806
063806
063806

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

063806
063806

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

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

063806

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

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

063806

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

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

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

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

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

063806

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

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

063806

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

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

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

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

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

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

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

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

063806
info

Note

-- Removed(xref:trunk Scripts Bash Functions Render) --, to know more

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

063806
063806

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

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

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

2.59.3 Usage

063806
063806

Use the following commands to administer both identity and translation

063806
pre-rendering configuration scripts:
b130a0

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

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

063806
configuration script.
b130a0

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

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

063806
configuration script.  
b130a0

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

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

063806
configuration script.  
b9dbd3

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

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

063806
configuration script.
b130a0

b130a0
b130a0
7ba52f
063806

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

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

b9dbd3
063806
063806

2.59.4 See also

ee1f37
b130a0
063806
2.50 The <tt>`trunk/Scripts/Bash'</tt> Directory  
b130a0
b130a0
193ea4
193ea4
ee1f37
063806
[ < ]
063806
[ > ]
ee1f37
   
063806
[ << ]
063806
[ Up ]
063806
[ >> ]
ee1f37
ee1f37

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

ee1f37
</body>
ee1f37
</html>