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

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

ee1f37
ee1f37
b9dbd3
b9dbd3

2.59.1 Goals

ee1f37
b9dbd3

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

b9dbd3
pre-rendering configuration scripts.
ee1f37

ee1f37
b9dbd3
b9dbd3

2.59.2 Description

b9dbd3
b9dbd3

Pre-rendering configuration scripts let you customize the way

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

b9dbd3

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

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

b9dbd3
b9dbd3
b9dbd3

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

b9dbd3
b9dbd3

Inside CentOS Artwork Repository, we consider identity entries to all

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

b9dbd3

Inside identity pre-rendering configuration scripts, image-based

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

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

Inside identity pre-rendering configuration scripts, text-based

b9dbd3
pre-rendering configuration scripts look like the following:
010b2d

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

When using identity pre-rendering configuration scripts, you can

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

b9dbd3
b9dbd3
b9dbd3

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

b9dbd3
b9dbd3

Translation pre-rendering configuration scripts take precedence before

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

b130a0
b9dbd3
b9dbd3

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

b9dbd3
b9dbd3

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

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

b9dbd3

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

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

b9dbd3

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

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

b9dbd3
ACTIONS[0]='BASE:renderImage'
b130a0
b9dbd3

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

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

b9dbd3

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

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

b9dbd3

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

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

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

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

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

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

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

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

b9dbd3
info

Note

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

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

aaf678
b9dbd3

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

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

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

2.59.3 Usage

ee1f37
b9dbd3

Use the following commands to administer both identity and translation

b9dbd3
pre-rendering configuration scripts:
b9dbd3

010b2d
b9dbd3
<samp>`centos-art config --create='path/to/dir/''</samp>
b9dbd3
b9dbd3

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

b9dbd3
configuration script.
010b2d

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

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

b9dbd3
configuration script.  
b9dbd3

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

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

b9dbd3
configuration script.  
010b2d

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

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

b9dbd3
configuration script.
b9dbd3

b9dbd3
b9dbd3
b9dbd3
b9dbd3

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

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

ee1f37
b9dbd3
b9dbd3

2.59.4 See also

ee1f37
ee1f37
b9dbd3
2.50 The <tt>`trunk/Scripts/Bash'</tt> Directory  
ee1f37
ee1f37
ee1f37
ee1f37
ee1f37
b9dbd3
[ < ]
b9dbd3
[ > ]
ee1f37
   
b9dbd3
[ << ]
b9dbd3
[ Up ]
b9dbd3
[ >> ]
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>