Output country codes supported by `centos-art.sh' script.
The cli_getCountryCodes function outputs a list with country
@@ -702,7 +741,7 @@ codes as defined in ISO3166 standard. When FILTER is provided,
- Function: cli_getCountryName [FILTER] - +
Outputs country name supported by `centos-art.sh' script.
@@ -715,7 +754,7 @@ exactly.- Function: cli_getCurrentLocale - +
Output current locale used by `centos-art.sh' script.
@@ -743,8 +782,14 @@ information to use inside `centos-art.sh' script.
- Function: cli_getLangCodes [FILTER] - +
Outputs language codes supported by `centos-art.sh' script.
@@ -756,7 +801,7 @@ regular expression pattern.- Function: cli_getLangName [FILTER] - +
Outputs language names supported by `centos-art.sh' script.
@@ -768,7 +813,7 @@ that matches the locale code specified in FILTER, exactly.- Function: cli_getLocales - +
Output locale codes supported by `centos-art.sh' script.
@@ -782,7 +827,7 @@ specifications (`LL') into one unique common locale specification- Function: cli_getRepoName NAME TYPE - +
Sanitate file names.
@@ -821,22 +866,23 @@ directory names before their utilization.Use
-cli_getRepoNamewhen you need to change file name convenctions inside `centos-art.sh' script.When changing file name convenctions inside
-cli_getRepoName-what you are really changing is the way functions interpret repository -file system organization. In order to a complete file name convenction -change, you also need to change file names and directory names inside -repository file system organization, just as you did in -cli_getRepoNamefunction. -
-
Note
See section trunk/Scripts/Bash/Functions/Path, for more -information on how to rename files and directories massively inside -repository file system organization. -
When we change file name convenctions inside
cli_getRepoName+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, +each time we change name convenctions in the repository (see section trunk/Scripts/Bash/Functions/Path, for more information). +
- Function: cli_getTemporalFile NAME - +
Output absolute path to temporal file NAME.
@@ -878,7 +924,7 @@ temporal files inside `centos-art.sh' script.- Function: cli_getThemeName - +
Output theme name.
@@ -890,9 +936,10 @@ Otherwise,cli_getThemeNamereturns an empty string.- Function: cli_printMessage MESSAGE [FORMAT] - + -
Give format to output messages. +
Define standard output message definition supported by +`centos-art.sh' script.
When FORMAT is not specified,
cli_printMessageoutputs information just as it was passed in MESSAGE variable. @@ -921,71 +968,72 @@ NOTE: $MESSAGE- `AsUpdatingLine' -
To print `Updating' messages using two-columns format. +
To print `Updating' messages on two-columns format.
Updating $MESSAGE
- `AsRemovingLine' -
To print `Removing' messages using two-columns format. +
To print `Removing' messages on two-columns format.
Removing $MESSAGE
- `AsCheckingLine' -
To print `Checking' messages using two-columns format. +
To print `Checking' messages on two-columns format.
Checking $MESSAGE
- `AsCreatingLine' -
To print `Creating' messages using two-columns format. +
To print `Creating' messages on two-columns format.
Creating $MESSAGE
- `AsSavedAsLine' -
To print `Saved as' messages using two-columns format. +
To print `Saved as' messages on two-columns format.
Saved as $MESSAGE
- `AsLinkToLine' -
To print `Linked to' messages using two-columns format. +
To print `Linked to' messages on two-columns format.
Linked to $MESSAGE
- `AsMovedToLine' -
To print `Moved to' messages using two-columns format. +
To print `Moved to' messages on two-columns format.
Moved to $MESSAGE
- `AsTranslationLine' -
To print `Translation' messages using two-columns format. +
To print `Translation' messages on two-columns format.
Translation $MESSAGE
- `AsConfigurationLine' -
To print `Configuration' messages using two-columns format. +
To print `Configuration' messages on two-columns format.
Configuration $MESSAGE
- `AsResponseLine' -
To print response messages using one-column format. +
To print response messages on one-column format.
--> $MESSAGE
- `AsRequestLine' -
To print request messages using one-column format. Request messages -supress the trailing newline character from final output. -
$MESSAGE +
To print request messages on one-column format. Request messages +output messages with one colon (`:') and without trailing newline +(`\n') at message end. +
$MESSAGE:
- `AsYesOrNoRequestLine' -
To print `yes or no' request messages using one-column format. If +
To print `yes or no' request messages on one-column format. If something different from `y' is answered (when using
en_US.UTF-8locale), script execution ends immediatly.$MESSAGE [y/N]:
-When you are using `centos-art.sh' script in a locale different -from
en_US.UTF-8, confirmation answer may be different from -`y'. For example, if you are usinges_ES.UTF-8locale, the +When we use `centos-art.sh' script in a locale different from +
en_US.UTF-8, confirmation answer may be different from +`y'. For example, if you usees_ES.UTF-8locale, the confirmation question would look like:$MESSAGE [s/N]: @@ -1016,21 +1064,21 @@ script termination.
- `AsRegularLine' -
To standardize regular messages using one-column format. +
To standardize regular messages on one-column format.
When MESSAGE contains a colon inside (e.g., `description: message'), the
cli_printMessagefunction outputs MESSAGE -using two-columns format. +on two-columns format.
Use
cli_printMessagefunction whenever you need to output +information from `centos-art.sh' script. +
- -
Tip
To improve two-columns format, change the following file:
trunk/Scripts/Bash/Styles/output_forTwoColumns.awk
Use
cli_printMessagefunction whenever you need to output -information from `centos-art.sh' script. -
svgfunctionality to aid you maintain such actions. - +3.45.2.1 Metadata maintainance
@@ -222,7 +222,7 @@ fixed Creat grant license consistency among all SVG files we manage inside CentOS Artwork Repository. - +3.45.2.2 Unused definitions
diff --git a/Manuals/en/Html/Repository/repository_53.html b/Manuals/en/Html/Repository/repository_53.html index a092bca..0514586 100644 --- a/Manuals/en/Html/Repository/repository_53.html +++ b/Manuals/en/Html/Repository/repository_53.html @@ -214,7 +214,7 @@ artworks translations (the translation entries).3.50.2.2 Translation Markers
Translation markers are used in "Theme Model Designs" and "Translation Files" as replacement patterns to commit content diff --git a/Manuals/en/Html/Repository/repository_64.html b/Manuals/en/Html/Repository/repository_64.html index bb8a110..4e08e36 100644 --- a/Manuals/en/Html/Repository/repository_64.html +++ b/Manuals/en/Html/Repository/repository_64.html @@ -107,7 +107,7 @@ ul.toc {list-style: none}
How to render translation files 3.50.3 Usage M Metadata maintainance 3.45.2 Description Metadata maintainance 3.45.2 Description S Specific translation files 3.50.2.6 Specific Translation Files Translation configuration scripts 3.50.2.8 Translation (Pre-)Rendering Configuration Scripts Translation entries 3.50.2.1 Translation Entries Translation files 3.50.2.3 Translation Files Translation markers 3.50.2.2 Translation Markers Translation markers 3.50.2.2 Translation Markers Translation paths 3.50.2.1 Translation Entries Translation pre-rendering configuration scripts 3.50.2.8 Translation (Pre-)Rendering Configuration Scripts Translation rendering 3.50.2.7 Translation Rendering trunk Translations Identity Widgets 3.60 trunk/Translations/Identity/Widgets U Unused definitions 3.45.2.1 Metadata maintainance Unused definitions 3.45.2.1 Metadata maintainance Jump to: B diff --git a/Manuals/en/Html/Repository/repository_toc.html b/Manuals/en/Html/Repository/repository_toc.html index a29255e..157d489 100644 --- a/Manuals/en/Html/Repository/repository_toc.html +++ b/Manuals/en/Html/Repository/repository_toc.html @@ -369,7 +369,7 @@ ul.toc {list-style: none} - 3.37.3 Usage
- 3.37.4 See also
diff --git a/Manuals/en/Info/Repository/repository.info.bz2 b/Manuals/en/Info/Repository/repository.info.bz2 index 23523ba..a260621 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 c072715..aa63daf 100644 --- a/Manuals/en/Plaintext/Repository/repository.txt +++ b/Manuals/en/Plaintext/Repository/repository.txt @@ -217,7 +217,7 @@ CentOS Artwork Repository 3.37.2 Description 3.37.3 Usage 3.37.3.1 Global variables - 3.37.3.2 Functions + 3.37.3.2 Global functions 3.37.3.3 Specific functions 3.37.4 See also 3.38 trunk/Scripts/Bash/Functions/Html @@ -3233,8 +3233,8 @@ for you to use inside specific functions: If no one of these values is set in `EDITOR' environment variable, `centos-art.sh' uses `/usr/bin/vim' text editor by default. -3.37.3.2 Functions -.................. +3.37.3.2 Global functions +......................... Functions defined under `trunk/Scripts/Bash/Functions/' directory are considered global. Global function can be used inside action specific @@ -3242,6 +3242,55 @@ functionalities and reused inside themselves. This section provides introductory information to global functions you can use inside `centos-art.sh' script. + -- Function: cli_checkActionArguments + Validate action value (ACTIONVAL) variable. + `cli_checkActionArguments' is called from `cli_getActionArguments' + function. + + -- Function: cli_checkFiles FILE [TYPE] + Verify file existence. + + `cli_checkFiles' receives a FILE absolute path and performs file + verification as specified in TYPE. When TYPE is not specified, + `cli_checkFiles' verifies FILE existence, no matter what kind of + file it be. If TYPE is specified, use one of the following values: + + `d' + `directory' + Ends script execution if FILE is not a directory. + + When you verify directories with cli_checkFiles, if directory + doesn't exist, `centos-art.sh' script asks you for + confirmation in order to create that directory. If you answer + positively, `centos-art.sh' script creates that directory and + continues script flows normally. Otherwise, if you answer + negatively, `centos-art.sh' ends script execution with an + error and documentation message. + + `f' + + `regular-file' + Ends script execution if FILE is not a regular file. + + `h' + `symbolic-link' + Ends script execution if FILE is not a symbolic link. + + `x' + `execution' + Ends script execution if FILE is not executable. + + `fh' + Ends script execution if FILE is neither a regular file nor a + symbolic link. + + `fd' + Ends script execution if FILE is neither a regular file nor a + directory. + + As default behaviour, if FILE passes all verifications, + `centos-art.sh' script continues with its normal flow. + -- Function: cli_commitRepoChanges [LOCATION] Syncronize changes between repository and working copy. @@ -3283,49 +3332,15 @@ introductory information to global functions you can use inside calling functions that modify files or directories inside the working copy as you may need to. - -- Function: cli_checkFiles FILE [TYPE] - Verify files existence. - - `cli_checkFiles' receives a FILE absolute path and performs file - verification as specified in TYPE. When TYPE is not specified, - `cli_checkFiles' verifies FILE existence, no matter what kind of - file it be. If TYPE is specified, use one of the following values: - - `d' - `directory' - Ends script execution if FILE is not a directory. - - When you verify directories with cli_checkFiles, if directory - doesn't exist, `centos-art.sh' script asks you for - confirmation in order to create that directory. If you answer - positively, `centos-art.sh' script creates that directory and - continues script flows normally. Otherwise, if you answer - negatively, `centos-art.sh' ends script execution with an - error and documentation message. - - `f' - - `regular-file' - Ends script execution if FILE is not a regular file. - - `h' - `symbolic-link' - Ends script execution if FILE is not a symbolic link. + -- Function: cli_doParseArguments - `x' - `execution' - Ends script execution if FILE is not executable. + -- Function: cli_doParseArgumentsReDef - `fh' - Ends script execution if FILE is neither a regular file nor a - symbolic link. + -- Function: cli_getActionArguments - `fd' - Ends script execution if FILE is neither a regular file nor a - directory. + -- Function: cli_getActionBuild - As default behaviour, if FILE passes all verifications, - `centos-art.sh' script continues with its normal flow. + -- Function: cli_getActions -- Function: cli_getCountryCodes [FILTER] Output country codes supported by `centos-art.sh' script. @@ -3369,6 +3384,8 @@ introductory information to global functions you can use inside Use `cli_getCurrentLocale' function to know what current locale information to use inside `centos-art.sh' script. + -- Function: cli_getFilesList + -- Function: cli_getLangCodes [FILTER] Outputs language codes supported by `centos-art.sh' script. @@ -3429,16 +3446,16 @@ introductory information to global functions you can use inside Use `cli_getRepoName' when you need to change file name convenctions inside `centos-art.sh' script. - When changing file name convenctions inside `cli_getRepoName' what - you are really changing is the way functions interpret repository - file system organization. In order to a complete file name - convenction change, you also need to change file names and - directory names inside repository file system organization, just - as you did in `cli_getRepoName' function. + When we change file name convenctions inside `cli_getRepoName' + 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, each time we change name convenctions in the + repository (*note trunk Scripts Bash Functions Path::, for more + information). - *Note* *Note trunk Scripts Bash Functions Path::, for more - information on how to rename files and directories massively - inside repository file system organization. + -- Function: cli_getRepoStatus -- Function: cli_getTemporalFile NAME Output absolute path to temporal file NAME. @@ -3490,7 +3507,8 @@ introductory information to global functions you can use inside Otherwise, `cli_getThemeName' returns an empty string. -- Function: cli_printMessage MESSAGE [FORMAT] - Give format to output messages. + Define standard output message definition supported by + `centos-art.sh' script. When FORMAT is not specified, `cli_printMessage' outputs information just as it was passed in MESSAGE variable. Otherwise, @@ -3515,64 +3533,63 @@ introductory information to global functions you can use inside ---------------------------------------------------------------------- `AsUpdatingLine' - To print `Updating' messages using two-columns format. + To print `Updating' messages on two-columns format. Updating $MESSAGE `AsRemovingLine' - To print `Removing' messages using two-columns format. + To print `Removing' messages on two-columns format. Removing $MESSAGE `AsCheckingLine' - To print `Checking' messages using two-columns format. + To print `Checking' messages on two-columns format. Checking $MESSAGE `AsCreatingLine' - To print `Creating' messages using two-columns format. + To print `Creating' messages on two-columns format. Creating $MESSAGE `AsSavedAsLine' - To print `Saved as' messages using two-columns format. + To print `Saved as' messages on two-columns format. Saved as $MESSAGE `AsLinkToLine' - To print `Linked to' messages using two-columns format. + To print `Linked to' messages on two-columns format. Linked to $MESSAGE `AsMovedToLine' - To print `Moved to' messages using two-columns format. + To print `Moved to' messages on two-columns format. Moved to $MESSAGE `AsTranslationLine' - To print `Translation' messages using two-columns format. + To print `Translation' messages on two-columns format. Translation $MESSAGE `AsConfigurationLine' - To print `Configuration' messages using two-columns format. + To print `Configuration' messages on two-columns format. Configuration $MESSAGE `AsResponseLine' - To print response messages using one-column format. + To print response messages on one-column format. --> $MESSAGE `AsRequestLine' - To print request messages using one-column format. Request - messages supress the trailing newline character from final - output. - $MESSAGE + To print request messages on one-column format. Request + messages output messages with one colon (`:') and without + trailing newline (`\n') at message end. + $MESSAGE: `AsYesOrNoRequestLine' - To print `yes or no' request messages using one-column - format. If something different from `y' is answered (when - using `en_US.UTF-8' locale), script execution ends immediatly. + To print `yes or no' request messages on one-column format. If + something different from `y' is answered (when using + `en_US.UTF-8' locale), script execution ends immediatly. $MESSAGE [y/N]: - When you are using `centos-art.sh' script in a locale - different from `en_US.UTF-8', confirmation answer may be - different from `y'. For example, if you are using - `es_ES.UTF-8' locale, the confirmation question would look - like: + When we use `centos-art.sh' script in a locale different from + `en_US.UTF-8', confirmation answer may be different from `y'. + For example, if you use `es_ES.UTF-8' locale, the + confirmation question would look like: $MESSAGE [s/N]: @@ -3603,19 +3620,19 @@ introductory information to global functions you can use inside script termination. `AsRegularLine' - To standardize regular messages using one-column format. + To standardize regular messages on one-column format. When MESSAGE contains a colon inside (e.g., `description: - message'), the `cli_printMessage' function outputs MESSAGE - using two-columns format. + message'), the `cli_printMessage' function outputs MESSAGE on + two-columns format. + + Use `cli_printMessage' function whenever you need to output + information from `centos-art.sh' script. *Tip* To improve two-columns format, change the following file: trunk/Scripts/Bash/Styles/output_forTwoColumns.awk - Use `cli_printMessage' function whenever you need to output - information from `centos-art.sh' script. - 3.37.3.3 Specific functions ........................... @@ -5967,24 +5984,24 @@ Index ***** branches: See 1. (line 390) -Common translation files: See 3.50.2.5. (line 5396) -How to render brands' translation files: See 3.52.3. (line 5700) -How to render fonts' translation files: See 3.54.3. (line 5773) -How to render translation files: See 3.50.3. (line 5566) -Metadata maintainance: See 3.45.2. (line 4540) -Specific translation files: See 3.50.2.6. (line 5421) +Common translation files: See 3.50.2.5. (line 5413) +How to render brands' translation files: See 3.52.3. (line 5717) +How to render fonts' translation files: See 3.54.3. (line 5790) +How to render translation files: See 3.50.3. (line 5583) +Metadata maintainance: See 3.45.2. (line 4557) +Specific translation files: See 3.50.2.6. (line 5438) tags: See 2. (line 393) -Template translation files: See 3.50.2.4. (line 5226) -Translation brands file names: See 3.52.2.1. (line 5657) -Translation configuration scripts: See 3.50.2.8. (line 5455) -Translation entries: See 3.50.2.1. (line 5042) -Translation files: See 3.50.2.3. (line 5158) -Translation markers: See 3.50.2.2. (line 5123) -Translation paths: See 3.50.2.1. (line 5042) +Template translation files: See 3.50.2.4. (line 5243) +Translation brands file names: See 3.52.2.1. (line 5674) +Translation configuration scripts: See 3.50.2.8. (line 5472) +Translation entries: See 3.50.2.1. (line 5059) +Translation files: See 3.50.2.3. (line 5175) +Translation markers: See 3.50.2.2. (line 5140) +Translation paths: See 3.50.2.1. (line 5059) Translation pre-rendering configuration scripts:See 3.50.2.8. - (line 5455) -Translation rendering: See 3.50.2.7. (line 5444) -Translation rendering default functionality: See 3.50.2.9. (line 5541) + (line 5472) +Translation rendering: See 3.50.2.7. (line 5461) +Translation rendering default functionality: See 3.50.2.9. (line 5558) trunk: See 3. (line 396) trunk Identity: See 3.1. (line 399) trunk Identity Brands: See 3.2. (line 819) @@ -6029,31 +6046,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 3631) -trunk Scripts Bash Functions Locale: See 3.39. (line 3652) -trunk Scripts Bash Functions Manual: See 3.40. (line 3732) -trunk Scripts Bash Functions Path: See 3.41. (line 3753) -trunk Scripts Bash Functions Render: See 3.42. (line 4155) -trunk Scripts Bash Functions Render Config: See 3.43. (line 4176) -trunk Scripts Bash Functions Shell: See 3.44. (line 4354) -trunk Scripts Bash Functions Svg: See 3.45. (line 4522) -trunk Scripts Bash Functions Verify: See 3.46. (line 4710) -trunk Scripts Bash Locale: See 3.47. (line 4926) -trunk Scripts Perl: See 3.48. (line 4955) -trunk Scripts Python: See 3.49. (line 4972) -trunk Translations: See 3.50. (line 4993) -trunk Translations Identity: See 3.51. (line 5595) -trunk Translations Identity Brands: See 3.52. (line 5616) -trunk Translations Identity Brands Tpl: See 3.53. (line 5711) -trunk Translations Identity Fonts: See 3.54. (line 5726) -trunk Translations Identity Models: See 3.55. (line 5789) -trunk Translations Identity Release: See 3.56. (line 5804) -trunk Translations Identity Themes: See 3.57. (line 5819) -trunk Translations Identity Themes Backgrounds:See 3.58. (line 5834) +trunk Scripts Bash Functions Html: See 3.38. (line 3648) +trunk Scripts Bash Functions Locale: See 3.39. (line 3669) +trunk Scripts Bash Functions Manual: See 3.40. (line 3749) +trunk Scripts Bash Functions Path: See 3.41. (line 3770) +trunk Scripts Bash Functions Render: See 3.42. (line 4172) +trunk Scripts Bash Functions Render Config: See 3.43. (line 4193) +trunk Scripts Bash Functions Shell: See 3.44. (line 4371) +trunk Scripts Bash Functions Svg: See 3.45. (line 4539) +trunk Scripts Bash Functions Verify: See 3.46. (line 4727) +trunk Scripts Bash Locale: See 3.47. (line 4943) +trunk Scripts Perl: See 3.48. (line 4972) +trunk Scripts Python: See 3.49. (line 4989) +trunk Translations: See 3.50. (line 5010) +trunk Translations Identity: See 3.51. (line 5612) +trunk Translations Identity Brands: See 3.52. (line 5633) +trunk Translations Identity Brands Tpl: See 3.53. (line 5728) +trunk Translations Identity Fonts: See 3.54. (line 5743) +trunk Translations Identity Models: See 3.55. (line 5806) +trunk Translations Identity Release: See 3.56. (line 5821) +trunk Translations Identity Themes: See 3.57. (line 5836) +trunk Translations Identity Themes Backgrounds:See 3.58. (line 5851) trunk Translations Identity Themes Distro Anaconda Progress:See 3.59. - (line 5855) -trunk Translations Identity Widgets: See 3.60. (line 5948) -Unused definitions: See 3.45.2.1. (line 4647) + (line 5872) +trunk Translations Identity Widgets: See 3.60. (line 5965) +Unused definitions: See 3.45.2.1. (line 4664) 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 02efe4d..b38e561 100644 --- a/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions.texi +++ b/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions.texi @@ -497,7 +497,7 @@ If no one of these values is set in @env{EDITOR} environment variable, @file{centos-art.sh} uses @file{/usr/bin/vim} text editor by default. @end defvar -@subsubsection Functions +@subsubsection Global functions Functions defined under @file{trunk/Scripts/Bash/Functions/} directory are considered global. Global function can be used inside action @@ -505,6 +505,55 @@ specific functionalities and reused inside themselves. This section provides introductory information to global functions you can use inside @file{centos-art.sh} script. +@defun cli_checkActionArguments +Validate action value (ACTIONVAL) variable. +@code{cli_checkActionArguments} is called from +@code{cli_getActionArguments} function. +@end defun + +@defun cli_checkFiles FILE [TYPE] +Verify file existence. + +@code{cli_checkFiles} receives a @var{FILE} absolute path and performs +file verification as specified in @var{TYPE}. When @var{TYPE} is not +specified, @code{cli_checkFiles} verifies @var{FILE} existence, no +matter what kind of file it be. If @var{TYPE} is specified, use one +of the following values: + +@table @option +@item d +@itemx directory +Ends script execution if @var{FILE} is not a directory. + +When you verify directories with cli_checkFiles, if directory doesn't +exist, @file{centos-art.sh} script asks you for confirmation in order +to create that directory. If you answer positively, +@file{centos-art.sh} script creates that directory and continues +script flows normally. Otherwise, if you answer negatively, +@file{centos-art.sh} ends script execution with an error and +documentation message. + +@item f +@item regular-file +Ends script execution if @var{FILE} is not a regular file. +@item h +@itemx symbolic-link +Ends script execution if @var{FILE} is not a symbolic link. +@item x +@itemx execution +Ends script execution if @var{FILE} is not executable. +@item fh +Ends script execution if @var{FILE} is neither a regular file nor a +symbolic link. +@item fd +Ends script execution if @var{FILE} is neither a regular file nor a +directory. +@end table + +As default behaviour, if @var{FILE} passes all verifications, +@file{centos-art.sh} script continues with its normal flow. +@end defun + @defun cli_commitRepoChanges [LOCATION] Syncronize changes between repository and working copy. @@ -551,47 +600,19 @@ calling functions that modify files or directories inside the working copy as you may need to. @end defun -@defun cli_checkFiles FILE [TYPE] -Verify files existence. - -@code{cli_checkFiles} receives a @var{FILE} absolute path and performs -file verification as specified in @var{TYPE}. When @var{TYPE} is not -specified, @code{cli_checkFiles} verifies @var{FILE} existence, no -matter what kind of file it be. If @var{TYPE} is specified, use one -of the following values: +@defun cli_doParseArguments +@end defun -@table @option -@item d -@itemx directory -Ends script execution if @var{FILE} is not a directory. +@defun cli_doParseArgumentsReDef +@end defun -When you verify directories with cli_checkFiles, if directory doesn't -exist, @file{centos-art.sh} script asks you for confirmation in order -to create that directory. If you answer positively, -@file{centos-art.sh} script creates that directory and continues -script flows normally. Otherwise, if you answer negatively, -@file{centos-art.sh} ends script execution with an error and -documentation message. +@defun cli_getActionArguments +@end defun -@item f -@item regular-file -Ends script execution if @var{FILE} is not a regular file. -@item h -@itemx symbolic-link -Ends script execution if @var{FILE} is not a symbolic link. -@item x -@itemx execution -Ends script execution if @var{FILE} is not executable. -@item fh -Ends script execution if @var{FILE} is neither a regular file nor a -symbolic link. -@item fd -Ends script execution if @var{FILE} is neither a regular file nor a -directory. -@end table +@defun cli_getActionBuild +@end defun -As default behaviour, if @var{FILE} passes all verifications, -@file{centos-art.sh} script continues with its normal flow. +@defun cli_getActions @end defun @defun cli_getCountryCodes [FILTER] @@ -639,6 +660,9 @@ Use @code{cli_getCurrentLocale} function to know what current locale information to use inside @file{centos-art.sh} script. @end defun +@defun cli_getFilesList +@end defun + @defun cli_getLangCodes [FILTER] Outputs language codes supported by @file{centos-art.sh} script. @@ -705,18 +729,16 @@ directory names before their utilization. Use @code{cli_getRepoName} when you need to change file name convenctions inside @file{centos-art.sh} script. -When changing file name convenctions inside @code{cli_getRepoName} -what you are really changing is the way functions interpret repository -file system organization. In order to a complete file name convenction -change, you also need to change file names and directory names inside -repository file system organization, just as you did in -@code{cli_getRepoName} function. +When we change file name convenctions inside @code{cli_getRepoName} +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, +each time we change name convenctions in the repository (@pxref{trunk +Scripts Bash Functions Path}, for more information). +@end defun -@quotation -@strong{Note} @xref{trunk Scripts Bash Functions Path}, for more -information on how to rename files and directories massively inside -repository file system organization. -@end quotation +@defun cli_getRepoStatus @end defun @defun cli_getTemporalFile @var{NAME} @@ -774,7 +796,8 @@ Otherwise, @code{cli_getThemeName} returns an empty string. @end defun @defun cli_printMessage MESSAGE [FORMAT] -Give format to output messages. +Define standard output message definition supported by +@file{centos-art.sh} script. When @var{FORMAT} is not specified, @code{cli_printMessage} outputs information just as it was passed in @var{MESSAGE} variable. @@ -806,74 +829,75 @@ NOTE: $MESSAGE @end verbatim @item AsUpdatingLine -To print @samp{Updating} messages using two-columns format. +To print @samp{Updating} messages on two-columns format. @verbatim Updating $MESSAGE @end verbatim @item AsRemovingLine -To print @samp{Removing} messages using two-columns format. +To print @samp{Removing} messages on two-columns format. @verbatim Removing $MESSAGE @end verbatim @item AsCheckingLine -To print @samp{Checking} messages using two-columns format. +To print @samp{Checking} messages on two-columns format. @verbatim Checking $MESSAGE @end verbatim @item AsCreatingLine -To print @samp{Creating} messages using two-columns format. +To print @samp{Creating} messages on two-columns format. @verbatim Creating $MESSAGE @end verbatim @item AsSavedAsLine -To print @samp{Saved as} messages using two-columns format. +To print @samp{Saved as} messages on two-columns format. @verbatim Saved as $MESSAGE @end verbatim @item AsLinkToLine -To print @samp{Linked to} messages using two-columns format. +To print @samp{Linked to} messages on two-columns format. @verbatim Linked to $MESSAGE @end verbatim @item AsMovedToLine -To print @samp{Moved to} messages using two-columns format. +To print @samp{Moved to} messages on two-columns format. @verbatim Moved to $MESSAGE @end verbatim @item AsTranslationLine -To print @samp{Translation} messages using two-columns format. +To print @samp{Translation} messages on two-columns format. @verbatim Translation $MESSAGE @end verbatim @item AsConfigurationLine -To print @samp{Configuration} messages using two-columns format. +To print @samp{Configuration} messages on two-columns format. @verbatim Configuration $MESSAGE @end verbatim @item AsResponseLine -To print response messages using one-column format. +To print response messages on one-column format. @verbatim --> $MESSAGE @end verbatim @item AsRequestLine -To print request messages using one-column format. Request messages -supress the trailing newline character from final output. +To print request messages on one-column format. Request messages +output messages with one colon (@samp{:}) and without trailing newline +(@samp{\n}) at message end. @verbatim -$MESSAGE +$MESSAGE: @end verbatim @item AsYesOrNoRequestLine -To print @samp{yes or no} request messages using one-column format. If +To print @samp{yes or no} request messages on one-column format. If something different from @samp{y} is answered (when using @code{en_US.UTF-8} locale), script execution ends immediatly. @@ -881,9 +905,9 @@ something different from @samp{y} is answered (when using $MESSAGE [y/N]: @end verbatim -When you are using @file{centos-art.sh} script in a locale different -from @code{en_US.UTF-8}, confirmation answer may be different from -@samp{y}. For example, if you are using @code{es_ES.UTF-8} locale, the +When we use @file{centos-art.sh} script in a locale different from +@code{en_US.UTF-8}, confirmation answer may be different from +@samp{y}. For example, if you use @code{es_ES.UTF-8} locale, the confirmation question would look like: @verbatim @@ -917,22 +941,22 @@ Use @option{AsToKnowMoreLine} option after errors and for intentional script termination. @item AsRegularLine -To standardize regular messages using one-column format. +To standardize regular messages on one-column format. When @var{MESSAGE} contains a colon inside (e.g., @samp{description: message}), the @code{cli_printMessage} function outputs @var{MESSAGE} -using two-columns format. +on two-columns format. @end table +Use @code{cli_printMessage} function whenever you need to output +information from @file{centos-art.sh} script. + @quotation @strong{Tip} To improve two-columns format, change the following file: @verbatim trunk/Scripts/Bash/Styles/output_forTwoColumns.awk @end verbatim @end quotation - -Use @code{cli_printMessage} function whenever you need to output -information from @file{centos-art.sh} script. @end defun @subsubsection Specific functions