diff --git a/Manuals/Filesystem/filesystem-html/filesystem_3.html b/Manuals/Filesystem/filesystem-html/filesystem_3.html index 89518d3..c3ab6b3 100644 --- a/Manuals/Filesystem/filesystem-html/filesystem_3.html +++ b/Manuals/Filesystem/filesystem-html/filesystem_3.html @@ -171,25 +171,25 @@ ul.toc {list-style: none} </td></tr> <tr><td align="left" valign="top"><a href="filesystem_52.html#SEC263">3.49 trunk/Scripts/Bash/centos-art/Functions</a></td><td> </td><td align="left" valign="top"> </td></tr> -<tr><td align="left" valign="top"><a href="filesystem_53.html#SEC268">3.50 trunk/Scripts/Bash/Functions</a></td><td> </td><td align="left" valign="top"> +<tr><td align="left" valign="top"><a href="filesystem_53.html#SEC271">3.50 trunk/Scripts/Bash/centos-art/Functions/Help</a></td><td> </td><td align="left" valign="top"> </td></tr> -<tr><td align="left" valign="top"><a href="filesystem_54.html#SEC276">3.51 trunk/Scripts/Bash/Functions/Html</a></td><td> </td><td align="left" valign="top"> +<tr><td align="left" valign="top"><a href="filesystem_54.html#SEC276">3.51 trunk/Scripts/Bash/centos-art/Functions/Html</a></td><td> </td><td align="left" valign="top"> </td></tr> -<tr><td align="left" valign="top"><a href="filesystem_55.html#SEC281">3.52 trunk/Scripts/Bash/Functions/Locale</a></td><td> </td><td align="left" valign="top"> +<tr><td align="left" valign="top"><a href="filesystem_55.html#SEC281">3.52 trunk/Scripts/Bash/centos-art/Functions/Locale</a></td><td> </td><td align="left" valign="top"> </td></tr> -<tr><td align="left" valign="top"><a href="filesystem_56.html#SEC286">3.53 trunk/Scripts/Bash/Functions/Manual</a></td><td> </td><td align="left" valign="top"> +<tr><td align="left" valign="top"><a href="filesystem_56.html#SEC286">3.53 trunk/Scripts/Bash/centos-art/Functions/Manual</a></td><td> </td><td align="left" valign="top"> </td></tr> -<tr><td align="left" valign="top"><a href="filesystem_57.html#SEC291">3.54 trunk/Scripts/Bash/Functions/Path</a></td><td> </td><td align="left" valign="top"> +<tr><td align="left" valign="top"><a href="filesystem_57.html#SEC291">3.54 trunk/Scripts/Bash/centos-art/Functions/Path</a></td><td> </td><td align="left" valign="top"> </td></tr> -<tr><td align="left" valign="top"><a href="filesystem_58.html#SEC302">3.55 trunk/Scripts/Bash/Functions/Render</a></td><td> </td><td align="left" valign="top"> +<tr><td align="left" valign="top"><a href="filesystem_58.html#SEC302">3.55 trunk/Scripts/Bash/centos-art/Functions/Render</a></td><td> </td><td align="left" valign="top"> </td></tr> -<tr><td align="left" valign="top"><a href="filesystem_59.html#SEC312">3.56 trunk/Scripts/Bash/Functions/Render/Config</a></td><td> </td><td align="left" valign="top"> +<tr><td align="left" valign="top"><a href="filesystem_59.html#SEC312">3.56 trunk/Scripts/Bash/centos-art/Functions/Render/Config</a></td><td> </td><td align="left" valign="top"> </td></tr> -<tr><td align="left" valign="top"><a href="filesystem_60.html#SEC320">3.57 trunk/Scripts/Bash/Functions/Shell</a></td><td> </td><td align="left" valign="top"> +<tr><td align="left" valign="top"><a href="filesystem_60.html#SEC320">3.57 trunk/Scripts/Bash/centos-art/Functions/Shell</a></td><td> </td><td align="left" valign="top"> </td></tr> -<tr><td align="left" valign="top"><a href="filesystem_61.html#SEC325">3.58 trunk/Scripts/Bash/Functions/Svg</a></td><td> </td><td align="left" valign="top"> +<tr><td align="left" valign="top"><a href="filesystem_61.html#SEC325">3.58 trunk/Scripts/Bash/centos-art/Functions/Svg</a></td><td> </td><td align="left" valign="top"> </td></tr> -<tr><td align="left" valign="top"><a href="filesystem_62.html#SEC332">3.59 trunk/Scripts/Bash/Functions/Verify</a></td><td> </td><td align="left" valign="top"> +<tr><td align="left" valign="top"><a href="filesystem_62.html#SEC332">3.59 trunk/Scripts/Bash/centos-art/Functions/Verify</a></td><td> </td><td align="left" valign="top"> </td></tr> <tr><td align="left" valign="top"><a href="filesystem_63.html#SEC340">3.60 trunk/Scripts/Bash/Locale</a></td><td> </td><td align="left" valign="top"> </td></tr> diff --git a/Manuals/Filesystem/filesystem-html/filesystem_50.html b/Manuals/Filesystem/filesystem-html/filesystem_50.html index 8bbf56b..ad774ba 100644 --- a/Manuals/Filesystem/filesystem-html/filesystem_50.html +++ b/Manuals/Filesystem/filesystem-html/filesystem_50.html @@ -99,7 +99,8 @@ operating system trys to execute that command. In order to execute the command, the operating system needs to know where it is, so the operating system uses the <var>PATH</var> environment variable to look for that command location. If your system was prepared to use CentOS -Artwork Repository correctly (see section <a href="filesystem_62.html#SEC332">trunk/Scripts/Bash/Functions/Verify</a>), you should have a symbolic link inside <tt>`~/bin/'</tt> +Artwork Repository correctly (-- <strong>Removed</strong>(pxref:trunk Scripts Bash Functions +Verify) --), you should have a symbolic link inside <tt>`~/bin/'</tt> directory that points to the <tt>`centos-art.sh'</tt> script file. As <tt>`~/bin/'</tt> directory is, by default, inside <var>PATH</var> environment variable, the execution of <code>centos-art</code> command runs the @@ -118,7 +119,7 @@ script execution environment. <tt>`centos-art.sh'</tt> script executes the <code>cli</code> global function from <tt>`cli.sh'</tt> function script to retrive command-line arguments and define some default values that may be used later by specific -function scripts (see section <a href="filesystem_53.html#SEC268">trunk/Scripts/Bash/Functions</a>). +function scripts (-- <strong>Removed</strong>(pxref:trunk Scripts Bash Functions) --). </p> <p>As convenction, the <tt>`centos-art.sh'</tt> command-line arguments have the following format: @@ -218,7 +219,8 @@ variables and functions defined inside function environment. <h3 class="subsection"> 3.47.3 Usage </h3> <p>The <tt>`centos-art.sh'</tt> script usage information is described inside -each specific function documentation (see section <a href="filesystem_53.html#SEC268">trunk/Scripts/Bash/Functions</a>). +each specific function documentation (-- <strong>Removed</strong>(pxref:trunk Scripts Bash +Functions) --). </p> <a name="SEC261"></a> @@ -227,8 +229,6 @@ each specific function documentation (see section <a href="filesystem_53.html#SE <table class="menu" border="0" cellspacing="0"> <tr><td align="left" valign="top"><a href="filesystem_49.html#SEC252">3.46 trunk/Scripts</a></td><td> </td><td align="left" valign="top"> </td></tr> -<tr><td align="left" valign="top"><a href="filesystem_53.html#SEC268">3.50 trunk/Scripts/Bash/Functions</a></td><td> </td><td align="left" valign="top"> -</td></tr> <tr><td align="left" valign="top"><a href="filesystem_63.html#SEC340">3.60 trunk/Scripts/Bash/Locale</a></td><td> </td><td align="left" valign="top"> </td></tr> </table> diff --git a/Manuals/Filesystem/filesystem-html/filesystem_52.html b/Manuals/Filesystem/filesystem-html/filesystem_52.html index 37503de..10ccdec 100644 --- a/Manuals/Filesystem/filesystem-html/filesystem_52.html +++ b/Manuals/Filesystem/filesystem-html/filesystem_52.html @@ -75,35 +75,1271 @@ ul.toc {list-style: none} <a name="SEC264"></a> <h3 class="subsection"> 3.49.1 Goals </h3> -<ul class="toc"> -<li> ... -</li></ul> - +<p>The <tt>`trunk/Scripts/Bash/Functions'</tt> directory exists to organize +<tt>`centos-art.sh'</tt> specific functionalities. +</p> <a name="SEC265"></a> <h3 class="subsection"> 3.49.2 Description </h3> -<ul class="toc"> -<li> ... -</li></ul> +<p>The specific functions of <tt>`centos-art.sh'</tt> script are designed +with "Software Toolbox" philosophy (see <a href="../coreutils/Toolbox-introduction.html#Toolbox-introduction">(coreutils.info)Toolbox introduction</a>) in mind: each program "should do one +thing well". Inside <tt>`centos-art.sh'</tt> script, each specific +functionality is considered a program that should do one thing well. +Of course, if you find that they still don't do it, feel free to +improve them in order for them to do so. +</p> +<p>The specific functions of <tt>`centos-art.sh'</tt> script are organized +inside specific directories under <tt>`trunk/Scripts/Bash/Functions'</tt> +location. Each specific function directory should be named as the +function it represents, with the first letter in uppercase. For +example, if the function name is <code>render</code>, the specific function +directory for it would be <samp>`trunk/Scripts/Bash/Functions/Render'</samp>. +</p> +<p>To better understand how specific functions of <tt>`centos-art.sh'</tt> +script are designed, lets create one function which only goal is to +output different kind of greetings to your screen. +</p> +<p>When we create specific functions for <tt>`centos-art.sh'</tt> script it +is crucial to know what these functions will do exactly and if there +is any function that already does what we intend to do. If there is no +one, it is good time to create them then. Otherwise, if +functionalities already available don't do what you exactly expect, +contact their authors and work together to improve them. +</p> +<blockquote class="orange"><img src="/home/centos/artwork/trunk/Identity/Widgets/Img/icon-admonition-idea.png" alt="Info"><h3>Tip</h3><p> Join CentOS developers mailing list +<a class="mailto" href="mailto:centos-art@centos.org">centos-art@centos.org</a> to share your ideas. +</p></blockquote> + +<p>It is also worth to know what global functions and variables do we +have available inside <tt>`centos-art.sh'</tt> script, so advantage can be +taken from them. Global variables are defined inside global function +scripts. Global functions scripts are stored immediatly under +<tt>`trunk/Scripts/Bash/Functions'</tt> directory, in files begining with +<samp>`cli'</samp> prefix. +</p> +<p>OK, let's begin with our functionality example. +</p> +<p>What function name do we use? Well, lets use <code>greet</code>. Note that +<samp>`hello'</samp> word is not a verb; but an expression, a kind of +greeting, an interjection specifically. In contrast, <samp>`greet'</samp> is a +verb and describes what we do when we say <samp>`Hello!'</samp>, <samp>`Hi!'</samp>, +and similar expressions. +</p> +<p>So far, we've gathered the following function information: +</p> +<pre class="verbatim">Name: greet +Path: trunk/Scripts/Bash/Functions/Greet +File: trunk/Scripts/Bash/Functions/Greet/greet.sh +</pre> +<p>The <tt>`greet.sh'</tt> function script is the first file +<tt>`centos-art.sh'</tt> script loads when the <samp>`greet'</samp> functionality +is called using commands like <samp>`centos-art greet --hello='World''</samp>. +The <tt>`greet.sh'</tt> function script contains the <code>greet</code> function +definition. +</p> +<p>Inside <tt>`centos-art.sh'</tt> script, as convenction, each function +script has one top commentary, followed by one blank line, and then +one function defintion below it only. +</p> +<p>Inside <tt>`centos-art.sh'</tt> script functions, top commentaries have +the following components: the functionality description, one-line for +copyright note with your personal information, the license under +which the function source code is released --the <tt>`centos-art.sh'</tt> +script is released as GPL, so do all its functions--, the <code>$Id$</code> +keyword of Subversion is later expanded by <code>svn propset</code> +command. +</p> +<p>In our <code>greet</code> function example, top commentary for +<tt>`greet.sh'</tt> function script would look like the following: +</p> +<pre class="verbatim">#!/bin/bash +# +# greet.sh -- This function outputs different kind of greetings to +# your screen. Use this function to understand how centos-art.sh +# script specific functionalities work. +# +# Copyright (C) YEAR YOURFULLNAME +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 +# USA. +# +# ---------------------------------------------------------------------- +# $Id$ +# ---------------------------------------------------------------------- +</pre> +<p>After top commentary, separated by one blank line, the <code>greet</code> +function definition would look like the following: +</p> +<pre class="verbatim">function greet { + + # Define global variables. + + # Define command-line interface. + greet_getActions + +} +</pre> +<p>The first definition inside <code>greet</code> function, are global +variables that will be available along <code>greet</code> function execution +environment. This time we didn't use global variable definitions for +<code>greet</code> function execution environment, so we left that section +empty. +</p> +<p>Later, we call <code>greet_getActions</code> function to define the +command-line interface of <code>greet</code> functionality. The command-line +interface of <code>greet</code> functionality defines what and how actions +are performed, based on arguments combination passed to +<tt>`centos-art.sh'</tt> script. +</p> +<pre class="verbatim">function greet_getActions { + + case "$ACTIONNAM" in + --hello ) + greet_doHello + ;; + + --bye ) + greet_doBye + ;; + + * ) + cli_printMessage "`gettext "The option provided is not valid."`" + cli_printMessage "$(caller)" 'AsToKnowMoreLine' + + esac + +} +</pre> +<p>The <var>ACTIONNAM</var> global variable is defined in <tt>`cli.sh'</tt> +function script and contains the value passed before the equal sign +(i.e., <samp>`='</samp>) in the second command-line argument of +<tt>`centos-art.sh'</tt> script. For example, if the second command-line +argument is <samp>`--hello='World''</samp>, the value of <var>ACTIONNAM</var> +variable would be <samp>`--hello'</samp>. Using this configuration let us +deside which action to perform based on the action name passed to +<tt>`centos-art.sh'</tt> script as second argument. +</p> +<p>The <code>greet</code> function definition makes available two valid +greetings through <samp>`--hello'</samp> and <samp>`--bye'</samp> options. If no +one of them is provided as second command-line argument, the <samp>`*'</samp> +case is evaluated instead. +</p> +<p>The <samp>`*'</samp> case and its two lines further on should always be +present in <tt>`_getActions.sh'</tt> function scripts, no matter what +specific functionality you are creating. This convenction helps the +user to find out documentation about current functionality in use, +when no valid action is provided. +</p> +<p>The <code>greet_doHello</code> and <code>greet_doBye</code> function definitions +are the core of <code>greet</code> specific functionality. In such function +definitions we set what our <code>greet</code> function really does: to +output different kinds of greetings. +</p> +<pre class="verbatim">function greet_doHello { + + cli_printMessage "`gettext "Hello"` $ACTIONVAL" + +} +</pre> +<p>The <code>greet_doHello</code> function definition is stored in +<tt>`greet_doHello.sh'</tt> function script. +</p> +<pre class="verbatim">function greet_doBye { + + cli_printMessage "`gettext "Goodbye"` $ACTIONVAL" + +} +</pre> +<p>The <code>greet_doBye</code> function definition is stored in the +<tt>`greet_doBye.sh'</tt> function script. +</p> +<p>Both <tt>`greet_doHello.sh'</tt> and <tt>`greet_doBye.sh'</tt> function +scripts are stored inside <code>greet</code> function directory path (i.e. +<tt>`trunk/Scripts/Bash/Functions/Greet'</tt>). +</p> +<p>The <var>ACTIONVAL</var> global variable is defined in <tt>`cli.sh'</tt> +function script and contains the value passed after the equal sign +(i.e., <samp>`='</samp>) in the second command-line argument of +<tt>`centos-art.sh'</tt> script. For example, if the second command-line +argument is <samp>`--hello='World''</samp>, the value of <var>ACTIONVAL</var> +variable would be <samp>`World'</samp> without quotes. +</p> +<p>Let's see how <code>greet</code> specific functionality files are organzied +under <code>greet</code> function directory. To see file organization we use +the <code>tree</code> command: +</p> +<pre class="verbatim">trunk/Scripts/Bash/Functions/Greet +|-- greet_doBye.sh +|-- greet_doHello.sh +|-- greet_getActions.sh +`-- greet.sh +</pre> +<p>To try the <code>greet</code> specific functionality we've just created, +pass the function name (i.e., <samp>`greet'</samp>) as first argument to +<tt>`centos-art.sh'</tt> script, and any of the valid options as second +argument. Some examples are illustrated below: +</p> +<pre class="verbatim">[centos@projects ~]$ centos-art greet --hello='World' +Hello World +[centos@projects ~]$ centos-art greet --bye='World' +Goodbye World +[centos@projects ~]$ +</pre> +<p>The word <samp>`World'</samp> in the examples above can be anything. In fact, +change it to have a little fun. +</p> +<p>Now that we have a specific function that works as we expect, it is +time to document it. To document <code>greet</code> specific functionality, +we use its directory path and the <code>manual</code> functionality +(-- <strong>Removed</strong>(pxref:trunk Scripts Bash Functions Manual) --) of <tt>`centos-art.sh'</tt> +script, just as the following command illustrates: +</p> +<pre class="verbatim">centos-art manual --edit=trunk/Scripts/Bash/Functions/Greet +</pre> +<p>To have a well documented function helps user to understand how your +function really works, and how it should be used. When no valid +action is passed to a function, the <tt>`centos-art.sh'</tt> script uses +the function documentation entry as vehicle to communicate which the +valid functions are. When no documentation entry exists for a +function, the <tt>`centos-art.sh'</tt> script informs that no +documentation entry exists for such function and requests user to +create it right at that time. +</p> +<p>Now that we have documented our function, it is time to translate its +output messages to different languages. To translate specific +functionality output messages to different languages we use the +<code>locale</code> functionality (-- <strong>Removed</strong>(pxref:trunk Scripts Bash Functions +Locale) --) of <tt>`centos-art.sh'</tt> script, just as the following command +illustrates: +</p> +<pre class="verbatim">centos-art locale --edit +</pre> +<blockquote class="orange"><img src="/home/centos/artwork/trunk/Identity/Widgets/Img/icon-admonition-alert.png" alt="Warning"><h3>Warning</h3><p> To translate output messages in different languages, +your system locale information --as in <code>LANG</code> environment +variable-- must be set to that locale you want to produce translated +messages for. For example, if you want to produce translated messages +for Spanish language, your system locale information must be set to +<samp>`es_ES.UTF-8'</samp>, or similar, first. +</p></blockquote> + +<p>Well, it seems that our example is rather complete by now. +</p> +<p>In <code>greet</code> function example we've described so far, we only use +<code>cli_printMessage</code> global function in action specific function +definitions in order to print messages, but more interesting things +can be achieved inside action specific function definitions. For +example, if you pass a directory path as action value in second +argument, you could retrive a list of files from therein, and process +them. If the list of files turns too long or you just want to control +which files to process, you could add the third argument in the form +<samp>`--filter='regex''</samp> and reduce the amount of files to process +using a regular expression pattern. +</p> +<p>The <code>greet</code> function described in this section may serve you as +an introduction to understand how specific functionalities work inside +<tt>`centos-art.sh'</tt> script. With some of luck this introduction will +also serve you as motivation to create your own <tt>`centos-art.sh'</tt> +script specific functionalities. +</p> +<p>By the way, the <code>greet</code> functionality doesn't exist inside +<tt>`centos-art.sh'</tt> script yet. Would you like to create it? +</p> <a name="SEC266"></a> <h3 class="subsection"> 3.49.3 Usage </h3> + +<a name="SEC267"></a> +<h4 class="subsubsection"> 3.49.3.1 Global variables </h4> + +<p>The following global variables of <tt>`centos-art.sh'</tt> script, are +available for you to use inside specific functions: +</p> +<dl> +<dt><u>Variable:</u> <b>TEXTDOMAIN</b> +<a name="IDX1"></a> +</dt> +<dd><p>Default domain used to retrieve translated messages. This value is set +in <tt>`initFunctions.sh'</tt> and shouldn't be changed. +</p></dd></dl> + +<dl> +<dt><u>Variable:</u> <b>TEXTDOMAINDIR</b> +<a name="IDX2"></a> +</dt> +<dd><p>Default directory used to retrieve translated messages. This value is +set in <tt>`initFunctions.sh'</tt> and shouldn't be changed. +</p></dd></dl> + +<dl> +<dt><u>Variable:</u> <b>FUNCNAM</b> +<a name="IDX3"></a> +</dt> +<dd><p>Define function name. +</p> +<p>Function names associate sets of actions. There is one set of actions +for each unique function name inside <tt>`centos-art.sh'</tt> script. +</p> +<p>Dunction names are passed as first argument in <tt>`centos-art.sh'</tt> +command-line interface. For example, in the command <samp>`centos-art +render --entry=path/to/dir --filter=regex'</samp>, the <var>ACTION</var> passed to +<tt>`centos-art.sh'</tt> script is <samp>`render'</samp>. +</p> +<p>When first argument is not provided, the <tt>`centos-art.sh'</tt> script +immediatly ends its execution. +</p></dd></dl> + +<dl> +<dt><u>Variable:</u> <b>FUNCDIR</b> +<a name="IDX4"></a> +</dt> +</dl> + +<dl> +<dt><u>Variable:</u> <b>FUNCDIRNAME</b> +<a name="IDX5"></a> +</dt> +</dl> + +<dl> +<dt><u>Variable:</u> <b>FUNCSCRIPT</b> +<a name="IDX6"></a> +</dt> +</dl> + +<dl> +<dt><u>Variable:</u> <b>FUNCCONFIG</b> +<a name="IDX7"></a> +</dt> +</dl> + +<dl> +<dt><u>Variable:</u> <b>ACTIONNAM</b> +<a name="IDX8"></a> +</dt> +<dd><p>Define action name. +</p> +<p>Each action name identifies an specific action to perform, inside an +specific function. +</p> +<p>Action name names aare passed as second argument in +<tt>`centos-art.sh'</tt> command-line interface. For example, in the +command <samp>`centos-art render --entry=path/to/dir --filter=regex'</samp>, +the <var>ACTIONNAM</var> passed to <tt>`centos-art.sh'</tt> script is +<samp>`--entry'</samp>. +</p> +<p>When second argument is not provided, the <tt>`centos-art.sh'</tt> script +immediatly ends its execution. +</p></dd></dl> + +<dl> +<dt><u>Variable:</u> <b>ACTIONVAL</b> +<a name="IDX9"></a> +</dt> +<dd><p>Define action value. +</p> +<p>Action values are associated to just one action name. Action values +contain the working copy entry over which its associated action will be +performed in. Working copy entries can be files or directories inside +the working copy. +</p></dd></dl> + +<dl> +<dt><u>Variable:</u> <b>REGEX</b> +<a name="IDX10"></a> +</dt> +<dd><p>Define regular expression used as pattern to build the list of files +to process. +</p> +<p>By default, <var>REGEX</var> variable is set to <code>.+</code> to match all +files. +</p> +<p>Functions that need to build a list of files to process use the option +<samp>`--filter'</samp> to redefine <var>REGEX</var> variable default value, and +so, control the amount of files to process. +</p></dd></dl> + +<dl> +<dt><u>Variable:</u> <b>ARGUMENTS</b> +<a name="IDX11"></a> +</dt> +<dd><p>Define optional arguments. +</p> +<p>Optional arguments, inside <tt>`centos-art.sh'</tt> script, are considered +as all command-line arguments passed to <tt>`centos-art.sh'</tt> script, +from third argument position on. For example, in the command +<samp>`centos-art render --entry=path/to/dir --filter=regex'</samp> , the +optional arguments are from <samp>`--filter=regex'</samp> argument on. +</p> +<p>Optional arguments are parsed using <code>getopt</code> command through +the following base construction: +</p> +<pre class="verbatim"># Define short options we want to support. +local ARGSS="" + +# Define long options we want to support. +local ARGSL="filter:,to:" + +# Parse arguments using getopt(1) command parser. +cli_doParseArguments + +# Reset positional parameters using output from (getopt) argument +# parser. +eval set -- "$ARGUMENTS" + +# Define action to take for each option passed. +while true; do + case "$1" in + --filter ) + REGEX="$2" + shift 2 + ;; + --to ) + TARGET="$2" + shift 2 + ;; + * ) + break + esac +done +</pre> +<p>Optional arguments provide support to command options inside +<tt>`centos-art.sh'</tt> script. For instance, consider the Subversion +(<code>svn</code>) command, where there are many options (e.g., +<samp>`copy'</samp>, <samp>`delete'</samp>, <samp>`move'</samp>, etc), and inside each +option there are several modifiers (e.g., <samp>`--revision'</samp>, +<samp>`--message'</samp>, <samp>`--username'</samp>, etc.) that can be combined one +another in their short or long variants. +</p> +<p>The <var>ARGUMENTS</var> variable is used to store arguments passed from +command-line for later use inside <tt>`centos-art.sh'</tt> script. Storing +arguments is specially useful when we want to run a command with some +specific options from them. Consider the following command: +</p> +<pre class="verbatim">centos-art path --copy=SOURCE --to=TARGET --message="The commit message goes here." --username='johndoe' +</pre> +<p>In the above command, the <samp>`--message'</samp>, and <samp>`--username'</samp> +options are specific to <code>svn copy</code> command. In such cases, +options are not interpreted by <tt>`centos-art.sh'</tt> script itself. +Instead, the <tt>`centos-art.sh'</tt> script uses <code>getopt</code> to +retrive them and store them in the <var>ARGUMENTS</var> variable for later +use, as described in the following command: +</p> +<pre class="verbatim"># Build subversion command to duplicate locations inside the +# workstation. +eval svn copy $SOURCE $TARGET --quiet $ARGUMENTS +</pre> +<p>When <code>getopt</code> parses <var>ARGUMENTS</var>, we may use short options +(e.g., <samp>`-m'</samp>) or long options (e.g., <samp>`--message'</samp>). When +we use short options, arguments are separated by one space from the +option (e.g., <samp>`-m 'This is a commit message.''</samp>). When we use +long options arguments are separated by an equal sign (<samp>`='</samp>) +(e.g., <samp>`--message='This is a commit message''</samp>). +</p> +<p>In order for <code>getopt</code> to parse <var>ARGUMENTS</var> correctly, it +is required to provide the short and long definition of options that +will be passed or at least supported by the command performing the +final action the function script exists for. +</p> +<p>As convenction, inside <tt>`centos-art.sh'</tt> script, short option +definitions are set in the <var>ARGSS</var> variable; and long option +definitions are set in the <var>ARGSL</var> variable. +</p> +<p>When you define short and long options, it may be needed to define +which of these option arguments are required and which not. To define +an option argument as required, you need to set one colon <samp>`:'</samp> +after the option definition (e.g., <samp>`-o m: -l message:'</samp>). On +the other hand, to define an option argument as not required, you need +to set two colons <samp>`::'</samp> after the option definition (e.g., +<samp>`-o m:: -l message::'</samp>). +</p></dd></dl> + +<dl> +<dt><u>Variable:</u> <b>EDITOR</b> +<a name="IDX12"></a> +</dt> +<dd><p>Default text editor. +</p> +<p>The <tt>`centos-art.sh'</tt> script uses default text <code>EDITOR</code> to edit +pre-commit subversion messages, translation files, configuration +files, script files, and similar text-based files. +</p> +<p>If <code>EDITOR</code> environment variable is not set, <tt>`centos-art.sh'</tt> +script uses <tt>`/usr/bin/vim'</tt> as default text editor. Otherwise, the +following values are recognized by <tt>`centos-art.sh'</tt> script: +</p> <ul class="toc"> -<li> ... +<li> <tt>`/usr/bin/vim'</tt> +</li><li> <tt>`/usr/bin/emacs'</tt> +</li><li> <tt>`/usr/bin/nano'</tt> </li></ul> +<p>If no one of these values is set in <code>EDITOR</code> environment variable, +<tt>`centos-art.sh'</tt> uses <tt>`/usr/bin/vim'</tt> text editor by default. +</p></dd></dl> -<a name="SEC267"></a> + +<a name="SEC268"></a> +<h4 class="subsubsection"> 3.49.3.2 Global functions </h4> + +<p>Function scripts stored directly under +<tt>`trunk/Scripts/Bash/Functions/'</tt> directory are used to define +global functions. Global functions can be used inside action specific +functionalities and or even be reused inside themselves. This section +provides introductory information to global functions you can use +inside <tt>`centos-art.sh'</tt> script. +</p> +<dl> +<dt><u>Function:</u> <b>cli_checkActionArguments</b> +<a name="IDX13"></a> +</dt> +<dd><p>Validate action value (<var>ACTIONVAL</var>) variable. +</p> +<p>The action value variable can take one of the following values: +</p> +<ol> +<li> Path to one directory inside the local working copy, +</li><li> Path to one file inside the local working copy, +</li></ol> + +<p>If another value different from that specified above is passed to +action value variable, the <tt>`centos-art.sh'</tt> script prints an error +message and ends script execution. +</p></dd></dl> + +<dl> +<dt><u>Function:</u> <b>cli_checkFiles</b><i> FILE [TYPE]</i> +<a name="IDX14"></a> +</dt> +<dd><p>Verify file existence. +</p> +<p><code>cli_checkFiles</code> receives a <var>FILE</var> absolute path and performs +file verification as specified in <var>TYPE</var>. When <var>TYPE</var> is not +specified, <code>cli_checkFiles</code> verifies <var>FILE</var> existence, no +matter what kind of file it be. If <var>TYPE</var> is specified, use one +of the following values: +</p> +<dl compact="compact"> +<dt> <samp>`d'</samp></dt> +<dt> <samp>`directory'</samp></dt> +<dd><p>Ends script execution if <var>FILE</var> is not a directory. +</p> +<p>When you verify directories with cli_checkFiles, if directory doesn't +exist, <tt>`centos-art.sh'</tt> script asks you for confirmation in order +to create that directory. If you answer positively, +<tt>`centos-art.sh'</tt> script creates that directory and continues +script flows normally. Otherwise, if you answer negatively, +<tt>`centos-art.sh'</tt> ends script execution with an error and +documentation message. +</p> +</dd> +<dt> <samp>`f'</samp></dt> +<dt> <samp>`regular-file'</samp></dt> +<dd><p>Ends script execution if <var>FILE</var> is not a regular file. +</p></dd> +<dt> <samp>`h'</samp></dt> +<dt> <samp>`symbolic-link'</samp></dt> +<dd><p>Ends script execution if <var>FILE</var> is not a symbolic link. +</p></dd> +<dt> <samp>`x'</samp></dt> +<dt> <samp>`execution'</samp></dt> +<dd><p>Ends script execution if <var>FILE</var> is not executable. +</p></dd> +<dt> <samp>`fh'</samp></dt> +<dd><p>Ends script execution if <var>FILE</var> is neither a regular file nor a +symbolic link. +</p></dd> +<dt> <samp>`fd'</samp></dt> +<dd><p>Ends script execution if <var>FILE</var> is neither a regular file nor a +directory. +</p></dd> +<dt> <samp>`isInWorkingCopy'</samp></dt> +<dd><p>Ends script execution if <var>FILE</var> is not inside the working copy. +</p></dd> +</dl> + +<p>As default behaviour, if <var>FILE</var> passes all verifications, +<tt>`centos-art.sh'</tt> script continues with its normal flow. +</p></dd></dl> + +<dl> +<dt><u>Function:</u> <b>cli_commitRepoChanges</b><i> [LOCATION]</i> +<a name="IDX15"></a> +</dt> +<dd><p>Syncronize changes between repository and working copy. +</p> +<p>The <code>cli_commitRepoChanges</code> function brings changes from the +central repository down to the working copy--using <code>svn +update</code>--, checks the working copy changes--using <code>svn +status</code> command--, prints status report--using both <code>svn +update</code> and <code>svn status</code> commands output, and finally, commits +recent changes from the working copy up to the repository--using +<code>svn commit</code> command--. +</p> +<p>Previous to commit the working copy changes up to the central +repository, the <code>cli_commitRepoChanges</code> function asks you to +verify changes--using <code>svn diff</code> command--, and later, +another confirmation question is shown to be sure you really want to +commit changes up to central repository. +</p> +<p>If <var>LOCATION</var> argument is not specified, the value of +<var>ACTIONVAL</var> variable is used as reference instead. +</p> +<div class="float"><a name="trunk_002fScripts_002fBash_002fFunctions_002fcli_005fcommitRepoChanges"></a> +<pre class="verbatim">---------------------------------------------------------------------- +--> Bringing changes from the repository into the working copy +--> Checking changes in the working copy +---------------------------------------------------------------------- +Added 0 file from the repository. +Deleted 0 file from the repository. +Updated 0 file from the repository. +Conflicted 0 file from the repository. +Merged 0 file from the repository. +Modified 4 files from the working copy. +Unversioned 0 file from the working copy. +Deleted 0 file from the working copy. +Added 0 file from the working copy. +---------------------------------------------------------------------- +</pre> +</div><p><strong>Figure 3.3: The <code>cli_commitRepoChanges</code> function output. +</strong> +</p> +<p>Call the <code>cli_commitRepoChanges</code> function before or/and after +calling functions that modify files or directories inside the working +copy as you may need to. +</p></dd></dl> + +<dl> +<dt><u>Function:</u> <b>cli_doParseArguments</b> +<a name="IDX16"></a> +</dt> +<dd><p>Redefine arguments (<var>ARGUMENTS</var>) global variable using +<code>getopt</code> command output. For more information about how to use +<code>cli_doParseArguments</code> function, see <var>ARGUMENTS</var> variable +description above. +</p></dd></dl> + +<dl> +<dt><u>Function:</u> <b>cli_doParseArgumentsReDef</b><i> $@</i> +<a name="IDX17"></a> +</dt> +<dd><p>Initialize/reset arguments (<var>ARGUMENTS</var>) global variable using +positional parameters variable (<var>$@</var>) as reference. +</p> +<p>When we work inside function definitions, positional parameters are +reset to the last function definition positional parameters. If you +need to redefine positional parameters from one specific function, you +need to call <code>cli_doParseArgumentsReDef</code> with the positional +parameters variable (<var>$@</var>), set as first argument, to that +specific function you want to redefine positional parameters at. +</p></dd></dl> + +<dl> +<dt><u>Function:</u> <b>cli_getArguments</b> +<a name="IDX18"></a> +</dt> +<dd><p>Initialize function name (<var>FUNCNAM</var>), action name +(<var>ACTIONNAM</var>), and action value (<var>ACTIONVAL</var>) global +variables, using positional parameters passed in <var>$@</var> variable. +</p> +<p>The <code>cli_getArguments</code> function is called from <code>cli.sh</code> +function script, using <code>cli</code> function positional parameters +(i.e., the positional parameters passed as arguments in the +command-line) as first function argument. +</p> +<p>Once command-line positional parameters are accesible to +<tt>`centos-art.sh'</tt> script execution evironment, +<code>cli_getArguments</code> uses regular expression to retrive +action variables from first and second argument. The first argument +defines the value used as function name (<var>FUNCNAM</var>), and the +second argument defines both values used as action name +(<var>ACTIONNAM</var>) and action value (<var>ACTIONVAL</var>), respectively. +</p> +<p>The first argument is a word in lower case. This word specifies the +name of the functionality you want to use (e.g., <samp>`render'</samp> to +render images, <samp>`manual'</samp> to work on documentation, and so on.) +</p> +<p>The second argument has a long option style (e.g., +<samp>`--option=value'</samp>). The <samp>`--option'</samp> represents the action name +(<var>ACTIONNAM</var>), and the characters inbetween the equal sign +(<samp>`='</samp>) and the first space character, are considered as the action +value (<var>ACTIONVAL</var>). In order to provide action values with space +characters inbetween you need to enclose action value with quotes like +in <samp>`--option='This is long value with spaces inbetween''</samp>. +Generally, action values are used to specify paths over which the +action name acts on. +</p> +<p>Once action related variables (i.e., <var>FUNCNAM</var>, <var>ACTIONNAM</var>, +and <var>ACTIONVAL</var>) are defined and validated, +<code>cli_getArguments</code> shifts the positional arguments to remove the +first two arguments passed (i.e., those used to retrive action related +variables) and redefine the arguments (<var>ARGUMENTS</var>) global +variable with the new positional parameters information. +</p></dd></dl> + +<dl> +<dt><u>Function:</u> <b>cli_getFunctions</b> +<a name="IDX19"></a> +</dt> +<dd><p>Initialize funtionalities supported by <tt>`centos-art.sh'</tt> script. +</p> +<p>Functionalities supported by <tt>`centos-art.sh'</tt> script are organized +in functionality directories under +<tt>`trunk/Scripts/Bash/Functions/'</tt> directory. Each functionality +directory stores function scripts to the functionality such directory +was created for. Function scripts contain function definitions. +Function definitions contain several commands focused on achieving one +specific task only (i.e., the one such functionality was created for). +</p> +<p>In order for <tt>`centos-art.sh'</tt> script to recognize a functionality, +such functionality needs to be stored under +<tt>`trunk/Scripts/Bash/Functions/'</tt> in a directory written +capitalized (i.e., the whole name is written in lowercase except the +first character which is in uppercase). The directory where one +specific functionality is stored is known as the <samp>`functionality +directory'</samp>. +</p> +<p>Inside each functionality directory, the functionalty itself is +implemented through function scripts. Function scripts are organized +in files independently one another and written in <samp>`camelCase'</samp> +format with the function name as prefix. Separation between prefix +and description is done using underscore (<samp>`_'</samp>) character. +</p> +<p>In order for <tt>`centos-art.sh'</tt> script to load functionalities +correctly, function definition inside function scripts should be set +using the <samp>`function'</samp> reserved word, just as in the following +example: +</p> +<pre class="verbatim">function prefix_doSomething { + + # Do something here... + +} +</pre> +<p>The above function definition is just a convenction we use, in order +to make identification of function names easier read and automate by +<tt>`centos-art.sh'</tt> script initialization commands, once +<tt>`centos-art.sh'</tt> script determines which functionality directory +to use. Specifically, in order to initialize and export functions, +<tt>`centos-art.sh'</tt> script executes all function scripts inside the +functionality directory, and later <code>grep</code> on them using a +regular expression pattern, where the <samp>`function'</samp> reserved word is +used as reference to retrive the function names and export them to +<tt>`centos-art.sh'</tt> script execution environment, and so, make +function definitions --from function scripts inside the functionality +directory-- available for further calls. +</p> +<p>If the functionality specified in the command-line first argument +doesn't have a functionality directory, <tt>`centos-art.sh'</tt> script +considers the functionality provided in the command-line as invalid +functionality and immediatly stops script execution with an error +message. +</p> +<p>In order to keep visual consistency among function scripts, please +consider using the following function script design model as template +for your own function scripts: +</p> +<pre class="verbatim">#!/bin/bash +# +# prefix_doSomething.sh -- This function illustrates function scripts +# design model you can use to create your own function scripts inside +# centos-art.sh script. +# +# Copyright (C) YEAR YOURFULLNAME +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 +# USA. +# +# ---------------------------------------------------------------------- +# $Id$ +# ---------------------------------------------------------------------- + +function prefix_doSomething { + + # Do something here... + +} +</pre></dd></dl> + +<dl> +<dt><u>Function:</u> <b>cli_getCountryCodes</b><i> [FILTER]</i> +<a name="IDX20"></a> +</dt> +<dd><p>Output country codes supported by <tt>`centos-art.sh'</tt> script. +</p> +<p>The <code>cli_getCountryCodes</code> function outputs a list with country +codes as defined in ISO3166 standard. When <var>FILTER</var> is provided, +<code>cli_getCountryCodes</code> outputs country codes that match +<var>FILTER</var> regular expression pattern. +</p></dd></dl> + +<dl> +<dt><u>Function:</u> <b>cli_getCountryName</b><i> [FILTER]</i> +<a name="IDX21"></a> +</dt> +<dd><p>Outputs country name supported by <tt>`centos-art.sh'</tt> script. +</p> +<p>The <code>cli_getCountryName</code> function reads one language locale code +in the format LL_CC and outputs the name of its related country as in +ISO3166. If filter is specified, <code>cli_getCountryName</code> returns the +country name that matches the locale code specified in <var>FILTER</var>, +exactly. +</p></dd></dl> + +<dl> +<dt><u>Function:</u> <b>cli_getCurrentLocale</b> +<a name="IDX22"></a> +</dt> +<dd><p>Output current locale used by <tt>`centos-art.sh'</tt> script. +</p> +<p>The <code>cli_getCurrentLocale</code> function uses <code>LANG</code> environment +variable to build a locale pattern that is later applied to +<code>cli_getLocales</code> function output in order to return the current +locale that <tt>`centos-art.sh'</tt> script works with. +</p> +<p>The current locale information, returned by +<code>cli_getCurrentLocale</code>, is output from more specific to less +specific. For example, if <samp>`en_GB'</samp> locale exists in +<code>cli_getLocales</code> function output, the <samp>`en_GB'</samp> locale would +take precedence before <samp>`en'</samp> locale. +</p> +<p>Locale precedence selection is quite important in order to define the +locale type we use for message translations. For example, if +<samp>`en_GB'</samp> is used, we are also saying that the common language +specification for English language (i.e., <samp>`en'</samp>) is no longer +used. Instead, we are using English non-common country-specific +language specifications like <samp>`en_AU'</samp>, <samp>`en_BW'</samp>, <samp>`en_GB'</samp>, +<samp>`en_US'</samp>, etc., for message translations. +</p> +<p>Use <code>cli_getCurrentLocale</code> function to know what current locale +information to use inside <tt>`centos-art.sh'</tt> script. +</p></dd></dl> + +<dl> +<dt><u>Function:</u> <b>cli_getFilesList</b><i> [LOCATION]</i> +<a name="IDX23"></a> +</dt> +<dd><p>Output list of files to process. +</p> +<p>The <code>cli_getFilesList</code> function uses <var>LOCATION</var> variable as +source location to build a list of files just as specified by regular +expression (<var>REGEX</var>) global variable. Essentially, what the +<code>cli_getFilesList</code> function does is using <code>find</code> command +to look for files in the location (<var>LOCATION</var>) just as posix-egrep +regular expression (<var>REGEX</var>) specifies. +</p> +<p>If <var>LOCATION</var> is not specified when <code>cli_getFilesList</code> +function is called, the action value (<var>ACTIONVAL</var>) global variable +is used as location value instead. +</p> +<p>By default, if the regular expression (<var>REGEX</var>) global variable is +not redefined after its first definition in the <code>cli</code> function, +all files that match default regular expression value (i.e., +<samp>`.+'</samp>) will be added to the list of files to process. Otherwise, +if you redefine the regular expression global variable after its first +definition in the <code>cli</code> function and before calling +<code>cli_getFilesList</code> function, the last value you specifed is used +instead. +</p> +<p>When you need to customize the regular expression (<var>REGEX</var>) global +variable value inside a function, do not redefine the global variable +(at least you be absolutly convinced you need to). Instead, set the +regular expression global variable as <samp>`local'</samp> to the function you +need a customized regular expression value for. If we don't redefine +the regular expression global variable as local to the function, or +use another name for the regular expression variable (which is not +very convenient in order to keep the amount of names to remember low), +you may experiment undesired concantenation issues that make your +regular expression to be something different from that you expect them +to be, specially if the function where you are doing the variable +redefinition is called several times during the same script execution. +</p> +<p>As result, the <code>cli_getFilesList</code> re-defines the value of +<var>FILES</var> variable with the list of files the <code>find</code> command +returned. As example, consider the following construction: +</p> +<pre class="verbatim">function prefix_doSomething { + + # Initialize the list of files to process. + local FILES='' + + # Initialize location. + local LOCATION=/home/centos/artwork/trunk/Identity/Themes/Models/Default + + # Re-define regular expression to match scalable vector graphic + # files only. Note how we use the global value of REGEX to build a + # new local REGEX value here. + local REGEX="${REGEX}.*\.(svgz|svg)" + + # Redefine list of files to process. + cli_getFilesList $LOCATION + + # Process list of files. + for FILE in $FILES;do + cli_printMessages "$FILE" 'AsResponseLine' + # Do something else here on... + done + +} +</pre> +</dd></dl> + +<dl> +<dt><u>Function:</u> <b>cli_getLangCodes</b><i> [FILTER]</i> +<a name="IDX24"></a> +</dt> +<dd><p>Outputs language codes supported by <tt>`centos-art.sh'</tt> script. +</p> +<p><code>cli_getLangCodes</code> function outputs a list of language codes as +defined in ISO639 standard. When <var>FILTER</var> is provided, +<code>cli_getLangCodes</code> outputs language codes that match <var>FILTER</var> +regular expression pattern. +</p></dd></dl> + +<dl> +<dt><u>Function:</u> <b>cli_getLangName</b><i> [FILTER]</i> +<a name="IDX25"></a> +</dt> +<dd><p>Outputs language names supported by <tt>`centos-art.sh'</tt> script. +</p> +<p><code>cli_getLangName</code> function reads one language locale code in the +format LL_CC and outputs the language related name as in ISO639. If +filter is specified, <code>cli_getLangName</code> returns the language name +that matches the locale code specified in <var>FILTER</var>, exactly. +</p></dd></dl> + +<dl> +<dt><u>Function:</u> <b>cli_getLocales</b> +<a name="IDX26"></a> +</dt> +<dd><p>Output locale codes supported by <tt>`centos-art.sh'</tt> script. +</p> +<p>Occasionally, you use <code>cli_getLocales</code> function to add locale +information in non-common country-specific language (<samp>`LL_CC'</samp>) +format for those languages (e.g., <samp>`bn_IN'</samp>, <samp>`pt_BR'</samp>, etc.) +which locale differences cannot be solved using common language +specifications (<samp>`LL'</samp>) into one unique common locale specification +(e.g., <samp>`bn'</samp>, <samp>`pt'</samp>, etc.). +</p></dd></dl> + +<dl> +<dt><u>Function:</u> <b>cli_getRepoName</b><i> NAME TYPE</i> +<a name="IDX27"></a> +</dt> +<dd><p>Sanitate file names. +</p> +<p>Inside <tt>`centos-art.sh'</tt> script, specific functionalities rely both +in <code>cli_getRepoName</code> and repository file system organization to +achieve their goals. Consider <code>cli_getRepoName</code> function as +central place to manage file name convenctions for other functions +inside <tt>`centos-art.sh'</tt> script. +</p> +<blockquote class="orange"><img src="/home/centos/artwork/trunk/Identity/Widgets/Img/icon-admonition-star.png" alt="Important"><h3>Important</h3><p> <code>cli_getRepoName</code> function doesn't verify file +or directory existence, for that purpose use <code>cli_checkFiles</code> +function instead. +</p></blockquote> + +<p>The <var>NAME</var> variable contains the file name or directory name you +want to sanitate. +</p> +<p>The <var>TYPE</var> variable specifies what type of sanitation you want to +perform on <var>NAME</var>. The <var>TYPE</var> can be one of the following +values: +</p> +<dl compact="compact"> +<dt> <samp>`d'</samp></dt> +<dt> <samp>`directory'</samp></dt> +<dd><p>Sanitate directory <var>NAME</var>s. +</p></dd> +<dt> <samp>`f'</samp></dt> +<dt> <samp>`regular-file'</samp></dt> +<dd><p>Sanitate regular file <var>NAME</var>s. +</p></dd> +</dl> + +<p>Use <code>cli_getRepoName</code> function to sanitate file names and +directory names before their utilization. +</p> +<p>Use <code>cli_getRepoName</code> when you need to change file name +convenctions inside <tt>`centos-art.sh'</tt> script. +</p> +<p>When we change file name convenctions inside <code>cli_getRepoName</code> +what we are really changing is the way functions interpret repository +file system organization. Notice that when we change a file name +(e.g., a function name), it is necessary to update all files where +such file name is placed on. This may require a massive substitution +inside the repository, each time we change name convenctions in the +repository (-- <strong>Removed</strong>(pxref:trunk Scripts Bash Functions Path) --, for more +information). +</p></dd></dl> + +<dl> +<dt><u>Function:</u> <b>cli_getRepoStatus</b><i> [LOCATION]</i> +<a name="IDX28"></a> +</dt> +<dd><p>Request repository status. +</p> +<p>This function requests the status of a <var>LOCATION</var> inside the +working copy using the <code>svn status</code> command and returns the +first character in the output line, just as described in <code>svn +help status</code>. If <var>LOCATION</var> is not a regular file or a directory, +inside the working copy, the <tt>`centos-art.sh'</tt> script prints a +message and ends its execution. +</p> +<p>Use this function to perform verifications based a repository +<var>LOCATION</var> status. +</p></dd></dl> + +<dl> +<dt><u>Function:</u> <b>cli_getTemporalFile</b><i> <var>NAME</var></i> +<a name="IDX29"></a> +</dt> +<dd><p>Output absolute path to temporal file <var>NAME</var>. +</p> +<p>The <code>cli_getTemporalFile</code> function uses <tt>`/tmp'</tt> directory as +source location to store temporal files, the <tt>`centos-art.sh'</tt> +script name, and a random identification string to let you run more +than one <tt>`centos-art.sh'</tt> script simultaneously on the same user +session. For example, due the following temporal file defintion: +</p> +<pre class="verbatim">cli_getTemporalFile $FILE +</pre> +<p>If <var>FILE</var> name is <tt>`instance.svg'</tt> and the unique random string +is <samp>`f16f7b51-ac12-4b7f-9e66-72df847f12de'</samp>, the final temporal +file, built from previous temporal file definition, would be: +</p> +<pre class="verbatim">/tmp/centos-art.sh-f16f7b51-ac12-4b7f-9e66-72df847f12de-instance.svg +</pre> +<p>When you use the <code>cli_getTemporalFile</code> function to create +temporal files, be sure to remove temporal files created once you've +ended up with them. For example, consider the following construction: +</p> +<pre class="verbatim">for FILE in $FILES;do + + # Initialize temporal instance of file. + INSTANCE=$(cli_getTemporalFile $FILE) + + # Do something ... + + # Remove temporal instance of file. + if [[ -f $INSTANCE ]];then + rm $INSTANCE + fi + +done +</pre> +<p>Use the <code>cli_getTemporalFile</code> function whenever you need to +create temporal files inside <tt>`centos-art.sh'</tt> script. +</p></dd></dl> + +<dl> +<dt><u>Function:</u> <b>cli_getThemeName</b> +<a name="IDX30"></a> +</dt> +<dd><p>Output theme name. +</p> +<p>In order for <code>cli_getThemeName</code> function to extract theme name +correctly, the <var>ACTIONVAL</var> variable must contain a directory path +under <tt>`trunk/Identity/Themes/Motifs/'</tt> directory structure. +Otherwise, <code>cli_getThemeName</code> returns an empty string. +</p></dd></dl> + +<dl> +<dt><u>Function:</u> <b>cli_printMessage</b><i> MESSAGE [FORMAT]</i> +<a name="IDX31"></a> +</dt> +<dd><p>Define standard output message definition supported by +<tt>`centos-art.sh'</tt> script. +</p> +<p>When <var>FORMAT</var> is not specified, <code>cli_printMessage</code> outputs +information just as it was passed in <var>MESSAGE</var> variable. +Otherwise, <var>FORMAT</var> can take one of the following values: +</p> +<dl compact="compact"> +<dt> <samp>`AsHeadingLine'</samp></dt> +<dd><p>To print heading messages. +</p><pre class="verbatim">---------------------------------------------------------------------- +$MESSAGE +---------------------------------------------------------------------- +</pre> +</dd> +<dt> <samp>`AsWarningLine'</samp></dt> +<dd><p>To print warning messages. +</p><pre class="verbatim">---------------------------------------------------------------------- +WARNING: $MESSAGE +---------------------------------------------------------------------- +</pre> +</dd> +<dt> <samp>`AsNoteLine'</samp></dt> +<dd><p>To print note messages. +</p><pre class="verbatim">---------------------------------------------------------------------- +NOTE: $MESSAGE +---------------------------------------------------------------------- +</pre> +</dd> +<dt> <samp>`AsUpdatingLine'</samp></dt> +<dd><p>To print <samp>`Updating'</samp> messages on two-columns format. +</p><pre class="verbatim">Updating $MESSAGE +</pre> +</dd> +<dt> <samp>`AsRemovingLine'</samp></dt> +<dd><p>To print <samp>`Removing'</samp> messages on two-columns format. +</p><pre class="verbatim">Removing $MESSAGE +</pre> +</dd> +<dt> <samp>`AsCheckingLine'</samp></dt> +<dd><p>To print <samp>`Checking'</samp> messages on two-columns format. +</p><pre class="verbatim">Checking $MESSAGE +</pre> +</dd> +<dt> <samp>`AsCreatingLine'</samp></dt> +<dd><p>To print <samp>`Creating'</samp> messages on two-columns format. +</p><pre class="verbatim">Creating $MESSAGE +</pre> +</dd> +<dt> <samp>`AsSavedAsLine'</samp></dt> +<dd><p>To print <samp>`Saved as'</samp> messages on two-columns format. +</p><pre class="verbatim">Saved as $MESSAGE +</pre> +</dd> +<dt> <samp>`AsLinkToLine'</samp></dt> +<dd><p>To print <samp>`Linked to'</samp> messages on two-columns format. +</p><pre class="verbatim">Linked to $MESSAGE +</pre> +</dd> +<dt> <samp>`AsMovedToLine'</samp></dt> +<dd><p>To print <samp>`Moved to'</samp> messages on two-columns format. +</p><pre class="verbatim">Moved to $MESSAGE +</pre> +</dd> +<dt> <samp>`AsTranslationLine'</samp></dt> +<dd><p>To print <samp>`Translation'</samp> messages on two-columns format. +</p><pre class="verbatim">Translation $MESSAGE +</pre> +</dd> +<dt> <samp>`AsConfigurationLine'</samp></dt> +<dd><p>To print <samp>`Configuration'</samp> messages on two-columns format. +</p><pre class="verbatim">Configuration $MESSAGE +</pre> +</dd> +<dt> <samp>`AsResponseLine'</samp></dt> +<dd><p>To print response messages on one-column format. +</p><pre class="verbatim">--> $MESSAGE +</pre> +</dd> +<dt> <samp>`AsRequestLine'</samp></dt> +<dd><p>To print request messages on one-column format. Request messages +output messages with one colon (<samp>`:'</samp>) and without trailing newline +(<samp>`\n'</samp>) at message end. +</p><pre class="verbatim">$MESSAGE: +</pre> +</dd> +<dt> <samp>`AsYesOrNoRequestLine'</samp></dt> +<dd><p>To print <samp>`yes or no'</samp> request messages on one-column format. If +something different from <samp>`y'</samp> is answered (when using +<code>en_US.UTF-8</code> locale), script execution ends immediatly. +</p> +<pre class="verbatim">$MESSAGE [y/N]: +</pre> +<p>When we use <tt>`centos-art.sh'</tt> script in a locale different from +<code>en_US.UTF-8</code>, confirmation answer may be different from +<samp>`y'</samp>. For example, if you use <code>es_ES.UTF-8</code> locale, the +confirmation question would look like: +</p> +<pre class="verbatim">$MESSAGE [s/N]: +</pre> +<p>and the confirmation answer would be <samp>`s'</samp>, as it is on Spanish +<samp>`sí'</samp> word. +</p> +<p>Definition of which confirmation word to use is set on translation +messages for your specific locale information. -- <strong>Removed</strong>(xref:trunk Scripts +Bash Functions Locale) --, for more information about locale-specific +translation messages. +</p> +</dd> +<dt> <samp>`AsToKnowMoreLine'</samp></dt> +<dd><p>To standardize <samp>`to know more, run the following command:'</samp> +messages. When the <samp>`AsToKnowMoreLine'</samp> option is used, the +<var>MESSAGE</var> value should be set to <code>"$(caller)"</code>. <code>caller</code> +is a Bash builtin that returns the context of the current subroutine +call. <samp>`AsToKnowMoreLine'</samp> option uses <code>caller</code> builtin +output to build documentation entries dynamically. +</p> +<pre class="verbatim">---------------------------------------------------------------------- +To know more, run the following command: +centos-art manual --read='path/to/dir' +---------------------------------------------------------------------- +</pre> +<p>Use <samp>`AsToKnowMoreLine'</samp> option after errors and for intentional +script termination. +</p> +</dd> +<dt> <samp>`AsRegularLine'</samp></dt> +<dd><p>To standardize regular messages on one-column format. +</p> +<p>When <var>MESSAGE</var> contains a colon inside (e.g., <samp>`description: +message'</samp>), the <code>cli_printMessage</code> function outputs <var>MESSAGE</var> +on two-columns format. +</p></dd> +</dl> + +<p>Use <code>cli_printMessage</code> function whenever you need to output +information from <tt>`centos-art.sh'</tt> script. +</p> +<blockquote class="orange"><img src="/home/centos/artwork/trunk/Identity/Widgets/Img/icon-admonition-idea.png" alt="Info"><h3>Tip</h3><p> To improve two-columns format, change the following file: +</p><pre class="verbatim">trunk/Scripts/Bash/Styles/output_forTwoColumns.awk +</pre></blockquote> +</dd></dl> + + +<a name="SEC269"></a> +<h4 class="subsubsection"> 3.49.3.3 Specific functions </h4> + +<p>The following specific functions of <tt>`centos-art.sh'</tt> script, are +available for you to use: +</p> + + +<a name="SEC270"></a> <h3 class="subsection"> 3.49.4 See also </h3> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top"><a href="filesystem_50.html#SEC257">3.47 trunk/Scripts/Bash</a></td><td> </td><td align="left" valign="top"> +</td></tr> +<tr><td align="left" valign="top"><a href="filesystem_63.html#SEC340">3.60 trunk/Scripts/Bash/Locale</a></td><td> </td><td align="left" valign="top"> +</td></tr> +</table> <table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="#SEC266" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="filesystem_53.html#SEC268" title="Next section in reading order"> > </a>]</td> +<tr><td valign="middle" align="left">[<a href="#SEC269" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="filesystem_53.html#SEC271" title="Next section in reading order"> > </a>]</td> <td valign="middle" align="left"> </td> <td valign="middle" align="left">[<a href="filesystem_3.html#SEC3" title="Beginning of this chapter or previous chapter"> << </a>]</td> <td valign="middle" align="left">[<a href="#SEC263" title="Up section"> Up </a>]</td> diff --git a/Manuals/Filesystem/filesystem-html/filesystem_53.html b/Manuals/Filesystem/filesystem-html/filesystem_53.html index 527c72f..e0e1634 100644 --- a/Manuals/Filesystem/filesystem-html/filesystem_53.html +++ b/Manuals/Filesystem/filesystem-html/filesystem_53.html @@ -20,10 +20,10 @@ Send bugs and suggestions to <users@texi2html.cvshome.org> --> <head> -<title>CentOS Artwork Repository - Filesystem: 3.50 trunk/Scripts/Bash/Functions</title> +<title>CentOS Artwork Repository - Filesystem: 3.50 trunk/Scripts/Bash/centos-art/Functions/Help</title> -<meta name="description" content="CentOS Artwork Repository - Filesystem: 3.50 trunk/Scripts/Bash/Functions"> -<meta name="keywords" content="CentOS Artwork Repository - Filesystem: 3.50 trunk/Scripts/Bash/Functions"> +<meta name="description" content="CentOS Artwork Repository - Filesystem: 3.50 trunk/Scripts/Bash/centos-art/Functions/Help"> +<meta name="keywords" content="CentOS Artwork Repository - Filesystem: 3.50 trunk/Scripts/Bash/centos-art/Functions/Help"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="texi2html 1.76"> @@ -52,8 +52,8 @@ ul.toc {list-style: none} <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000"> <table cellpadding="1" cellspacing="1" border="0"> -<tr><td valign="middle" align="left">[<a href="filesystem_52.html#SEC267" title="Previous section in reading order"> < </a>]</td> -<td valign="middle" align="left">[<a href="#SEC269" title="Next section in reading order"> > </a>]</td> +<tr><td valign="middle" align="left">[<a href="filesystem_52.html#SEC270" title="Previous section in reading order"> < </a>]</td> +<td valign="middle" align="left">[<a href="#SEC272" title="Next section in reading order"> > </a>]</td> <td valign="middle" align="left"> </td> <td valign="middle" align="left">[<a href="filesystem_3.html#SEC3" title="Beginning of this chapter or previous chapter"> << </a>]</td> <td valign="middle" align="left">[<a href="filesystem_3.html#SEC3" title="Up section"> Up </a>]</td> @@ -67,1292 +67,38 @@ ul.toc {list-style: none} <td valign="middle" align="left">[<a href="filesystem_66.html#SEC355" title="Index">Index</a>]</td> <td valign="middle" align="left">[<a href="filesystem_abt.html#SEC_About" title="About (help)"> ? </a>]</td> </tr></table> -<a name="trunk-Scripts-Bash-Functions"></a> -<a name="SEC268"></a> -<h2 class="section"> 3.50 trunk/Scripts/Bash/Functions </h2> - - -<a name="SEC269"></a> -<h3 class="subsection"> 3.50.1 Goals </h3> - -<p>The <tt>`trunk/Scripts/Bash/Functions'</tt> directory exists to organize -<tt>`centos-art.sh'</tt> specific functionalities. -</p> - -<a name="SEC270"></a> -<h3 class="subsection"> 3.50.2 Description </h3> - -<p>The specific functions of <tt>`centos-art.sh'</tt> script are designed -with "Software Toolbox" philosophy (see <a href="../coreutils/Toolbox-introduction.html#Toolbox-introduction">(coreutils.info)Toolbox introduction</a>) in mind: each program "should do one -thing well". Inside <tt>`centos-art.sh'</tt> script, each specific -functionality is considered a program that should do one thing well. -Of course, if you find that they still don't do it, feel free to -improve them in order for them to do so. -</p> -<p>The specific functions of <tt>`centos-art.sh'</tt> script are organized -inside specific directories under <tt>`trunk/Scripts/Bash/Functions'</tt> -location. Each specific function directory should be named as the -function it represents, with the first letter in uppercase. For -example, if the function name is <code>render</code>, the specific function -directory for it would be <samp>`trunk/Scripts/Bash/Functions/Render'</samp>. -</p> -<p>To better understand how specific functions of <tt>`centos-art.sh'</tt> -script are designed, lets create one function which only goal is to -output different kind of greetings to your screen. -</p> -<p>When we create specific functions for <tt>`centos-art.sh'</tt> script it -is crucial to know what these functions will do exactly and if there -is any function that already does what we intend to do. If there is no -one, it is good time to create them then. Otherwise, if -functionalities already available don't do what you exactly expect, -contact their authors and work together to improve them. -</p> -<blockquote class="orange"><img src="/home/centos/artwork/trunk/Identity/Widgets/Img/icon-admonition-idea.png" alt="Info"><h3>Tip</h3><p> Join CentOS developers mailing list -<a class="mailto" href="mailto:centos-art@centos.org">centos-art@centos.org</a> to share your ideas. -</p></blockquote> - -<p>It is also worth to know what global functions and variables do we -have available inside <tt>`centos-art.sh'</tt> script, so advantage can be -taken from them. Global variables are defined inside global function -scripts. Global functions scripts are stored immediatly under -<tt>`trunk/Scripts/Bash/Functions'</tt> directory, in files begining with -<samp>`cli'</samp> prefix. -</p> -<p>OK, let's begin with our functionality example. -</p> -<p>What function name do we use? Well, lets use <code>greet</code>. Note that -<samp>`hello'</samp> word is not a verb; but an expression, a kind of -greeting, an interjection specifically. In contrast, <samp>`greet'</samp> is a -verb and describes what we do when we say <samp>`Hello!'</samp>, <samp>`Hi!'</samp>, -and similar expressions. -</p> -<p>So far, we've gathered the following function information: -</p> -<pre class="verbatim">Name: greet -Path: trunk/Scripts/Bash/Functions/Greet -File: trunk/Scripts/Bash/Functions/Greet/greet.sh -</pre> -<p>The <tt>`greet.sh'</tt> function script is the first file -<tt>`centos-art.sh'</tt> script loads when the <samp>`greet'</samp> functionality -is called using commands like <samp>`centos-art greet --hello='World''</samp>. -The <tt>`greet.sh'</tt> function script contains the <code>greet</code> function -definition. -</p> -<p>Inside <tt>`centos-art.sh'</tt> script, as convenction, each function -script has one top commentary, followed by one blank line, and then -one function defintion below it only. -</p> -<p>Inside <tt>`centos-art.sh'</tt> script functions, top commentaries have -the following components: the functionality description, one-line for -copyright note with your personal information, the license under -which the function source code is released --the <tt>`centos-art.sh'</tt> -script is released as GPL, so do all its functions--, the <code>$Id$</code> -keyword of Subversion is later expanded by <code>svn propset</code> -command. -</p> -<p>In our <code>greet</code> function example, top commentary for -<tt>`greet.sh'</tt> function script would look like the following: -</p> -<pre class="verbatim">#!/bin/bash -# -# greet.sh -- This function outputs different kind of greetings to -# your screen. Use this function to understand how centos-art.sh -# script specific functionalities work. -# -# Copyright (C) YEAR YOURFULLNAME -# -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 2 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, but -# WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program; if not, write to the Free Software -# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 -# USA. -# -# ---------------------------------------------------------------------- -# $Id$ -# ---------------------------------------------------------------------- -</pre> -<p>After top commentary, separated by one blank line, the <code>greet</code> -function definition would look like the following: -</p> -<pre class="verbatim">function greet { - - # Define global variables. - - # Define command-line interface. - greet_getActions - -} -</pre> -<p>The first definition inside <code>greet</code> function, are global -variables that will be available along <code>greet</code> function execution -environment. This time we didn't use global variable definitions for -<code>greet</code> function execution environment, so we left that section -empty. -</p> -<p>Later, we call <code>greet_getActions</code> function to define the -command-line interface of <code>greet</code> functionality. The command-line -interface of <code>greet</code> functionality defines what and how actions -are performed, based on arguments combination passed to -<tt>`centos-art.sh'</tt> script. -</p> -<pre class="verbatim">function greet_getActions { - - case "$ACTIONNAM" in - - --hello ) - greet_doHello - ;; - - --bye ) - greet_doBye - ;; - - * ) - cli_printMessage "`gettext "The option provided is not valid."`" - cli_printMessage "$(caller)" 'AsToKnowMoreLine' - - esac - -} -</pre> -<p>The <var>ACTIONNAM</var> global variable is defined in <tt>`cli.sh'</tt> -function script and contains the value passed before the equal sign -(i.e., <samp>`='</samp>) in the second command-line argument of -<tt>`centos-art.sh'</tt> script. For example, if the second command-line -argument is <samp>`--hello='World''</samp>, the value of <var>ACTIONNAM</var> -variable would be <samp>`--hello'</samp>. Using this configuration let us -deside which action to perform based on the action name passed to -<tt>`centos-art.sh'</tt> script as second argument. -</p> -<p>The <code>greet</code> function definition makes available two valid -greetings through <samp>`--hello'</samp> and <samp>`--bye'</samp> options. If no -one of them is provided as second command-line argument, the <samp>`*'</samp> -case is evaluated instead. -</p> -<p>The <samp>`*'</samp> case and its two lines further on should always be -present in <tt>`_getActions.sh'</tt> function scripts, no matter what -specific functionality you are creating. This convenction helps the -user to find out documentation about current functionality in use, -when no valid action is provided. -</p> -<p>The <code>greet_doHello</code> and <code>greet_doBye</code> function definitions -are the core of <code>greet</code> specific functionality. In such function -definitions we set what our <code>greet</code> function really does: to -output different kinds of greetings. -</p> -<pre class="verbatim">function greet_doHello { - - cli_printMessage "`gettext "Hello"` $ACTIONVAL" - -} -</pre> -<p>The <code>greet_doHello</code> function definition is stored in -<tt>`greet_doHello.sh'</tt> function script. -</p> -<pre class="verbatim">function greet_doBye { - - cli_printMessage "`gettext "Goodbye"` $ACTIONVAL" - -} -</pre> -<p>The <code>greet_doBye</code> function definition is stored in the -<tt>`greet_doBye.sh'</tt> function script. -</p> -<p>Both <tt>`greet_doHello.sh'</tt> and <tt>`greet_doBye.sh'</tt> function -scripts are stored inside <code>greet</code> function directory path (i.e. -<tt>`trunk/Scripts/Bash/Functions/Greet'</tt>). -</p> -<p>The <var>ACTIONVAL</var> global variable is defined in <tt>`cli.sh'</tt> -function script and contains the value passed after the equal sign -(i.e., <samp>`='</samp>) in the second command-line argument of -<tt>`centos-art.sh'</tt> script. For example, if the second command-line -argument is <samp>`--hello='World''</samp>, the value of <var>ACTIONVAL</var> -variable would be <samp>`World'</samp> without quotes. -</p> -<p>Let's see how <code>greet</code> specific functionality files are organzied -under <code>greet</code> function directory. To see file organization we use -the <code>tree</code> command: -</p> -<pre class="verbatim">trunk/Scripts/Bash/Functions/Greet -|-- greet_doBye.sh -|-- greet_doHello.sh -|-- greet_getActions.sh -`-- greet.sh -</pre> -<p>To try the <code>greet</code> specific functionality we've just created, -pass the function name (i.e., <samp>`greet'</samp>) as first argument to -<tt>`centos-art.sh'</tt> script, and any of the valid options as second -argument. Some examples are illustrated below: -</p> -<pre class="verbatim">[centos@projects ~]$ centos-art greet --hello='World' -Hello World -[centos@projects ~]$ centos-art greet --bye='World' -Goodbye World -[centos@projects ~]$ -</pre> -<p>The word <samp>`World'</samp> in the examples above can be anything. In fact, -change it to have a little fun. -</p> -<p>Now that we have a specific function that works as we expect, it is -time to document it. To document <code>greet</code> specific functionality, -we use its directory path and the <code>manual</code> functionality -(see section <a href="filesystem_56.html#SEC286">trunk/Scripts/Bash/Functions/Manual</a>) of <tt>`centos-art.sh'</tt> -script, just as the following command illustrates: -</p> -<pre class="verbatim">centos-art manual --edit=trunk/Scripts/Bash/Functions/Greet -</pre> -<p>To have a well documented function helps user to understand how your -function really works, and how it should be used. When no valid -action is passed to a function, the <tt>`centos-art.sh'</tt> script uses -the function documentation entry as vehicle to communicate which the -valid functions are. When no documentation entry exists for a -function, the <tt>`centos-art.sh'</tt> script informs that no -documentation entry exists for such function and requests user to -create it right at that time. -</p> -<p>Now that we have documented our function, it is time to translate its -output messages to different languages. To translate specific -functionality output messages to different languages we use the -<code>locale</code> functionality (see section <a href="filesystem_55.html#SEC281">trunk/Scripts/Bash/Functions/Locale</a>) of <tt>`centos-art.sh'</tt> script, just as the following command -illustrates: -</p> -<pre class="verbatim">centos-art locale --edit -</pre> -<blockquote class="orange"><img src="/home/centos/artwork/trunk/Identity/Widgets/Img/icon-admonition-alert.png" alt="Warning"><h3>Warning</h3><p> To translate output messages in different languages, -your system locale information --as in <code>LANG</code> environment -variable-- must be set to that locale you want to produce translated -messages for. For example, if you want to produce translated messages -for Spanish language, your system locale information must be set to -<samp>`es_ES.UTF-8'</samp>, or similar, first. -</p></blockquote> - -<p>Well, it seems that our example is rather complete by now. -</p> -<p>In <code>greet</code> function example we've described so far, we only use -<code>cli_printMessage</code> global function in action specific function -definitions in order to print messages, but more interesting things -can be achieved inside action specific function definitions. For -example, if you pass a directory path as action value in second -argument, you could retrive a list of files from therein, and process -them. If the list of files turns too long or you just want to control -which files to process, you could add the third argument in the form -<samp>`--filter='regex''</samp> and reduce the amount of files to process -using a regular expression pattern. -</p> -<p>The <code>greet</code> function described in this section may serve you as -an introduction to understand how specific functionalities work inside -<tt>`centos-art.sh'</tt> script. With some of luck this introduction will -also serve you as motivation to create your own <tt>`centos-art.sh'</tt> -script specific functionalities. -</p> -<p>By the way, the <code>greet</code> functionality doesn't exist inside -<tt>`centos-art.sh'</tt> script yet. Would you like to create it? -</p> - +<a name="trunk-Scripts-Bash-centos_002dart-Functions-Help"></a> <a name="SEC271"></a> -<h3 class="subsection"> 3.50.3 Usage </h3> +<h2 class="section"> 3.50 trunk/Scripts/Bash/centos-art/Functions/Help </h2> <a name="SEC272"></a> -<h4 class="subsubsection"> 3.50.3.1 Global variables </h4> - -<p>The following global variables of <tt>`centos-art.sh'</tt> script, are -available for you to use inside specific functions: -</p> -<dl> -<dt><u>Variable:</u> <b>TEXTDOMAIN</b> -<a name="IDX1"></a> -</dt> -<dd><p>Default domain used to retrieve translated messages. This value is set -in <tt>`initFunctions.sh'</tt> and shouldn't be changed. -</p></dd></dl> - -<dl> -<dt><u>Variable:</u> <b>TEXTDOMAINDIR</b> -<a name="IDX2"></a> -</dt> -<dd><p>Default directory used to retrieve translated messages. This value is -set in <tt>`initFunctions.sh'</tt> and shouldn't be changed. -</p></dd></dl> - -<dl> -<dt><u>Variable:</u> <b>FUNCNAM</b> -<a name="IDX3"></a> -</dt> -<dd><p>Define function name. -</p> -<p>Function names associate sets of actions. There is one set of actions -for each unique function name inside <tt>`centos-art.sh'</tt> script. -</p> -<p>Dunction names are passed as first argument in <tt>`centos-art.sh'</tt> -command-line interface. For example, in the command <samp>`centos-art -render --entry=path/to/dir --filter=regex'</samp>, the <var>ACTION</var> passed to -<tt>`centos-art.sh'</tt> script is <samp>`render'</samp>. -</p> -<p>When first argument is not provided, the <tt>`centos-art.sh'</tt> script -immediatly ends its execution. -</p></dd></dl> - -<dl> -<dt><u>Variable:</u> <b>FUNCDIR</b> -<a name="IDX4"></a> -</dt> -</dl> - -<dl> -<dt><u>Variable:</u> <b>FUNCDIRNAME</b> -<a name="IDX5"></a> -</dt> -</dl> - -<dl> -<dt><u>Variable:</u> <b>FUNCSCRIPT</b> -<a name="IDX6"></a> -</dt> -</dl> - -<dl> -<dt><u>Variable:</u> <b>FUNCCONFIG</b> -<a name="IDX7"></a> -</dt> -</dl> - -<dl> -<dt><u>Variable:</u> <b>ACTIONNAM</b> -<a name="IDX8"></a> -</dt> -<dd><p>Define action name. -</p> -<p>Each action name identifies an specific action to perform, inside an -specific function. -</p> -<p>Action name names aare passed as second argument in -<tt>`centos-art.sh'</tt> command-line interface. For example, in the -command <samp>`centos-art render --entry=path/to/dir --filter=regex'</samp>, -the <var>ACTIONNAM</var> passed to <tt>`centos-art.sh'</tt> script is -<samp>`--entry'</samp>. -</p> -<p>When second argument is not provided, the <tt>`centos-art.sh'</tt> script -immediatly ends its execution. -</p></dd></dl> - -<dl> -<dt><u>Variable:</u> <b>ACTIONVAL</b> -<a name="IDX9"></a> -</dt> -<dd><p>Define action value. -</p> -<p>Action values are associated to just one action name. Action values -contain the working copy entry over which its associated action will be -performed in. Working copy entries can be files or directories inside -the working copy. -</p></dd></dl> - -<dl> -<dt><u>Variable:</u> <b>REGEX</b> -<a name="IDX10"></a> -</dt> -<dd><p>Define regular expression used as pattern to build the list of files -to process. -</p> -<p>By default, <var>REGEX</var> variable is set to <code>.+</code> to match all -files. -</p> -<p>Functions that need to build a list of files to process use the option -<samp>`--filter'</samp> to redefine <var>REGEX</var> variable default value, and -so, control the amount of files to process. -</p></dd></dl> - -<dl> -<dt><u>Variable:</u> <b>ARGUMENTS</b> -<a name="IDX11"></a> -</dt> -<dd><p>Define optional arguments. -</p> -<p>Optional arguments, inside <tt>`centos-art.sh'</tt> script, are considered -as all command-line arguments passed to <tt>`centos-art.sh'</tt> script, -from third argument position on. For example, in the command -<samp>`centos-art render --entry=path/to/dir --filter=regex'</samp> , the -optional arguments are from <samp>`--filter=regex'</samp> argument on. -</p> -<p>Optional arguments are parsed using <code>getopt</code> command through -the following base construction: -</p> -<pre class="verbatim"># Define short options we want to support. -local ARGSS="" - -# Define long options we want to support. -local ARGSL="filter:,to:" - -# Parse arguments using getopt(1) command parser. -cli_doParseArguments - -# Reset positional parameters using output from (getopt) argument -# parser. -eval set -- "$ARGUMENTS" - -# Define action to take for each option passed. -while true; do - case "$1" in - --filter ) - REGEX="$2" - shift 2 - ;; - --to ) - TARGET="$2" - shift 2 - ;; - * ) - break - esac -done -</pre> -<p>Optional arguments provide support to command options inside -<tt>`centos-art.sh'</tt> script. For instance, consider the Subversion -(<code>svn</code>) command, where there are many options (e.g., -<samp>`copy'</samp>, <samp>`delete'</samp>, <samp>`move'</samp>, etc), and inside each -option there are several modifiers (e.g., <samp>`--revision'</samp>, -<samp>`--message'</samp>, <samp>`--username'</samp>, etc.) that can be combined one -another in their short or long variants. -</p> -<p>The <var>ARGUMENTS</var> variable is used to store arguments passed from -command-line for later use inside <tt>`centos-art.sh'</tt> script. Storing -arguments is specially useful when we want to run a command with some -specific options from them. Consider the following command: -</p> -<pre class="verbatim">centos-art path --copy=SOURCE --to=TARGET --message="The commit message goes here." --username='johndoe' -</pre> -<p>In the above command, the <samp>`--message'</samp>, and <samp>`--username'</samp> -options are specific to <code>svn copy</code> command. In such cases, -options are not interpreted by <tt>`centos-art.sh'</tt> script itself. -Instead, the <tt>`centos-art.sh'</tt> script uses <code>getopt</code> to -retrive them and store them in the <var>ARGUMENTS</var> variable for later -use, as described in the following command: -</p> -<pre class="verbatim"># Build subversion command to duplicate locations inside the -# workstation. -eval svn copy $SOURCE $TARGET --quiet $ARGUMENTS -</pre> -<p>When <code>getopt</code> parses <var>ARGUMENTS</var>, we may use short options -(e.g., <samp>`-m'</samp>) or long options (e.g., <samp>`--message'</samp>). When -we use short options, arguments are separated by one space from the -option (e.g., <samp>`-m 'This is a commit message.''</samp>). When we use -long options arguments are separated by an equal sign (<samp>`='</samp>) -(e.g., <samp>`--message='This is a commit message''</samp>). -</p> -<p>In order for <code>getopt</code> to parse <var>ARGUMENTS</var> correctly, it -is required to provide the short and long definition of options that -will be passed or at least supported by the command performing the -final action the function script exists for. -</p> -<p>As convenction, inside <tt>`centos-art.sh'</tt> script, short option -definitions are set in the <var>ARGSS</var> variable; and long option -definitions are set in the <var>ARGSL</var> variable. -</p> -<p>When you define short and long options, it may be needed to define -which of these option arguments are required and which not. To define -an option argument as required, you need to set one colon <samp>`:'</samp> -after the option definition (e.g., <samp>`-o m: -l message:'</samp>). On -the other hand, to define an option argument as not required, you need -to set two colons <samp>`::'</samp> after the option definition (e.g., -<samp>`-o m:: -l message::'</samp>). -</p></dd></dl> +<h3 class="subsection"> 3.50.1 Goals </h3> -<dl> -<dt><u>Variable:</u> <b>EDITOR</b> -<a name="IDX12"></a> -</dt> -<dd><p>Default text editor. -</p> -<p>The <tt>`centos-art.sh'</tt> script uses default text <code>EDITOR</code> to edit -pre-commit subversion messages, translation files, configuration -files, script files, and similar text-based files. -</p> -<p>If <code>EDITOR</code> environment variable is not set, <tt>`centos-art.sh'</tt> -script uses <tt>`/usr/bin/vim'</tt> as default text editor. Otherwise, the -following values are recognized by <tt>`centos-art.sh'</tt> script: -</p> <ul class="toc"> -<li> <tt>`/usr/bin/vim'</tt> -</li><li> <tt>`/usr/bin/emacs'</tt> -</li><li> <tt>`/usr/bin/nano'</tt> +<li> ... </li></ul> -<p>If no one of these values is set in <code>EDITOR</code> environment variable, -<tt>`centos-art.sh'</tt> uses <tt>`/usr/bin/vim'</tt> text editor by default. -</p></dd></dl> - <a name="SEC273"></a> -<h4 class="subsubsection"> 3.50.3.2 Global functions </h4> - -<p>Function scripts stored directly under -<tt>`trunk/Scripts/Bash/Functions/'</tt> directory are used to define -global functions. Global functions can be used inside action specific -functionalities and or even be reused inside themselves. This section -provides introductory information to global functions you can use -inside <tt>`centos-art.sh'</tt> script. -</p> -<dl> -<dt><u>Function:</u> <b>cli_checkActionArguments</b> -<a name="IDX13"></a> -</dt> -<dd><p>Validate action value (<var>ACTIONVAL</var>) variable. -</p> -<p>The action value variable can take one of the following values: -</p> -<ol> -<li> Path to one directory inside the local working copy, -</li><li> Path to one file inside the local working copy, -</li></ol> - -<p>If another value different from that specified above is passed to -action value variable, the <tt>`centos-art.sh'</tt> script prints an error -message and ends script execution. -</p></dd></dl> - -<dl> -<dt><u>Function:</u> <b>cli_checkFiles</b><i> FILE [TYPE]</i> -<a name="IDX14"></a> -</dt> -<dd><p>Verify file existence. -</p> -<p><code>cli_checkFiles</code> receives a <var>FILE</var> absolute path and performs -file verification as specified in <var>TYPE</var>. When <var>TYPE</var> is not -specified, <code>cli_checkFiles</code> verifies <var>FILE</var> existence, no -matter what kind of file it be. If <var>TYPE</var> is specified, use one -of the following values: -</p> -<dl compact="compact"> -<dt> <samp>`d'</samp></dt> -<dt> <samp>`directory'</samp></dt> -<dd><p>Ends script execution if <var>FILE</var> is not a directory. -</p> -<p>When you verify directories with cli_checkFiles, if directory doesn't -exist, <tt>`centos-art.sh'</tt> script asks you for confirmation in order -to create that directory. If you answer positively, -<tt>`centos-art.sh'</tt> script creates that directory and continues -script flows normally. Otherwise, if you answer negatively, -<tt>`centos-art.sh'</tt> ends script execution with an error and -documentation message. -</p> -</dd> -<dt> <samp>`f'</samp></dt> -<dt> <samp>`regular-file'</samp></dt> -<dd><p>Ends script execution if <var>FILE</var> is not a regular file. -</p></dd> -<dt> <samp>`h'</samp></dt> -<dt> <samp>`symbolic-link'</samp></dt> -<dd><p>Ends script execution if <var>FILE</var> is not a symbolic link. -</p></dd> -<dt> <samp>`x'</samp></dt> -<dt> <samp>`execution'</samp></dt> -<dd><p>Ends script execution if <var>FILE</var> is not executable. -</p></dd> -<dt> <samp>`fh'</samp></dt> -<dd><p>Ends script execution if <var>FILE</var> is neither a regular file nor a -symbolic link. -</p></dd> -<dt> <samp>`fd'</samp></dt> -<dd><p>Ends script execution if <var>FILE</var> is neither a regular file nor a -directory. -</p></dd> -<dt> <samp>`isInWorkingCopy'</samp></dt> -<dd><p>Ends script execution if <var>FILE</var> is not inside the working copy. -</p></dd> -</dl> - -<p>As default behaviour, if <var>FILE</var> passes all verifications, -<tt>`centos-art.sh'</tt> script continues with its normal flow. -</p></dd></dl> - -<dl> -<dt><u>Function:</u> <b>cli_commitRepoChanges</b><i> [LOCATION]</i> -<a name="IDX15"></a> -</dt> -<dd><p>Syncronize changes between repository and working copy. -</p> -<p>The <code>cli_commitRepoChanges</code> function brings changes from the -central repository down to the working copy--using <code>svn -update</code>--, checks the working copy changes--using <code>svn -status</code> command--, prints status report--using both <code>svn -update</code> and <code>svn status</code> commands output, and finally, commits -recent changes from the working copy up to the repository--using -<code>svn commit</code> command--. -</p> -<p>Previous to commit the working copy changes up to the central -repository, the <code>cli_commitRepoChanges</code> function asks you to -verify changes--using <code>svn diff</code> command--, and later, -another confirmation question is shown to be sure you really want to -commit changes up to central repository. -</p> -<p>If <var>LOCATION</var> argument is not specified, the value of -<var>ACTIONVAL</var> variable is used as reference instead. -</p> -<div class="float"><a name="trunk_002fScripts_002fBash_002fFunctions_002fcli_005fcommitRepoChanges"></a> -<pre class="verbatim">---------------------------------------------------------------------- ---> Bringing changes from the repository into the working copy ---> Checking changes in the working copy ----------------------------------------------------------------------- -Added 0 file from the repository. -Deleted 0 file from the repository. -Updated 0 file from the repository. -Conflicted 0 file from the repository. -Merged 0 file from the repository. -Modified 4 files from the working copy. -Unversioned 0 file from the working copy. -Deleted 0 file from the working copy. -Added 0 file from the working copy. ----------------------------------------------------------------------- -</pre> -</div><p><strong>Figure 3.3: The <code>cli_commitRepoChanges</code> function output. -</strong> -</p> -<p>Call the <code>cli_commitRepoChanges</code> function before or/and after -calling functions that modify files or directories inside the working -copy as you may need to. -</p></dd></dl> - -<dl> -<dt><u>Function:</u> <b>cli_doParseArguments</b> -<a name="IDX16"></a> -</dt> -<dd><p>Redefine arguments (<var>ARGUMENTS</var>) global variable using -<code>getopt</code> command output. For more information about how to use -<code>cli_doParseArguments</code> function, see <var>ARGUMENTS</var> variable -description above. -</p></dd></dl> - -<dl> -<dt><u>Function:</u> <b>cli_doParseArgumentsReDef</b><i> $@</i> -<a name="IDX17"></a> -</dt> -<dd><p>Initialize/reset arguments (<var>ARGUMENTS</var>) global variable using -positional parameters variable (<var>$@</var>) as reference. -</p> -<p>When we work inside function definitions, positional parameters are -reset to the last function definition positional parameters. If you -need to redefine positional parameters from one specific function, you -need to call <code>cli_doParseArgumentsReDef</code> with the positional -parameters variable (<var>$@</var>), set as first argument, to that -specific function you want to redefine positional parameters at. -</p></dd></dl> - -<dl> -<dt><u>Function:</u> <b>cli_getArguments</b> -<a name="IDX18"></a> -</dt> -<dd><p>Initialize function name (<var>FUNCNAM</var>), action name -(<var>ACTIONNAM</var>), and action value (<var>ACTIONVAL</var>) global -variables, using positional parameters passed in <var>$@</var> variable. -</p> -<p>The <code>cli_getArguments</code> function is called from <code>cli.sh</code> -function script, using <code>cli</code> function positional parameters -(i.e., the positional parameters passed as arguments in the -command-line) as first function argument. -</p> -<p>Once command-line positional parameters are accesible to -<tt>`centos-art.sh'</tt> script execution evironment, -<code>cli_getArguments</code> uses regular expression to retrive -action variables from first and second argument. The first argument -defines the value used as function name (<var>FUNCNAM</var>), and the -second argument defines both values used as action name -(<var>ACTIONNAM</var>) and action value (<var>ACTIONVAL</var>), respectively. -</p> -<p>The first argument is a word in lower case. This word specifies the -name of the functionality you want to use (e.g., <samp>`render'</samp> to -render images, <samp>`manual'</samp> to work on documentation, and so on.) -</p> -<p>The second argument has a long option style (e.g., -<samp>`--option=value'</samp>). The <samp>`--option'</samp> represents the action name -(<var>ACTIONNAM</var>), and the characters inbetween the equal sign -(<samp>`='</samp>) and the first space character, are considered as the action -value (<var>ACTIONVAL</var>). In order to provide action values with space -characters inbetween you need to enclose action value with quotes like -in <samp>`--option='This is long value with spaces inbetween''</samp>. -Generally, action values are used to specify paths over which the -action name acts on. -</p> -<p>Once action related variables (i.e., <var>FUNCNAM</var>, <var>ACTIONNAM</var>, -and <var>ACTIONVAL</var>) are defined and validated, -<code>cli_getArguments</code> shifts the positional arguments to remove the -first two arguments passed (i.e., those used to retrive action related -variables) and redefine the arguments (<var>ARGUMENTS</var>) global -variable with the new positional parameters information. -</p></dd></dl> - -<dl> -<dt><u>Function:</u> <b>cli_getFunctions</b> -<a name="IDX19"></a> -</dt> -<dd><p>Initialize funtionalities supported by <tt>`centos-art.sh'</tt> script. -</p> -<p>Functionalities supported by <tt>`centos-art.sh'</tt> script are organized -in functionality directories under -<tt>`trunk/Scripts/Bash/Functions/'</tt> directory. Each functionality -directory stores function scripts to the functionality such directory -was created for. Function scripts contain function definitions. -Function definitions contain several commands focused on achieving one -specific task only (i.e., the one such functionality was created for). -</p> -<p>In order for <tt>`centos-art.sh'</tt> script to recognize a functionality, -such functionality needs to be stored under -<tt>`trunk/Scripts/Bash/Functions/'</tt> in a directory written -capitalized (i.e., the whole name is written in lowercase except the -first character which is in uppercase). The directory where one -specific functionality is stored is known as the <samp>`functionality -directory'</samp>. -</p> -<p>Inside each functionality directory, the functionalty itself is -implemented through function scripts. Function scripts are organized -in files independently one another and written in <samp>`camelCase'</samp> -format with the function name as prefix. Separation between prefix -and description is done using underscore (<samp>`_'</samp>) character. -</p> -<p>In order for <tt>`centos-art.sh'</tt> script to load functionalities -correctly, function definition inside function scripts should be set -using the <samp>`function'</samp> reserved word, just as in the following -example: -</p> -<pre class="verbatim">function prefix_doSomething { - - # Do something here... - -} -</pre> -<p>The above function definition is just a convenction we use, in order -to make identification of function names easier read and automate by -<tt>`centos-art.sh'</tt> script initialization commands, once -<tt>`centos-art.sh'</tt> script determines which functionality directory -to use. Specifically, in order to initialize and export functions, -<tt>`centos-art.sh'</tt> script executes all function scripts inside the -functionality directory, and later <code>grep</code> on them using a -regular expression pattern, where the <samp>`function'</samp> reserved word is -used as reference to retrive the function names and export them to -<tt>`centos-art.sh'</tt> script execution environment, and so, make -function definitions --from function scripts inside the functionality -directory-- available for further calls. -</p> -<p>If the functionality specified in the command-line first argument -doesn't have a functionality directory, <tt>`centos-art.sh'</tt> script -considers the functionality provided in the command-line as invalid -functionality and immediatly stops script execution with an error -message. -</p> -<p>In order to keep visual consistency among function scripts, please -consider using the following function script design model as template -for your own function scripts: -</p> -<pre class="verbatim">#!/bin/bash -# -# prefix_doSomething.sh -- This function illustrates function scripts -# design model you can use to create your own function scripts inside -# centos-art.sh script. -# -# Copyright (C) YEAR YOURFULLNAME -# -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 2 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, but -# WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program; if not, write to the Free Software -# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 -# USA. -# -# ---------------------------------------------------------------------- -# $Id$ -# ---------------------------------------------------------------------- - -function prefix_doSomething { - - # Do something here... - -} -</pre></dd></dl> - -<dl> -<dt><u>Function:</u> <b>cli_getCountryCodes</b><i> [FILTER]</i> -<a name="IDX20"></a> -</dt> -<dd><p>Output country codes supported by <tt>`centos-art.sh'</tt> script. -</p> -<p>The <code>cli_getCountryCodes</code> function outputs a list with country -codes as defined in ISO3166 standard. When <var>FILTER</var> is provided, -<code>cli_getCountryCodes</code> outputs country codes that match -<var>FILTER</var> regular expression pattern. -</p></dd></dl> - -<dl> -<dt><u>Function:</u> <b>cli_getCountryName</b><i> [FILTER]</i> -<a name="IDX21"></a> -</dt> -<dd><p>Outputs country name supported by <tt>`centos-art.sh'</tt> script. -</p> -<p>The <code>cli_getCountryName</code> function reads one language locale code -in the format LL_CC and outputs the name of its related country as in -ISO3166. If filter is specified, <code>cli_getCountryName</code> returns the -country name that matches the locale code specified in <var>FILTER</var>, -exactly. -</p></dd></dl> - -<dl> -<dt><u>Function:</u> <b>cli_getCurrentLocale</b> -<a name="IDX22"></a> -</dt> -<dd><p>Output current locale used by <tt>`centos-art.sh'</tt> script. -</p> -<p>The <code>cli_getCurrentLocale</code> function uses <code>LANG</code> environment -variable to build a locale pattern that is later applied to -<code>cli_getLocales</code> function output in order to return the current -locale that <tt>`centos-art.sh'</tt> script works with. -</p> -<p>The current locale information, returned by -<code>cli_getCurrentLocale</code>, is output from more specific to less -specific. For example, if <samp>`en_GB'</samp> locale exists in -<code>cli_getLocales</code> function output, the <samp>`en_GB'</samp> locale would -take precedence before <samp>`en'</samp> locale. -</p> -<p>Locale precedence selection is quite important in order to define the -locale type we use for message translations. For example, if -<samp>`en_GB'</samp> is used, we are also saying that the common language -specification for English language (i.e., <samp>`en'</samp>) is no longer -used. Instead, we are using English non-common country-specific -language specifications like <samp>`en_AU'</samp>, <samp>`en_BW'</samp>, <samp>`en_GB'</samp>, -<samp>`en_US'</samp>, etc., for message translations. -</p> -<p>Use <code>cli_getCurrentLocale</code> function to know what current locale -information to use inside <tt>`centos-art.sh'</tt> script. -</p></dd></dl> - -<dl> -<dt><u>Function:</u> <b>cli_getFilesList</b><i> [LOCATION]</i> -<a name="IDX23"></a> -</dt> -<dd><p>Output list of files to process. -</p> -<p>The <code>cli_getFilesList</code> function uses <var>LOCATION</var> variable as -source location to build a list of files just as specified by regular -expression (<var>REGEX</var>) global variable. Essentially, what the -<code>cli_getFilesList</code> function does is using <code>find</code> command -to look for files in the location (<var>LOCATION</var>) just as posix-egrep -regular expression (<var>REGEX</var>) specifies. -</p> -<p>If <var>LOCATION</var> is not specified when <code>cli_getFilesList</code> -function is called, the action value (<var>ACTIONVAL</var>) global variable -is used as location value instead. -</p> -<p>By default, if the regular expression (<var>REGEX</var>) global variable is -not redefined after its first definition in the <code>cli</code> function, -all files that match default regular expression value (i.e., -<samp>`.+'</samp>) will be added to the list of files to process. Otherwise, -if you redefine the regular expression global variable after its first -definition in the <code>cli</code> function and before calling -<code>cli_getFilesList</code> function, the last value you specifed is used -instead. -</p> -<p>When you need to customize the regular expression (<var>REGEX</var>) global -variable value inside a function, do not redefine the global variable -(at least you be absolutly convinced you need to). Instead, set the -regular expression global variable as <samp>`local'</samp> to the function you -need a customized regular expression value for. If we don't redefine -the regular expression global variable as local to the function, or -use another name for the regular expression variable (which is not -very convenient in order to keep the amount of names to remember low), -you may experiment undesired concantenation issues that make your -regular expression to be something different from that you expect them -to be, specially if the function where you are doing the variable -redefinition is called several times during the same script execution. -</p> -<p>As result, the <code>cli_getFilesList</code> re-defines the value of -<var>FILES</var> variable with the list of files the <code>find</code> command -returned. As example, consider the following construction: -</p> -<pre class="verbatim">function prefix_doSomething { - - # Initialize the list of files to process. - local FILES='' - - # Initialize location. - local LOCATION=/home/centos/artwork/trunk/Identity/Themes/Models/Default - - # Re-define regular expression to match scalable vector graphic - # files only. Note how we use the global value of REGEX to build a - # new local REGEX value here. - local REGEX="${REGEX}.*\.(svgz|svg)" - - # Redefine list of files to process. - cli_getFilesList $LOCATION - - # Process list of files. - for FILE in $FILES;do - cli_printMessages "$FILE" 'AsResponseLine' - # Do something else here on... - done - -} -</pre> -</dd></dl> - -<dl> -<dt><u>Function:</u> <b>cli_getLangCodes</b><i> [FILTER]</i> -<a name="IDX24"></a> -</dt> -<dd><p>Outputs language codes supported by <tt>`centos-art.sh'</tt> script. -</p> -<p><code>cli_getLangCodes</code> function outputs a list of language codes as -defined in ISO639 standard. When <var>FILTER</var> is provided, -<code>cli_getLangCodes</code> outputs language codes that match <var>FILTER</var> -regular expression pattern. -</p></dd></dl> - -<dl> -<dt><u>Function:</u> <b>cli_getLangName</b><i> [FILTER]</i> -<a name="IDX25"></a> -</dt> -<dd><p>Outputs language names supported by <tt>`centos-art.sh'</tt> script. -</p> -<p><code>cli_getLangName</code> function reads one language locale code in the -format LL_CC and outputs the language related name as in ISO639. If -filter is specified, <code>cli_getLangName</code> returns the language name -that matches the locale code specified in <var>FILTER</var>, exactly. -</p></dd></dl> - -<dl> -<dt><u>Function:</u> <b>cli_getLocales</b> -<a name="IDX26"></a> -</dt> -<dd><p>Output locale codes supported by <tt>`centos-art.sh'</tt> script. -</p> -<p>Occasionally, you use <code>cli_getLocales</code> function to add locale -information in non-common country-specific language (<samp>`LL_CC'</samp>) -format for those languages (e.g., <samp>`bn_IN'</samp>, <samp>`pt_BR'</samp>, etc.) -which locale differences cannot be solved using common language -specifications (<samp>`LL'</samp>) into one unique common locale specification -(e.g., <samp>`bn'</samp>, <samp>`pt'</samp>, etc.). -</p></dd></dl> - -<dl> -<dt><u>Function:</u> <b>cli_getRepoName</b><i> NAME TYPE</i> -<a name="IDX27"></a> -</dt> -<dd><p>Sanitate file names. -</p> -<p>Inside <tt>`centos-art.sh'</tt> script, specific functionalities rely both -in <code>cli_getRepoName</code> and repository file system organization to -achieve their goals. Consider <code>cli_getRepoName</code> function as -central place to manage file name convenctions for other functions -inside <tt>`centos-art.sh'</tt> script. -</p> -<blockquote class="orange"><img src="/home/centos/artwork/trunk/Identity/Widgets/Img/icon-admonition-star.png" alt="Important"><h3>Important</h3><p> <code>cli_getRepoName</code> function doesn't verify file -or directory existence, for that purpose use <code>cli_checkFiles</code> -function instead. -</p></blockquote> - -<p>The <var>NAME</var> variable contains the file name or directory name you -want to sanitate. -</p> -<p>The <var>TYPE</var> variable specifies what type of sanitation you want to -perform on <var>NAME</var>. The <var>TYPE</var> can be one of the following -values: -</p> -<dl compact="compact"> -<dt> <samp>`d'</samp></dt> -<dt> <samp>`directory'</samp></dt> -<dd><p>Sanitate directory <var>NAME</var>s. -</p></dd> -<dt> <samp>`f'</samp></dt> -<dt> <samp>`regular-file'</samp></dt> -<dd><p>Sanitate regular file <var>NAME</var>s. -</p></dd> -</dl> - -<p>Use <code>cli_getRepoName</code> function to sanitate file names and -directory names before their utilization. -</p> -<p>Use <code>cli_getRepoName</code> when you need to change file name -convenctions inside <tt>`centos-art.sh'</tt> script. -</p> -<p>When we change file name convenctions inside <code>cli_getRepoName</code> -what we are really changing is the way functions interpret repository -file system organization. Notice that when we change a file name -(e.g., a function name), it is necessary to update all files where -such file name is placed on. This may require a massive substitution -inside the repository, each time we change name convenctions in the -repository (see section <a href="filesystem_57.html#SEC291">trunk/Scripts/Bash/Functions/Path</a>, for more -information). -</p></dd></dl> - -<dl> -<dt><u>Function:</u> <b>cli_getRepoStatus</b><i> [LOCATION]</i> -<a name="IDX28"></a> -</dt> -<dd><p>Request repository status. -</p> -<p>This function requests the status of a <var>LOCATION</var> inside the -working copy using the <code>svn status</code> command and returns the -first character in the output line, just as described in <code>svn -help status</code>. If <var>LOCATION</var> is not a regular file or a directory, -inside the working copy, the <tt>`centos-art.sh'</tt> script prints a -message and ends its execution. -</p> -<p>Use this function to perform verifications based a repository -<var>LOCATION</var> status. -</p></dd></dl> - -<dl> -<dt><u>Function:</u> <b>cli_getTemporalFile</b><i> <var>NAME</var></i> -<a name="IDX29"></a> -</dt> -<dd><p>Output absolute path to temporal file <var>NAME</var>. -</p> -<p>The <code>cli_getTemporalFile</code> function uses <tt>`/tmp'</tt> directory as -source location to store temporal files, the <tt>`centos-art.sh'</tt> -script name, and a random identification string to let you run more -than one <tt>`centos-art.sh'</tt> script simultaneously on the same user -session. For example, due the following temporal file defintion: -</p> -<pre class="verbatim">cli_getTemporalFile $FILE -</pre> -<p>If <var>FILE</var> name is <tt>`instance.svg'</tt> and the unique random string -is <samp>`f16f7b51-ac12-4b7f-9e66-72df847f12de'</samp>, the final temporal -file, built from previous temporal file definition, would be: -</p> -<pre class="verbatim">/tmp/centos-art.sh-f16f7b51-ac12-4b7f-9e66-72df847f12de-instance.svg -</pre> -<p>When you use the <code>cli_getTemporalFile</code> function to create -temporal files, be sure to remove temporal files created once you've -ended up with them. For example, consider the following construction: -</p> -<pre class="verbatim">for FILE in $FILES;do - - # Initialize temporal instance of file. - INSTANCE=$(cli_getTemporalFile $FILE) - - # Do something ... - - # Remove temporal instance of file. - if [[ -f $INSTANCE ]];then - rm $INSTANCE - fi - -done -</pre> -<p>Use the <code>cli_getTemporalFile</code> function whenever you need to -create temporal files inside <tt>`centos-art.sh'</tt> script. -</p></dd></dl> - -<dl> -<dt><u>Function:</u> <b>cli_getThemeName</b> -<a name="IDX30"></a> -</dt> -<dd><p>Output theme name. -</p> -<p>In order for <code>cli_getThemeName</code> function to extract theme name -correctly, the <var>ACTIONVAL</var> variable must contain a directory path -under <tt>`trunk/Identity/Themes/Motifs/'</tt> directory structure. -Otherwise, <code>cli_getThemeName</code> returns an empty string. -</p></dd></dl> - -<dl> -<dt><u>Function:</u> <b>cli_printMessage</b><i> MESSAGE [FORMAT]</i> -<a name="IDX31"></a> -</dt> -<dd><p>Define standard output message definition supported by -<tt>`centos-art.sh'</tt> script. -</p> -<p>When <var>FORMAT</var> is not specified, <code>cli_printMessage</code> outputs -information just as it was passed in <var>MESSAGE</var> variable. -Otherwise, <var>FORMAT</var> can take one of the following values: -</p> -<dl compact="compact"> -<dt> <samp>`AsHeadingLine'</samp></dt> -<dd><p>To print heading messages. -</p><pre class="verbatim">---------------------------------------------------------------------- -$MESSAGE ----------------------------------------------------------------------- -</pre> -</dd> -<dt> <samp>`AsWarningLine'</samp></dt> -<dd><p>To print warning messages. -</p><pre class="verbatim">---------------------------------------------------------------------- -WARNING: $MESSAGE ----------------------------------------------------------------------- -</pre> -</dd> -<dt> <samp>`AsNoteLine'</samp></dt> -<dd><p>To print note messages. -</p><pre class="verbatim">---------------------------------------------------------------------- -NOTE: $MESSAGE ----------------------------------------------------------------------- -</pre> -</dd> -<dt> <samp>`AsUpdatingLine'</samp></dt> -<dd><p>To print <samp>`Updating'</samp> messages on two-columns format. -</p><pre class="verbatim">Updating $MESSAGE -</pre> -</dd> -<dt> <samp>`AsRemovingLine'</samp></dt> -<dd><p>To print <samp>`Removing'</samp> messages on two-columns format. -</p><pre class="verbatim">Removing $MESSAGE -</pre> -</dd> -<dt> <samp>`AsCheckingLine'</samp></dt> -<dd><p>To print <samp>`Checking'</samp> messages on two-columns format. -</p><pre class="verbatim">Checking $MESSAGE -</pre> -</dd> -<dt> <samp>`AsCreatingLine'</samp></dt> -<dd><p>To print <samp>`Creating'</samp> messages on two-columns format. -</p><pre class="verbatim">Creating $MESSAGE -</pre> -</dd> -<dt> <samp>`AsSavedAsLine'</samp></dt> -<dd><p>To print <samp>`Saved as'</samp> messages on two-columns format. -</p><pre class="verbatim">Saved as $MESSAGE -</pre> -</dd> -<dt> <samp>`AsLinkToLine'</samp></dt> -<dd><p>To print <samp>`Linked to'</samp> messages on two-columns format. -</p><pre class="verbatim">Linked to $MESSAGE -</pre> -</dd> -<dt> <samp>`AsMovedToLine'</samp></dt> -<dd><p>To print <samp>`Moved to'</samp> messages on two-columns format. -</p><pre class="verbatim">Moved to $MESSAGE -</pre> -</dd> -<dt> <samp>`AsTranslationLine'</samp></dt> -<dd><p>To print <samp>`Translation'</samp> messages on two-columns format. -</p><pre class="verbatim">Translation $MESSAGE -</pre> -</dd> -<dt> <samp>`AsConfigurationLine'</samp></dt> -<dd><p>To print <samp>`Configuration'</samp> messages on two-columns format. -</p><pre class="verbatim">Configuration $MESSAGE -</pre> -</dd> -<dt> <samp>`AsResponseLine'</samp></dt> -<dd><p>To print response messages on one-column format. -</p><pre class="verbatim">--> $MESSAGE -</pre> -</dd> -<dt> <samp>`AsRequestLine'</samp></dt> -<dd><p>To print request messages on one-column format. Request messages -output messages with one colon (<samp>`:'</samp>) and without trailing newline -(<samp>`\n'</samp>) at message end. -</p><pre class="verbatim">$MESSAGE: -</pre> -</dd> -<dt> <samp>`AsYesOrNoRequestLine'</samp></dt> -<dd><p>To print <samp>`yes or no'</samp> request messages on one-column format. If -something different from <samp>`y'</samp> is answered (when using -<code>en_US.UTF-8</code> locale), script execution ends immediatly. -</p> -<pre class="verbatim">$MESSAGE [y/N]: -</pre> -<p>When we use <tt>`centos-art.sh'</tt> script in a locale different from -<code>en_US.UTF-8</code>, confirmation answer may be different from -<samp>`y'</samp>. For example, if you use <code>es_ES.UTF-8</code> locale, the -confirmation question would look like: -</p> -<pre class="verbatim">$MESSAGE [s/N]: -</pre> -<p>and the confirmation answer would be <samp>`s'</samp>, as it is on Spanish -<samp>`sí'</samp> word. -</p> -<p>Definition of which confirmation word to use is set on translation -messages for your specific locale information. See section <a href="filesystem_55.html#SEC281">trunk/Scripts/Bash/Functions/Locale</a>, for more information about locale-specific -translation messages. -</p> -</dd> -<dt> <samp>`AsToKnowMoreLine'</samp></dt> -<dd><p>To standardize <samp>`to know more, run the following command:'</samp> -messages. When the <samp>`AsToKnowMoreLine'</samp> option is used, the -<var>MESSAGE</var> value should be set to <code>"$(caller)"</code>. <code>caller</code> -is a Bash builtin that returns the context of the current subroutine -call. <samp>`AsToKnowMoreLine'</samp> option uses <code>caller</code> builtin -output to build documentation entries dynamically. -</p> -<pre class="verbatim">---------------------------------------------------------------------- -To know more, run the following command: -centos-art manual --read='path/to/dir' ----------------------------------------------------------------------- -</pre> -<p>Use <samp>`AsToKnowMoreLine'</samp> option after errors and for intentional -script termination. -</p> -</dd> -<dt> <samp>`AsRegularLine'</samp></dt> -<dd><p>To standardize regular messages on one-column format. -</p> -<p>When <var>MESSAGE</var> contains a colon inside (e.g., <samp>`description: -message'</samp>), the <code>cli_printMessage</code> function outputs <var>MESSAGE</var> -on two-columns format. -</p></dd> -</dl> +<h3 class="subsection"> 3.50.2 Description </h3> -<p>Use <code>cli_printMessage</code> function whenever you need to output -information from <tt>`centos-art.sh'</tt> script. -</p> -<blockquote class="orange"><img src="/home/centos/artwork/trunk/Identity/Widgets/Img/icon-admonition-idea.png" alt="Info"><h3>Tip</h3><p> To improve two-columns format, change the following file: -</p><pre class="verbatim">trunk/Scripts/Bash/Styles/output_forTwoColumns.awk -</pre></blockquote> -</dd></dl> +<ul class="toc"> +<li> ... +</li></ul> <a name="SEC274"></a> -<h4 class="subsubsection"> 3.50.3.3 Specific functions </h4> +<h3 class="subsection"> 3.50.3 Usage </h3> -<p>The following specific functions of <tt>`centos-art.sh'</tt> script, are -available for you to use: -</p> -<table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top"><a href="filesystem_54.html#SEC276">3.51 trunk/Scripts/Bash/Functions/Html</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="filesystem_55.html#SEC281">3.52 trunk/Scripts/Bash/Functions/Locale</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="filesystem_56.html#SEC286">3.53 trunk/Scripts/Bash/Functions/Manual</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="filesystem_57.html#SEC291">3.54 trunk/Scripts/Bash/Functions/Path</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="filesystem_58.html#SEC302">3.55 trunk/Scripts/Bash/Functions/Render</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="filesystem_59.html#SEC312">3.56 trunk/Scripts/Bash/Functions/Render/Config</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="filesystem_60.html#SEC320">3.57 trunk/Scripts/Bash/Functions/Shell</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="filesystem_61.html#SEC325">3.58 trunk/Scripts/Bash/Functions/Svg</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="filesystem_62.html#SEC332">3.59 trunk/Scripts/Bash/Functions/Verify</a></td><td> </td><td align="left" valign="top"> -</td></tr> -</table> +<ul class="toc"> +<li> ... +</li></ul> <a name="SEC275"></a> <h3 class="subsection"> 3.50.4 See also </h3> -<table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top"><a href="filesystem_50.html#SEC257">3.47 trunk/Scripts/Bash</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="filesystem_63.html#SEC340">3.60 trunk/Scripts/Bash/Locale</a></td><td> </td><td align="left" valign="top"> -</td></tr> -</table> <table cellpadding="1" cellspacing="1" border="0"> @@ -1360,7 +106,7 @@ available for you to use: <td valign="middle" align="left">[<a href="filesystem_54.html#SEC276" title="Next section in reading order"> > </a>]</td> <td valign="middle" align="left"> </td> <td valign="middle" align="left">[<a href="filesystem_3.html#SEC3" title="Beginning of this chapter or previous chapter"> << </a>]</td> -<td valign="middle" align="left">[<a href="#SEC268" title="Up section"> Up </a>]</td> +<td valign="middle" align="left">[<a href="#SEC271" title="Up section"> Up </a>]</td> <td valign="middle" align="left">[<a href="filesystem_66.html#SEC355" title="Next chapter"> >> </a>]</td> </tr></table> <p> diff --git a/Manuals/Filesystem/filesystem-html/filesystem_54.html b/Manuals/Filesystem/filesystem-html/filesystem_54.html index 9efa026..81600d9 100644 --- a/Manuals/Filesystem/filesystem-html/filesystem_54.html +++ b/Manuals/Filesystem/filesystem-html/filesystem_54.html @@ -20,10 +20,10 @@ Send bugs and suggestions to <users@texi2html.cvshome.org> --> <head> -<title>CentOS Artwork Repository - Filesystem: 3.51 trunk/Scripts/Bash/Functions/Html</title> +<title>CentOS Artwork Repository - Filesystem: 3.51 trunk/Scripts/Bash/centos-art/Functions/Html</title> -<meta name="description" content="CentOS Artwork Repository - Filesystem: 3.51 trunk/Scripts/Bash/Functions/Html"> -<meta name="keywords" content="CentOS Artwork Repository - Filesystem: 3.51 trunk/Scripts/Bash/Functions/Html"> +<meta name="description" content="CentOS Artwork Repository - Filesystem: 3.51 trunk/Scripts/Bash/centos-art/Functions/Html"> +<meta name="keywords" content="CentOS Artwork Repository - Filesystem: 3.51 trunk/Scripts/Bash/centos-art/Functions/Html"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="texi2html 1.76"> @@ -67,9 +67,9 @@ ul.toc {list-style: none} <td valign="middle" align="left">[<a href="filesystem_66.html#SEC355" title="Index">Index</a>]</td> <td valign="middle" align="left">[<a href="filesystem_abt.html#SEC_About" title="About (help)"> ? </a>]</td> </tr></table> -<a name="trunk-Scripts-Bash-Functions-Html"></a> +<a name="trunk-Scripts-Bash-centos_002dart-Functions-Html"></a> <a name="SEC276"></a> -<h2 class="section"> 3.51 trunk/Scripts/Bash/Functions/Html </h2> +<h2 class="section"> 3.51 trunk/Scripts/Bash/centos-art/Functions/Html </h2> <a name="SEC277"></a> diff --git a/Manuals/Filesystem/filesystem-html/filesystem_55.html b/Manuals/Filesystem/filesystem-html/filesystem_55.html index 146a907..1243c52 100644 --- a/Manuals/Filesystem/filesystem-html/filesystem_55.html +++ b/Manuals/Filesystem/filesystem-html/filesystem_55.html @@ -20,10 +20,10 @@ Send bugs and suggestions to <users@texi2html.cvshome.org> --> <head> -<title>CentOS Artwork Repository - Filesystem: 3.52 trunk/Scripts/Bash/Functions/Locale</title> +<title>CentOS Artwork Repository - Filesystem: 3.52 trunk/Scripts/Bash/centos-art/Functions/Locale</title> -<meta name="description" content="CentOS Artwork Repository - Filesystem: 3.52 trunk/Scripts/Bash/Functions/Locale"> -<meta name="keywords" content="CentOS Artwork Repository - Filesystem: 3.52 trunk/Scripts/Bash/Functions/Locale"> +<meta name="description" content="CentOS Artwork Repository - Filesystem: 3.52 trunk/Scripts/Bash/centos-art/Functions/Locale"> +<meta name="keywords" content="CentOS Artwork Repository - Filesystem: 3.52 trunk/Scripts/Bash/centos-art/Functions/Locale"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="texi2html 1.76"> @@ -67,9 +67,9 @@ ul.toc {list-style: none} <td valign="middle" align="left">[<a href="filesystem_66.html#SEC355" title="Index">Index</a>]</td> <td valign="middle" align="left">[<a href="filesystem_abt.html#SEC_About" title="About (help)"> ? </a>]</td> </tr></table> -<a name="trunk-Scripts-Bash-Functions-Locale"></a> +<a name="trunk-Scripts-Bash-centos_002dart-Functions-Locale"></a> <a name="SEC281"></a> -<h2 class="section"> 3.52 trunk/Scripts/Bash/Functions/Locale </h2> +<h2 class="section"> 3.52 trunk/Scripts/Bash/centos-art/Functions/Locale </h2> <a name="SEC282"></a> diff --git a/Manuals/Filesystem/filesystem-html/filesystem_56.html b/Manuals/Filesystem/filesystem-html/filesystem_56.html index 70e0edc..9f67fb4 100644 --- a/Manuals/Filesystem/filesystem-html/filesystem_56.html +++ b/Manuals/Filesystem/filesystem-html/filesystem_56.html @@ -20,10 +20,10 @@ Send bugs and suggestions to <users@texi2html.cvshome.org> --> <head> -<title>CentOS Artwork Repository - Filesystem: 3.53 trunk/Scripts/Bash/Functions/Manual</title> +<title>CentOS Artwork Repository - Filesystem: 3.53 trunk/Scripts/Bash/centos-art/Functions/Manual</title> -<meta name="description" content="CentOS Artwork Repository - Filesystem: 3.53 trunk/Scripts/Bash/Functions/Manual"> -<meta name="keywords" content="CentOS Artwork Repository - Filesystem: 3.53 trunk/Scripts/Bash/Functions/Manual"> +<meta name="description" content="CentOS Artwork Repository - Filesystem: 3.53 trunk/Scripts/Bash/centos-art/Functions/Manual"> +<meta name="keywords" content="CentOS Artwork Repository - Filesystem: 3.53 trunk/Scripts/Bash/centos-art/Functions/Manual"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="texi2html 1.76"> @@ -67,9 +67,9 @@ ul.toc {list-style: none} <td valign="middle" align="left">[<a href="filesystem_66.html#SEC355" title="Index">Index</a>]</td> <td valign="middle" align="left">[<a href="filesystem_abt.html#SEC_About" title="About (help)"> ? </a>]</td> </tr></table> -<a name="trunk-Scripts-Bash-Functions-Manual"></a> +<a name="trunk-Scripts-Bash-centos_002dart-Functions-Manual"></a> <a name="SEC286"></a> -<h2 class="section"> 3.53 trunk/Scripts/Bash/Functions/Manual </h2> +<h2 class="section"> 3.53 trunk/Scripts/Bash/centos-art/Functions/Manual </h2> <a name="SEC287"></a> diff --git a/Manuals/Filesystem/filesystem-html/filesystem_57.html b/Manuals/Filesystem/filesystem-html/filesystem_57.html index 63a514f..352cec1 100644 --- a/Manuals/Filesystem/filesystem-html/filesystem_57.html +++ b/Manuals/Filesystem/filesystem-html/filesystem_57.html @@ -20,10 +20,10 @@ Send bugs and suggestions to <users@texi2html.cvshome.org> --> <head> -<title>CentOS Artwork Repository - Filesystem: 3.54 trunk/Scripts/Bash/Functions/Path</title> +<title>CentOS Artwork Repository - Filesystem: 3.54 trunk/Scripts/Bash/centos-art/Functions/Path</title> -<meta name="description" content="CentOS Artwork Repository - Filesystem: 3.54 trunk/Scripts/Bash/Functions/Path"> -<meta name="keywords" content="CentOS Artwork Repository - Filesystem: 3.54 trunk/Scripts/Bash/Functions/Path"> +<meta name="description" content="CentOS Artwork Repository - Filesystem: 3.54 trunk/Scripts/Bash/centos-art/Functions/Path"> +<meta name="keywords" content="CentOS Artwork Repository - Filesystem: 3.54 trunk/Scripts/Bash/centos-art/Functions/Path"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="texi2html 1.76"> @@ -67,9 +67,9 @@ ul.toc {list-style: none} <td valign="middle" align="left">[<a href="filesystem_66.html#SEC355" title="Index">Index</a>]</td> <td valign="middle" align="left">[<a href="filesystem_abt.html#SEC_About" title="About (help)"> ? </a>]</td> </tr></table> -<a name="trunk-Scripts-Bash-Functions-Path"></a> +<a name="trunk-Scripts-Bash-centos_002dart-Functions-Path"></a> <a name="SEC291"></a> -<h2 class="section"> 3.54 trunk/Scripts/Bash/Functions/Path </h2> +<h2 class="section"> 3.54 trunk/Scripts/Bash/centos-art/Functions/Path </h2> <a name="SEC292"></a> @@ -415,8 +415,6 @@ In this command, <tt>`SRC'</tt> is a working copy (WC) entry. <table class="menu" border="0" cellspacing="0"> <tr><td align="left" valign="top"><a href="filesystem_50.html#SEC257">3.47 trunk/Scripts/Bash</a></td><td> </td><td align="left" valign="top"> </td></tr> -<tr><td align="left" valign="top"><a href="filesystem_53.html#SEC268">3.50 trunk/Scripts/Bash/Functions</a></td><td> </td><td align="left" valign="top"> -</td></tr> </table> diff --git a/Manuals/Filesystem/filesystem-html/filesystem_58.html b/Manuals/Filesystem/filesystem-html/filesystem_58.html index 9292157..02dc894 100644 --- a/Manuals/Filesystem/filesystem-html/filesystem_58.html +++ b/Manuals/Filesystem/filesystem-html/filesystem_58.html @@ -20,10 +20,10 @@ Send bugs and suggestions to <users@texi2html.cvshome.org> --> <head> -<title>CentOS Artwork Repository - Filesystem: 3.55 trunk/Scripts/Bash/Functions/Render</title> +<title>CentOS Artwork Repository - Filesystem: 3.55 trunk/Scripts/Bash/centos-art/Functions/Render</title> -<meta name="description" content="CentOS Artwork Repository - Filesystem: 3.55 trunk/Scripts/Bash/Functions/Render"> -<meta name="keywords" content="CentOS Artwork Repository - Filesystem: 3.55 trunk/Scripts/Bash/Functions/Render"> +<meta name="description" content="CentOS Artwork Repository - Filesystem: 3.55 trunk/Scripts/Bash/centos-art/Functions/Render"> +<meta name="keywords" content="CentOS Artwork Repository - Filesystem: 3.55 trunk/Scripts/Bash/centos-art/Functions/Render"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="texi2html 1.76"> @@ -67,9 +67,9 @@ ul.toc {list-style: none} <td valign="middle" align="left">[<a href="filesystem_66.html#SEC355" title="Index">Index</a>]</td> <td valign="middle" align="left">[<a href="filesystem_abt.html#SEC_About" title="About (help)"> ? </a>]</td> </tr></table> -<a name="trunk-Scripts-Bash-Functions-Render"></a> +<a name="trunk-Scripts-Bash-centos_002dart-Functions-Render"></a> <a name="SEC302"></a> -<h2 class="section"> 3.55 trunk/Scripts/Bash/Functions/Render </h2> +<h2 class="section"> 3.55 trunk/Scripts/Bash/centos-art/Functions/Render </h2> <p>The <code>render</code> functionality exists to produce both identity and translation files on different levels of information (i.e., different @@ -180,7 +180,8 @@ produce image-based content, <tt>`centos-art.sh'</tt> produces <acronym title="Portable Network Graphics">PNG</acronym> (Portable Network Graphics) files with the <code>.png</code> extension. Once the base image format has been produced, it is possible for <tt>`centos-art.sh'</tt> to use it in order to automatically -create other image formats that may be needed (see section <a href="filesystem_59.html#SEC312">trunk/Scripts/Bash/Functions/Render/Config</a>). +create other image formats that may be needed (-- <strong>Removed</strong>(pxref:trunk Scripts +Bash Functions Render Config) --). </p> <p>Inside the working copy, you can find an example of "design template without translation" configuration at <tt>`trunk/Identity/Models/'</tt>. @@ -288,7 +289,7 @@ design template instance is removed. At this point, whole production flow once again (design template by design template), until all design templates be processed. </p> -<p>See section <a href="filesystem_59.html#SEC312">trunk/Scripts/Bash/Functions/Render/Config</a>, for more +<p>-- <strong>Removed</strong>(xref:trunk Scripts Bash Functions Render Config) --, for more information. </p></dd> </dl> @@ -799,10 +800,6 @@ have been duplicated, the functionality stops thereat. <a name="SEC311"></a> <h3 class="subsection"> 3.55.5 See also </h3> -<table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top"><a href="filesystem_59.html#SEC312">3.56 trunk/Scripts/Bash/Functions/Render/Config</a></td><td> </td><td align="left" valign="top"> -</td></tr> -</table> <table cellpadding="1" cellspacing="1" border="0"> diff --git a/Manuals/Filesystem/filesystem-html/filesystem_59.html b/Manuals/Filesystem/filesystem-html/filesystem_59.html index 098d629..fa2491d 100644 --- a/Manuals/Filesystem/filesystem-html/filesystem_59.html +++ b/Manuals/Filesystem/filesystem-html/filesystem_59.html @@ -20,10 +20,10 @@ Send bugs and suggestions to <users@texi2html.cvshome.org> --> <head> -<title>CentOS Artwork Repository - Filesystem: 3.56 trunk/Scripts/Bash/Functions/Render/Config</title> +<title>CentOS Artwork Repository - Filesystem: 3.56 trunk/Scripts/Bash/centos-art/Functions/Render/Config</title> -<meta name="description" content="CentOS Artwork Repository - Filesystem: 3.56 trunk/Scripts/Bash/Functions/Render/Config"> -<meta name="keywords" content="CentOS Artwork Repository - Filesystem: 3.56 trunk/Scripts/Bash/Functions/Render/Config"> +<meta name="description" content="CentOS Artwork Repository - Filesystem: 3.56 trunk/Scripts/Bash/centos-art/Functions/Render/Config"> +<meta name="keywords" content="CentOS Artwork Repository - Filesystem: 3.56 trunk/Scripts/Bash/centos-art/Functions/Render/Config"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="texi2html 1.76"> @@ -67,9 +67,9 @@ ul.toc {list-style: none} <td valign="middle" align="left">[<a href="filesystem_66.html#SEC355" title="Index">Index</a>]</td> <td valign="middle" align="left">[<a href="filesystem_abt.html#SEC_About" title="About (help)"> ? </a>]</td> </tr></table> -<a name="trunk-Scripts-Bash-Functions-Render-Config"></a> +<a name="trunk-Scripts-Bash-centos_002dart-Functions-Render-Config"></a> <a name="SEC312"></a> -<h2 class="section"> 3.56 trunk/Scripts/Bash/Functions/Render/Config </h2> +<h2 class="section"> 3.56 trunk/Scripts/Bash/centos-art/Functions/Render/Config </h2> <a name="SEC313"></a> @@ -206,7 +206,7 @@ file in the list of files to process has been rendered. The <samp>`LAST'</samp> action is optional. Possible values for <samp>`LAST'</samp> actions may be <samp>`groupByFormat'</samp>, <samp>`renderGdmTgz'</samp>, etc. </p> -<blockquote class="blue"><img src="/home/centos/artwork/trunk/Identity/Widgets/Img/icon-admonition-info.png" alt="info"><h3>Note</h3><p> See section <a href="filesystem_58.html#SEC302">trunk/Scripts/Bash/Functions/Render</a>, to know more +<blockquote class="blue"><img src="/home/centos/artwork/trunk/Identity/Widgets/Img/icon-admonition-info.png" alt="info"><h3>Note</h3><p> -- <strong>Removed</strong>(xref:trunk Scripts Bash Functions Render) --, to know more about possible values for <samp>`BASE'</samp>, <samp>`POST'</samp> and <samp>`LAST'</samp> action definitions. </p></blockquote> @@ -265,10 +265,6 @@ directory path under <tt>`trunk/Identity'</tt> or <table class="menu" border="0" cellspacing="0"> <tr><td align="left" valign="top"><a href="filesystem_50.html#SEC257">3.47 trunk/Scripts/Bash</a></td><td> </td><td align="left" valign="top"> </td></tr> -<tr><td align="left" valign="top"><a href="filesystem_53.html#SEC268">3.50 trunk/Scripts/Bash/Functions</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top"><a href="filesystem_58.html#SEC302">3.55 trunk/Scripts/Bash/Functions/Render</a></td><td> </td><td align="left" valign="top"> -</td></tr> </table> diff --git a/Manuals/Filesystem/filesystem-html/filesystem_60.html b/Manuals/Filesystem/filesystem-html/filesystem_60.html index 1ae9ba0..3710232 100644 --- a/Manuals/Filesystem/filesystem-html/filesystem_60.html +++ b/Manuals/Filesystem/filesystem-html/filesystem_60.html @@ -20,10 +20,10 @@ Send bugs and suggestions to <users@texi2html.cvshome.org> --> <head> -<title>CentOS Artwork Repository - Filesystem: 3.57 trunk/Scripts/Bash/Functions/Shell</title> +<title>CentOS Artwork Repository - Filesystem: 3.57 trunk/Scripts/Bash/centos-art/Functions/Shell</title> -<meta name="description" content="CentOS Artwork Repository - Filesystem: 3.57 trunk/Scripts/Bash/Functions/Shell"> -<meta name="keywords" content="CentOS Artwork Repository - Filesystem: 3.57 trunk/Scripts/Bash/Functions/Shell"> +<meta name="description" content="CentOS Artwork Repository - Filesystem: 3.57 trunk/Scripts/Bash/centos-art/Functions/Shell"> +<meta name="keywords" content="CentOS Artwork Repository - Filesystem: 3.57 trunk/Scripts/Bash/centos-art/Functions/Shell"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="texi2html 1.76"> @@ -67,9 +67,9 @@ ul.toc {list-style: none} <td valign="middle" align="left">[<a href="filesystem_66.html#SEC355" title="Index">Index</a>]</td> <td valign="middle" align="left">[<a href="filesystem_abt.html#SEC_About" title="About (help)"> ? </a>]</td> </tr></table> -<a name="trunk-Scripts-Bash-Functions-Shell"></a> +<a name="trunk-Scripts-Bash-centos_002dart-Functions-Shell"></a> <a name="SEC320"></a> -<h2 class="section"> 3.57 trunk/Scripts/Bash/Functions/Shell </h2> +<h2 class="section"> 3.57 trunk/Scripts/Bash/centos-art/Functions/Shell </h2> <a name="SEC321"></a> @@ -255,8 +255,6 @@ list of files to process. <table class="menu" border="0" cellspacing="0"> <tr><td align="left" valign="top"><a href="filesystem_50.html#SEC257">3.47 trunk/Scripts/Bash</a></td><td> </td><td align="left" valign="top"> </td></tr> -<tr><td align="left" valign="top"><a href="filesystem_53.html#SEC268">3.50 trunk/Scripts/Bash/Functions</a></td><td> </td><td align="left" valign="top"> -</td></tr> </table> diff --git a/Manuals/Filesystem/filesystem-html/filesystem_61.html b/Manuals/Filesystem/filesystem-html/filesystem_61.html index d6871ed..792426f 100644 --- a/Manuals/Filesystem/filesystem-html/filesystem_61.html +++ b/Manuals/Filesystem/filesystem-html/filesystem_61.html @@ -20,10 +20,10 @@ Send bugs and suggestions to <users@texi2html.cvshome.org> --> <head> -<title>CentOS Artwork Repository - Filesystem: 3.58 trunk/Scripts/Bash/Functions/Svg</title> +<title>CentOS Artwork Repository - Filesystem: 3.58 trunk/Scripts/Bash/centos-art/Functions/Svg</title> -<meta name="description" content="CentOS Artwork Repository - Filesystem: 3.58 trunk/Scripts/Bash/Functions/Svg"> -<meta name="keywords" content="CentOS Artwork Repository - Filesystem: 3.58 trunk/Scripts/Bash/Functions/Svg"> +<meta name="description" content="CentOS Artwork Repository - Filesystem: 3.58 trunk/Scripts/Bash/centos-art/Functions/Svg"> +<meta name="keywords" content="CentOS Artwork Repository - Filesystem: 3.58 trunk/Scripts/Bash/centos-art/Functions/Svg"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="texi2html 1.76"> @@ -67,9 +67,9 @@ ul.toc {list-style: none} <td valign="middle" align="left">[<a href="filesystem_66.html#SEC355" title="Index">Index</a>]</td> <td valign="middle" align="left">[<a href="filesystem_abt.html#SEC_About" title="About (help)"> ? </a>]</td> </tr></table> -<a name="trunk-Scripts-Bash-Functions-Svg"></a> +<a name="trunk-Scripts-Bash-centos_002dart-Functions-Svg"></a> <a name="SEC325"></a> -<h2 class="section"> 3.58 trunk/Scripts/Bash/Functions/Svg </h2> +<h2 class="section"> 3.58 trunk/Scripts/Bash/centos-art/Functions/Svg </h2> <a name="SEC326"></a> @@ -287,8 +287,6 @@ list of files to process. <table class="menu" border="0" cellspacing="0"> <tr><td align="left" valign="top"><a href="filesystem_50.html#SEC257">3.47 trunk/Scripts/Bash</a></td><td> </td><td align="left" valign="top"> </td></tr> -<tr><td align="left" valign="top"><a href="filesystem_53.html#SEC268">3.50 trunk/Scripts/Bash/Functions</a></td><td> </td><td align="left" valign="top"> -</td></tr> </table> diff --git a/Manuals/Filesystem/filesystem-html/filesystem_62.html b/Manuals/Filesystem/filesystem-html/filesystem_62.html index c79eca3..4d52d15 100644 --- a/Manuals/Filesystem/filesystem-html/filesystem_62.html +++ b/Manuals/Filesystem/filesystem-html/filesystem_62.html @@ -20,10 +20,10 @@ Send bugs and suggestions to <users@texi2html.cvshome.org> --> <head> -<title>CentOS Artwork Repository - Filesystem: 3.59 trunk/Scripts/Bash/Functions/Verify</title> +<title>CentOS Artwork Repository - Filesystem: 3.59 trunk/Scripts/Bash/centos-art/Functions/Verify</title> -<meta name="description" content="CentOS Artwork Repository - Filesystem: 3.59 trunk/Scripts/Bash/Functions/Verify"> -<meta name="keywords" content="CentOS Artwork Repository - Filesystem: 3.59 trunk/Scripts/Bash/Functions/Verify"> +<meta name="description" content="CentOS Artwork Repository - Filesystem: 3.59 trunk/Scripts/Bash/centos-art/Functions/Verify"> +<meta name="keywords" content="CentOS Artwork Repository - Filesystem: 3.59 trunk/Scripts/Bash/centos-art/Functions/Verify"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="texi2html 1.76"> @@ -67,9 +67,9 @@ ul.toc {list-style: none} <td valign="middle" align="left">[<a href="filesystem_66.html#SEC355" title="Index">Index</a>]</td> <td valign="middle" align="left">[<a href="filesystem_abt.html#SEC_About" title="About (help)"> ? </a>]</td> </tr></table> -<a name="trunk-Scripts-Bash-Functions-Verify"></a> +<a name="trunk-Scripts-Bash-centos_002dart-Functions-Verify"></a> <a name="SEC332"></a> -<h2 class="section"> 3.59 trunk/Scripts/Bash/Functions/Verify </h2> +<h2 class="section"> 3.59 trunk/Scripts/Bash/centos-art/Functions/Verify </h2> <a name="SEC333"></a> @@ -334,8 +334,6 @@ provided at all. <table class="menu" border="0" cellspacing="0"> <tr><td align="left" valign="top"><a href="filesystem_50.html#SEC257">3.47 trunk/Scripts/Bash</a></td><td> </td><td align="left" valign="top"> </td></tr> -<tr><td align="left" valign="top"><a href="filesystem_53.html#SEC268">3.50 trunk/Scripts/Bash/Functions</a></td><td> </td><td align="left" valign="top"> -</td></tr> </table> diff --git a/Manuals/Filesystem/filesystem-html/filesystem_63.html b/Manuals/Filesystem/filesystem-html/filesystem_63.html index 37e530b..f55d5c1 100644 --- a/Manuals/Filesystem/filesystem-html/filesystem_63.html +++ b/Manuals/Filesystem/filesystem-html/filesystem_63.html @@ -85,7 +85,7 @@ used by <tt>`centos-art.sh'</tt> script. <p>Translated messages of <tt>`centos-art.sh'</tt> script are managed using GNU <code>gettext</code> utilities. Most translation actions have been automated through <tt>`centos-art.sh'</tt> script "locale" functionality -(see section <a href="filesystem_55.html#SEC281">trunk/Scripts/Bash/Functions/Locale</a>). +(-- <strong>Removed</strong>(pxref:trunk Scripts Bash Functions Locale) --). </p> <a name="SEC343"></a> @@ -93,7 +93,8 @@ automated through <tt>`centos-art.sh'</tt> script "locale" functionali <p>The content of <tt>`trunk/Scripts/Bash/Locale'</tt> directory should not be managed manually. Instead, use the "locale" functionality of -<tt>`centos-art.sh'</tt> script. See section <a href="filesystem_55.html#SEC281">trunk/Scripts/Bash/Functions/Locale</a>, for more information on how to use <tt>`centos-art.sh'</tt> +<tt>`centos-art.sh'</tt> script. -- <strong>Removed</strong>(xref:trunk Scripts Bash Functions +Locale) --, for more information on how to use <tt>`centos-art.sh'</tt> "locale" functionality. </p> @@ -101,8 +102,6 @@ be managed manually. Instead, use the "locale" functionality of <h3 class="subsection"> 3.60.4 See also </h3> <table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top"><a href="filesystem_53.html#SEC268">3.50 trunk/Scripts/Bash/Functions</a></td><td> </td><td align="left" valign="top"> -</td></tr> <tr><td align="left" valign="top"><a href="filesystem_49.html#SEC252">3.46 trunk/Scripts</a></td><td> </td><td align="left" valign="top"> </td></tr> </table> diff --git a/Manuals/Filesystem/filesystem-html/filesystem_66.html b/Manuals/Filesystem/filesystem-html/filesystem_66.html index 512bc36..f751c83 100644 --- a/Manuals/Filesystem/filesystem-html/filesystem_66.html +++ b/Manuals/Filesystem/filesystem-html/filesystem_66.html @@ -148,16 +148,16 @@ ul.toc {list-style: none} <tr><td></td><td valign="top"><a href="filesystem_50.html#SEC257">trunk Scripts Bash</a></td><td valign="top"><a href="filesystem_50.html#SEC257">3.47 trunk/Scripts/Bash</a></td></tr> <tr><td></td><td valign="top"><a href="filesystem_51.html#SEC262">trunk Scripts Bash centos-art</a></td><td valign="top"><a href="filesystem_51.html#SEC262">3.48 trunk/Scripts/Bash/centos-art</a></td></tr> <tr><td></td><td valign="top"><a href="filesystem_52.html#SEC263">trunk Scripts Bash centos-art Functions</a></td><td valign="top"><a href="filesystem_52.html#SEC263">3.49 trunk/Scripts/Bash/centos-art/Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="filesystem_53.html#SEC268">trunk Scripts Bash Functions</a></td><td valign="top"><a href="filesystem_53.html#SEC268">3.50 trunk/Scripts/Bash/Functions</a></td></tr> -<tr><td></td><td valign="top"><a href="filesystem_54.html#SEC276">trunk Scripts Bash Functions Html</a></td><td valign="top"><a href="filesystem_54.html#SEC276">3.51 trunk/Scripts/Bash/Functions/Html</a></td></tr> -<tr><td></td><td valign="top"><a href="filesystem_55.html#SEC281">trunk Scripts Bash Functions Locale</a></td><td valign="top"><a href="filesystem_55.html#SEC281">3.52 trunk/Scripts/Bash/Functions/Locale</a></td></tr> -<tr><td></td><td valign="top"><a href="filesystem_56.html#SEC286">trunk Scripts Bash Functions Manual</a></td><td valign="top"><a href="filesystem_56.html#SEC286">3.53 trunk/Scripts/Bash/Functions/Manual</a></td></tr> -<tr><td></td><td valign="top"><a href="filesystem_57.html#SEC291">trunk Scripts Bash Functions Path</a></td><td valign="top"><a href="filesystem_57.html#SEC291">3.54 trunk/Scripts/Bash/Functions/Path</a></td></tr> -<tr><td></td><td valign="top"><a href="filesystem_58.html#SEC302">trunk Scripts Bash Functions Render</a></td><td valign="top"><a href="filesystem_58.html#SEC302">3.55 trunk/Scripts/Bash/Functions/Render</a></td></tr> -<tr><td></td><td valign="top"><a href="filesystem_59.html#SEC312">trunk Scripts Bash Functions Render Config</a></td><td valign="top"><a href="filesystem_59.html#SEC312">3.56 trunk/Scripts/Bash/Functions/Render/Config</a></td></tr> -<tr><td></td><td valign="top"><a href="filesystem_60.html#SEC320">trunk Scripts Bash Functions Shell</a></td><td valign="top"><a href="filesystem_60.html#SEC320">3.57 trunk/Scripts/Bash/Functions/Shell</a></td></tr> -<tr><td></td><td valign="top"><a href="filesystem_61.html#SEC325">trunk Scripts Bash Functions Svg</a></td><td valign="top"><a href="filesystem_61.html#SEC325">3.58 trunk/Scripts/Bash/Functions/Svg</a></td></tr> -<tr><td></td><td valign="top"><a href="filesystem_62.html#SEC332">trunk Scripts Bash Functions Verify</a></td><td valign="top"><a href="filesystem_62.html#SEC332">3.59 trunk/Scripts/Bash/Functions/Verify</a></td></tr> +<tr><td></td><td valign="top"><a href="filesystem_53.html#SEC271">trunk Scripts Bash centos-art Functions Help</a></td><td valign="top"><a href="filesystem_53.html#SEC271">3.50 trunk/Scripts/Bash/centos-art/Functions/Help</a></td></tr> +<tr><td></td><td valign="top"><a href="filesystem_54.html#SEC276">trunk Scripts Bash centos-art Functions Html</a></td><td valign="top"><a href="filesystem_54.html#SEC276">3.51 trunk/Scripts/Bash/centos-art/Functions/Html</a></td></tr> +<tr><td></td><td valign="top"><a href="filesystem_55.html#SEC281">trunk Scripts Bash centos-art Functions Locale</a></td><td valign="top"><a href="filesystem_55.html#SEC281">3.52 trunk/Scripts/Bash/centos-art/Functions/Locale</a></td></tr> +<tr><td></td><td valign="top"><a href="filesystem_56.html#SEC286">trunk Scripts Bash centos-art Functions Manual</a></td><td valign="top"><a href="filesystem_56.html#SEC286">3.53 trunk/Scripts/Bash/centos-art/Functions/Manual</a></td></tr> +<tr><td></td><td valign="top"><a href="filesystem_57.html#SEC291">trunk Scripts Bash centos-art Functions Path</a></td><td valign="top"><a href="filesystem_57.html#SEC291">3.54 trunk/Scripts/Bash/centos-art/Functions/Path</a></td></tr> +<tr><td></td><td valign="top"><a href="filesystem_58.html#SEC302">trunk Scripts Bash centos-art Functions Render</a></td><td valign="top"><a href="filesystem_58.html#SEC302">3.55 trunk/Scripts/Bash/centos-art/Functions/Render</a></td></tr> +<tr><td></td><td valign="top"><a href="filesystem_59.html#SEC312">trunk Scripts Bash centos-art Functions Render Config</a></td><td valign="top"><a href="filesystem_59.html#SEC312">3.56 trunk/Scripts/Bash/centos-art/Functions/Render/Config</a></td></tr> +<tr><td></td><td valign="top"><a href="filesystem_60.html#SEC320">trunk Scripts Bash centos-art Functions Shell</a></td><td valign="top"><a href="filesystem_60.html#SEC320">3.57 trunk/Scripts/Bash/centos-art/Functions/Shell</a></td></tr> +<tr><td></td><td valign="top"><a href="filesystem_61.html#SEC325">trunk Scripts Bash centos-art Functions Svg</a></td><td valign="top"><a href="filesystem_61.html#SEC325">3.58 trunk/Scripts/Bash/centos-art/Functions/Svg</a></td></tr> +<tr><td></td><td valign="top"><a href="filesystem_62.html#SEC332">trunk Scripts Bash centos-art Functions Verify</a></td><td valign="top"><a href="filesystem_62.html#SEC332">3.59 trunk/Scripts/Bash/centos-art/Functions/Verify</a></td></tr> <tr><td></td><td valign="top"><a href="filesystem_63.html#SEC340">trunk Scripts Bash Locale</a></td><td valign="top"><a href="filesystem_63.html#SEC340">3.60 trunk/Scripts/Bash/Locale</a></td></tr> <tr><td></td><td valign="top"><a href="filesystem_64.html#SEC345">trunk Scripts Perl</a></td><td valign="top"><a href="filesystem_64.html#SEC345">3.61 trunk/Scripts/Perl</a></td></tr> <tr><td></td><td valign="top"><a href="filesystem_65.html#SEC350">trunk Scripts Python</a></td><td valign="top"><a href="filesystem_65.html#SEC350">3.62 trunk/Scripts/Python</a></td></tr> diff --git a/Manuals/Filesystem/filesystem-html/filesystem_67.html b/Manuals/Filesystem/filesystem-html/filesystem_67.html index 8a352a0..0c19687 100644 --- a/Manuals/Filesystem/filesystem-html/filesystem_67.html +++ b/Manuals/Filesystem/filesystem-html/filesystem_67.html @@ -75,7 +75,7 @@ ul.toc {list-style: none} </p></dd> <dt><a href="filesystem_50.html#fig_003atrunk_002fScripts_002fBash_002fFunctions_003aInitialization">Figure 3.2</a></dt><dd><p>The actions initialization environment. </p></dd> -<dt><a href="filesystem_53.html#trunk_002fScripts_002fBash_002fFunctions_002fcli_005fcommitRepoChanges">Figure 3.3</a></dt><dd><p>The <code>cli_commitRepoChanges</code> function output. +<dt><a href="filesystem_52.html#trunk_002fScripts_002fBash_002fFunctions_002fcli_005fcommitRepoChanges">Figure 3.3</a></dt><dd><p>The <code>cli_commitRepoChanges</code> function output. </p></dd> <dt><a href="filesystem_60.html#fig_003atrunk_002fScripts_002fBash_002fFunctions_002fShell_003a1">Figure 3.4</a></dt><dd><p>The functions script base comment structure </p></dd> diff --git a/Manuals/Filesystem/filesystem-html/filesystem_toc.html b/Manuals/Filesystem/filesystem-html/filesystem_toc.html index aa4e5fd..5d1e750 100644 --- a/Manuals/Filesystem/filesystem-html/filesystem_toc.html +++ b/Manuals/Filesystem/filesystem-html/filesystem_toc.html @@ -435,43 +435,43 @@ ul.toc {list-style: none} <ul class="toc"> <li><a name="TOC264" href="filesystem_52.html#SEC264">3.49.1 Goals</a></li> <li><a name="TOC265" href="filesystem_52.html#SEC265">3.49.2 Description</a></li> - <li><a name="TOC266" href="filesystem_52.html#SEC266">3.49.3 Usage</a></li> - <li><a name="TOC267" href="filesystem_52.html#SEC267">3.49.4 See also</a></li> - </ul></li> - <li><a name="TOC268" href="filesystem_53.html#SEC268">3.50 trunk/Scripts/Bash/Functions</a> - <ul class="toc"> - <li><a name="TOC269" href="filesystem_53.html#SEC269">3.50.1 Goals</a></li> - <li><a name="TOC270" href="filesystem_53.html#SEC270">3.50.2 Description</a></li> - <li><a name="TOC271" href="filesystem_53.html#SEC271">3.50.3 Usage</a> + <li><a name="TOC266" href="filesystem_52.html#SEC266">3.49.3 Usage</a> <ul class="toc"> - <li><a name="TOC272" href="filesystem_53.html#SEC272">3.50.3.1 Global variables</a></li> - <li><a name="TOC273" href="filesystem_53.html#SEC273">3.50.3.2 Global functions</a></li> - <li><a name="TOC274" href="filesystem_53.html#SEC274">3.50.3.3 Specific functions</a></li> + <li><a name="TOC267" href="filesystem_52.html#SEC267">3.49.3.1 Global variables</a></li> + <li><a name="TOC268" href="filesystem_52.html#SEC268">3.49.3.2 Global functions</a></li> + <li><a name="TOC269" href="filesystem_52.html#SEC269">3.49.3.3 Specific functions</a></li> </ul></li> + <li><a name="TOC270" href="filesystem_52.html#SEC270">3.49.4 See also</a></li> + </ul></li> + <li><a name="TOC271" href="filesystem_53.html#SEC271">3.50 trunk/Scripts/Bash/centos-art/Functions/Help</a> + <ul class="toc"> + <li><a name="TOC272" href="filesystem_53.html#SEC272">3.50.1 Goals</a></li> + <li><a name="TOC273" href="filesystem_53.html#SEC273">3.50.2 Description</a></li> + <li><a name="TOC274" href="filesystem_53.html#SEC274">3.50.3 Usage</a></li> <li><a name="TOC275" href="filesystem_53.html#SEC275">3.50.4 See also</a></li> </ul></li> - <li><a name="TOC276" href="filesystem_54.html#SEC276">3.51 trunk/Scripts/Bash/Functions/Html</a> + <li><a name="TOC276" href="filesystem_54.html#SEC276">3.51 trunk/Scripts/Bash/centos-art/Functions/Html</a> <ul class="toc"> <li><a name="TOC277" href="filesystem_54.html#SEC277">3.51.1 Goals</a></li> <li><a name="TOC278" href="filesystem_54.html#SEC278">3.51.2 Description</a></li> <li><a name="TOC279" href="filesystem_54.html#SEC279">3.51.3 Usage</a></li> <li><a name="TOC280" href="filesystem_54.html#SEC280">3.51.4 See also</a></li> </ul></li> - <li><a name="TOC281" href="filesystem_55.html#SEC281">3.52 trunk/Scripts/Bash/Functions/Locale</a> + <li><a name="TOC281" href="filesystem_55.html#SEC281">3.52 trunk/Scripts/Bash/centos-art/Functions/Locale</a> <ul class="toc"> <li><a name="TOC282" href="filesystem_55.html#SEC282">3.52.1 Goals</a></li> <li><a name="TOC283" href="filesystem_55.html#SEC283">3.52.2 Description</a></li> <li><a name="TOC284" href="filesystem_55.html#SEC284">3.52.3 Usage</a></li> <li><a name="TOC285" href="filesystem_55.html#SEC285">3.52.4 See also</a></li> </ul></li> - <li><a name="TOC286" href="filesystem_56.html#SEC286">3.53 trunk/Scripts/Bash/Functions/Manual</a> + <li><a name="TOC286" href="filesystem_56.html#SEC286">3.53 trunk/Scripts/Bash/centos-art/Functions/Manual</a> <ul class="toc"> <li><a name="TOC287" href="filesystem_56.html#SEC287">3.53.1 Goals</a></li> <li><a name="TOC288" href="filesystem_56.html#SEC288">3.53.2 Description</a></li> <li><a name="TOC289" href="filesystem_56.html#SEC289">3.53.3 Usage</a></li> <li><a name="TOC290" href="filesystem_56.html#SEC290">3.53.4 See also</a></li> </ul></li> - <li><a name="TOC291" href="filesystem_57.html#SEC291">3.54 trunk/Scripts/Bash/Functions/Path</a> + <li><a name="TOC291" href="filesystem_57.html#SEC291">3.54 trunk/Scripts/Bash/centos-art/Functions/Path</a> <ul class="toc"> <li><a name="TOC292" href="filesystem_57.html#SEC292">3.54.1 Goals</a></li> <li><a name="TOC293" href="filesystem_57.html#SEC293">3.54.2 Description</a> @@ -486,7 +486,7 @@ ul.toc {list-style: none} <li><a name="TOC300" href="filesystem_57.html#SEC300">3.54.3 Usage</a></li> <li><a name="TOC301" href="filesystem_57.html#SEC301">3.54.4 See also</a></li> </ul></li> - <li><a name="TOC302" href="filesystem_58.html#SEC302">3.55 trunk/Scripts/Bash/Functions/Render</a> + <li><a name="TOC302" href="filesystem_58.html#SEC302">3.55 trunk/Scripts/Bash/centos-art/Functions/Render</a> <ul class="toc"> <li><a name="TOC303" href="filesystem_58.html#SEC303">3.55.1 Renderable identity directory structures</a> <ul class="toc"> @@ -500,7 +500,7 @@ ul.toc {list-style: none} <li><a name="TOC310" href="filesystem_58.html#SEC310">3.55.4 Usage</a></li> <li><a name="TOC311" href="filesystem_58.html#SEC311">3.55.5 See also</a></li> </ul></li> - <li><a name="TOC312" href="filesystem_59.html#SEC312">3.56 trunk/Scripts/Bash/Functions/Render/Config</a> + <li><a name="TOC312" href="filesystem_59.html#SEC312">3.56 trunk/Scripts/Bash/centos-art/Functions/Render/Config</a> <ul class="toc"> <li><a name="TOC313" href="filesystem_59.html#SEC313">3.56.1 Goals</a></li> <li><a name="TOC314" href="filesystem_59.html#SEC314">3.56.2 Description</a> @@ -512,14 +512,14 @@ ul.toc {list-style: none} <li><a name="TOC318" href="filesystem_59.html#SEC318">3.56.3 Usage</a></li> <li><a name="TOC319" href="filesystem_59.html#SEC319">3.56.4 See also</a></li> </ul></li> - <li><a name="TOC320" href="filesystem_60.html#SEC320">3.57 trunk/Scripts/Bash/Functions/Shell</a> + <li><a name="TOC320" href="filesystem_60.html#SEC320">3.57 trunk/Scripts/Bash/centos-art/Functions/Shell</a> <ul class="toc"> <li><a name="TOC321" href="filesystem_60.html#SEC321">3.57.1 Goals</a></li> <li><a name="TOC322" href="filesystem_60.html#SEC322">3.57.2 Description</a></li> <li><a name="TOC323" href="filesystem_60.html#SEC323">3.57.3 Usage</a></li> <li><a name="TOC324" href="filesystem_60.html#SEC324">3.57.4 See also</a></li> </ul></li> - <li><a name="TOC325" href="filesystem_61.html#SEC325">3.58 trunk/Scripts/Bash/Functions/Svg</a> + <li><a name="TOC325" href="filesystem_61.html#SEC325">3.58 trunk/Scripts/Bash/centos-art/Functions/Svg</a> <ul class="toc"> <li><a name="TOC326" href="filesystem_61.html#SEC326">3.58.1 Goals</a></li> <li><a name="TOC327" href="filesystem_61.html#SEC327">3.58.2 Description</a> @@ -530,7 +530,7 @@ ul.toc {list-style: none} <li><a name="TOC330" href="filesystem_61.html#SEC330">3.58.3 Usage</a></li> <li><a name="TOC331" href="filesystem_61.html#SEC331">3.58.4 See also</a></li> </ul></li> - <li><a name="TOC332" href="filesystem_62.html#SEC332">3.59 trunk/Scripts/Bash/Functions/Verify</a> + <li><a name="TOC332" href="filesystem_62.html#SEC332">3.59 trunk/Scripts/Bash/centos-art/Functions/Verify</a> <ul class="toc"> <li><a name="TOC333" href="filesystem_62.html#SEC333">3.59.1 Goals</a></li> <li><a name="TOC334" href="filesystem_62.html#SEC334">3.59.2 Description</a> diff --git a/Manuals/Filesystem/filesystem.pdf b/Manuals/Filesystem/filesystem.pdf index cdf6274..d346729 100644 Binary files a/Manuals/Filesystem/filesystem.pdf and b/Manuals/Filesystem/filesystem.pdf differ diff --git a/Manuals/Filesystem/filesystem.xml b/Manuals/Filesystem/filesystem.xml index e47ef3c..b9c9c71 100644 --- a/Manuals/Filesystem/filesystem.xml +++ b/Manuals/Filesystem/filesystem.xml @@ -328,53 +328,53 @@ <menucomment></menucomment> </menuentry> <menuentry> - <menunode>trunk Scripts Bash Functions</menunode> - <menutitle>trunk Scripts Bash Functions</menutitle> + <menunode>trunk Scripts Bash centos-art Functions Help</menunode> + <menutitle>trunk Scripts Bash centos-art Functions Help</menutitle> <menucomment></menucomment> </menuentry> <menuentry> - <menunode>trunk Scripts Bash Functions Html</menunode> - <menutitle>trunk Scripts Bash Functions Html</menutitle> + <menunode>trunk Scripts Bash centos-art Functions Html</menunode> + <menutitle>trunk Scripts Bash centos-art Functions Html</menutitle> <menucomment></menucomment> </menuentry> <menuentry> - <menunode>trunk Scripts Bash Functions Locale</menunode> - <menutitle>trunk Scripts Bash Functions Locale</menutitle> + <menunode>trunk Scripts Bash centos-art Functions Locale</menunode> + <menutitle>trunk Scripts Bash centos-art Functions Locale</menutitle> <menucomment></menucomment> </menuentry> <menuentry> - <menunode>trunk Scripts Bash Functions Manual</menunode> - <menutitle>trunk Scripts Bash Functions Manual</menutitle> + <menunode>trunk Scripts Bash centos-art Functions Manual</menunode> + <menutitle>trunk Scripts Bash centos-art Functions Manual</menutitle> <menucomment></menucomment> </menuentry> <menuentry> - <menunode>trunk Scripts Bash Functions Path</menunode> - <menutitle>trunk Scripts Bash Functions Path</menutitle> + <menunode>trunk Scripts Bash centos-art Functions Path</menunode> + <menutitle>trunk Scripts Bash centos-art Functions Path</menutitle> <menucomment></menucomment> </menuentry> <menuentry> - <menunode>trunk Scripts Bash Functions Render</menunode> - <menutitle>trunk Scripts Bash Functions Render</menutitle> + <menunode>trunk Scripts Bash centos-art Functions Render</menunode> + <menutitle>trunk Scripts Bash centos-art Functions Render</menutitle> <menucomment></menucomment> </menuentry> <menuentry> - <menunode>trunk Scripts Bash Functions Render Config</menunode> - <menutitle>trunk Scripts Bash Functions Render Config</menutitle> + <menunode>trunk Scripts Bash centos-art Functions Render Config</menunode> + <menutitle>trunk Scripts Bash centos-art Functions Render Config</menutitle> <menucomment></menucomment> </menuentry> <menuentry> - <menunode>trunk Scripts Bash Functions Shell</menunode> - <menutitle>trunk Scripts Bash Functions Shell</menutitle> + <menunode>trunk Scripts Bash centos-art Functions Shell</menunode> + <menutitle>trunk Scripts Bash centos-art Functions Shell</menutitle> <menucomment></menucomment> </menuentry> <menuentry> - <menunode>trunk Scripts Bash Functions Svg</menunode> - <menutitle>trunk Scripts Bash Functions Svg</menutitle> + <menunode>trunk Scripts Bash centos-art Functions Svg</menunode> + <menutitle>trunk Scripts Bash centos-art Functions Svg</menutitle> <menucomment></menucomment> </menuentry> <menuentry> - <menunode>trunk Scripts Bash Functions Verify</menunode> - <menutitle>trunk Scripts Bash Functions Verify</menutitle> + <menunode>trunk Scripts Bash centos-art Functions Verify</menunode> + <menutitle>trunk Scripts Bash centos-art Functions Verify</menutitle> <menucomment></menucomment> </menuentry> <menuentry> @@ -2995,9 +2995,9 @@ vim /home/centos/artwork/trunk/Translations/Fonts/dejavu_lgc_sans-boldoblique.se <title>Description</title> <para>The best way to understand <file>centos-art.sh</file> automation script is studying its source code. However, as start point, you may prefer to read an introductory resume before diving into the source code details.</para> <para>The <file>centos-art.sh</file> script is written in Bash. Most tasks, inside <file>centos-art.sh</file> script, have been organized in many specific functionalities that you can invoke from the <command>centos-art</command> command-line interface.</para> - <para>When you type the <command>centos-art</command> command in your terminal, the operating system trys to execute that command. In order to execute the command, the operating system needs to know where it is, so the operating system uses the <var>PATH</var> environment variable to look for that command location. If your system was prepared to use CentOS Artwork Repository correctly (see <xref><xrefnodename>trunk Scripts Bash Functions Verify</xrefnodename></xref>), you should have a symbolic link inside <file>~/bin/</file> directory that points to the <file>centos-art.sh</file> script file. As <file>~/bin/</file> directory is, by default, inside <var>PATH</var> environment variable, the execution of <command>centos-art</command> command runs the <file>centos-art.sh</file> script.</para> + <para>When you type the <command>centos-art</command> command in your terminal, the operating system trys to execute that command. In order to execute the command, the operating system needs to know where it is, so the operating system uses the <var>PATH</var> environment variable to look for that command location. If your system was prepared to use CentOS Artwork Repository correctly (— <strong>Removed</strong>(pxref:trunk Scripts Bash Functions Verify) —), you should have a symbolic link inside <file>~/bin/</file> directory that points to the <file>centos-art.sh</file> script file. As <file>~/bin/</file> directory is, by default, inside <var>PATH</var> environment variable, the execution of <command>centos-art</command> command runs the <file>centos-art.sh</file> script.</para> <para>When <file>centos-art.sh</file> script is executed, the first it does is executing the <file>trunk/Scripts/Bash/initEnvironment.sh</file> script to initialize global variables (e.g., <command>gettext</command> variables) and global function scripts. Global function scripts are located inside <file>trunk/Scripts/Bash/Functions</file> directory and their file names begin with <samp>cli</samp>. Global function scripts provide common functionalities that can be used anywhere inside <file>centos-art.sh</file> script execution environment.</para> - <para>Once global variables and function scripts have been loaded, <file>centos-art.sh</file> script executes the <command>cli</command> global function from <file>cli.sh</file> function script to retrive command-line arguments and define some default values that may be used later by specific function scripts (see <xref><xrefnodename>trunk Scripts Bash Functions</xrefnodename></xref>).</para> + <para>Once global variables and function scripts have been loaded, <file>centos-art.sh</file> script executes the <command>cli</command> global function from <file>cli.sh</file> function script to retrive command-line arguments and define some default values that may be used later by specific function scripts (— <strong>Removed</strong>(pxref:trunk Scripts Bash Functions) —).</para> <para>As convenction, the <file>centos-art.sh</file> command-line arguments have the following format:</para> <verbatim xml:space="preserve"><![CDATA[ centos-art arg1 --arg2=val2 --arg3=val3 @@ -3079,7 +3079,7 @@ centos-art arg1 --arg2=val2 --arg3=val3 <subsection> <title>Usage</title> - <para>The <file>centos-art.sh</file> script usage information is described inside each specific function documentation (see <xref><xrefnodename>trunk Scripts Bash Functions</xrefnodename></xref>).</para> + <para>The <file>centos-art.sh</file> script usage information is described inside each specific function documentation (— <strong>Removed</strong>(pxref:trunk Scripts Bash Functions) —).</para> </subsection> <subsection> @@ -3088,12 +3088,8 @@ centos-art arg1 --arg2=val2 --arg3=val3 <menuentry> <menunode>trunk Scripts</menunode> <menutitle>trunk Scripts</menutitle> - <menucomment></menucomment> - </menuentry> - <menuentry> - <menunode>trunk Scripts Bash Functions</menunode> - <menutitle>trunk Scripts Bash Functions</menutitle> - <menucomment></menucomment> + <menucomment> +<!-- Removed(* trunk Scripts Bash Functions::) - --></menucomment> </menuentry> <menuentry> <menunode>trunk Scripts Bash Locale</menunode> @@ -3116,7 +3112,7 @@ centos-art arg1 --arg2=val2 --arg3=val3 </node> <node> <nodename>trunk Scripts Bash centos-art Functions</nodename> - <nodenext>trunk Scripts Bash Functions</nodenext> + <nodenext>trunk Scripts Bash centos-art Functions Help</nodenext> <nodeprev>trunk Scripts Bash centos-art</nodeprev> <nodeup>trunk</nodeup> <section> @@ -3124,51 +3120,6 @@ centos-art arg1 --arg2=val2 --arg3=val3 <para><indexterm index="cp">trunk Scripts Bash centos-art Functions</indexterm></para> <subsection> <title>Goals</title> - <itemize> - <itemfunction>•</itemfunction> - <item> - <para>...</para> - </item> - </itemize> - </subsection> - - <subsection> - <title>Description</title> - <itemize> - <itemfunction>•</itemfunction> - <item> - <para>...</para> - </item> - </itemize> - </subsection> - - <subsection> - <title>Usage</title> - <itemize> - <itemfunction>•</itemfunction> - <item> - <para>...</para> - </item> - </itemize> - </subsection> - - <subsection> - <title>See also</title> - <menu> - </menu> - </subsection> - </section> - </node> - <node> - <nodename>trunk Scripts Bash Functions</nodename> - <nodenext>trunk Scripts Bash Functions Html</nodenext> - <nodeprev>trunk Scripts Bash centos-art Functions</nodeprev> - <nodeup>trunk</nodeup> - <section> - <title>trunk/Scripts/Bash/Functions</title> - <para><indexterm index="cp">trunk Scripts Bash Functions</indexterm></para> - <subsection> - <title>Goals</title> <para>The <file>trunk/Scripts/Bash/Functions</file> directory exists to organize <file>centos-art.sh</file> specific functionalities.</para> </subsection> @@ -3295,12 +3246,12 @@ Goodbye World [centos@projects ~]$ ]]></verbatim> <para>The word <samp>World</samp> in the examples above can be anything. In fact, change it to have a little fun.</para> - <para>Now that we have a specific function that works as we expect, it is time to document it. To document <code>greet</code> specific functionality, we use its directory path and the <code>manual</code> functionality (see <xref><xrefnodename>trunk Scripts Bash Functions Manual</xrefnodename></xref>) of <file>centos-art.sh</file> script, just as the following command illustrates:</para> + <para>Now that we have a specific function that works as we expect, it is time to document it. To document <code>greet</code> specific functionality, we use its directory path and the <code>manual</code> functionality (— <strong>Removed</strong>(pxref:trunk Scripts Bash Functions Manual) —) of <file>centos-art.sh</file> script, just as the following command illustrates:</para> <verbatim xml:space="preserve"><![CDATA[ centos-art manual --edit=trunk/Scripts/Bash/Functions/Greet ]]></verbatim> <para>To have a well documented function helps user to understand how your function really works, and how it should be used. When no valid action is passed to a function, the <file>centos-art.sh</file> script uses the function documentation entry as vehicle to communicate which the valid functions are. When no documentation entry exists for a function, the <file>centos-art.sh</file> script informs that no documentation entry exists for such function and requests user to create it right at that time.</para> - <para>Now that we have documented our function, it is time to translate its output messages to different languages. To translate specific functionality output messages to different languages we use the <code>locale</code> functionality (see <xref><xrefnodename>trunk Scripts Bash Functions Locale</xrefnodename></xref>) of <file>centos-art.sh</file> script, just as the following command illustrates:</para> + <para>Now that we have documented our function, it is time to translate its output messages to different languages. To translate specific functionality output messages to different languages we use the <code>locale</code> functionality (— <strong>Removed</strong>(pxref:trunk Scripts Bash Functions Locale) —) of <file>centos-art.sh</file> script, just as the following command illustrates:</para> <verbatim xml:space="preserve"><![CDATA[ centos-art locale --edit ]]></verbatim> @@ -3852,7 +3803,7 @@ function prefix_doSomething { </table> <para>Use <code>cli_getRepoName</code> function to sanitate file names and directory names before their utilization.</para> <para>Use <code>cli_getRepoName</code> when you need to change file name convenctions inside <file>centos-art.sh</file> script.</para> - <para>When we change file name convenctions inside <code>cli_getRepoName</code> what we are really changing is the way functions interpret repository file system organization. Notice that when we change a file name (e.g., a function name), it is necessary to update all files where such file name is placed on. This may require a massive substitution inside the repository, each time we change name convenctions in the repository (see <xref><xrefnodename>trunk Scripts Bash Functions Path</xrefnodename></xref>, for more information).</para> + <para>When we change file name convenctions inside <code>cli_getRepoName</code> what we are really changing is the way functions interpret repository file system organization. Notice that when we change a file name (e.g., a function name), it is necessary to update all files where such file name is placed on. This may require a massive substitution inside the repository, each time we change name convenctions in the repository (— <strong>Removed</strong>(pxref:trunk Scripts Bash Functions Path) —, for more information).</para> </definitionitem> </definition> <definition> @@ -4071,7 +4022,7 @@ $MESSAGE [y/N]: $MESSAGE [s/N]: ]]></verbatim> <para>and the confirmation answer would be <samp>s</samp>, as it is on Spanish <samp>sí</samp> word.</para> - <para>Definition of which confirmation word to use is set on translation messages for your specific locale information. See <xref><xrefnodename>trunk Scripts Bash Functions Locale</xrefnodename></xref>, for more information about locale-specific translation messages.</para> + <para>Definition of which confirmation word to use is set on translation messages for your specific locale information. — <strong>Removed</strong>(xref:trunk Scripts Bash Functions Locale) —, for more information about locale-specific translation messages.</para> </item> </tableitem> <tableitem> @@ -4110,51 +4061,15 @@ trunk/Scripts/Bash/Styles/output_forTwoColumns.awk <title>Specific functions</title> <para>The following specific functions of <file>centos-art.sh</file> script, are available for you to use:</para> <menu> - <menuentry> - <menunode>trunk Scripts Bash Functions Html</menunode> - <menutitle>trunk Scripts Bash Functions Html</menutitle> - <menucomment></menucomment> - </menuentry> - <menuentry> - <menunode>trunk Scripts Bash Functions Locale</menunode> - <menutitle>trunk Scripts Bash Functions Locale</menutitle> - <menucomment></menucomment> - </menuentry> - <menuentry> - <menunode>trunk Scripts Bash Functions Manual</menunode> - <menutitle>trunk Scripts Bash Functions Manual</menutitle> - <menucomment></menucomment> - </menuentry> - <menuentry> - <menunode>trunk Scripts Bash Functions Path</menunode> - <menutitle>trunk Scripts Bash Functions Path</menutitle> - <menucomment></menucomment> - </menuentry> - <menuentry> - <menunode>trunk Scripts Bash Functions Render</menunode> - <menutitle>trunk Scripts Bash Functions Render</menutitle> - <menucomment></menucomment> - </menuentry> - <menuentry> - <menunode>trunk Scripts Bash Functions Render Config</menunode> - <menutitle>trunk Scripts Bash Functions Render Config</menutitle> - <menucomment></menucomment> - </menuentry> - <menuentry> - <menunode>trunk Scripts Bash Functions Shell</menunode> - <menutitle>trunk Scripts Bash Functions Shell</menutitle> - <menucomment></menucomment> - </menuentry> - <menuentry> - <menunode>trunk Scripts Bash Functions Svg</menunode> - <menutitle>trunk Scripts Bash Functions Svg</menutitle> - <menucomment></menucomment> - </menuentry> - <menuentry> - <menunode>trunk Scripts Bash Functions Verify</menunode> - <menutitle>trunk Scripts Bash Functions Verify</menutitle> - <menucomment></menucomment> - </menuentry> +<!-- Removed(* trunk Scripts Bash Functions Html::) - --> +<!-- Removed(* trunk Scripts Bash Functions Locale::) - --> +<!-- Removed(* trunk Scripts Bash Functions Manual::) - --> +<!-- Removed(* trunk Scripts Bash Functions Path::) - --> +<!-- Removed(* trunk Scripts Bash Functions Render::) - --> +<!-- Removed(* trunk Scripts Bash Functions Render Config::) - --> +<!-- Removed(* trunk Scripts Bash Functions Shell::) - --> +<!-- Removed(* trunk Scripts Bash Functions Svg::) - --> +<!-- Removed(* trunk Scripts Bash Functions Verify::) - --> </menu> </subsubsection> </subsection> @@ -4177,13 +4092,13 @@ trunk/Scripts/Bash/Styles/output_forTwoColumns.awk </section> </node> <node> - <nodename>trunk Scripts Bash Functions Html</nodename> - <nodenext>trunk Scripts Bash Functions Locale</nodenext> - <nodeprev>trunk Scripts Bash Functions</nodeprev> + <nodename>trunk Scripts Bash centos-art Functions Help</nodename> + <nodenext>trunk Scripts Bash centos-art Functions Html</nodenext> + <nodeprev>trunk Scripts Bash centos-art Functions</nodeprev> <nodeup>trunk</nodeup> <section> - <title>trunk/Scripts/Bash/Functions/Html</title> - <para><indexterm index="cp">trunk Scripts Bash Functions Html</indexterm></para> + <title>trunk/Scripts/Bash/centos-art/Functions/Help</title> + <para><indexterm index="cp">trunk Scripts Bash centos-art Functions Help</indexterm></para> <subsection> <title>Goals</title> <itemize> @@ -4222,13 +4137,58 @@ trunk/Scripts/Bash/Styles/output_forTwoColumns.awk </section> </node> <node> - <nodename>trunk Scripts Bash Functions Locale</nodename> - <nodenext>trunk Scripts Bash Functions Manual</nodenext> - <nodeprev>trunk Scripts Bash Functions Html</nodeprev> + <nodename>trunk Scripts Bash centos-art Functions Html</nodename> + <nodenext>trunk Scripts Bash centos-art Functions Locale</nodenext> + <nodeprev>trunk Scripts Bash centos-art Functions Help</nodeprev> <nodeup>trunk</nodeup> <section> - <title>trunk/Scripts/Bash/Functions/Locale</title> - <para><indexterm index="cp">trunk Scripts Bash Functions Locale</indexterm></para> + <title>trunk/Scripts/Bash/centos-art/Functions/Html</title> + <para><indexterm index="cp">trunk Scripts Bash centos-art Functions Html</indexterm></para> + <subsection> + <title>Goals</title> + <itemize> + <itemfunction>•</itemfunction> + <item> + <para>...</para> + </item> + </itemize> + </subsection> + + <subsection> + <title>Description</title> + <itemize> + <itemfunction>•</itemfunction> + <item> + <para>...</para> + </item> + </itemize> + </subsection> + + <subsection> + <title>Usage</title> + <itemize> + <itemfunction>•</itemfunction> + <item> + <para>...</para> + </item> + </itemize> + </subsection> + + <subsection> + <title>See also</title> + <menu> + </menu> + </subsection> + </section> + </node> + <node> + <nodename>trunk Scripts Bash centos-art Functions Locale</nodename> + <nodenext>trunk Scripts Bash centos-art Functions Manual</nodenext> + <nodeprev>trunk Scripts Bash centos-art Functions Html</nodeprev> + <nodeup>trunk</nodeup> + <section> + <title>trunk/Scripts/Bash/centos-art/Functions/Locale</title> + <para><indexterm index="cp">trunk Scripts Bash centos-art Functions Locale</indexterm></para> <subsection> <title>Goals</title> <itemize> @@ -4296,13 +4256,13 @@ trunk/Scripts/Bash/Styles/output_forTwoColumns.awk </section> </node> <node> - <nodename>trunk Scripts Bash Functions Manual</nodename> - <nodenext>trunk Scripts Bash Functions Path</nodenext> - <nodeprev>trunk Scripts Bash Functions Locale</nodeprev> + <nodename>trunk Scripts Bash centos-art Functions Manual</nodename> + <nodenext>trunk Scripts Bash centos-art Functions Path</nodenext> + <nodeprev>trunk Scripts Bash centos-art Functions Locale</nodeprev> <nodeup>trunk</nodeup> <section> - <title>trunk/Scripts/Bash/Functions/Manual</title> - <para><indexterm index="cp">trunk Scripts Bash Functions Manual</indexterm></para> + <title>trunk/Scripts/Bash/centos-art/Functions/Manual</title> + <para><indexterm index="cp">trunk Scripts Bash centos-art Functions Manual</indexterm></para> <subsection> <title>Goals</title> <itemize> @@ -4341,13 +4301,13 @@ trunk/Scripts/Bash/Styles/output_forTwoColumns.awk </section> </node> <node> - <nodename>trunk Scripts Bash Functions Path</nodename> - <nodenext>trunk Scripts Bash Functions Render</nodenext> - <nodeprev>trunk Scripts Bash Functions Manual</nodeprev> + <nodename>trunk Scripts Bash centos-art Functions Path</nodename> + <nodenext>trunk Scripts Bash centos-art Functions Render</nodenext> + <nodeprev>trunk Scripts Bash centos-art Functions Manual</nodeprev> <nodeup>trunk</nodeup> <section> - <title>trunk/Scripts/Bash/Functions/Path</title> - <para><indexterm index="cp">trunk Scripts Bash Functions Path</indexterm></para> + <title>trunk/Scripts/Bash/centos-art/Functions/Path</title> + <para><indexterm index="cp">trunk Scripts Bash centos-art Functions Path</indexterm></para> <subsection> <title>Goals</title> <para>This section exists to organize files related to <code>path</code> functiontionality. The <code>path</code> functionality standardizes movement, syncronization, branching, tagging, and general file maintainance inside the repository.</para> @@ -4456,25 +4416,21 @@ centos-art manual --read=turnk/Identity/Themes/Motifs/TreeFlower/ <menuentry> <menunode>trunk Scripts Bash</menunode> <menutitle>trunk Scripts Bash</menutitle> - <menucomment></menucomment> - </menuentry> - <menuentry> - <menunode>trunk Scripts Bash Functions</menunode> - <menutitle>trunk Scripts Bash Functions</menutitle> - <menucomment></menucomment> + <menucomment> +<!-- Removed(* trunk Scripts Bash Functions::) - --></menucomment> </menuentry> </menu> </subsection> </section> </node> <node> - <nodename>trunk Scripts Bash Functions Render</nodename> - <nodenext>trunk Scripts Bash Functions Render Config</nodenext> - <nodeprev>trunk Scripts Bash Functions Path</nodeprev> + <nodename>trunk Scripts Bash centos-art Functions Render</nodename> + <nodenext>trunk Scripts Bash centos-art Functions Render Config</nodenext> + <nodeprev>trunk Scripts Bash centos-art Functions Path</nodeprev> <nodeup>trunk</nodeup> <section> - <title>trunk/Scripts/Bash/Functions/Render</title> - <para><indexterm index="cp">trunk Scripts Bash Functions Render</indexterm>The <code>render</code> functionality exists to produce both identity and translation files on different levels of information (i.e., different languages, release numbers, architectures, etc.).</para> + <title>trunk/Scripts/Bash/centos-art/Functions/Render</title> + <para><indexterm index="cp">trunk Scripts Bash centos-art Functions Render</indexterm>The <code>render</code> functionality exists to produce both identity and translation files on different levels of information (i.e., different languages, release numbers, architectures, etc.).</para> <para>The <code>render</code> functionality relies on “renderable directory structures” to produce files. Renderable directory structures can be either “identity directory structures” or “translation directory structures” with special directories inside.</para> <subsection> @@ -4510,7 +4466,7 @@ trunk/Identity/Path/To/Dir <-- Renderable identity directory structure. <quotation> <para><strong>Note</strong> At rendition time, the content of <file>Img/</file> directory structure is produced by <file>centos-art.sh</file> automatically.</para> </quotation> - <para>When a renderable identity directory structure is configured to produce image-based content, <file>centos-art.sh</file> produces <acronym><acronymword>PNG</acronymword><acronymdesc>Portable Network Graphics</acronymdesc></acronym> files with the <code>.png</code> extension. Once the base image format has been produced, it is possible for <file>centos-art.sh</file> to use it in order to automatically create other image formats that may be needed (see <xref><xrefnodename>trunk Scripts Bash Functions Render Config</xrefnodename></xref>).</para> + <para>When a renderable identity directory structure is configured to produce image-based content, <file>centos-art.sh</file> produces <acronym><acronymword>PNG</acronymword><acronymdesc>Portable Network Graphics</acronymdesc></acronym> files with the <code>.png</code> extension. Once the base image format has been produced, it is possible for <file>centos-art.sh</file> to use it in order to automatically create other image formats that may be needed (— <strong>Removed</strong>(pxref:trunk Scripts Bash Functions Render Config) —).</para> <para>Inside the working copy, you can find an example of “design template without translation” configuration at <file>trunk/Identity/Models/</file>.</para> <para>See <xref><xrefnodename>trunk Identity</xrefnodename></xref>, for more information.</para> </item> @@ -4571,7 +4527,7 @@ trunk/Identity/NewDir/Img/file.png 3 | Remove design template instance. ]]></verbatim> <para>Finally, when the untranslated image has been created, the temporal design template instance is removed. At this point, <file>centos-art.sh</file> takes the next design template and repeats the whole production flow once again (design template by design template), until all design templates be processed.</para> - <para>See <xref><xrefnodename>trunk Scripts Bash Functions Render Config</xrefnodename></xref>, for more information.</para> + <para>— <strong>Removed</strong>(xref:trunk Scripts Bash Functions Render Config) —, for more information.</para> </item> </tableitem> </table> @@ -4839,23 +4795,19 @@ function render_loadConfig { <subsection> <title>See also</title> <menu> - <menuentry> - <menunode>trunk Scripts Bash Functions Render Config</menunode> - <menutitle>trunk Scripts Bash Functions Render Config</menutitle> - <menucomment></menucomment> - </menuentry> +<!-- Removed(* trunk Scripts Bash Functions Render Config::) - --> </menu> </subsection> </section> </node> <node> - <nodename>trunk Scripts Bash Functions Render Config</nodename> - <nodenext>trunk Scripts Bash Functions Shell</nodenext> - <nodeprev>trunk Scripts Bash Functions Render</nodeprev> + <nodename>trunk Scripts Bash centos-art Functions Render Config</nodename> + <nodenext>trunk Scripts Bash centos-art Functions Shell</nodenext> + <nodeprev>trunk Scripts Bash centos-art Functions Render</nodeprev> <nodeup>trunk</nodeup> <section> - <title>trunk/Scripts/Bash/Functions/Render/Config</title> - <para><indexterm index="cp">trunk Scripts Bash Functions Render Config</indexterm></para> + <title>trunk/Scripts/Bash/centos-art/Functions/Render/Config</title> + <para><indexterm index="cp">trunk Scripts Bash centos-art Functions Render Config</indexterm></para> <subsection> <title>Goals</title> <para>The <file>trunk/Scripts/Bash/Config</file> directory exists to oraganize pre-rendering configuration scripts.</para> @@ -4924,7 +4876,7 @@ ACTIONS[1]='POST:renderFormats: xpm jpg tif' ]]></verbatim> <para>The <samp>LAST</samp> action specifies which actions to apply once the last file in the list of files to process has been rendered. The <samp>LAST</samp> action is optional. Possible values for <samp>LAST</samp> actions may be <samp>groupByFormat</samp>, <samp>renderGdmTgz</samp>, etc.</para> <quotation> - <para><strong>Note</strong> See <xref><xrefnodename>trunk Scripts Bash Functions Render</xrefnodename></xref>, to know more about possible values for <samp>BASE</samp>, <samp>POST</samp> and <samp>LAST</samp> action definitions.</para> + <para><strong>Note</strong> — <strong>Removed</strong>(xref:trunk Scripts Bash Functions Render) —, to know more about possible values for <samp>BASE</samp>, <samp>POST</samp> and <samp>LAST</samp> action definitions.</para> </quotation> <para>To specify the <samp>LAST</samp> action, you need to set the <samp>LAST:</samp> string followed by the function name of the action you want to perform. For example, consider the following example if you want to render all files first and organize them later:</para> <verbatim xml:space="preserve"><![CDATA[ @@ -4973,30 +4925,22 @@ ACTIONS[2]='LAST:groupByformat: png xpm jpg tif' <menuentry> <menunode>trunk Scripts Bash</menunode> <menutitle>trunk Scripts Bash</menutitle> - <menucomment></menucomment> - </menuentry> - <menuentry> - <menunode>trunk Scripts Bash Functions</menunode> - <menutitle>trunk Scripts Bash Functions</menutitle> - <menucomment></menucomment> - </menuentry> - <menuentry> - <menunode>trunk Scripts Bash Functions Render</menunode> - <menutitle>trunk Scripts Bash Functions Render</menutitle> - <menucomment></menucomment> + <menucomment> +<!-- Removed(* trunk Scripts Bash Functions::) - --> +<!-- Removed(* trunk Scripts Bash Functions Render::) - --></menucomment> </menuentry> </menu> </subsection> </section> </node> <node> - <nodename>trunk Scripts Bash Functions Shell</nodename> - <nodenext>trunk Scripts Bash Functions Svg</nodenext> - <nodeprev>trunk Scripts Bash Functions Render Config</nodeprev> + <nodename>trunk Scripts Bash centos-art Functions Shell</nodename> + <nodenext>trunk Scripts Bash centos-art Functions Svg</nodenext> + <nodeprev>trunk Scripts Bash centos-art Functions Render Config</nodeprev> <nodeup>trunk</nodeup> <section> - <title>trunk/Scripts/Bash/Functions/Shell</title> - <para><indexterm index="cp">trunk Scripts Bash Functions Shell</indexterm></para> + <title>trunk/Scripts/Bash/centos-art/Functions/Shell</title> + <para><indexterm index="cp">trunk Scripts Bash centos-art Functions Shell</indexterm></para> <subsection> <title>Goals</title> <para>This section exists to organize files related to <code>shell</code> functionality of <file>centos-art.sh</file> script.</para> @@ -5112,25 +5056,21 @@ Copyright (C) 1989, 1991 Free Software Foundation, Inc. <menuentry> <menunode>trunk Scripts Bash</menunode> <menutitle>trunk Scripts Bash</menutitle> - <menucomment></menucomment> - </menuentry> - <menuentry> - <menunode>trunk Scripts Bash Functions</menunode> - <menutitle>trunk Scripts Bash Functions</menutitle> - <menucomment></menucomment> + <menucomment> +<!-- Removed(* trunk Scripts Bash Functions::) - --></menucomment> </menuentry> </menu> </subsection> </section> </node> <node> - <nodename>trunk Scripts Bash Functions Svg</nodename> - <nodenext>trunk Scripts Bash Functions Verify</nodenext> - <nodeprev>trunk Scripts Bash Functions Shell</nodeprev> + <nodename>trunk Scripts Bash centos-art Functions Svg</nodename> + <nodenext>trunk Scripts Bash centos-art Functions Verify</nodenext> + <nodeprev>trunk Scripts Bash centos-art Functions Shell</nodeprev> <nodeup>trunk</nodeup> <section> - <title>trunk/Scripts/Bash/Functions/Svg</title> - <para><indexterm index="cp">trunk Scripts Bash Functions Svg</indexterm></para> + <title>trunk/Scripts/Bash/centos-art/Functions/Svg</title> + <para><indexterm index="cp">trunk Scripts Bash centos-art Functions Svg</indexterm></para> <subsection> <title>Goals</title> <para>This section exists to organize files related to <code>svg</code> functionality of <file>centos-art.sh</file> script.</para> @@ -5271,25 +5211,21 @@ Copyright (C) 1989, 1991 Free Software Foundation, Inc. <menuentry> <menunode>trunk Scripts Bash</menunode> <menutitle>trunk Scripts Bash</menutitle> - <menucomment></menucomment> - </menuentry> - <menuentry> - <menunode>trunk Scripts Bash Functions</menunode> - <menutitle>trunk Scripts Bash Functions</menutitle> - <menucomment></menucomment> + <menucomment> +<!-- Removed(* trunk Scripts Bash Functions::) - --></menucomment> </menuentry> </menu> </subsection> </section> </node> <node> - <nodename>trunk Scripts Bash Functions Verify</nodename> + <nodename>trunk Scripts Bash centos-art Functions Verify</nodename> <nodenext>trunk Scripts Bash Locale</nodenext> - <nodeprev>trunk Scripts Bash Functions Svg</nodeprev> + <nodeprev>trunk Scripts Bash centos-art Functions Svg</nodeprev> <nodeup>trunk</nodeup> <section> - <title>trunk/Scripts/Bash/Functions/Verify</title> - <para><indexterm index="cp">trunk Scripts Bash Functions Verify</indexterm></para> + <title>trunk/Scripts/Bash/centos-art/Functions/Verify</title> + <para><indexterm index="cp">trunk Scripts Bash centos-art Functions Verify</indexterm></para> <subsection> <title>Goals</title> <para>This section exists to organize files related to <file>centos-art.sh</file> script <samp>verify</samp> functionality. The <samp>verify</samp> functionality of <file>centos-art.sh</file> script helps you to verify the workstation configuration you are planning to use as host for your working copy of CentOS Artwork Repository.</para> @@ -5415,12 +5351,8 @@ Copyright (C) 1989, 1991 Free Software Foundation, Inc. <menuentry> <menunode>trunk Scripts Bash</menunode> <menutitle>trunk Scripts Bash</menutitle> - <menucomment></menucomment> - </menuentry> - <menuentry> - <menunode>trunk Scripts Bash Functions</menunode> - <menutitle>trunk Scripts Bash Functions</menutitle> - <menucomment></menucomment> + <menucomment> +<!-- Removed(* trunk Scripts Bash Functions::) - --></menucomment> </menuentry> </menu> </subsection> @@ -5429,7 +5361,7 @@ Copyright (C) 1989, 1991 Free Software Foundation, Inc. <node> <nodename>trunk Scripts Bash Locale</nodename> <nodenext>trunk Scripts Perl</nodenext> - <nodeprev>trunk Scripts Bash Functions Verify</nodeprev> + <nodeprev>trunk Scripts Bash centos-art Functions Verify</nodeprev> <nodeup>trunk</nodeup> <section> <title>trunk/Scripts/Bash/Locale</title> @@ -5441,22 +5373,18 @@ Copyright (C) 1989, 1991 Free Software Foundation, Inc. <subsection> <title>Description</title> - <para>Translated messages of <file>centos-art.sh</file> script are managed using GNU <command>gettext</command> utilities. Most translation actions have been automated through <file>centos-art.sh</file> script “locale” functionality (see <xref><xrefnodename>trunk Scripts Bash Functions Locale</xrefnodename></xref>).</para> + <para>Translated messages of <file>centos-art.sh</file> script are managed using GNU <command>gettext</command> utilities. Most translation actions have been automated through <file>centos-art.sh</file> script “locale” functionality (— <strong>Removed</strong>(pxref:trunk Scripts Bash Functions Locale) —).</para> </subsection> <subsection> <title>Usage</title> - <para>The content of <file>trunk/Scripts/Bash/Locale</file> directory should not be managed manually. Instead, use the “locale” functionality of <file>centos-art.sh</file> script. See <xref><xrefnodename>trunk Scripts Bash Functions Locale</xrefnodename></xref>, for more information on how to use <file>centos-art.sh</file> “locale” functionality.</para> + <para>The content of <file>trunk/Scripts/Bash/Locale</file> directory should not be managed manually. Instead, use the “locale” functionality of <file>centos-art.sh</file> script. — <strong>Removed</strong>(xref:trunk Scripts Bash Functions Locale) —, for more information on how to use <file>centos-art.sh</file> “locale” functionality.</para> </subsection> <subsection> <title>See also</title> <menu> - <menuentry> - <menunode>trunk Scripts Bash Functions</menunode> - <menutitle>trunk Scripts Bash Functions</menutitle> - <menucomment></menucomment> - </menuentry> +<!-- Removed(* trunk Scripts Bash Functions::) - --> <menuentry> <menunode>trunk Scripts</menunode> <menutitle>trunk Scripts</menutitle> diff --git a/Manuals/Filesystem/trunk/Scripts/Bash.texi b/Manuals/Filesystem/trunk/Scripts/Bash.texi index dffcf07..72f99d0 100644 --- a/Manuals/Filesystem/trunk/Scripts/Bash.texi +++ b/Manuals/Filesystem/trunk/Scripts/Bash.texi @@ -22,8 +22,8 @@ operating system trys to execute that command. In order to execute the command, the operating system needs to know where it is, so the operating system uses the @var{PATH} environment variable to look for that command location. If your system was prepared to use CentOS -Artwork Repository correctly (@pxref{trunk Scripts Bash Functions -Verify}), you should have a symbolic link inside @file{~/bin/} +Artwork Repository correctly (--- @strong{Removed}(pxref:trunk Scripts Bash Functions +Verify) ---), you should have a symbolic link inside @file{~/bin/} directory that points to the @file{centos-art.sh} script file. As @file{~/bin/} directory is, by default, inside @var{PATH} environment variable, the execution of @command{centos-art} command runs the @@ -42,7 +42,7 @@ Once global variables and function scripts have been loaded, @file{centos-art.sh} script executes the @command{cli} global function from @file{cli.sh} function script to retrive command-line arguments and define some default values that may be used later by specific -function scripts (@pxref{trunk Scripts Bash Functions}). +function scripts (--- @strong{Removed}(pxref:trunk Scripts Bash Functions) ---). As convenction, the @file{centos-art.sh} command-line arguments have the following format: @@ -144,13 +144,13 @@ variables and functions defined inside function environment. @subsection Usage The @file{centos-art.sh} script usage information is described inside -each specific function documentation (@pxref{trunk Scripts Bash -Functions}). +each specific function documentation (--- @strong{Removed}(pxref:trunk Scripts Bash +Functions) ---). @subsection See also @menu * trunk Scripts:: -* trunk Scripts Bash Functions:: +@comment --- Removed(* trunk Scripts Bash Functions::) --- * trunk Scripts Bash Locale:: @end menu diff --git a/Manuals/Filesystem/trunk/Scripts/Bash/Functions.texi b/Manuals/Filesystem/trunk/Scripts/Bash/Functions.texi deleted file mode 100755 index fb39647..0000000 --- a/Manuals/Filesystem/trunk/Scripts/Bash/Functions.texi +++ /dev/null @@ -1,22 +0,0 @@ -@subsection Goals - -@itemize -@item ... -@end itemize - -@subsection Description - -@itemize -@item ... -@end itemize - -@subsection Usage - -@itemize -@item ... -@end itemize - -@subsection See also - -@menu -@end menu diff --git a/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Html.texi b/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Html.texi deleted file mode 100755 index fb39647..0000000 --- a/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Html.texi +++ /dev/null @@ -1,22 +0,0 @@ -@subsection Goals - -@itemize -@item ... -@end itemize - -@subsection Description - -@itemize -@item ... -@end itemize - -@subsection Usage - -@itemize -@item ... -@end itemize - -@subsection See also - -@menu -@end menu diff --git a/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Locale.texi b/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Locale.texi deleted file mode 100755 index fb39647..0000000 --- a/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Locale.texi +++ /dev/null @@ -1,22 +0,0 @@ -@subsection Goals - -@itemize -@item ... -@end itemize - -@subsection Description - -@itemize -@item ... -@end itemize - -@subsection Usage - -@itemize -@item ... -@end itemize - -@subsection See also - -@menu -@end menu diff --git a/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Manual.texi b/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Manual.texi deleted file mode 100755 index fb39647..0000000 --- a/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Manual.texi +++ /dev/null @@ -1,22 +0,0 @@ -@subsection Goals - -@itemize -@item ... -@end itemize - -@subsection Description - -@itemize -@item ... -@end itemize - -@subsection Usage - -@itemize -@item ... -@end itemize - -@subsection See also - -@menu -@end menu diff --git a/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Path.texi b/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Path.texi deleted file mode 100755 index fb39647..0000000 --- a/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Path.texi +++ /dev/null @@ -1,22 +0,0 @@ -@subsection Goals - -@itemize -@item ... -@end itemize - -@subsection Description - -@itemize -@item ... -@end itemize - -@subsection Usage - -@itemize -@item ... -@end itemize - -@subsection See also - -@menu -@end menu diff --git a/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Render.texi b/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Render.texi deleted file mode 100755 index fb39647..0000000 --- a/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Render.texi +++ /dev/null @@ -1,22 +0,0 @@ -@subsection Goals - -@itemize -@item ... -@end itemize - -@subsection Description - -@itemize -@item ... -@end itemize - -@subsection Usage - -@itemize -@item ... -@end itemize - -@subsection See also - -@menu -@end menu diff --git a/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Render/Config.texi b/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Render/Config.texi deleted file mode 100755 index fb39647..0000000 --- a/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Render/Config.texi +++ /dev/null @@ -1,22 +0,0 @@ -@subsection Goals - -@itemize -@item ... -@end itemize - -@subsection Description - -@itemize -@item ... -@end itemize - -@subsection Usage - -@itemize -@item ... -@end itemize - -@subsection See also - -@menu -@end menu diff --git a/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Shell.texi b/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Shell.texi deleted file mode 100755 index fb39647..0000000 --- a/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Shell.texi +++ /dev/null @@ -1,22 +0,0 @@ -@subsection Goals - -@itemize -@item ... -@end itemize - -@subsection Description - -@itemize -@item ... -@end itemize - -@subsection Usage - -@itemize -@item ... -@end itemize - -@subsection See also - -@menu -@end menu diff --git a/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Svg.texi b/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Svg.texi deleted file mode 100755 index fb39647..0000000 --- a/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Svg.texi +++ /dev/null @@ -1,22 +0,0 @@ -@subsection Goals - -@itemize -@item ... -@end itemize - -@subsection Description - -@itemize -@item ... -@end itemize - -@subsection Usage - -@itemize -@item ... -@end itemize - -@subsection See also - -@menu -@end menu diff --git a/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Verify.texi b/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Verify.texi deleted file mode 100755 index fb39647..0000000 --- a/Manuals/Filesystem/trunk/Scripts/Bash/Functions/Verify.texi +++ /dev/null @@ -1,22 +0,0 @@ -@subsection Goals - -@itemize -@item ... -@end itemize - -@subsection Description - -@itemize -@item ... -@end itemize - -@subsection Usage - -@itemize -@item ... -@end itemize - -@subsection See also - -@menu -@end menu diff --git a/Manuals/Filesystem/trunk/Scripts/Bash/Locale.texi b/Manuals/Filesystem/trunk/Scripts/Bash/Locale.texi index ea50a2f..6a4006f 100644 --- a/Manuals/Filesystem/trunk/Scripts/Bash/Locale.texi +++ b/Manuals/Filesystem/trunk/Scripts/Bash/Locale.texi @@ -8,19 +8,19 @@ used by @file{centos-art.sh} script. Translated messages of @file{centos-art.sh} script are managed using GNU @command{gettext} utilities. Most translation actions have been automated through @file{centos-art.sh} script ``locale'' functionality -(@pxref{trunk Scripts Bash Functions Locale}). +(--- @strong{Removed}(pxref:trunk Scripts Bash Functions Locale) ---). @subsection Usage The content of @file{trunk/Scripts/Bash/Locale} directory should not be managed manually. Instead, use the ``locale'' functionality of -@file{centos-art.sh} script. @xref{trunk Scripts Bash Functions -Locale}, for more information on how to use @file{centos-art.sh} +@file{centos-art.sh} script. --- @strong{Removed}(xref:trunk Scripts Bash Functions +Locale) ---, for more information on how to use @file{centos-art.sh} ``locale'' functionality. @subsection See also @menu -* trunk Scripts Bash Functions:: +@comment --- Removed(* trunk Scripts Bash Functions::) --- * trunk Scripts:: @end menu diff --git a/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions.texi b/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions.texi index eea03fd..f1f3d23 100755 --- a/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions.texi +++ b/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions.texi @@ -246,7 +246,7 @@ change it to have a little fun. Now that we have a specific function that works as we expect, it is time to document it. To document @code{greet} specific functionality, we use its directory path and the @code{manual} functionality -(@pxref{trunk Scripts Bash Functions Manual}) of @file{centos-art.sh} +(--- @strong{Removed}(pxref:trunk Scripts Bash Functions Manual) ---) of @file{centos-art.sh} script, just as the following command illustrates: @verbatim @@ -265,8 +265,8 @@ create it right at that time. Now that we have documented our function, it is time to translate its output messages to different languages. To translate specific functionality output messages to different languages we use the -@code{locale} functionality (@pxref{trunk Scripts Bash Functions -Locale}) of @file{centos-art.sh} script, just as the following command +@code{locale} functionality (--- @strong{Removed}(pxref:trunk Scripts Bash Functions +Locale) ---) of @file{centos-art.sh} script, just as the following command illustrates: @verbatim @@ -961,7 +961,7 @@ file system organization. Notice that when we change a file name (e.g., a function name), it is necessary to update all files where such file name is placed on. This may require a massive substitution inside the repository, each time we change name convenctions in the -repository (@pxref{trunk Scripts Bash Functions Path}, for more +repository (--- @strong{Removed}(pxref:trunk Scripts Bash Functions Path) ---, for more information). @end defun @@ -1156,8 +1156,8 @@ and the confirmation answer would be @samp{s}, as it is on Spanish @samp{sí} word. Definition of which confirmation word to use is set on translation -messages for your specific locale information. @xref{trunk Scripts -Bash Functions Locale}, for more information about locale-specific +messages for your specific locale information. --- @strong{Removed}(xref:trunk Scripts +Bash Functions Locale) ---, for more information about locale-specific translation messages. @item AsToKnowMoreLine @@ -1203,15 +1203,15 @@ The following specific functions of @file{centos-art.sh} script, are available for you to use: @menu -* trunk Scripts Bash Functions Html:: -* trunk Scripts Bash Functions Locale:: -* trunk Scripts Bash Functions Manual:: -* trunk Scripts Bash Functions Path:: -* trunk Scripts Bash Functions Render:: -* trunk Scripts Bash Functions Render Config:: -* trunk Scripts Bash Functions Shell:: -* trunk Scripts Bash Functions Svg:: -* trunk Scripts Bash Functions Verify:: +@comment --- Removed(* trunk Scripts Bash Functions Html::) --- +@comment --- Removed(* trunk Scripts Bash Functions Locale::) --- +@comment --- Removed(* trunk Scripts Bash Functions Manual::) --- +@comment --- Removed(* trunk Scripts Bash Functions Path::) --- +@comment --- Removed(* trunk Scripts Bash Functions Render::) --- +@comment --- Removed(* trunk Scripts Bash Functions Render Config::) --- +@comment --- Removed(* trunk Scripts Bash Functions Shell::) --- +@comment --- Removed(* trunk Scripts Bash Functions Svg::) --- +@comment --- Removed(* trunk Scripts Bash Functions Verify::) --- @end menu @subsection See also diff --git a/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Path.texi b/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Path.texi index 8353df5..a7c6c55 100644 --- a/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Path.texi +++ b/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Path.texi @@ -323,5 +323,5 @@ In this command, @file{SRC} is a working copy (WC) entry. @menu * trunk Scripts Bash:: -* trunk Scripts Bash Functions:: +@comment --- Removed(* trunk Scripts Bash Functions::) --- @end menu diff --git a/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Render.texi b/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Render.texi index 71dcbc5..7dfe2c5 100644 --- a/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Render.texi +++ b/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Render.texi @@ -106,8 +106,8 @@ produce image-based content, @file{centos-art.sh} produces @acronym{PNG,Portable Network Graphics} files with the @code{.png} extension. Once the base image format has been produced, it is possible for @file{centos-art.sh} to use it in order to automatically -create other image formats that may be needed (@pxref{trunk Scripts -Bash Functions Render Config}). +create other image formats that may be needed (--- @strong{Removed}(pxref:trunk Scripts +Bash Functions Render Config) ---). Inside the working copy, you can find an example of ``design template without translation'' configuration at @file{trunk/Identity/Models/}. @@ -221,7 +221,7 @@ design template instance is removed. At this point, whole production flow once again (design template by design template), until all design templates be processed. -@xref{trunk Scripts Bash Functions Render Config}, for more +--- @strong{Removed}(xref:trunk Scripts Bash Functions Render Config) ---, for more information. @end table @@ -732,5 +732,5 @@ have been duplicated, the functionality stops thereat. @subsection See also @menu -* trunk Scripts Bash Functions Render Config:: +@comment --- Removed(* trunk Scripts Bash Functions Render Config::) --- @end menu diff --git a/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Render/Config.texi b/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Render/Config.texi index 2c430a9..3b3322b 100644 --- a/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Render/Config.texi +++ b/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Render/Config.texi @@ -134,7 +134,7 @@ file in the list of files to process has been rendered. The actions may be @samp{groupByFormat}, @samp{renderGdmTgz}, etc. @quotation -@strong{Note} @xref{trunk Scripts Bash Functions Render}, to know more +@strong{Note} --- @strong{Removed}(xref:trunk Scripts Bash Functions Render) ---, to know more about possible values for @samp{BASE}, @samp{POST} and @samp{LAST} action definitions. @end quotation @@ -187,6 +187,6 @@ directory path under @file{trunk/Identity} or @menu * trunk Scripts Bash:: -* trunk Scripts Bash Functions:: -* trunk Scripts Bash Functions Render:: +@comment --- Removed(* trunk Scripts Bash Functions::) --- +@comment --- Removed(* trunk Scripts Bash Functions Render::) --- @end menu diff --git a/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Shell.texi b/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Shell.texi index 92e5aa7..a5016fe 100644 --- a/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Shell.texi +++ b/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Shell.texi @@ -180,5 +180,5 @@ list of files to process. @menu * trunk Scripts Bash:: -* trunk Scripts Bash Functions:: +@comment --- Removed(* trunk Scripts Bash Functions::) --- @end menu diff --git a/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Svg.texi b/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Svg.texi index 37889d4..341745d 100644 --- a/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Svg.texi +++ b/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Svg.texi @@ -188,5 +188,5 @@ list of files to process. @menu * trunk Scripts Bash:: -* trunk Scripts Bash Functions:: +@comment --- Removed(* trunk Scripts Bash Functions::) --- @end menu diff --git a/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Verify.texi b/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Verify.texi index bbf2a3c..ff98b51 100644 --- a/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Verify.texi +++ b/Manuals/Filesystem/trunk/Scripts/Bash/centos-art/Functions/Verify.texi @@ -241,5 +241,5 @@ provided at all. @menu * trunk Scripts Bash:: -* trunk Scripts Bash Functions:: +@comment --- Removed(* trunk Scripts Bash Functions::) --- @end menu diff --git a/Manuals/Filesystem/trunk/chapter-menu.texi b/Manuals/Filesystem/trunk/chapter-menu.texi index cdaec48..3295493 100644 --- a/Manuals/Filesystem/trunk/chapter-menu.texi +++ b/Manuals/Filesystem/trunk/chapter-menu.texi @@ -58,16 +58,6 @@ * trunk Scripts Bash centos-art Functions Shell:: * trunk Scripts Bash centos-art Functions Svg:: * trunk Scripts Bash centos-art Functions Verify:: -* trunk Scripts Bash Functions:: -* trunk Scripts Bash Functions Html:: -* trunk Scripts Bash Functions Locale:: -* trunk Scripts Bash Functions Manual:: -* trunk Scripts Bash Functions Path:: -* trunk Scripts Bash Functions Render:: -* trunk Scripts Bash Functions Render Config:: -* trunk Scripts Bash Functions Shell:: -* trunk Scripts Bash Functions Svg:: -* trunk Scripts Bash Functions Verify:: * trunk Scripts Bash Locale:: * trunk Scripts Perl:: * trunk Scripts Python:: diff --git a/Manuals/Filesystem/trunk/chapter-nodes.texi b/Manuals/Filesystem/trunk/chapter-nodes.texi index c0cebb9..f598fb4 100644 --- a/Manuals/Filesystem/trunk/chapter-nodes.texi +++ b/Manuals/Filesystem/trunk/chapter-nodes.texi @@ -293,56 +293,6 @@ @cindex trunk Scripts Bash centos-art Functions Verify @include trunk/Scripts/Bash/centos-art/Functions/Verify.texi -@node trunk Scripts Bash Functions -@section trunk/Scripts/Bash/Functions -@cindex trunk Scripts Bash Functions -@include trunk/Scripts/Bash/Functions.texi - -@node trunk Scripts Bash Functions Html -@section trunk/Scripts/Bash/Functions/Html -@cindex trunk Scripts Bash Functions Html -@include trunk/Scripts/Bash/Functions/Html.texi - -@node trunk Scripts Bash Functions Locale -@section trunk/Scripts/Bash/Functions/Locale -@cindex trunk Scripts Bash Functions Locale -@include trunk/Scripts/Bash/Functions/Locale.texi - -@node trunk Scripts Bash Functions Manual -@section trunk/Scripts/Bash/Functions/Manual -@cindex trunk Scripts Bash Functions Manual -@include trunk/Scripts/Bash/Functions/Manual.texi - -@node trunk Scripts Bash Functions Path -@section trunk/Scripts/Bash/Functions/Path -@cindex trunk Scripts Bash Functions Path -@include trunk/Scripts/Bash/Functions/Path.texi - -@node trunk Scripts Bash Functions Render -@section trunk/Scripts/Bash/Functions/Render -@cindex trunk Scripts Bash Functions Render -@include trunk/Scripts/Bash/Functions/Render.texi - -@node trunk Scripts Bash Functions Render Config -@section trunk/Scripts/Bash/Functions/Render/Config -@cindex trunk Scripts Bash Functions Render Config -@include trunk/Scripts/Bash/Functions/Render/Config.texi - -@node trunk Scripts Bash Functions Shell -@section trunk/Scripts/Bash/Functions/Shell -@cindex trunk Scripts Bash Functions Shell -@include trunk/Scripts/Bash/Functions/Shell.texi - -@node trunk Scripts Bash Functions Svg -@section trunk/Scripts/Bash/Functions/Svg -@cindex trunk Scripts Bash Functions Svg -@include trunk/Scripts/Bash/Functions/Svg.texi - -@node trunk Scripts Bash Functions Verify -@section trunk/Scripts/Bash/Functions/Verify -@cindex trunk Scripts Bash Functions Verify -@include trunk/Scripts/Bash/Functions/Verify.texi - @node trunk Scripts Bash Locale @section trunk/Scripts/Bash/Locale @cindex trunk Scripts Bash Locale