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

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

063806
7ba52f
f66721
671838

2.59.1 Goals

063806
671838

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

671838
pre-rendering configuration scripts.
f66721

671838
671838
671838

2.59.2 Description

671838
671838

Pre-rendering configuration scripts let you customize the way

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

671838

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

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

671838
671838
671838

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

671838
671838

Inside CentOS Artwork Repository, we consider identity entries to all

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

671838

Inside identity pre-rendering configuration scripts, image-based

671838
pre-rendering configuration scripts look like the following:
f66721

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

Inside identity pre-rendering configuration scripts, text-based

671838
pre-rendering configuration scripts look like the following:
f66721

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

When using identity pre-rendering configuration scripts, you can

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

671838
671838
671838

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

671838
671838

Translation pre-rendering configuration scripts take precedence before

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

671838
671838
671838

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

671838
671838

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

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

671838

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

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

671838

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

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

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

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

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

671838

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

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

671838

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

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

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

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

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

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

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

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

671838
info

Note

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

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

f66721
671838

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

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

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

2.59.3 Usage

f66721
671838

Use the following commands to administer both identity and translation

671838
pre-rendering configuration scripts:
b130a0

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

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

671838
configuration script.
b130a0

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

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

671838
configuration script.  
b130a0

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

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

671838
configuration script.  
b9dbd3

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

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

671838
configuration script.
f66721

671838
b130a0
7ba52f
671838

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

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

b9dbd3
063806
671838

2.59.4 See also

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