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>
273af8
<title>CentOS Artwork Repository: 3.43 trunk/Scripts/Bash/Functions/Render/Config</title>
4c79b5
273af8
<meta name="description" content="CentOS Artwork Repository: 3.43 trunk/Scripts/Bash/Functions/Render/Config">
273af8
<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
e68a7a
[ < ]
e68a7a
[ > ]
4c79b5
   
4c79b5
[ << ]
4c79b5
[ Up ]
273af8
[ >> ]
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
   
4c79b5
[Top]
4c79b5
[Contents]
273af8
[Index]
4c79b5
[ ? ]
4c79b5
273af8
e68a7a
273af8

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

cb2a5d
300762
e68a7a
fe989b

3.43.1 Goals

fe989b
273af8

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

273af8
pre-rendering configuration scripts.
54b5a5

915635
e68a7a
008ee0

3.43.2 Description

915635
273af8

Pre-rendering configuration scripts let you customize the way

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

273af8

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

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

273af8
273af8
273af8

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

273af8
273af8

Inside CentOS Artwork Repository, we consider identity entries to all

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

273af8

Inside identity pre-rendering configuration scripts, image-based

273af8
pre-rendering configuration scripts look like the following:
273af8

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

Inside identity pre-rendering configuration scripts, text-based

273af8
pre-rendering configuration scripts look like the following:
273af8

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

When using identity pre-rendering configuration scripts, you can

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

273af8
273af8
273af8

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

273af8
273af8

Translation pre-rendering configuration scripts take precedence before

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

54b5a5
273af8
273af8

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

273af8
273af8

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

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

273af8

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

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

273af8

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

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

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

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

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

273af8

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

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

273af8

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

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

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

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

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

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

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

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

273af8
info

Note

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

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

63f275
273af8

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

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

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

3.43.3 Usage

081970
273af8

Use the following commands to administer both identity and translation

273af8
pre-rendering configuration scripts:
273af8

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

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

273af8
configuration script.
60c152

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

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

273af8
configuration script.  
273af8

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

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

273af8
configuration script.  
273af8

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

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

273af8
configuration script.
60c152

273af8
273af8
273af8
273af8

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

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

54b5a5
273af8
4c79b5

3.43.4 See also

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