From a69d1adac9b51e7941a449016b0f6aa37b683dbb Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Dec 06 2010 13:11:07 +0000 Subject: Update documentation manual. --- diff --git a/Manuals/en/Html/Repository/repository_40.html b/Manuals/en/Html/Repository/repository_40.html index bb09679..9ab0d6c 100644 --- a/Manuals/en/Html/Repository/repository_40.html +++ b/Manuals/en/Html/Repository/repository_40.html @@ -795,7 +795,7 @@ action name acts on.

Once action related variables (i.e., FUNCNAM, ACTIONNAM, and ACTIONVAL) are defined and validated, cli_getActionsArguments shifts the positional arguments to -remove the first two arguments passed (i.e., those one used to retrive +remove the first two arguments passed (i.e., those used to retrive action related variables) and redefine the arguments (ARGUMENTS) global variable with the new positional parameters information.

@@ -812,14 +812,10 @@ in functionality directories under 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. +specific task only (i.e., the one such functionality was created for).

-

Functionalities supported by `centos-art.sh' script are -initialized and executed using the `centos-art.sh' script -functionality name convenction as reference. -

-

In order to for `centos-art.sh' script to recognize a -functionality, such functionality needs to be stored under +

In order for `centos-art.sh' script to recognize a functionality, +such functionality needs to be stored under `trunk/Scripts/Bash/Functions/' 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 @@ -828,9 +824,9 @@ directory'.

Inside each functionality directory, the functionalty itself is implemented through function scripts. Function scripts are organized -in independent files written in `camelCase' format with the -function name as prefix. Separation between prefix and description is -done using underscore (`_') character. +in files independently one another and written in `camelCase' +format with the function name as prefix. Separation between prefix +and description is done using underscore (`_') character.

In order for `centos-art.sh' script to load functionalities correctly, function definition inside function scripts should be set @@ -843,9 +839,28 @@ example: } -

In order to keep visual consistency among function scripts, use the -following function script design model as template to create your own -function scripts: +

The above function definition is just a convenction we use, in order +to make identification of function names easier read and automate by +`centos-art.sh' script initialization commands, once +`centos-art.sh' script determines which functionality directory +to use. Specifically, in order to initialize and export functions, +`centos-art.sh' script executes all function scripts inside the +functionality directory, and later grep on them using a +regular expression pattern, where the `function' reserved word is +used as reference to retrive the function names and export them to +`centos-art.sh' script execution environment, and so, make +function definitions --from function scripts inside the functionality +directory-- available for further calls. +

+

If the functionality specified in the command-line first argument +doesn't have a functionality directory, `centos-art.sh' script +considers the functionality provided in the command-line as invalid +functionality and immediatly stops script execution with an error +message. +

+

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: 

#!/bin/bash
 #
@@ -879,17 +894,7 @@ function prefix_doSomething {
     # Do something here...
 
 }
-
-

Once `centos-art.sh' script determines which functionality -directory to use, function scripts are executed and function -definitinos exported. This way, function definitions are made -available inside `centos-art.sh' script execution evironment for -further calls. If the functionality specified in the command-line -first argument doesn't have a functionality directory, -`centos-art.sh' script considers the functionality provided in -the command-line as invalid functionality and immediatly stops script -execution with an informative message. -

+
Function: cli_getCountryCodes [FILTER] @@ -946,10 +951,39 @@ information to use inside `centos-art.sh' script.

-
Function: cli_getFilesList +
Function: cli_getFilesList [LOCATION]
-
+

Output list of files to process. +

+

The cli_getFilesList function uses LOCATION variable as +source location to build a list of files just as specified by regular +expression (REGEX) global variable. +

+

If LOCATION is not specified when cli_getFilesList +function is called, the action value (ACTIONVAL) global variable +is used instead. +

+

By default, if the regular expression (REGEX) global variable is +not redefined after its first definition in cli function, all +files as in `.+' regular expression will be added to the list of +files to process. Otherwise, if you redefine the regular expression +global variable after its first definition in cli and before +calling cli_getFilesList function, the value you specifed is +used instead. +

+

When you need customize the regular expression (REGEX) global +variable value inside a function, do not redefine the global variable. +Instead, make regular expression global variable as `local' to +the function you need a customized regular expression value for. If +you don't redefine the regular expression global variable as local, or +use another name (which is not convenient), 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 you are doing the redefinition is called several times +during the script execution flow. +

+
Function: cli_getLangCodes [FILTER] diff --git a/Manuals/en/Info/Repository/repository.info.bz2 b/Manuals/en/Info/Repository/repository.info.bz2 index 0b5bce9..37e39f7 100644 Binary files a/Manuals/en/Info/Repository/repository.info.bz2 and b/Manuals/en/Info/Repository/repository.info.bz2 differ diff --git a/Manuals/en/Plaintext/Repository/repository.txt b/Manuals/en/Plaintext/Repository/repository.txt index bea82e4..478cfe3 100644 --- a/Manuals/en/Plaintext/Repository/repository.txt +++ b/Manuals/en/Plaintext/Repository/repository.txt @@ -3420,9 +3420,9 @@ global functions you can use inside `centos-art.sh' script. Once action related variables (i.e., FUNCNAM, ACTIONNAM, and ACTIONVAL) are defined and validated, `cli_getActionsArguments' shifts the positional arguments to remove the first two arguments - passed (i.e., those one used to retrive action related variables) - and redefine the arguments (ARGUMENTS) global variable with the - new positional parameters information. + passed (i.e., those used to retrive action related variables) and + redefine the arguments (ARGUMENTS) global variable with the new + positional parameters information. -- Function: cli_getActions Initialize funtionalities supported by `centos-art.sh' script. @@ -3432,14 +3432,11 @@ global functions you can use inside `centos-art.sh' script. 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. + several commands focused on achieving one specific task only + (i.e., the one such functionality was created for). - Functionalities supported by `centos-art.sh' script are - initialized and executed using the `centos-art.sh' script - functionality name convenction as reference. - - In order to for `centos-art.sh' script to recognize a - functionality, such functionality needs to be stored under + In order for `centos-art.sh' script to recognize a functionality, + such functionality needs to be stored under `trunk/Scripts/Bash/Functions/' 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 @@ -3447,9 +3444,10 @@ global functions you can use inside `centos-art.sh' script. Inside each functionality directory, the functionalty itself is implemented through function scripts. Function scripts are - organized in independent files written in `camelCase' format with - the function name as prefix. Separation between prefix and - description is done using underscore (`_') character. + organized in files independently one another and written in + `camelCase' format with the function name as prefix. Separation + between prefix and description is done using underscore (`_') + character. In order for `centos-art.sh' script to load functionalities correctly, function definition inside function scripts should be @@ -3463,9 +3461,28 @@ global functions you can use inside `centos-art.sh' script. } - In order to keep visual consistency among function scripts, use the - following function script design model as template to create your - own function scripts: + The above function definition is just a convenction we use, in + order to make identification of function names easier read and + automate by `centos-art.sh' script initialization commands, once + `centos-art.sh' script determines which functionality directory to + use. Specifically, in order to initialize and export functions, + `centos-art.sh' script executes all function scripts inside the + functionality directory, and later `grep' on them using a regular + expression pattern, where the `function' reserved word is used as + reference to retrive the function names and export them to + `centos-art.sh' script execution environment, and so, make + function definitions --from function scripts inside the + functionality directory-- available for further calls. + + If the functionality specified in the command-line first argument + doesn't have a functionality directory, `centos-art.sh' script + considers the functionality provided in the command-line as invalid + functionality and immediatly stops script execution with an error + message. + + 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: #!/bin/bash @@ -3501,16 +3518,6 @@ global functions you can use inside `centos-art.sh' script. } - Once `centos-art.sh' script determines which functionality - directory to use, function scripts are executed and function - definitinos exported. This way, function definitions are made - available inside `centos-art.sh' script execution evironment for - further calls. If the functionality specified in the command-line - first argument doesn't have a functionality directory, - `centos-art.sh' script considers the functionality provided in the - command-line as invalid functionality and immediatly stops script - execution with an informative message. - -- Function: cli_getCountryCodes [FILTER] Output country codes supported by `centos-art.sh' script. @@ -3553,7 +3560,37 @@ global functions you can use inside `centos-art.sh' script. Use `cli_getCurrentLocale' function to know what current locale information to use inside `centos-art.sh' script. - -- Function: cli_getFilesList + -- Function: cli_getFilesList [LOCATION] + Output list of files to process. + + The `cli_getFilesList' function uses LOCATION variable as source + location to build a list of files just as specified by regular + expression (REGEX) global variable. + + If LOCATION is not specified when `cli_getFilesList' function is + called, the action value (ACTIONVAL) global variable is used + instead. + + By default, if the regular expression (REGEX) global variable is + not redefined after its first definition in `cli' function, all + files as in `.+' regular expression will be added to the list of + files to process. Otherwise, if you redefine the regular expression + global variable after its first definition in `cli' and before + calling `cli_getFilesList' function, the value you specifed is + used instead. + + When you need customize the regular expression (REGEX) global + variable value inside a function, do not redefine the global + variable. Instead, make regular expression global variable as + `local' to the function you need a customized regular expression + value for. If you don't redefine the regular expression global + variable as local, or use another name (which is not convenient), + 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 you are doing the + redefinition is called several times during the script execution + flow. + -- Function: cli_getLangCodes [FILTER] Outputs language codes supported by `centos-art.sh' script. @@ -6153,24 +6190,24 @@ Index ***** branches: See 1. (line 390) -Common translation files: See 3.50.2.5. (line 5582) -How to render brands' translation files: See 3.52.3. (line 5886) -How to render fonts' translation files: See 3.54.3. (line 5959) -How to render translation files: See 3.50.3. (line 5752) -Metadata maintainance: See 3.45.2. (line 4726) -Specific translation files: See 3.50.2.6. (line 5607) +Common translation files: See 3.50.2.5. (line 5619) +How to render brands' translation files: See 3.52.3. (line 5923) +How to render fonts' translation files: See 3.54.3. (line 5996) +How to render translation files: See 3.50.3. (line 5789) +Metadata maintainance: See 3.45.2. (line 4763) +Specific translation files: See 3.50.2.6. (line 5644) tags: See 2. (line 393) -Template translation files: See 3.50.2.4. (line 5412) -Translation brands file names: See 3.52.2.1. (line 5843) -Translation configuration scripts: See 3.50.2.8. (line 5641) -Translation entries: See 3.50.2.1. (line 5228) -Translation files: See 3.50.2.3. (line 5344) -Translation markers: See 3.50.2.2. (line 5309) -Translation paths: See 3.50.2.1. (line 5228) +Template translation files: See 3.50.2.4. (line 5449) +Translation brands file names: See 3.52.2.1. (line 5880) +Translation configuration scripts: See 3.50.2.8. (line 5678) +Translation entries: See 3.50.2.1. (line 5265) +Translation files: See 3.50.2.3. (line 5381) +Translation markers: See 3.50.2.2. (line 5346) +Translation paths: See 3.50.2.1. (line 5265) Translation pre-rendering configuration scripts:See 3.50.2.8. - (line 5641) -Translation rendering: See 3.50.2.7. (line 5630) -Translation rendering default functionality: See 3.50.2.9. (line 5727) + (line 5678) +Translation rendering: See 3.50.2.7. (line 5667) +Translation rendering default functionality: See 3.50.2.9. (line 5764) trunk: See 3. (line 396) trunk Identity: See 3.1. (line 399) trunk Identity Brands: See 3.2. (line 819) @@ -6215,31 +6252,31 @@ trunk Manuals: See 3.34. (line 2579) trunk Scripts: See 3.35. (line 2633) trunk Scripts Bash: See 3.36. (line 2657) trunk Scripts Bash Functions: See 3.37. (line 2769) -trunk Scripts Bash Functions Html: See 3.38. (line 3817) -trunk Scripts Bash Functions Locale: See 3.39. (line 3838) -trunk Scripts Bash Functions Manual: See 3.40. (line 3918) -trunk Scripts Bash Functions Path: See 3.41. (line 3939) -trunk Scripts Bash Functions Render: See 3.42. (line 4341) -trunk Scripts Bash Functions Render Config: See 3.43. (line 4362) -trunk Scripts Bash Functions Shell: See 3.44. (line 4540) -trunk Scripts Bash Functions Svg: See 3.45. (line 4708) -trunk Scripts Bash Functions Verify: See 3.46. (line 4896) -trunk Scripts Bash Locale: See 3.47. (line 5112) -trunk Scripts Perl: See 3.48. (line 5141) -trunk Scripts Python: See 3.49. (line 5158) -trunk Translations: See 3.50. (line 5179) -trunk Translations Identity: See 3.51. (line 5781) -trunk Translations Identity Brands: See 3.52. (line 5802) -trunk Translations Identity Brands Tpl: See 3.53. (line 5897) -trunk Translations Identity Fonts: See 3.54. (line 5912) -trunk Translations Identity Models: See 3.55. (line 5975) -trunk Translations Identity Release: See 3.56. (line 5990) -trunk Translations Identity Themes: See 3.57. (line 6005) -trunk Translations Identity Themes Backgrounds:See 3.58. (line 6020) +trunk Scripts Bash Functions Html: See 3.38. (line 3854) +trunk Scripts Bash Functions Locale: See 3.39. (line 3875) +trunk Scripts Bash Functions Manual: See 3.40. (line 3955) +trunk Scripts Bash Functions Path: See 3.41. (line 3976) +trunk Scripts Bash Functions Render: See 3.42. (line 4378) +trunk Scripts Bash Functions Render Config: See 3.43. (line 4399) +trunk Scripts Bash Functions Shell: See 3.44. (line 4577) +trunk Scripts Bash Functions Svg: See 3.45. (line 4745) +trunk Scripts Bash Functions Verify: See 3.46. (line 4933) +trunk Scripts Bash Locale: See 3.47. (line 5149) +trunk Scripts Perl: See 3.48. (line 5178) +trunk Scripts Python: See 3.49. (line 5195) +trunk Translations: See 3.50. (line 5216) +trunk Translations Identity: See 3.51. (line 5818) +trunk Translations Identity Brands: See 3.52. (line 5839) +trunk Translations Identity Brands Tpl: See 3.53. (line 5934) +trunk Translations Identity Fonts: See 3.54. (line 5949) +trunk Translations Identity Models: See 3.55. (line 6012) +trunk Translations Identity Release: See 3.56. (line 6027) +trunk Translations Identity Themes: See 3.57. (line 6042) +trunk Translations Identity Themes Backgrounds:See 3.58. (line 6057) trunk Translations Identity Themes Distro Anaconda Progress:See 3.59. - (line 6041) -trunk Translations Identity Widgets: See 3.60. (line 6134) -Unused definitions: See 3.45.2.1. (line 4833) + (line 6078) +trunk Translations Identity Widgets: See 3.60. (line 6171) +Unused definitions: See 3.45.2.1. (line 4870) List of Figures *************** diff --git a/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions.texi b/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions.texi index 2ece8ba..d0c84f9 100644 --- a/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions.texi +++ b/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions.texi @@ -690,7 +690,7 @@ action name acts on. Once action related variables (i.e., @var{FUNCNAM}, @var{ACTIONNAM}, and @var{ACTIONVAL}) are defined and validated, @code{cli_getActionsArguments} shifts the positional arguments to -remove the first two arguments passed (i.e., those one used to retrive +remove the first two arguments passed (i.e., those used to retrive action related variables) and redefine the arguments (@var{ARGUMENTS}) global variable with the new positional parameters information. @end defun @@ -704,14 +704,10 @@ in functionality directories under 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. +specific task only (i.e., the one such functionality was created for). -Functionalities supported by @file{centos-art.sh} script are -initialized and executed using the @file{centos-art.sh} script -functionality name convenction as reference. - -In order to for @file{centos-art.sh} script to recognize a -functionality, such functionality needs to be stored under +In order for @file{centos-art.sh} script to recognize a functionality, +such functionality needs to be stored under @file{trunk/Scripts/Bash/Functions/} 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 @@ -720,9 +716,9 @@ directory}. Inside each functionality directory, the functionalty itself is implemented through function scripts. Function scripts are organized -in independent files written in @samp{camelCase} format with the -function name as prefix. Separation between prefix and description is -done using underscore (@samp{_}) character. +in files independently one another and written in @samp{camelCase} +format with the function name as prefix. Separation between prefix +and description is done using underscore (@samp{_}) character. In order for @file{centos-art.sh} script to load functionalities correctly, function definition inside function scripts should be set @@ -737,9 +733,28 @@ function prefix_doSomething { } @end verbatim -In order to keep visual consistency among function scripts, use the -following function script design model as template to create your own -function scripts: +The above function definition is just a convenction we use, in order +to make identification of function names easier read and automate by +@file{centos-art.sh} script initialization commands, once +@file{centos-art.sh} script determines which functionality directory +to use. Specifically, in order to initialize and export functions, +@file{centos-art.sh} script executes all function scripts inside the +functionality directory, and later @command{grep} on them using a +regular expression pattern, where the @samp{function} reserved word is +used as reference to retrive the function names and export them to +@file{centos-art.sh} script execution environment, and so, make +function definitions ---from function scripts inside the functionality +directory--- available for further calls. + +If the functionality specified in the command-line first argument +doesn't have a functionality directory, @file{centos-art.sh} script +considers the functionality provided in the command-line as invalid +functionality and immediatly stops script execution with an error +message. + +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: @verbatim #!/bin/bash @@ -775,16 +790,6 @@ function prefix_doSomething { } @end verbatim - -Once @file{centos-art.sh} script determines which functionality -directory to use, function scripts are executed and function -definitinos exported. This way, function definitions are made -available inside @file{centos-art.sh} script execution evironment for -further calls. If the functionality specified in the command-line -first argument doesn't have a functionality directory, -@file{centos-art.sh} script considers the functionality provided in -the command-line as invalid functionality and immediatly stops script -execution with an informative message. @end defun @defun cli_getCountryCodes [FILTER] @@ -832,7 +837,36 @@ Use @code{cli_getCurrentLocale} function to know what current locale information to use inside @file{centos-art.sh} script. @end defun -@defun cli_getFilesList +@defun cli_getFilesList [LOCATION] +Output list of files to process. + +The @code{cli_getFilesList} function uses @var{LOCATION} variable as +source location to build a list of files just as specified by regular +expression (@var{REGEX}) global variable. + +If @var{LOCATION} is not specified when @code{cli_getFilesList} +function is called, the action value (@var{ACTIONVAL}) global variable +is used instead. + +By default, if the regular expression (@var{REGEX}) global variable is +not redefined after its first definition in @code{cli} function, all +files as in @samp{.+} regular expression will be added to the list of +files to process. Otherwise, if you redefine the regular expression +global variable after its first definition in @code{cli} and before +calling @code{cli_getFilesList} function, the value you specifed is +used instead. + +When you need customize the regular expression (@var{REGEX}) global +variable value inside a function, do not redefine the global variable. +Instead, make regular expression global variable as @samp{local} to +the function you need a customized regular expression value for. If +you don't redefine the regular expression global variable as local, or +use another name (which is not convenient), 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 you are doing the redefinition is called several times +during the script execution flow. + @end defun @defun cli_getLangCodes [FILTER]