Blame Manuals/en/Html/Repository/repository_46.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>
63f275
<title>CentOS Artwork Repository: 3.43 trunk/Scripts/Bash/Functions/Render/Config</title>
4c79b5
63f275
<meta name="description" content="CentOS Artwork Repository: 3.43 trunk/Scripts/Bash/Functions/Render/Config">
63f275
<meta name="keywords" content="CentOS Artwork Repository: 3.43 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
63f275
[ < ]
63f275
[ > ]
4c79b5
   
4c79b5
[ << ]
4c79b5
[ Up ]
63f275
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
63f275
[Index]
4c79b5
[ ? ]
4c79b5
63f275
63f275
63f275

3.43 trunk/Scripts/Bash/Functions/Render/Config

cb2a5d
300762
63f275
fe989b

3.43.1 Goals

fe989b
63f275

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

63f275
pre-rendering configuration scripts.
54b5a5

915635
63f275
008ee0

3.43.2 Description

915635
63f275

Pre-rendering configuration scripts let you customize the way

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

63f275

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

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

54b5a5
63f275
63f275

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

54b5a5
63f275

Inside CentOS Artwork Repository, we consider identity entries to all

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

63f275

Inside identity pre-rendering configuration scripts, image-based

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

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

Inside identity pre-rendering configuration scripts, text-based

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

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

When using identity pre-rendering configuration scripts, you can

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

54b5a5
63f275
63f275

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

54b5a5
63f275

Translation pre-rendering configuration scripts take precedence before

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

54b5a5
63f275
63f275

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

54b5a5
63f275

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

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

63f275

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

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

63f275

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

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

63f275
ACTIONS[0]='BASE:renderImage'
63f275
63f275

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

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

63f275

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

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

63f275

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

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

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

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

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

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

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

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

63f275
info

Note

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

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

63f275
63f275

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

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

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

3.43.3 Usage

081970
63f275

Use the following commands to administer both identity and translation

63f275
pre-rendering configuration scripts:
54b5a5

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

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

63f275
configuration script.
54b5a5

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

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

63f275
configuration script.  
54b5a5

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

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

63f275
configuration script.  
54b5a5

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

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

63f275
configuration script.
54b5a5

54b5a5
54b5a5
915635
63f275

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

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

54b5a5
63f275
4c79b5

3.43.4 See also

4c79b5
54b5a5
63f275
3.36 trunk/Scripts/Bash  
63f275
63f275
3.37 trunk/Scripts/Bash/Functions  
54b5a5
63f275
3.42 trunk/Scripts/Bash/Functions/Render  
54b5a5
54b5a5
4c79b5
4c79b5
4c79b5
63f275
[ < ]
63f275
[ > ]
4c79b5
   
4c79b5
[ << ]
63f275
[ Up ]
63f275
[ >> ]
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>