diff --git a/Manuals/en/Html/Repository/repository_40.html b/Manuals/en/Html/Repository/repository_40.html index 541ab03..4dd6d2e 100644 --- a/Manuals/en/Html/Repository/repository_40.html +++ b/Manuals/en/Html/Repository/repository_40.html @@ -780,7 +780,92 @@ global variable with the new positional parameters information.
Function: cli_getActions
- +

Initialize funtionalities supported by `centos-art.sh' script. +

+

Functionalities supported by `centos-art.sh' script are organized +in functionality directories under +`trunk/Scripts/Bash/Functions/' 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. +

+

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 +`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 functionality is stored is known as the `functionality +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 order for `centos-art.sh' script to load functionalities +correctly, function definition inside function scripts should be set +using the `function' reserved word, just as in the following +example: +

+
function prefix_doSomething {
+
+    # Do something here...
+
+}
+
+

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

+
#!/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...
+
+}
+
+

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] diff --git a/Manuals/en/Info/Repository/repository.info.bz2 b/Manuals/en/Info/Repository/repository.info.bz2 index 9ed33fa..3489fa2 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 2975d37..758561d 100644 --- a/Manuals/en/Plaintext/Repository/repository.txt +++ b/Manuals/en/Plaintext/Repository/repository.txt @@ -3400,6 +3400,91 @@ introductory information to global functions you can use inside new positional parameters information. -- Function: cli_getActions + Initialize funtionalities supported by `centos-art.sh' script. + + Functionalities supported by `centos-art.sh' script are organized + in functionality directories under `trunk/Scripts/Bash/Functions/' + 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. + + 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 + `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 + functionality is stored is known as the `functionality 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 order for `centos-art.sh' script to load functionalities + correctly, function definition inside function scripts should be + set using the `function' reserved word, just as in the following + example: + + + function prefix_doSomething { + + # Do something here... + + } + + In order to keep visual consistency among function scripts, use the + following function script design model as template to create your + own function scripts: + + + #!/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... + + } + + 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. @@ -6043,24 +6128,24 @@ Index ***** branches: See 1. (line 390) -Common translation files: See 3.50.2.5. (line 5472) -How to render brands' translation files: See 3.52.3. (line 5776) -How to render fonts' translation files: See 3.54.3. (line 5849) -How to render translation files: See 3.50.3. (line 5642) -Metadata maintainance: See 3.45.2. (line 4616) -Specific translation files: See 3.50.2.6. (line 5497) +Common translation files: See 3.50.2.5. (line 5557) +How to render brands' translation files: See 3.52.3. (line 5861) +How to render fonts' translation files: See 3.54.3. (line 5934) +How to render translation files: See 3.50.3. (line 5727) +Metadata maintainance: See 3.45.2. (line 4701) +Specific translation files: See 3.50.2.6. (line 5582) tags: See 2. (line 393) -Template translation files: See 3.50.2.4. (line 5302) -Translation brands file names: See 3.52.2.1. (line 5733) -Translation configuration scripts: See 3.50.2.8. (line 5531) -Translation entries: See 3.50.2.1. (line 5118) -Translation files: See 3.50.2.3. (line 5234) -Translation markers: See 3.50.2.2. (line 5199) -Translation paths: See 3.50.2.1. (line 5118) +Template translation files: See 3.50.2.4. (line 5387) +Translation brands file names: See 3.52.2.1. (line 5818) +Translation configuration scripts: See 3.50.2.8. (line 5616) +Translation entries: See 3.50.2.1. (line 5203) +Translation files: See 3.50.2.3. (line 5319) +Translation markers: See 3.50.2.2. (line 5284) +Translation paths: See 3.50.2.1. (line 5203) Translation pre-rendering configuration scripts:See 3.50.2.8. - (line 5531) -Translation rendering: See 3.50.2.7. (line 5520) -Translation rendering default functionality: See 3.50.2.9. (line 5617) + (line 5616) +Translation rendering: See 3.50.2.7. (line 5605) +Translation rendering default functionality: See 3.50.2.9. (line 5702) trunk: See 3. (line 396) trunk Identity: See 3.1. (line 399) trunk Identity Brands: See 3.2. (line 819) @@ -6105,31 +6190,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 3707) -trunk Scripts Bash Functions Locale: See 3.39. (line 3728) -trunk Scripts Bash Functions Manual: See 3.40. (line 3808) -trunk Scripts Bash Functions Path: See 3.41. (line 3829) -trunk Scripts Bash Functions Render: See 3.42. (line 4231) -trunk Scripts Bash Functions Render Config: See 3.43. (line 4252) -trunk Scripts Bash Functions Shell: See 3.44. (line 4430) -trunk Scripts Bash Functions Svg: See 3.45. (line 4598) -trunk Scripts Bash Functions Verify: See 3.46. (line 4786) -trunk Scripts Bash Locale: See 3.47. (line 5002) -trunk Scripts Perl: See 3.48. (line 5031) -trunk Scripts Python: See 3.49. (line 5048) -trunk Translations: See 3.50. (line 5069) -trunk Translations Identity: See 3.51. (line 5671) -trunk Translations Identity Brands: See 3.52. (line 5692) -trunk Translations Identity Brands Tpl: See 3.53. (line 5787) -trunk Translations Identity Fonts: See 3.54. (line 5802) -trunk Translations Identity Models: See 3.55. (line 5865) -trunk Translations Identity Release: See 3.56. (line 5880) -trunk Translations Identity Themes: See 3.57. (line 5895) -trunk Translations Identity Themes Backgrounds:See 3.58. (line 5910) +trunk Scripts Bash Functions Html: See 3.38. (line 3792) +trunk Scripts Bash Functions Locale: See 3.39. (line 3813) +trunk Scripts Bash Functions Manual: See 3.40. (line 3893) +trunk Scripts Bash Functions Path: See 3.41. (line 3914) +trunk Scripts Bash Functions Render: See 3.42. (line 4316) +trunk Scripts Bash Functions Render Config: See 3.43. (line 4337) +trunk Scripts Bash Functions Shell: See 3.44. (line 4515) +trunk Scripts Bash Functions Svg: See 3.45. (line 4683) +trunk Scripts Bash Functions Verify: See 3.46. (line 4871) +trunk Scripts Bash Locale: See 3.47. (line 5087) +trunk Scripts Perl: See 3.48. (line 5116) +trunk Scripts Python: See 3.49. (line 5133) +trunk Translations: See 3.50. (line 5154) +trunk Translations Identity: See 3.51. (line 5756) +trunk Translations Identity Brands: See 3.52. (line 5777) +trunk Translations Identity Brands Tpl: See 3.53. (line 5872) +trunk Translations Identity Fonts: See 3.54. (line 5887) +trunk Translations Identity Models: See 3.55. (line 5950) +trunk Translations Identity Release: See 3.56. (line 5965) +trunk Translations Identity Themes: See 3.57. (line 5980) +trunk Translations Identity Themes Backgrounds:See 3.58. (line 5995) trunk Translations Identity Themes Distro Anaconda Progress:See 3.59. - (line 5931) -trunk Translations Identity Widgets: See 3.60. (line 6024) -Unused definitions: See 3.45.2.1. (line 4723) + (line 6016) +trunk Translations Identity Widgets: See 3.60. (line 6109) +Unused definitions: See 3.45.2.1. (line 4808) 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 a36950f..10ae98f 100644 --- a/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions.texi +++ b/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions.texi @@ -672,6 +672,95 @@ global variable with the new positional parameters information. @end defun @defun cli_getActions +Initialize funtionalities supported by @file{centos-art.sh} script. + +Functionalities supported by @file{centos-art.sh} script are organized +in functionality directories under +@file{trunk/Scripts/Bash/Functions/} 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. + +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 +@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 +specific functionality is stored is known as the @samp{functionality +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 order for @file{centos-art.sh} script to load functionalities +correctly, function definition inside function scripts should be set +using the @samp{function} reserved word, just as in the following +example: + +@verbatim +function prefix_doSomething { + + # Do something here... + +} +@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: + +@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... + +} +@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]