Blame Identity/Manual/repository-html/repository_2.69.html

728c6d
728c6d
<html>
728c6d
728c6d
organization, and administration of CentOS Artwork Repository.
728c6d
728c6d
Copyright C 2009-2011 Alain Reguera Delgado
728c6d
728c6d
Permission is granted to copy, distribute and/or modify this document
728c6d
under the terms of the GNU Free Documentation License, Version 1.2 or
728c6d
any later version published by the Free Software Foundation; with no
728c6d
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
728c6d
copy of the license is included in the section entitled GNU Free
728c6d
Documentation License.  
728c6d
-->
728c6d
728c6d
728c6d
Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
728c6d
            Karl Berry  <karl@freefriends.org>
728c6d
            Olaf Bachmann <obachman@mathematik.uni-kl.de>
728c6d
            and many others.
728c6d
Maintained by: Many creative people <dev@texi2html.cvshome.org>
728c6d
Send bugs and suggestions to <users@texi2html.cvshome.org>
728c6d
728c6d
-->
728c6d
<head>
728c6d
<title>CentOS Artwork Repository: 2.69 The trunk/Scripts/Functions/Render/Config Directory</title>
728c6d
728c6d
<meta name="description" content="CentOS Artwork Repository: 2.69 The trunk/Scripts/Functions/Render/Config Directory">
728c6d
<meta name="keywords" content="CentOS Artwork Repository: 2.69 The trunk/Scripts/Functions/Render/Config Directory">
728c6d
<meta name="resource-type" content="document">
728c6d
<meta name="distribution" content="global">
728c6d
<meta name="Generator" content="texi2html 1.76">
728c6d
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
728c6d
<style type="text/css">
728c6d
728c6d
/* CSS
728c6d
 *
728c6d
 * repository.css -- This file provides visual style for repository
728c6d
 * documentation manual in HTML format, as output by Texi2html
728c6d
 * program.
728c6d
 *
728c6d
 * Copyright (C) 2009-2011 Alain Reguera Delgado
728c6d
 *
728c6d
 * This program is free software; you can redistribute it and/or
728c6d
 * modify it under the terms of the GNU General Public License as
728c6d
 * published by the Free Software Foundation; either version 2 of the
728c6d
 * License, or (at your option) any later version.
728c6d
 * 
728c6d
 * This program is distributed in the hope that it will be useful, but
728c6d
 * WITHOUT ANY WARRANTY; without even the implied warranty of
728c6d
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
728c6d
 * General Public License for more details.
728c6d
 *
728c6d
 * You should have received a copy of the GNU General Public License
728c6d
 * along with this program; if not, write to the Free Software
728c6d
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
728c6d
 * USA.
728c6d
 * ----------------------------------------------------------------------
728c6d
 * $Id$
728c6d
 * ----------------------------------------------------------------------
728c6d
 */
728c6d
728c6d
@import url("/home/centos/artwork/trunk/Identity/Webenv/Css/base.css");
728c6d
@import url("/home/centos/artwork/trunk/Identity/Webenv/Css/base-app.css");
728c6d
728c6d
a.summary-letter {text-decoration: none}
728c6d
pre.display {font-family: serif}
728c6d
pre.format {font-family: serif}
728c6d
pre.menu-comment {font-family: serif}
728c6d
pre.menu-preformatted {font-family: serif}
728c6d
pre.smalldisplay {font-family: serif; font-size: smaller}
728c6d
pre.smallexample {font-size: smaller}
728c6d
pre.smallformat {font-family: serif; font-size: smaller}
728c6d
pre.smalllisp {font-size: smaller}
728c6d
span.sansserif {font-family:sans-serif; font-weight:normal;}
728c6d
ul.toc {list-style: none}
728c6d
-->
728c6d
</style>
728c6d
728c6d
728c6d
</head>
728c6d
728c6d
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
728c6d
728c6d
728c6d
[ < ]
728c6d
[ > ]
728c6d
   
728c6d
[Contents]
728c6d
[Index]
728c6d
[ ? ]
728c6d
728c6d
728c6d
728c6d

2.69 The <tt>`trunk/Scripts/Functions/Render/Config'</tt> Directory

728c6d
    728c6d
    2.69.1 Goals 
    728c6d
    2.69.2 Description 
    728c6d
      728c6d
      2.69.2.1 The <tt>`render.conf.sh'</tt> identity model 
      728c6d
      2.69.2.2 The <tt>`render.conf.sh'</tt> translation model 
      728c6d
      2.69.2.3 The <tt>`render.conf.sh'</tt> rendering actions 
      728c6d
      728c6d
      2.69.3 Usage 
      728c6d
      2.69.4 See also 
      728c6d
      728c6d
      728c6d
      728c6d
      728c6d

      2.69.1 Goals

      728c6d
      728c6d

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

      728c6d
      pre-rendering configuration scripts.
      728c6d

      728c6d
      728c6d
      728c6d

      2.69.2 Description

      728c6d
        728c6d
        2.69.2.1 The <tt>`render.conf.sh'</tt> identity model 
        728c6d
        2.69.2.2 The <tt>`render.conf.sh'</tt> translation model 
        728c6d
        2.69.2.3 The <tt>`render.conf.sh'</tt> rendering actions 
        728c6d
        728c6d
        728c6d

        Pre-rendering configuration scripts let you customize the way

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

        728c6d

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

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

        728c6d
        728c6d
        728c6d

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

        728c6d
        728c6d

        Inside CentOS Artwork Repository, we consider identity entries to all

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

        728c6d

        Inside identity pre-rendering configuration scripts, image-based

        728c6d
        pre-rendering configuration scripts look like the following:
        728c6d

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

        Inside identity pre-rendering configuration scripts, text-based

        728c6d
        pre-rendering configuration scripts look like the following:
        728c6d

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

        When using identity pre-rendering configuration scripts, you can

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

        728c6d
        728c6d
        728c6d

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

        728c6d
        728c6d

        Translation pre-rendering configuration scripts take precedence before

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

        728c6d
        728c6d
        728c6d

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

        728c6d
        728c6d

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

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

        728c6d

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

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

        728c6d

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

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

        728c6d
        ACTIONS[0]='BASE:renderImage'
        728c6d
        728c6d

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

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

        728c6d

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

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

        728c6d

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

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

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

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

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

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

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

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

        728c6d
        info

        Note

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

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

        728c6d
        728c6d

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

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

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

        2.69.3 Usage

        728c6d
        728c6d

        Use the following commands to administer both identity and translation

        728c6d
        pre-rendering configuration scripts:
        728c6d

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

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

        728c6d
        configuration script.
        728c6d

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

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

        728c6d
        configuration script.  
        728c6d

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

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

        728c6d
        configuration script.  
        728c6d

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

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

        728c6d
        configuration script.
        728c6d

        728c6d
        728c6d
        728c6d
        728c6d

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

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

        728c6d
        728c6d
        728c6d

        2.69.4 See also

        728c6d
        728c6d
        728c6d
        728c6d
        728c6d
        [Contents]
        728c6d
        [Index]
        728c6d
        [ ? ]
        728c6d
        728c6d

        728c6d
         <font size="-1">
        728c6d
          This document was generated on March, 30 2011 using texi2html 1.76.
        728c6d
         </font>
        728c6d
         
        728c6d
        728c6d

        728c6d
        </body>
        728c6d
        </html>