From 6414c43090b91527de53f9e100d6fad84e262a3f Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Jan 03 2011 19:43:42 +0000 Subject: Update documentation manual. --- diff --git a/Manuals/en/Html/Repository/repository.html b/Manuals/en/Html/Repository/repository.html index 3b3e61f..2da7dad 100644 --- a/Manuals/en/Html/Repository/repository.html +++ b/Manuals/en/Html/Repository/repository.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: CentOS Artwork Repository +The CentOS Artwork Repository: CentOS Artwork Repository - - + + @@ -63,19 +58,14 @@ ul.toc {list-style: none} - +
[Top] [Contents][Index][Index] [ ? ]

CentOS Artwork Repository

-

This manual describes the CentOS Artwork Repository. -

-

The CentOS Artwork Repository exists to organize and automate The -CentOS Project corporate visual identity (see section trunk/Identity, to -start on). +

The CentOS Artwork Repository user guide.

-

Copyright © 2009, 2010 Alain Reguera Delgado. All rights -reserved. +

Copyright © 2009, 2010, 2011 Alain Reguera Delgado

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or @@ -92,9 +82,9 @@ Documentation License. 3. trunk   -Index   +Index   -List of Figures   +List of Figures   @@ -105,12 +95,12 @@ Documentation License. - +
[Top] [Contents][Index][Index] [ ? ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_1.html b/Manuals/en/Html/Repository/repository_1.html index b7eca45..738f1ff 100644 --- a/Manuals/en/Html/Repository/repository_1.html +++ b/Manuals/en/Html/Repository/repository_1.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 1. branches +The CentOS Artwork Repository: 1. branches - - + + @@ -71,7 +66,7 @@ ul.toc {list-style: none}   [Top] [Contents] -[Index] +[Index] [ ? ] @@ -94,7 +89,7 @@ ul.toc {list-style: none}

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_10.html b/Manuals/en/Html/Repository/repository_10.html index 2c3e7ea..ef3429a 100644 --- a/Manuals/en/Html/Repository/repository_10.html +++ b/Manuals/en/Html/Repository/repository_10.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.7 trunk/Identity/Models/Css +The CentOS Artwork Repository: 3.7 trunk/Identity/Models/Css - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -113,11 +108,11 @@ to HTML design models.   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_11.html b/Manuals/en/Html/Repository/repository_11.html index 9b40898..4e8a53f 100644 --- a/Manuals/en/Html/Repository/repository_11.html +++ b/Manuals/en/Html/Repository/repository_11.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.8 trunk/Identity/Models/Html +The CentOS Artwork Repository: 3.8 trunk/Identity/Models/Html - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -114,11 +109,11 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_12.html b/Manuals/en/Html/Repository/repository_12.html index ce1adec..f340fc9 100644 --- a/Manuals/en/Html/Repository/repository_12.html +++ b/Manuals/en/Html/Repository/repository_12.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.9 trunk/Identity/Models/Img/Promo/Web +The CentOS Artwork Repository: 3.9 trunk/Identity/Models/Img/Promo/Web - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -118,11 +113,11 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_13.html b/Manuals/en/Html/Repository/repository_13.html index b462a5d..e010a0d 100644 --- a/Manuals/en/Html/Repository/repository_13.html +++ b/Manuals/en/Html/Repository/repository_13.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.10 trunk/Identity/Models/Tpl +The CentOS Artwork Repository: 3.10 trunk/Identity/Models/Tpl - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -114,11 +109,11 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_14.html b/Manuals/en/Html/Repository/repository_14.html index 3e11292..e8826d6 100644 --- a/Manuals/en/Html/Repository/repository_14.html +++ b/Manuals/en/Html/Repository/repository_14.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.11 trunk/Identity/Models/Tpl/Promo/Web +The CentOS Artwork Repository: 3.11 trunk/Identity/Models/Tpl/Promo/Web - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -446,11 +441,11 @@ CentOS [base] and CentOS [updates] repositories.   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_15.html b/Manuals/en/Html/Repository/repository_15.html index 562975b..ebd8192 100644 --- a/Manuals/en/Html/Repository/repository_15.html +++ b/Manuals/en/Html/Repository/repository_15.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.12 trunk/Identity/Models/Xcf +The CentOS Artwork Repository: 3.12 trunk/Identity/Models/Xcf - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -114,11 +109,11 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_16.html b/Manuals/en/Html/Repository/repository_16.html index 8ec5be2..3cd4326 100644 --- a/Manuals/en/Html/Repository/repository_16.html +++ b/Manuals/en/Html/Repository/repository_16.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.13 trunk/Identity/Release +The CentOS Artwork Repository: 3.13 trunk/Identity/Release - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -106,11 +101,11 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_17.html b/Manuals/en/Html/Repository/repository_17.html index cfe1b4d..55a0822 100644 --- a/Manuals/en/Html/Repository/repository_17.html +++ b/Manuals/en/Html/Repository/repository_17.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.14 trunk/Identity/Themes +The CentOS Artwork Repository: 3.14 trunk/Identity/Themes - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -127,11 +122,11 @@ final CentOS themes. CentOS themes can be tagged as "Default" or   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_18.html b/Manuals/en/Html/Repository/repository_18.html index 42fbc20..f179ffe 100644 --- a/Manuals/en/Html/Repository/repository_18.html +++ b/Manuals/en/Html/Repository/repository_18.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.15 trunk/Identity/Themes/Models +The CentOS Artwork Repository: 3.15 trunk/Identity/Themes/Models - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -120,11 +115,11 @@ a directory to the list. By default you have the `See section   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_19.html b/Manuals/en/Html/Repository/repository_19.html index df73441..aff11f9 100644 --- a/Manuals/en/Html/Repository/repository_19.html +++ b/Manuals/en/Html/Repository/repository_19.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.16 trunk/Identity/Themes/Models/Alternative +The CentOS Artwork Repository: 3.16 trunk/Identity/Themes/Models/Alternative - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -118,11 +113,11 @@ themes are maintained by CentOS Community.   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_2.html b/Manuals/en/Html/Repository/repository_2.html index e8d7b35..c214e66 100644 --- a/Manuals/en/Html/Repository/repository_2.html +++ b/Manuals/en/Html/Repository/repository_2.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 2. tags +The CentOS Artwork Repository: 2. tags - - + + @@ -71,7 +66,7 @@ ul.toc {list-style: none}   [Top] [Contents] -[Index] +[Index] [ ? ] @@ -94,7 +89,7 @@ ul.toc {list-style: none}

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_20.html b/Manuals/en/Html/Repository/repository_20.html index 672c32f..2bdcc5b 100644 --- a/Manuals/en/Html/Repository/repository_20.html +++ b/Manuals/en/Html/Repository/repository_20.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.17 trunk/Identity/Themes/Models/Default +The CentOS Artwork Repository: 3.17 trunk/Identity/Themes/Models/Default - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -119,11 +114,11 @@ described in See section Theme Motifs.   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_21.html b/Manuals/en/Html/Repository/repository_21.html index 180635c..f2b546b 100644 --- a/Manuals/en/Html/Repository/repository_21.html +++ b/Manuals/en/Html/Repository/repository_21.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.18 trunk/Identity/Themes/Models/Default/Distro +The CentOS Artwork Repository: 3.18 trunk/Identity/Themes/Models/Default/Distro - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -178,11 +173,11 @@ the CentOS brand will exonerate user form visual isolation.   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_22.html b/Manuals/en/Html/Repository/repository_22.html index e0a0f32..b2049ab 100644 --- a/Manuals/en/Html/Repository/repository_22.html +++ b/Manuals/en/Html/Repository/repository_22.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.19 trunk/Identity/Themes/Models/Default/Distro/Anaconda +The CentOS Artwork Repository: 3.19 trunk/Identity/Themes/Models/Default/Distro/Anaconda - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -106,11 +101,11 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_23.html b/Manuals/en/Html/Repository/repository_23.html index aea2128..b555d46 100644 --- a/Manuals/en/Html/Repository/repository_23.html +++ b/Manuals/en/Html/Repository/repository_23.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.20 trunk/Identity/Themes/Models/Default/Promo +The CentOS Artwork Repository: 3.20 trunk/Identity/Themes/Models/Default/Promo - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -119,11 +114,11 @@ examples of promotion designs.   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_24.html b/Manuals/en/Html/Repository/repository_24.html index b4861ec..448d477 100644 --- a/Manuals/en/Html/Repository/repository_24.html +++ b/Manuals/en/Html/Repository/repository_24.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.21 trunk/Identity/Themes/Models/Default/Web +The CentOS Artwork Repository: 3.21 trunk/Identity/Themes/Models/Default/Web - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -118,11 +113,11 @@ HTML standards should be consider here.   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_25.html b/Manuals/en/Html/Repository/repository_25.html index db3c0a2..9c8566a 100644 --- a/Manuals/en/Html/Repository/repository_25.html +++ b/Manuals/en/Html/Repository/repository_25.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.22 trunk/Identity/Themes/Motifs +The CentOS Artwork Repository: 3.22 trunk/Identity/Themes/Motifs - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -210,11 +205,11 @@ works are released under   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_26.html b/Manuals/en/Html/Repository/repository_26.html index 3791b0f..00df34b 100644 --- a/Manuals/en/Html/Repository/repository_26.html +++ b/Manuals/en/Html/Repository/repository_26.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.23 trunk/Identity/Themes/Motifs/Flame +The CentOS Artwork Repository: 3.23 trunk/Identity/Themes/Motifs/Flame - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -107,7 +102,7 @@ to reduce the time used to produce new artistic motifs, because of its "randomly generated" nature. Once the artistic motif be created, it is propagated through all visual manifestations of CentOS Project corporate visual identity using the `centos-art.sh' script -(see section trunk/Scripts/Bash) inside the CentOS Artwork Repository. +(see section trunk/Scripts/Bash) inside the CentOS Artwork Repository.

To set the time intervals between each new visual style production, we could reuse the CentOS distribution major release schema. I.e., we @@ -338,11 +333,11 @@ variables you may face.   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_27.html b/Manuals/en/Html/Repository/repository_27.html index 98ab517..8ddd111 100644 --- a/Manuals/en/Html/Repository/repository_27.html +++ b/Manuals/en/Html/Repository/repository_27.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.24 trunk/Identity/Themes/Motifs/Modern +The CentOS Artwork Repository: 3.24 trunk/Identity/Themes/Motifs/Modern - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -111,11 +106,11 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_28.html b/Manuals/en/Html/Repository/repository_28.html index d321bc3..e889cf9 100644 --- a/Manuals/en/Html/Repository/repository_28.html +++ b/Manuals/en/Html/Repository/repository_28.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.25 trunk/Identity/Themes/Motifs/Modern/Backgrounds +The CentOS Artwork Repository: 3.25 trunk/Identity/Themes/Motifs/Modern/Backgrounds - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -210,7 +205,7 @@ can contain subdirectories to help you organize the design process. 3.28 trunk/Identity/Themes/Motifs/Modern/Backgrounds/Xcf   -3.58 trunk/Translations/Identity/Themes/Backgrounds   +3.59 trunk/Translations/Identity/Themes/Backgrounds   @@ -222,11 +217,11 @@ can contain subdirectories to help you organize the design process.   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_29.html b/Manuals/en/Html/Repository/repository_29.html index fc281a6..8708920 100644 --- a/Manuals/en/Html/Repository/repository_29.html +++ b/Manuals/en/Html/Repository/repository_29.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.26 trunk/Identity/Themes/Motifs/Modern/Backgrounds/Img +The CentOS Artwork Repository: 3.26 trunk/Identity/Themes/Motifs/Modern/Backgrounds/Img - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -111,11 +106,11 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_3.html b/Manuals/en/Html/Repository/repository_3.html index 7d5ea7a..3162ef9 100644 --- a/Manuals/en/Html/Repository/repository_3.html +++ b/Manuals/en/Html/Repository/repository_3.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3. trunk +The CentOS Artwork Repository: 3. trunk - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -146,59 +141,61 @@ ul.toc {list-style: none} 3.33 trunk/Identity/Widgets   -3.34 trunk/Manuals   +3.34 trunk/Identity/Widgets2   + +3.35 trunk/Manuals   -3.35 trunk/Scripts   +3.36 trunk/Scripts   -3.36 trunk/Scripts/Bash   +3.37 trunk/Scripts/Bash   -3.37 trunk/Scripts/Bash/Functions   +3.38 trunk/Scripts/Bash/Functions   -3.38 trunk/Scripts/Bash/Functions/Html   +3.39 trunk/Scripts/Bash/Functions/Html   -3.39 trunk/Scripts/Bash/Functions/Locale   +3.40 trunk/Scripts/Bash/Functions/Locale   -3.40 trunk/Scripts/Bash/Functions/Manual   +3.41 trunk/Scripts/Bash/Functions/Manual   -3.41 trunk/Scripts/Bash/Functions/Path   +3.42 trunk/Scripts/Bash/Functions/Path   -3.42 trunk/Scripts/Bash/Functions/Render   +3.43 trunk/Scripts/Bash/Functions/Render   -3.43 trunk/Scripts/Bash/Functions/Render/Config   +3.44 trunk/Scripts/Bash/Functions/Render/Config   -3.44 trunk/Scripts/Bash/Functions/Shell   +3.45 trunk/Scripts/Bash/Functions/Shell   -3.45 trunk/Scripts/Bash/Functions/Svg   +3.46 trunk/Scripts/Bash/Functions/Svg   -3.46 trunk/Scripts/Bash/Functions/Verify   +3.47 trunk/Scripts/Bash/Functions/Verify   -3.47 trunk/Scripts/Bash/Locale   +3.48 trunk/Scripts/Bash/Locale   -3.48 trunk/Scripts/Perl   +3.49 trunk/Scripts/Perl   -3.49 trunk/Scripts/Python   +3.50 trunk/Scripts/Python   -3.50 trunk/Translations   +3.51 trunk/Translations   -3.51 trunk/Translations/Identity   +3.52 trunk/Translations/Identity   -3.52 trunk/Translations/Identity/Brands   +3.53 trunk/Translations/Identity/Brands   -3.53 trunk/Translations/Identity/Brands/Tpl   +3.54 trunk/Translations/Identity/Brands/Tpl   -3.54 trunk/Translations/Identity/Fonts   +3.55 trunk/Translations/Identity/Fonts   -3.55 trunk/Translations/Identity/Models   +3.56 trunk/Translations/Identity/Models   -3.56 trunk/Translations/Identity/Release   +3.57 trunk/Translations/Identity/Release   -3.57 trunk/Translations/Identity/Themes   +3.58 trunk/Translations/Identity/Themes   -3.58 trunk/Translations/Identity/Themes/Backgrounds   +3.59 trunk/Translations/Identity/Themes/Backgrounds   -3.59 trunk/Translations/Identity/Themes/Distro/Anaconda/Progress   +3.60 trunk/Translations/Identity/Themes/Distro/Anaconda/Progress   -3.60 trunk/Translations/Identity/Widgets   +3.61 trunk/Translations/Identity/Widgets   @@ -209,11 +206,11 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_30.html b/Manuals/en/Html/Repository/repository_30.html index c46a8ab..7c51929 100644 --- a/Manuals/en/Html/Repository/repository_30.html +++ b/Manuals/en/Html/Repository/repository_30.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.27 trunk/Identity/Themes/Motifs/Modern/Backgrounds/Tpl +The CentOS Artwork Repository: 3.27 trunk/Identity/Themes/Motifs/Modern/Backgrounds/Tpl - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -110,11 +105,11 @@ command line interface.   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_31.html b/Manuals/en/Html/Repository/repository_31.html index 11462e7..98c27e2 100644 --- a/Manuals/en/Html/Repository/repository_31.html +++ b/Manuals/en/Html/Repository/repository_31.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.28 trunk/Identity/Themes/Motifs/Modern/Backgrounds/Xcf +The CentOS Artwork Repository: 3.28 trunk/Identity/Themes/Motifs/Modern/Backgrounds/Xcf - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -119,11 +114,11 @@ based on them. In this last case you need the `Xcf/' directory.   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_32.html b/Manuals/en/Html/Repository/repository_32.html index 3c36119..4d1d48d 100644 --- a/Manuals/en/Html/Repository/repository_32.html +++ b/Manuals/en/Html/Repository/repository_32.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.29 trunk/Identity/Themes/Motifs/Modern/Distro/Anaconda/Progress +The CentOS Artwork Repository: 3.29 trunk/Identity/Themes/Motifs/Modern/Distro/Anaconda/Progress - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -96,7 +91,7 @@ ul.toc {list-style: none}

To render Anaconda progress slide images using the Modern's artistic motif design, the Default theme model, and available translation files -(see section trunk/Translations/Identity/Themes/Distro/Anaconda/Progress); +(see section trunk/Translations/Identity/Themes/Distro/Anaconda/Progress); use the following commands:

- +
 
cd /home/centos/artwork/trunk/Identity/Themes/Motifs/Modern/Distro/Anaconda/Progress/
@@ -147,11 +142,11 @@ centos-art render --identity
  [ << ] [ Up ][ >> ][ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_33.html b/Manuals/en/Html/Repository/repository_33.html index cb5d73f..7958555 100644 --- a/Manuals/en/Html/Repository/repository_33.html +++ b/Manuals/en/Html/Repository/repository_33.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.30 trunk/Identity/Themes/Motifs/Modern/Palettes +The CentOS Artwork Repository: 3.30 trunk/Identity/Themes/Motifs/Modern/Palettes - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -111,11 +106,11 @@ limitations. Theme palettes contain theme's unique color information.   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_34.html b/Manuals/en/Html/Repository/repository_34.html index 9b51fa6..3a104f1 100644 --- a/Manuals/en/Html/Repository/repository_34.html +++ b/Manuals/en/Html/Repository/repository_34.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.31 trunk/Identity/Themes/Motifs/TreeFlower +The CentOS Artwork Repository: 3.31 trunk/Identity/Themes/Motifs/TreeFlower - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -112,11 +107,11 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_35.html b/Manuals/en/Html/Repository/repository_35.html index e8cba77..5ba5a60 100644 --- a/Manuals/en/Html/Repository/repository_35.html +++ b/Manuals/en/Html/Repository/repository_35.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.32 trunk/Identity/Themes/Motifs/TreeFlower/Backgrounds +The CentOS Artwork Repository: 3.32 trunk/Identity/Themes/Motifs/TreeFlower/Backgrounds - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -417,11 +412,11 @@ the following `syslinux.hex' file:   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_36.html b/Manuals/en/Html/Repository/repository_36.html index 072037f..ada87f0 100644 --- a/Manuals/en/Html/Repository/repository_36.html +++ b/Manuals/en/Html/Repository/repository_36.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.33 trunk/Identity/Widgets +The CentOS Artwork Repository: 3.33 trunk/Identity/Widgets - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -106,11 +101,11 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_37.html b/Manuals/en/Html/Repository/repository_37.html index c7882f0..6cc5230 100644 --- a/Manuals/en/Html/Repository/repository_37.html +++ b/Manuals/en/Html/Repository/repository_37.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.34 trunk/Manuals +The CentOS Artwork Repository: 3.34 trunk/Identity/Widgets2 - - + + @@ -64,19 +59,19 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] - + -

3.34 trunk/Manuals

+

3.34 trunk/Identity/Widgets2

@@ -90,60 +85,10 @@ ul.toc {list-style: none}

3.34.2 Description

- -

3.34.3 Usage

-
-
`centos-art help --read='path/to/dir''
-

Use this command to read directory documentation specified in -`path/to/dir'. -

-
-
`centos-art help --read='path/to/dir' --filter='filename''
-

Use this command to read file documentation as specified by -`path/to/dir/filename' combination. -

-
-
`centos-art help --edit='path/to/dir''
-

Use this command to edit directory documentation as specified in -`path/to/dir'. -

-
-
`centos-art help --edit='path/to/dir' --filter='filename''
-

Use this command to edit file documentation as specified in -`path/to/dir/filename' combination. -

-
-
`centos-art help --update='path/to/dir''
-

Use this command to update documentation output files. -

-
-
`centos-art help --remove='path/to/dir''
-

Use this command to remove directory documentation as specified in -`path/to/dir'. -

-
Caution

Caution

When directory documentation is removed all -documentation under it is also removed. -

- -
Info

Tip

To recover from directory documentation lost, try the -following command (before commit local changes up to central -repository): -

svn revert path/to/dir --recursive
-
- -
-
`centos-art help --remove='path/to/dir' --filter='filename''
-

Use this command to remove file documentation as specified in -`path/to/dir/filename' combination. -

-
-

3.34.4 See also

@@ -156,11 +101,11 @@ repository):   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_38.html b/Manuals/en/Html/Repository/repository_38.html index 1894749..bd1479f 100644 --- a/Manuals/en/Html/Repository/repository_38.html +++ b/Manuals/en/Html/Repository/repository_38.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.35 trunk/Scripts +The CentOS Artwork Repository: 3.35 trunk/Manuals - - + + @@ -64,29 +59,26 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] - + -

3.35 trunk/Scripts

+

3.35 trunk/Manuals

3.35.1 Goals

-

The `trunk/Scripts' directory exists to: -

@@ -101,9 +93,51 @@ programming language.

3.35.3 Usage

- +
+
`centos-art help --read='path/to/dir''
+

Use this command to read directory documentation specified in +`path/to/dir'. +

+
+
`centos-art help --read='path/to/dir' --filter='filename''
+

Use this command to read file documentation as specified by +`path/to/dir/filename' combination. +

+
+
`centos-art help --edit='path/to/dir''
+

Use this command to edit directory documentation as specified in +`path/to/dir'. +

+
+
`centos-art help --edit='path/to/dir' --filter='filename''
+

Use this command to edit file documentation as specified in +`path/to/dir/filename' combination. +

+
+
`centos-art help --update='path/to/dir''
+

Use this command to update documentation output files. +

+
+
`centos-art help --remove='path/to/dir''
+

Use this command to remove directory documentation as specified in +`path/to/dir'. +

+
Caution

Caution

When directory documentation is removed all +documentation under it is also removed. +

+ +
Info

Tip

To recover from directory documentation lost, try the +following command (before commit local changes up to central +repository): +

svn revert path/to/dir --recursive
+
+ +
+
`centos-art help --remove='path/to/dir' --filter='filename''
+

Use this command to remove file documentation as specified in +`path/to/dir/filename' combination. +

+
@@ -117,11 +151,11 @@ programming language.   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_39.html b/Manuals/en/Html/Repository/repository_39.html index 6b3c898..4d266ac 100644 --- a/Manuals/en/Html/Repository/repository_39.html +++ b/Manuals/en/Html/Repository/repository_39.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.36 trunk/Scripts/Bash +The CentOS Artwork Repository: 3.36 trunk/Scripts - - + + @@ -64,181 +59,51 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] - + -

3.36 trunk/Scripts/Bash

+

3.36 trunk/Scripts

3.36.1 Goals

-

The `trunk/Scripts/Bash' directory exists to organize the trunk -development line of `centos-art.sh' automation script. The -`centos-art.sh' script standardizes frequent tasks inside your -working copy of CentOS Artwork Repository. +

The `trunk/Scripts' directory exists to:

+ +

3.36.2 Description

-

The best way to understand `centos-art.sh' 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. -

-

The `centos-art.sh' script is written in Bash. Most tasks, inside -`centos-art.sh' script, have been organized in many specific -functionalities that you can invoke from the centos-art -command-line interface. -

-

When you type the centos-art 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 PATH environment variable to look for -that command's location. If your system was prepared to use CentOS -Artwork Repository correctly (see section trunk/Scripts/Bash/Functions/Verify), you should have a symbolic link inside `~/bin/' -directory that points to the `centos-art.sh' script file. As -`~/bin/' directory is, by default, inside PATH environment -variable, the execution of centos-art command runs the -`centos-art.sh' script. -

-

When `centos-art.sh' script is executed, the first it does is -executing the `trunk/Scripts/Bash/initEnvironment.sh' script to -initialize global variables (e.g., gettext's variables) and -global function scripts. Global function scripts are located inside -`trunk/Scripts/Bash/Functions' directory and their file names -begin with `cli'. Global function scripts provide common -functionalities that can be used anywhere inside `centos-art.sh' -script execution environment. -

-

Once global variables and function scripts have been loaded, -`centos-art.sh' script executes the cli global function -from `cli.sh' function script to retrive command-line arguments -and define some default values that may be used later by specific -function scripts (see section trunk/Scripts/Bash/Functions). -

-

As convenction, the `centos-art.sh' command-line arguments have -the following format: -

-
centos-art arg1 --arg2=val2 --arg3=val3
-
-

In the above example, `centos-art' is the command you use to -invoke `centos-art.sh' script. The `arg1' is required and -represents the functionality you want to perform (e.g., -`verify', `render', `locale', `manual', -etc.). The remaining arguments are modifiers to `arg1'. The -`--arg2' definition is required and represets, specifically, -the action inside the functionality you want to perform. The -`--arg3' and on, are optional. -

-

Once command-line arguments have been retrived, the -`centos-art.sh' script loads specific functionalities using the -`cli_getFunctions.sh' function script. Only one specific -functionality can be loaded at one script execution I.e., you run -centos-art.sh script to run just one functionality. -

-
-
+----------------------------------------------------------------------+
-| [centos@host]$ centos-art function --action='value' --option='value' |
-+----------------------------------------------------------------------+
-| ~/bin/centos-art --> ~/artwork/trunk/Scripts/Bash/centos-art.sh      |
-+---v-----------------------------------------v------------------------+
-    | centos-art.sh                           |
-    +---v---------------------------------v---+
-    .   | initEnvironment.sh              |   .
-    .   +---------------------------------+   .
-    .   | cli $@                          |   .
-    .   +---v-------------------------v---+   .
-    .   .   | cli_getFunctions        |   .   .
-    .   .   +---v-----------------v---+   .   .
-    .   .   .   | function1       |   .   .   .
-    .   .   .   | function2       |   .   .   .
-    .   .   .   | function3       |   .   .   .
-    .   .   .   +-----------------+   .   .   .
-    .   .   ...........................   .   .
-    .   ...................................   .
-    ...........................................
-
-

Figure 3.12: The functionalities initialization environment. - -

-

Functionalities are implemented by means of actions. Once the -functionality has been initiazalized, actions initialization take -place for that functionality. Actions initialization model is very -similar to functions initialization model. But with the difference, -that actions are loaded inside function environment, and so, share -variables and functions defined inside function environment. -

-
-
+--------------------------------------+
-| cli_getFunctions                     |
-+---v------------------------------v---+
-.   | function1                    |   .
-.   +---v----------------------v---+   .
-.   .   | function1_getActions |   .   .
-.   .   +---v--------------v---+   .   .
-.   .   .   | action 1     |   .   .   .
-.   .   .   | action 2     |   .   .   .
-.   .   .   | action n     |   .   .   .
-.   .   .   +--------------+   .   .   .
-.   .   ........................   .   .
-.   ................................   .
-.   +------------------------------+   .
-.   | function2                    |   .
-.   +---v----------------------v---+   .
-.   .   | function2_getActions |   .   .
-.   .   +---v--------------v---+   .   .
-.   .   .   | action 1     |   .   .   .
-.   .   .   | action 2     |   .   .   .
-.   .   .   | action n     |   .   .   .
-.   .   .   +--------------+   .   .   .
-.   .   ........................   .   .
-.   ................................   .
-.   +------------------------------+   .
-.   | function3                    |   .
-.   +---v----------------------v---+   .
-.   .   | function3_getActions |   .   .
-.   .   +---v--------------v---+   .   .
-.   .   .   | action 1     |   .   .   .
-.   .   .   | action 2     |   .   .   .
-.   .   .   | action n     |   .   .   .
-.   .   .   +--------------+   .   .   .
-.   .   ........................   .   .
-.   ................................   .
-........................................
-
-

Figure 3.13: The actions initialization environment. - -

+ +

3.36.3 Usage

-

The `centos-art.sh' script usage information is described inside -each specific function documentation (see section trunk/Scripts/Bash/Functions). -

+ +

3.36.4 See also

- - - - -
3.35 trunk/Scripts   -
3.37 trunk/Scripts/Bash/Functions   -
3.47 trunk/Scripts/Bash/Locale   -
@@ -247,11 +112,11 @@ each specific function documentation (see section   - +
[ << ] [ Up ][ >> ][ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_4.html b/Manuals/en/Html/Repository/repository_4.html index ca30607..9c92202 100644 --- a/Manuals/en/Html/Repository/repository_4.html +++ b/Manuals/en/Html/Repository/repository_4.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.1 trunk/Identity +The CentOS Artwork Repository: 3.1 trunk/Identity - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -501,7 +496,7 @@ may be created using the renderFormats post-rendering action, inside the image-based related pre-rendering configuration script.

-

See section trunk/Scripts/Bash, for more information. +

See section trunk/Scripts/Bash, for more information.

@@ -509,7 +504,7 @@ script.

3.1.6 See also

-
3.50 trunk/Translations   +
3.51 trunk/Translations  
@@ -530,11 +525,11 @@ links).   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_40.html b/Manuals/en/Html/Repository/repository_40.html index 00f40ed..ae08f9c 100644 --- a/Manuals/en/Html/Repository/repository_40.html +++ b/Manuals/en/Html/Repository/repository_40.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.37 trunk/Scripts/Bash/Functions +The CentOS Artwork Repository: 3.37 trunk/Scripts/Bash - - + + @@ -64,1322 +59,194 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] - + -

3.37 trunk/Scripts/Bash/Functions

+

3.37 trunk/Scripts/Bash

3.37.1 Goals

-

The `trunk/Scripts/Bash/Functions' directory exists to organize -`centos-art.sh' specific functionalities. +

The `trunk/Scripts/Bash' directory exists to organize the trunk +development line of `centos-art.sh' automation script. The +`centos-art.sh' script standardizes frequent tasks inside your +working copy of CentOS Artwork Repository.

3.37.2 Description

-

The specific functions of `centos-art.sh' script are designed -with "Software Toolbox" philosophy (see (coreutils.info)Toolbox introduction) in mind: each program "should do one -thing well". Inside `centos-art.sh' 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. -

-

The specific functions of `centos-art.sh' script are organized -inside specific directories under `trunk/Scripts/Bash/Functions' -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 render, the specific function -directory for it would be `trunk/Scripts/Bash/Functions/Render'. -

-

To better understand how specific functions of `centos-art.sh' -script are designed, lets create one function which only goal is to -output different kind of greetings to your screen. -

-

When we create specific functions for `centos-art.sh' 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. -

-
Info

Tip

Join CentOS developers mailing list -centos-art@centos.org to share your ideas. -

- -

It is also worth to know what global functions and variables do we -have available inside `centos-art.sh' script, so advantage can be -taken from them. Global variables are defined inside global function -scripts. Global functions scripts are stored immediatly under -`trunk/Scripts/Bash/Functions' directory, in files begining with -`cli' prefix. -

-

OK, let's begin with our functionality example. -

-

What function name do we use? Well, lets use greet. Note that -`hello' word is not a verb; but an expression, a kind of -greeting, an interjection specifically. In contrast, `greet' is a -verb and describes what we do when we say `Hello!', `Hi!', -and similar expressions. -

-

So far, we've gathered the following function information: -

-
Name: greet
-Path: trunk/Scripts/Bash/Functions/Greet
-File: trunk/Scripts/Bash/Functions/Greet/greet.sh
-
-

The `greet.sh' function script is the first file -`centos-art.sh' script loads when the `greet' functionality -is called using commands like `centos-art greet --hello='World''. -The `greet.sh' function script contains the greet function -definition. -

-

Inside `centos-art.sh' script, as convenction, each function -script has one top commentary, followed by one blank line, and then -one function defintion below it only. -

-

Inside `centos-art.sh' 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 `centos-art.sh' -script is released as GPL, so do all its functions--, subversion's -$Id$ keyword which is later expanded by svn propset -command. -

-

In our greet function example, top commentary for -`greet.sh' function script would look like the following: -

-
#!/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$
-# ----------------------------------------------------------------------
-
-

After top commentary, separated by one blank line, the greet -function definition would look like the following: -

-
function greet {
-
-    # Define global variables.
-
-    # Define command-line interface.
-    greet_getActions
-
-}
-
-

The first definition inside greet function, are global -variables that will be available along greet function execution -environment. This time we didn't use global variable definitions for -greet function execution environment, so we left that section -empty. -

-

Later, we call greet_getActions function to define the -command-line interface of greet functionality. The command-line -interface of greet functionality defines what and how actions -are performed, based on arguments combination passed to +

The best way to understand `centos-art.sh' 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. +

+

The `centos-art.sh' script is written in Bash. Most tasks, inside +`centos-art.sh' script, have been organized in many specific +functionalities that you can invoke from the centos-art +command-line interface. +

+

When you type the centos-art 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 PATH environment variable to look for +that command's location. If your system was prepared to use CentOS +Artwork Repository correctly (see section trunk/Scripts/Bash/Functions/Verify), you should have a symbolic link inside `~/bin/' +directory that points to the `centos-art.sh' script file. As +`~/bin/' directory is, by default, inside PATH environment +variable, the execution of centos-art command runs the `centos-art.sh' script.

-
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
-
-}
-
-

The ACTIONNAM global variable is defined in `cli.sh' -function script and contains the value passed before the equal sign -(i.e., `=') in the second command-line argument of -`centos-art.sh' script. For example, if the second command-line -argument is `--hello='World'', the value of ACTIONNAM -variable would be `--hello'. Using this configuration let us -deside which action to perform based on the action name passed to -`centos-art.sh' script as second argument. -

-

The greet function definition makes available two valid -greetings through `--hello' and `--bye' options. If no -one of them is provided as second command-line argument, the `*' -case is evaluated instead. -

-

The `*' case and its two lines further on should always be -present in `_getActions.sh' 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. -

-

The greet_doHello and greet_doBye function definitions -are the core of greet specific functionality. In such function -definitions we set what our greet function really does: to -output different kinds of greetings. -

-
function greet_doHello {
-
-    cli_printMessage "`gettext "Hello"` $ACTIONVAL"
-
-}
-
-

The greet_doHello function definition is stored in -`greet_doHello.sh' function script. -

-
function greet_doBye {
-
-    cli_printMessage "`gettext "Goodbye"` $ACTIONVAL"
-
-}
-
-

The greet_doBye function definition is stored in the -`greet_doBye.sh' function script. -

-

Both `greet_doHello.sh' and `greet_doBye.sh' function -scripts are stored inside greet's function directory path (i.e. -`trunk/Scripts/Bash/Functions/Greet'). -

-

The ACTIONVAL global variable is defined in `cli.sh' -function script and contains the value passed after the equal sign -(i.e., `=') in the second command-line argument of -`centos-art.sh' script. For example, if the second command-line -argument is `--hello='World'', the value of ACTIONVAL -variable would be `World' without quotes. -

-

Let's see how greet specific functionality files are organzied -under greet's function directory. To see file organization we -use the tree command: -

-
trunk/Scripts/Bash/Functions/Greet
-|-- greet_doBye.sh
-|-- greet_doHello.sh
-|-- greet_getActions.sh
-`-- greet.sh
-
-

To try the greet specific functionality we've just created, -pass the function name (i.e., `greet') as first argument to -`centos-art.sh' script, and any of the valid options as second -argument. Some examples are illustrated below: -

-
[centos@projects ~]$ centos-art greet --hello='World'
-Hello World
-[centos@projects ~]$ centos-art greet --bye='World'
-Goodbye World
-[centos@projects ~]$ 
-
-

The word `World' in the examples above can be anything. In fact, -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 greet specific functionality, -we use its directory path and the manual functionality -(see section trunk/Scripts/Bash/Functions/Manual) of `centos-art.sh' -script, just as the following command illustrates: -

-
centos-art manual --edit=trunk/Scripts/Bash/Functions/Greet
-
-

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 `centos-art.sh' script uses -the function documentation entry as vehicle to communicate which the -valid functions are. When no documentation entry exists for a -function, the `centos-art.sh' script informs that no -documentation entry exists for such function and requests user to -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 -locale functionality (see section trunk/Scripts/Bash/Functions/Locale) of `centos-art.sh' script, just as the following command -illustrates: -

-
centos-art locale --edit
-
-
Warning

Warning

To translate output messages in different languages, -your system locale information --as in LANG 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 -`es_ES.UTF-8', or similar, first. -

- -

Well, it seems that our example is rather complete by now. -

-

In greet function example we've described so far, we only use -cli_printMessage 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 -`--filter='regex'' and reduce the amount of files to process -using a regular expression pattern. -

-

The greet function described in this section may serve you as -an introduction to understand how specific functionalities work inside -`centos-art.sh' script. With some of luck this introduction will -also serve you as motivation to create your own `centos-art.sh' -script specific functionalities. +

When `centos-art.sh' script is executed, the first it does is +executing the `trunk/Scripts/Bash/initEnvironment.sh' script to +initialize global variables (e.g., gettext's variables) and +global function scripts. Global function scripts are located inside +`trunk/Scripts/Bash/Functions' directory and their file names +begin with `cli'. Global function scripts provide common +functionalities that can be used anywhere inside `centos-art.sh' +script execution environment. +

+

Once global variables and function scripts have been loaded, +`centos-art.sh' script executes the cli global function +from `cli.sh' function script to retrive command-line arguments +and define some default values that may be used later by specific +function scripts (see section trunk/Scripts/Bash/Functions). +

+

As convenction, the `centos-art.sh' command-line arguments have +the following format: +

+
centos-art arg1 --arg2=val2 --arg3=val3
+
+

In the above example, `centos-art' is the command you use to +invoke `centos-art.sh' script. The `arg1' is required and +represents the functionality you want to perform (e.g., +`verify', `render', `locale', `manual', +etc.). The remaining arguments are modifiers to `arg1'. The +`--arg2' definition is required and represets, specifically, +the action inside the functionality you want to perform. The +`--arg3' and on, are optional. +

+

Once command-line arguments have been retrived, the +`centos-art.sh' script loads specific functionalities using the +`cli_getFunctions.sh' function script. Only one specific +functionality can be loaded at one script execution I.e., you run +centos-art.sh script to run just one functionality. +

+
+
+----------------------------------------------------------------------+
+| [centos@host]$ centos-art function --action='value' --option='value' |
++----------------------------------------------------------------------+
+| ~/bin/centos-art --> ~/artwork/trunk/Scripts/Bash/centos-art.sh      |
++---v-----------------------------------------v------------------------+
+    | centos-art.sh                           |
+    +---v---------------------------------v---+
+    .   | initEnvironment.sh              |   .
+    .   +---------------------------------+   .
+    .   | cli $@                          |   .
+    .   +---v-------------------------v---+   .
+    .   .   | cli_getFunctions        |   .   .
+    .   .   +---v-----------------v---+   .   .
+    .   .   .   | function1       |   .   .   .
+    .   .   .   | function2       |   .   .   .
+    .   .   .   | function3       |   .   .   .
+    .   .   .   +-----------------+   .   .   .
+    .   .   ...........................   .   .
+    .   ...................................   .
+    ...........................................
+
+

Figure 3.12: The functionalities initialization environment. +

-

By the way, the greet functionality doesn't exist inside -`centos-art.sh' script yet. Would you like to create it? +

Functionalities are implemented by means of actions. Once the +functionality has been initiazalized, actions initialization take +place for that functionality. Actions initialization model is very +similar to functions initialization model. But with the difference, +that actions are loaded inside function environment, and so, share +variables and functions defined inside function environment. +

+
+
+--------------------------------------+
+| cli_getFunctions                     |
++---v------------------------------v---+
+.   | function1                    |   .
+.   +---v----------------------v---+   .
+.   .   | function1_getActions |   .   .
+.   .   +---v--------------v---+   .   .
+.   .   .   | action 1     |   .   .   .
+.   .   .   | action 2     |   .   .   .
+.   .   .   | action n     |   .   .   .
+.   .   .   +--------------+   .   .   .
+.   .   ........................   .   .
+.   ................................   .
+.   +------------------------------+   .
+.   | function2                    |   .
+.   +---v----------------------v---+   .
+.   .   | function2_getActions |   .   .
+.   .   +---v--------------v---+   .   .
+.   .   .   | action 1     |   .   .   .
+.   .   .   | action 2     |   .   .   .
+.   .   .   | action n     |   .   .   .
+.   .   .   +--------------+   .   .   .
+.   .   ........................   .   .
+.   ................................   .
+.   +------------------------------+   .
+.   | function3                    |   .
+.   +---v----------------------v---+   .
+.   .   | function3_getActions |   .   .
+.   .   +---v--------------v---+   .   .
+.   .   .   | action 1     |   .   .   .
+.   .   .   | action 2     |   .   .   .
+.   .   .   | action n     |   .   .   .
+.   .   .   +--------------+   .   .   .
+.   .   ........................   .   .
+.   ................................   .
+........................................
+
+

Figure 3.13: The actions initialization environment. +

3.37.3 Usage

- - -

3.37.3.1 Global variables

- -

The following global variables of `centos-art.sh' script, are -available for you to use inside specific functions: +

The `centos-art.sh' script usage information is described inside +each specific function documentation (see section trunk/Scripts/Bash/Functions).

-
-
Variable: TEXTDOMAIN - -
-

Default domain used to retrieve translated messages. This value is set -in `initFunctions.sh' and shouldn't be changed. -

- -
-
Variable: TEXTDOMAINDIR - -
-

Default directory used to retrieve translated messages. This value is -set in `initFunctions.sh' and shouldn't be changed. -

-
-
Variable: FUNCNAM - -
-

Define function name. -

-

Function names associate sets of actions. There is one set of actions -for each unique function name inside `centos-art.sh' script. -

-

Dunction names are passed as first argument in `centos-art.sh' -command-line interface. For example, in the command `centos-art -render --entry=path/to/dir --filter=regex', the ACTION passed to -`centos-art.sh' script is `render'. -

-

When first argument is not provided, the `centos-art.sh' script -immediatly ends its execution. -

- -
-
Variable: ACTIONNAM - -
-

Define action name. -

-

Each action name identifies an specific action to perform, inside an -specific function. -

-

Action name names aare passed as second argument in -`centos-art.sh' command-line interface. For example, in the -command `centos-art render --entry=path/to/dir --filter=regex', -the ACTIONNAM passed to `centos-art.sh' script is -`--entry'. -

-

When second argument is not provided, the `centos-art.sh' script -immediatly ends its execution. -

- -
-
Variable: ACTIONVAL - -
-

Define action value. -

-

Action values are associated to just one action name. Action values -contain the repository entry over which its associated action will be -performed in. Repository entries can be directories, files, or URLs -refering the repository structure. -

-

When action value is not specified as repository entry, the -`centos-art.sh' script evaluates the current directory it was -executed from. If such directory is under the repository structure -(i.e., `/home/centos/artwork/'), the `centos-art.sh' script -uses that directory as value to ACTIONVAL variable. Otherwise, -if outside the repository structure, the `centos-art.sh' script -prints the message `The path provided can't be processed.' and, -after it, immediatly ends script execution. -

-

Default action value is passed as second argument in -`centos-art.sh' command-line interface. For example, in the -command `centos-art render --entry=path/to/dir --filter=regex', -the ACTIONVAL passed to `centos-art.sh' script is -`path/to/dir'. -

- -
-
Variable: REGEX - -
-

Define regular expression used as pattern to build the list of files -to process. -

-

By default, REGEX variable is set to .+ to match all -files. -

-

Functions that need to build a list of files to process use the option -`--filter' to redefine REGEX variable default value, and -so, control the amount of files to process. -

- -
-
Variable: ARGUMENTS - -
-

Define optional arguments. -

-

Optional arguments, inside `centos-art.sh' script, are considered -as all command-line arguments passed to `centos-art.sh' script, -from third argument position on. For example, in the command -`centos-art render --entry=path/to/dir --filter=regex' , the -optional arguments are from `--filter=regex' argument on. -

-

Optional arguments are parsed using getopt command through -the following base construction: -

-
# 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
-
-

Optional arguments provide support to command options inside -`centos-art.sh' script. For instance, consider the Subversion -(svn) command, where there are many options (e.g., -`copy', `delete', `move', etc), and inside each -option there are several modifiers (e.g., `--revision', -`--message', `--username', etc.) that can be combined one -another in their short or long variants. -

-

The ARGUMENTS variable is used to store arguments passed from -command-line for later use inside `centos-art.sh' script. Storing -arguments is specially useful when we want to run a command with some -specific options from them. Consider the following command: -

-
centos-art path --copy=SOURCE --to=TARGET --message="The commit message goes here." --username='johndoe'
-
-

In the above command, the `--message', and `--username' -options are specific to svn copy command. In such cases, -options are not interpreted by `centos-art.sh' script itself. -Instead, the `centos-art.sh' script uses getopt to -retrive them and store them in the ARGUMENTS variable for later -use, as described in the following command: -

-
# Build subversion command to duplicate locations inside the
-# workstation.
-eval svn copy $SOURCE $TARGET --quiet $ARGUMENTS
-
-

When getopt parses ARGUMENTS, we may use short options -(e.g., `-m') or long options (e.g., `--message'). When -we use short options, arguments are separated by one space from the -option (e.g., `-m 'This is a commit message.''). When we use -long options arguments are separated by an equal sign (`=') -(e.g., `--message='This is a commit message''). -

-

In order for getopt to parse ARGUMENTS 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. -

-

As convenction, inside `centos-art.sh' script, short option -definitions are set in the ARGSS variable; and long option -definitions are set in the ARGSL variable. -

-

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 `:' -after the option definition (e.g., `-o m: -l message:'). On -the other hand, to define an option argument as not required, you need -to set two colons `::' after the option definition (e.g., -`-o m:: -l message::'). -

- -
-
Variable: EDITOR - -
-

Default text editor. -

-

The `centos-art.sh' script uses default text EDITOR to edit -pre-commit subversion messages, translation files, configuration -files, script files, and similar text-based files. -

-

If EDITOR environment variable is not set, `centos-art.sh' -script uses `/usr/bin/vim' as default text editor. Otherwise, the -following values are recognized by `centos-art.sh' script: -

-
    -
  • `/usr/bin/vim' -
  • `/usr/bin/emacs' -
  • `/usr/bin/nano' -
- -

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 Global functions

- -

Function scripts stored directly under -`trunk/Scripts/Bash/Functions/' 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 `centos-art.sh' script. -

-
-
Function: cli_checkActionArguments - -
-

Validate action value (ACTIONVAL) variable. -

-

The action value variable can take one of the following values: -

-
    -
  1. Path to one directory inside the local working copy, -
  2. Path to one file inside the local working copy, -
  3. URL to one directory inside the remote central repository, -
  4. URL to one file inside the remote central repository. -
- -

If another value different from that specified above is passed to -action value variable, the `centos-art.sh' script prints an error -message and ends script execution. Notice that when you provide a URL -there is no verification in order to determine the directory or file -you refered on it is valid or not. That verification is done by the -command that receives the location inside the functionality. The only -verification `centos-art.sh' script makes with URL is granting -that they begin with `https://projects.centos.org/svn/artwork'. -

-

cli_checkActionArguments is called from -cli_getArguments function and, probably, there is not -other use for cli_checkActionArguments but to be called from -cli_getArguments function. -

-

Update cli_checkActionArguments function if you need to improve -action value (ACTIONVAL) variable input validation. -

-
- -
-
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. -

-
`isInWorkingCopy'
-

Ends script execution if FILE is not inside the working copy. -

-
- -

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. -

-

The cli_commitRepoChanges function brings changes from the -central repository down to the working copy--using svn -update--, checks the working copy changes--using svn -status command--, prints status report--using both svn -update and svn status commands output, and finally, commits -recent changes from the working copy up to the repository--using -svn commit command--. -

-

Previous to commit the working copy changes up to the central -repository, the cli_commitRepoChanges function asks you to -verify changes--using svn diff command--, and later, -another confirmation question is shown to be sure you really want to -commit changes up to central repository. -

-

If LOCATION argument is not specified, the value of -ACTIONVAL variable is used as reference instead. -

-
-
----------------------------------------------------------------------
---> 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.
-----------------------------------------------------------------------
-
-

Figure 3.14: The cli_commitRepoChanges function output. - -

-

Call the cli_commitRepoChanges function before or/and after -calling functions that modify files or directories inside the working -copy as you may need to. -

- -
-
Function: cli_doParseArguments - -
-

Redefine arguments (ARGUMENTS) global variable using -getopt command output. For more information about how to use -cli_doParseArguments function, see ARGUMENTS variable -description above. -

- -
-
Function: cli_doParseArgumentsReDef $@ - -
-

Initialize/reset arguments (ARGUMENTS) global variable using -positional parameters variable ($@) as reference. -

-

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 cli_doParseArgumentsReDef with the positional -parameters variable ($@), set as first argument, to that -specific function you want to redefine positional parameters at. -

- -
-
Function: cli_getArguments - -
-

Initialize function name (FUNCNAM), action name -(ACTIONNAM), and action value (ACTIONVAL) global -variables, using positional parameters passed in $@ variable. -

-

The cli_getArguments function is called from cli.sh -function script, using cli function's positional parameters -(i.e., the positional parameters passed as arguments in the -command-line) as first function argument. -

-

Once command-line positional parameters are accesible to -`centos-art.sh' script execution evironment, -cli_getArguments uses regular expression to retrive -action variables from first and second argument. The first argument -defines the value used as function name (FUNCNAM), and the -second argument defines both values used as action name -(ACTIONNAM) and action value (ACTIONVAL), respectively. -

-

The first argument is a word in lower case. This word specifies the -name of the functionality you want to use (e.g., `render' to -render images, `manual' to work on documentation, and so on.) -

-

The second argument has a long option style (e.g., -`--option=value'). The `--option' represents the action name -(ACTIONNAM), and the characters inbetween the equal sign -(`=') and the first space character, are considered as the action -value (ACTIONVAL). In order to provide action values with space -characters inbetween you need to enclose action value with quotes like -in `--option='This is long value with spaces inbetween''. -Generally, action values are used to specify paths over which the -action name acts on. -

-

Once action related variables (i.e., FUNCNAM, ACTIONNAM, -and ACTIONVAL) are defined and validated, -cli_getArguments shifts the positional arguments to 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. -

- -
-
Function: cli_getFunctions - -
-

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 (i.e., the one such functionality was created for). -

-

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 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 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 -using the `function' reserved word, just as in the following -example: -

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

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
-#
-# 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...
-
-}
-
- -
-
Function: cli_getCountryCodes [FILTER] - -
-

Output country codes supported by `centos-art.sh' script. -

-

The cli_getCountryCodes function outputs a list with country -codes as defined in ISO3166 standard. When FILTER is provided, -cli_getCountryCodes outputs country codes that match -FILTER regular expression pattern. -

- -
-
Function: cli_getCountryName [FILTER] - -
-

Outputs country name supported by `centos-art.sh' script. -

-

The cli_getCountryName 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, cli_getCountryName returns the -country name that matches the locale code specified in FILTER, -exactly. -

- -
-
Function: cli_getCurrentLocale - -
-

Output current locale used by `centos-art.sh' script. -

-

The cli_getCurrentLocale function uses LANG environment -variable to build a locale pattern that is later applied to -cli_getLocales function output in order to return the current -locale that `centos-art.sh' script works with. -

-

The current locale information, returned by -cli_getCurrentLocale, is output from more specific to less -specific. For example, if `en_GB' locale exists in -cli_getLocales function output, the `en_GB' locale would -take precedence before `en' locale. -

-

Locale precedence selection is quite important in order to define the -locale type we use for message translations. For example, if -`en_GB' is used, we are also saying that the common language -specification for English language (i.e., `en') is no longer -used. Instead, we are using English non-common country-specific -language specifications like `en_AU', `en_BW', `en_GB', -`en_US', etc., for message translations. -

-

Use cli_getCurrentLocale function to know what current locale -information to use inside `centos-art.sh' script. -

- -
-
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. Essentially, what the -cli_getFilesList function does is using find command -to look for files in the location (LOCATION) just as posix-egrep -regular expression (REGEX) specifies. -

-

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

-

By default, if the regular expression (REGEX) global variable is -not redefined after its first definition in the cli function, -all files that match default regular expression value (i.e., -`.+') 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 cli function and before calling -cli_getFilesList function, the last value you specifed is used -instead. -

-

When you need to customize the regular expression (REGEX) 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 `local' 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. -

-

As result, the cli_getFilesList re-defines the value of -FILES variable with the list of files the find command -returned. As example, consider the following construction: -

-
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
-
-}
-
-
- -
-
Function: cli_getLangCodes [FILTER] - -
-

Outputs language codes supported by `centos-art.sh' script. -

-

cli_getLangCodes function outputs a list of language codes as -defined in ISO639 standard. When FILTER is provided, -cli_getLangCodes outputs language codes that match FILTER -regular expression pattern. -

- -
-
Function: cli_getLangName [FILTER] - -
-

Outputs language names supported by `centos-art.sh' script. -

-

cli_getLangName function reads one language locale code in the -format LL_CC and outputs the language related name as in ISO639. If -filter is specified, cli_getLangName returns the language name -that matches the locale code specified in FILTER, exactly. -

- -
-
Function: cli_getLocales - -
-

Output locale codes supported by `centos-art.sh' script. -

-

Occasionally, you use cli_getLocales function to add locale -information in non-common country-specific language (`LL_CC') -format for those languages (e.g., `bn_IN', `pt_BR', etc.) -which locale differences cannot be solved using common language -specifications (`LL') into one unique common locale specification -(e.g., `bn', `pt', etc.). -

- -
-
Function: cli_getRepoName NAME TYPE - -
-

Sanitate file names. -

-

Inside `centos-art.sh' script, specific functionalities rely both -in cli_getRepoName and repository file system organization to -achieve their goals. Consider cli_getRepoName function as -central place to manage file name convenctions for other functions -inside `centos-art.sh' script. -

-
Important

Important

cli_getRepoName function doesn't verify file -or directory existence, for that purpose use cli_checkFiles -function instead. -

- -

The NAME variable contains the file name or directory name you -want to sanitate. -

-

The TYPE variable specifies what type of sanitation you want to -perform on NAME. The TYPE can be one of the following -values: -

-
-
`d'
-
`directory'
-

Sanitate directory NAMEs. -

-
`f'
-
`regular-file'
-

Sanitate regular file NAMEs. -

-
- -

Use cli_getRepoName function to sanitate file names and -directory names before their utilization. -

-

Use cli_getRepoName when you need to change file name -convenctions inside `centos-art.sh' script. -

-

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 -inside the repository, each time we change name convenctions in the -repository (see section trunk/Scripts/Bash/Functions/Path, for more -information). -

- -
-
Function: cli_getRepoStatus [LOCATION] - -
-

Request repository status. -

-

This function requests the status of a LOCATION inside the -working copy using the svn status command and returns the -first character in the output line, just as described in svn -help status. If LOCATION is not a regular file or a directory, -inside the working copy, the `centos-art.sh' script prints a -message and ends its execution. -

-

Use this function to perform verifications based a repository -LOCATION status. -

- -
-
Function: cli_getTemporalFile NAME - -
-

Output absolute path to temporal file NAME. -

-

The cli_getTemporalFile function uses `/tmp' directory as -source location to store temporal files, the `centos-art.sh' -script name, and a random identification string to let you run more -than one `centos-art.sh' script simultaneously on the same user -session. For example, due the following temporal file defintion: -

-
cli_getTemporalFile $FILE
-
-

If FILE name is `instance.svg' and the unique random string -is `f16f7b51-ac12-4b7f-9e66-72df847f12de', the final temporal -file, built from previous temporal file definition, would be: -

-
/tmp/centos-art.sh-f16f7b51-ac12-4b7f-9e66-72df847f12de-instance.svg
-
-

When you use the cli_getTemporalFile 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: -

-
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
-
-

Use the cli_getTemporalFile function whenever you need to -create temporal files inside `centos-art.sh' script. -

- -
-
Function: cli_getThemeName - -
-

Output theme name. -

-

In order for cli_getThemeName function to extract theme name -correctly, the ACTIONVAL variable must contain a directory path -under `trunk/Identity/Themes/Motifs/' directory structure. -Otherwise, cli_getThemeName returns an empty string. -

- -
-
Function: cli_printMessage MESSAGE [FORMAT] - -
-

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, FORMAT can take one of the following values: -

-
-
`AsHeadingLine'
-

To print heading messages. -

----------------------------------------------------------------------
-$MESSAGE
-----------------------------------------------------------------------
-
-
-
`AsWarningLine'
-

To print warning messages. -

----------------------------------------------------------------------
-WARNING: $MESSAGE
-----------------------------------------------------------------------
-
-
-
`AsNoteLine'
-

To print note messages. -

----------------------------------------------------------------------
-NOTE: $MESSAGE
-----------------------------------------------------------------------
-
-
-
`AsUpdatingLine'
-

To print `Updating' messages on two-columns format. -

Updating        $MESSAGE
-
-
-
`AsRemovingLine'
-

To print `Removing' messages on two-columns format. -

Removing        $MESSAGE
-
-
-
`AsCheckingLine'
-

To print `Checking' messages on two-columns format. -

Checking        $MESSAGE
-
-
-
`AsCreatingLine'
-

To print `Creating' messages on two-columns format. -

Creating        $MESSAGE
-
-
-
`AsSavedAsLine'
-

To print `Saved as' messages on two-columns format. -

Saved as        $MESSAGE
-
-
-
`AsLinkToLine'
-

To print `Linked to' messages on two-columns format. -

Linked to       $MESSAGE
-
-
-
`AsMovedToLine'
-

To print `Moved to' messages on two-columns format. -

Moved to        $MESSAGE
-
-
-
`AsTranslationLine'
-

To print `Translation' messages on two-columns format. -

Translation     $MESSAGE
-
-
-
`AsConfigurationLine'
-

To print `Configuration' messages on two-columns format. -

Configuration   $MESSAGE
-
-
-
`AsResponseLine'
-

To print response messages on one-column format. -

--> $MESSAGE
-
-
-
`AsRequestLine'
-

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 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 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]:
-
-

and the confirmation answer would be `s', as it is on Spanish -`sí' word. -

-

Definition of which confirmation word to use is set on translation -messages for your specific locale information. See section trunk/Scripts/Bash/Functions/Locale, for more information about locale-specific -translation messages. -

-
-
`AsToKnowMoreLine'
-

To standardize `to know more, run the following command:' -messages. When the `AsToKnowMoreLine' option is used, the -MESSAGE value should be set to "$(caller)". caller -is a Bash builtin that returns the context of the current subroutine -call. `AsToKnowMoreLine' option uses caller builtin -output to build documentation entries dynamically. -

-
----------------------------------------------------------------------
-To know more, run the following command:
-centos-art manual --read='path/to/dir'
-----------------------------------------------------------------------
-
-

Use `AsToKnowMoreLine' option after errors and for intentional -script termination. -

-
-
`AsRegularLine'
-

To standardize regular messages on one-column format. -

-

When MESSAGE contains a colon inside (e.g., `description: -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. -

-
Info

Tip

To improve two-columns format, change the following file: -

trunk/Scripts/Bash/Styles/output_forTwoColumns.awk
-
-
- - - -

3.37.3.3 Specific functions

- -

The following specific functions of `centos-art.sh' script, are -available for you to use: -

- - - - - - - - - - -
3.38 trunk/Scripts/Bash/Functions/Html   -
3.39 trunk/Scripts/Bash/Functions/Locale   -
3.40 trunk/Scripts/Bash/Functions/Manual   -
3.41 trunk/Scripts/Bash/Functions/Path   -
3.42 trunk/Scripts/Bash/Functions/Render   -
3.43 trunk/Scripts/Bash/Functions/Render/Config   -
3.44 trunk/Scripts/Bash/Functions/Shell   -
3.45 trunk/Scripts/Bash/Functions/Svg   -
3.46 trunk/Scripts/Bash/Functions/Verify   -
- - - +

3.37.4 See also

- + -
3.36 trunk/Scripts/Bash   +
3.36 trunk/Scripts   +
3.38 trunk/Scripts/Bash/Functions  
3.47 trunk/Scripts/Bash/Locale   +
3.48 trunk/Scripts/Bash/Locale  
- - + + - +
[ < ][ > ]
[ < ][ > ]   [ << ] [ Up ][ >> ][ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_41.html b/Manuals/en/Html/Repository/repository_41.html index d3492ba..eb8abf3 100644 --- a/Manuals/en/Html/Repository/repository_41.html +++ b/Manuals/en/Html/Repository/repository_41.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.38 trunk/Scripts/Bash/Functions/Html +The CentOS Artwork Repository: 3.38 trunk/Scripts/Bash/Functions - - + + @@ -59,53 +54,1307 @@ ul.toc {list-style: none} - - + + - + - +
[ < ][ > ]
[ < ][ > ]   [ << ] [ Up ][ >> ][ >> ]         [Top] [Contents][Index][Index] [ ? ]
- + + +

3.38 trunk/Scripts/Bash/Functions

+ + + +

3.38.1 Goals

+ +

The `trunk/Scripts/Bash/Functions' directory exists to organize +`centos-art.sh' specific functionalities. +

+ + +

3.38.2 Description

+ +

The specific functions of `centos-art.sh' script are designed +with "Software Toolbox" philosophy (see (coreutils.info)Toolbox introduction) in mind: each program "should do one +thing well". Inside `centos-art.sh' 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. +

+

The specific functions of `centos-art.sh' script are organized +inside specific directories under `trunk/Scripts/Bash/Functions' +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 render, the specific function +directory for it would be `trunk/Scripts/Bash/Functions/Render'. +

+

To better understand how specific functions of `centos-art.sh' +script are designed, lets create one function which only goal is to +output different kind of greetings to your screen. +

+

When we create specific functions for `centos-art.sh' 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. +

+
Info

Tip

Join CentOS developers mailing list +centos-art@centos.org to share your ideas. +

+ +

It is also worth to know what global functions and variables do we +have available inside `centos-art.sh' script, so advantage can be +taken from them. Global variables are defined inside global function +scripts. Global functions scripts are stored immediatly under +`trunk/Scripts/Bash/Functions' directory, in files begining with +`cli' prefix. +

+

OK, let's begin with our functionality example. +

+

What function name do we use? Well, lets use greet. Note that +`hello' word is not a verb; but an expression, a kind of +greeting, an interjection specifically. In contrast, `greet' is a +verb and describes what we do when we say `Hello!', `Hi!', +and similar expressions. +

+

So far, we've gathered the following function information: +

+
Name: greet
+Path: trunk/Scripts/Bash/Functions/Greet
+File: trunk/Scripts/Bash/Functions/Greet/greet.sh
+
+

The `greet.sh' function script is the first file +`centos-art.sh' script loads when the `greet' functionality +is called using commands like `centos-art greet --hello='World''. +The `greet.sh' function script contains the greet function +definition. +

+

Inside `centos-art.sh' script, as convenction, each function +script has one top commentary, followed by one blank line, and then +one function defintion below it only. +

+

Inside `centos-art.sh' 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 `centos-art.sh' +script is released as GPL, so do all its functions--, subversion's +$Id$ keyword which is later expanded by svn propset +command. +

+

In our greet function example, top commentary for +`greet.sh' function script would look like the following: +

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

After top commentary, separated by one blank line, the greet +function definition would look like the following: +

+
function greet {
+
+    # Define global variables.
+
+    # Define command-line interface.
+    greet_getActions
+
+}
+
+

The first definition inside greet function, are global +variables that will be available along greet function execution +environment. This time we didn't use global variable definitions for +greet function execution environment, so we left that section +empty. +

+

Later, we call greet_getActions function to define the +command-line interface of greet functionality. The command-line +interface of greet functionality defines what and how actions +are performed, based on arguments combination passed to +`centos-art.sh' script. +

+
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
+
+}
+
+

The ACTIONNAM global variable is defined in `cli.sh' +function script and contains the value passed before the equal sign +(i.e., `=') in the second command-line argument of +`centos-art.sh' script. For example, if the second command-line +argument is `--hello='World'', the value of ACTIONNAM +variable would be `--hello'. Using this configuration let us +deside which action to perform based on the action name passed to +`centos-art.sh' script as second argument. +

+

The greet function definition makes available two valid +greetings through `--hello' and `--bye' options. If no +one of them is provided as second command-line argument, the `*' +case is evaluated instead. +

+

The `*' case and its two lines further on should always be +present in `_getActions.sh' 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. +

+

The greet_doHello and greet_doBye function definitions +are the core of greet specific functionality. In such function +definitions we set what our greet function really does: to +output different kinds of greetings. +

+
function greet_doHello {
+
+    cli_printMessage "`gettext "Hello"` $ACTIONVAL"
+
+}
+
+

The greet_doHello function definition is stored in +`greet_doHello.sh' function script. +

+
function greet_doBye {
+
+    cli_printMessage "`gettext "Goodbye"` $ACTIONVAL"
+
+}
+
+

The greet_doBye function definition is stored in the +`greet_doBye.sh' function script. +

+

Both `greet_doHello.sh' and `greet_doBye.sh' function +scripts are stored inside greet's function directory path (i.e. +`trunk/Scripts/Bash/Functions/Greet'). +

+

The ACTIONVAL global variable is defined in `cli.sh' +function script and contains the value passed after the equal sign +(i.e., `=') in the second command-line argument of +`centos-art.sh' script. For example, if the second command-line +argument is `--hello='World'', the value of ACTIONVAL +variable would be `World' without quotes. +

+

Let's see how greet specific functionality files are organzied +under greet's function directory. To see file organization we +use the tree command: +

+
trunk/Scripts/Bash/Functions/Greet
+|-- greet_doBye.sh
+|-- greet_doHello.sh
+|-- greet_getActions.sh
+`-- greet.sh
+
+

To try the greet specific functionality we've just created, +pass the function name (i.e., `greet') as first argument to +`centos-art.sh' script, and any of the valid options as second +argument. Some examples are illustrated below: +

+
[centos@projects ~]$ centos-art greet --hello='World'
+Hello World
+[centos@projects ~]$ centos-art greet --bye='World'
+Goodbye World
+[centos@projects ~]$ 
+
+

The word `World' in the examples above can be anything. In fact, +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 greet specific functionality, +we use its directory path and the manual functionality +(see section trunk/Scripts/Bash/Functions/Manual) of `centos-art.sh' +script, just as the following command illustrates: +

+
centos-art manual --edit=trunk/Scripts/Bash/Functions/Greet
+
+

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 `centos-art.sh' script uses +the function documentation entry as vehicle to communicate which the +valid functions are. When no documentation entry exists for a +function, the `centos-art.sh' script informs that no +documentation entry exists for such function and requests user to +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 +locale functionality (see section trunk/Scripts/Bash/Functions/Locale) of `centos-art.sh' script, just as the following command +illustrates: +

+
centos-art locale --edit
+
+
Warning

Warning

To translate output messages in different languages, +your system locale information --as in LANG 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 +`es_ES.UTF-8', or similar, first. +

+ +

Well, it seems that our example is rather complete by now. +

+

In greet function example we've described so far, we only use +cli_printMessage 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 +`--filter='regex'' and reduce the amount of files to process +using a regular expression pattern. +

+

The greet function described in this section may serve you as +an introduction to understand how specific functionalities work inside +`centos-art.sh' script. With some of luck this introduction will +also serve you as motivation to create your own `centos-art.sh' +script specific functionalities. +

+

By the way, the greet functionality doesn't exist inside +`centos-art.sh' script yet. Would you like to create it? +

+ -

3.38 trunk/Scripts/Bash/Functions/Html

+

3.38.3 Usage

-

3.38.1 Goals

+

3.38.3.1 Global variables

+ +

The following global variables of `centos-art.sh' script, are +available for you to use inside specific functions: +

+
+
Variable: TEXTDOMAIN + +
+

Default domain used to retrieve translated messages. This value is set +in `initFunctions.sh' and shouldn't be changed. +

+ +
+
Variable: TEXTDOMAINDIR + +
+

Default directory used to retrieve translated messages. This value is +set in `initFunctions.sh' and shouldn't be changed. +

+ +
+
Variable: FUNCNAM + +
+

Define function name. +

+

Function names associate sets of actions. There is one set of actions +for each unique function name inside `centos-art.sh' script. +

+

Dunction names are passed as first argument in `centos-art.sh' +command-line interface. For example, in the command `centos-art +render --entry=path/to/dir --filter=regex', the ACTION passed to +`centos-art.sh' script is `render'. +

+

When first argument is not provided, the `centos-art.sh' script +immediatly ends its execution. +

+ +
+
Variable: FUNCDIR + +
+
+ +
+
Variable: FUNCDIRNAME + +
+
+
+
Variable: FUNCSCRIPT + +
+
+ +
+
Variable: FUNCCONFIG + +
+
+ +
+
Variable: ACTIONNAM + +
+

Define action name. +

+

Each action name identifies an specific action to perform, inside an +specific function. +

+

Action name names aare passed as second argument in +`centos-art.sh' command-line interface. For example, in the +command `centos-art render --entry=path/to/dir --filter=regex', +the ACTIONNAM passed to `centos-art.sh' script is +`--entry'. +

+

When second argument is not provided, the `centos-art.sh' script +immediatly ends its execution. +

+ +
+
Variable: ACTIONVAL + +
+

Define action value. +

+

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. +

+ +
+
Variable: REGEX + +
+

Define regular expression used as pattern to build the list of files +to process. +

+

By default, REGEX variable is set to .+ to match all +files. +

+

Functions that need to build a list of files to process use the option +`--filter' to redefine REGEX variable default value, and +so, control the amount of files to process. +

+ +
+
Variable: ARGUMENTS + +
+

Define optional arguments. +

+

Optional arguments, inside `centos-art.sh' script, are considered +as all command-line arguments passed to `centos-art.sh' script, +from third argument position on. For example, in the command +`centos-art render --entry=path/to/dir --filter=regex' , the +optional arguments are from `--filter=regex' argument on. +

+

Optional arguments are parsed using getopt command through +the following base construction: +

+
# 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
+
+

Optional arguments provide support to command options inside +`centos-art.sh' script. For instance, consider the Subversion +(svn) command, where there are many options (e.g., +`copy', `delete', `move', etc), and inside each +option there are several modifiers (e.g., `--revision', +`--message', `--username', etc.) that can be combined one +another in their short or long variants. +

+

The ARGUMENTS variable is used to store arguments passed from +command-line for later use inside `centos-art.sh' script. Storing +arguments is specially useful when we want to run a command with some +specific options from them. Consider the following command: +

+
centos-art path --copy=SOURCE --to=TARGET --message="The commit message goes here." --username='johndoe'
+
+

In the above command, the `--message', and `--username' +options are specific to svn copy command. In such cases, +options are not interpreted by `centos-art.sh' script itself. +Instead, the `centos-art.sh' script uses getopt to +retrive them and store them in the ARGUMENTS variable for later +use, as described in the following command: +

+
# Build subversion command to duplicate locations inside the
+# workstation.
+eval svn copy $SOURCE $TARGET --quiet $ARGUMENTS
+
+

When getopt parses ARGUMENTS, we may use short options +(e.g., `-m') or long options (e.g., `--message'). When +we use short options, arguments are separated by one space from the +option (e.g., `-m 'This is a commit message.''). When we use +long options arguments are separated by an equal sign (`=') +(e.g., `--message='This is a commit message''). +

+

In order for getopt to parse ARGUMENTS 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. +

+

As convenction, inside `centos-art.sh' script, short option +definitions are set in the ARGSS variable; and long option +definitions are set in the ARGSL variable. +

+

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 `:' +after the option definition (e.g., `-o m: -l message:'). On +the other hand, to define an option argument as not required, you need +to set two colons `::' after the option definition (e.g., +`-o m:: -l message::'). +

+ +
+
Variable: EDITOR + +
+

Default text editor. +

+

The `centos-art.sh' script uses default text EDITOR to edit +pre-commit subversion messages, translation files, configuration +files, script files, and similar text-based files. +

+

If EDITOR environment variable is not set, `centos-art.sh' +script uses `/usr/bin/vim' as default text editor. Otherwise, the +following values are recognized by `centos-art.sh' script: +

    -
  • ... +
  • `/usr/bin/vim' +
  • `/usr/bin/emacs' +
  • `/usr/bin/nano'
+

If no one of these values is set in EDITOR environment variable, +`centos-art.sh' uses `/usr/bin/vim' text editor by default. +

+ -

3.38.2 Description

+

3.38.3.2 Global functions

- +

Function scripts stored directly under +`trunk/Scripts/Bash/Functions/' 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 `centos-art.sh' script. +

+
+
Function: cli_checkActionArguments + +
+

Validate action value (ACTIONVAL) variable. +

+

The action value variable can take one of the following values: +

+
    +
  1. Path to one directory inside the local working copy, +
  2. Path to one file inside the local working copy, +
+ +

If another value different from that specified above is passed to +action value variable, the `centos-art.sh' script prints an error +message and ends script execution. +

+ +
+
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. +

+
`isInWorkingCopy'
+

Ends script execution if FILE is not inside the working copy. +

+
+ +

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. +

+

The cli_commitRepoChanges function brings changes from the +central repository down to the working copy--using svn +update--, checks the working copy changes--using svn +status command--, prints status report--using both svn +update and svn status commands output, and finally, commits +recent changes from the working copy up to the repository--using +svn commit command--. +

+

Previous to commit the working copy changes up to the central +repository, the cli_commitRepoChanges function asks you to +verify changes--using svn diff command--, and later, +another confirmation question is shown to be sure you really want to +commit changes up to central repository. +

+

If LOCATION argument is not specified, the value of +ACTIONVAL variable is used as reference instead. +

+
+
----------------------------------------------------------------------
+--> 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.
+----------------------------------------------------------------------
+
+

Figure 3.14: The cli_commitRepoChanges function output. + +

+

Call the cli_commitRepoChanges function before or/and after +calling functions that modify files or directories inside the working +copy as you may need to. +

+ +
+
Function: cli_doParseArguments + +
+

Redefine arguments (ARGUMENTS) global variable using +getopt command output. For more information about how to use +cli_doParseArguments function, see ARGUMENTS variable +description above. +

+ +
+
Function: cli_doParseArgumentsReDef $@ + +
+

Initialize/reset arguments (ARGUMENTS) global variable using +positional parameters variable ($@) as reference. +

+

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 cli_doParseArgumentsReDef with the positional +parameters variable ($@), set as first argument, to that +specific function you want to redefine positional parameters at. +

+ +
+
Function: cli_getArguments + +
+

Initialize function name (FUNCNAM), action name +(ACTIONNAM), and action value (ACTIONVAL) global +variables, using positional parameters passed in $@ variable. +

+

The cli_getArguments function is called from cli.sh +function script, using cli function's positional parameters +(i.e., the positional parameters passed as arguments in the +command-line) as first function argument. +

+

Once command-line positional parameters are accesible to +`centos-art.sh' script execution evironment, +cli_getArguments uses regular expression to retrive +action variables from first and second argument. The first argument +defines the value used as function name (FUNCNAM), and the +second argument defines both values used as action name +(ACTIONNAM) and action value (ACTIONVAL), respectively. +

+

The first argument is a word in lower case. This word specifies the +name of the functionality you want to use (e.g., `render' to +render images, `manual' to work on documentation, and so on.) +

+

The second argument has a long option style (e.g., +`--option=value'). The `--option' represents the action name +(ACTIONNAM), and the characters inbetween the equal sign +(`=') and the first space character, are considered as the action +value (ACTIONVAL). In order to provide action values with space +characters inbetween you need to enclose action value with quotes like +in `--option='This is long value with spaces inbetween''. +Generally, action values are used to specify paths over which the +action name acts on. +

+

Once action related variables (i.e., FUNCNAM, ACTIONNAM, +and ACTIONVAL) are defined and validated, +cli_getArguments shifts the positional arguments to 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. +

+ +
+
Function: cli_getFunctions + +
+

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 (i.e., the one such functionality was created for). +

+

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 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 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 +using the `function' reserved word, just as in the following +example: +

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

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
+#
+# 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...
+
+}
+
+ +
+
Function: cli_getCountryCodes [FILTER] + +
+

Output country codes supported by `centos-art.sh' script. +

+

The cli_getCountryCodes function outputs a list with country +codes as defined in ISO3166 standard. When FILTER is provided, +cli_getCountryCodes outputs country codes that match +FILTER regular expression pattern. +

+ +
+
Function: cli_getCountryName [FILTER] + +
+

Outputs country name supported by `centos-art.sh' script. +

+

The cli_getCountryName 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, cli_getCountryName returns the +country name that matches the locale code specified in FILTER, +exactly. +

+ +
+
Function: cli_getCurrentLocale + +
+

Output current locale used by `centos-art.sh' script. +

+

The cli_getCurrentLocale function uses LANG environment +variable to build a locale pattern that is later applied to +cli_getLocales function output in order to return the current +locale that `centos-art.sh' script works with. +

+

The current locale information, returned by +cli_getCurrentLocale, is output from more specific to less +specific. For example, if `en_GB' locale exists in +cli_getLocales function output, the `en_GB' locale would +take precedence before `en' locale. +

+

Locale precedence selection is quite important in order to define the +locale type we use for message translations. For example, if +`en_GB' is used, we are also saying that the common language +specification for English language (i.e., `en') is no longer +used. Instead, we are using English non-common country-specific +language specifications like `en_AU', `en_BW', `en_GB', +`en_US', etc., for message translations. +

+

Use cli_getCurrentLocale function to know what current locale +information to use inside `centos-art.sh' script. +

+ +
+
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. Essentially, what the +cli_getFilesList function does is using find command +to look for files in the location (LOCATION) just as posix-egrep +regular expression (REGEX) specifies. +

+

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

+

By default, if the regular expression (REGEX) global variable is +not redefined after its first definition in the cli function, +all files that match default regular expression value (i.e., +`.+') 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 cli function and before calling +cli_getFilesList function, the last value you specifed is used +instead. +

+

When you need to customize the regular expression (REGEX) 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 `local' 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. +

+

As result, the cli_getFilesList re-defines the value of +FILES variable with the list of files the find command +returned. As example, consider the following construction: +

+
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
+
+}
+
+
+ +
+
Function: cli_getLangCodes [FILTER] + +
+

Outputs language codes supported by `centos-art.sh' script. +

+

cli_getLangCodes function outputs a list of language codes as +defined in ISO639 standard. When FILTER is provided, +cli_getLangCodes outputs language codes that match FILTER +regular expression pattern. +

+ +
+
Function: cli_getLangName [FILTER] + +
+

Outputs language names supported by `centos-art.sh' script. +

+

cli_getLangName function reads one language locale code in the +format LL_CC and outputs the language related name as in ISO639. If +filter is specified, cli_getLangName returns the language name +that matches the locale code specified in FILTER, exactly. +

+ +
+
Function: cli_getLocales + +
+

Output locale codes supported by `centos-art.sh' script. +

+

Occasionally, you use cli_getLocales function to add locale +information in non-common country-specific language (`LL_CC') +format for those languages (e.g., `bn_IN', `pt_BR', etc.) +which locale differences cannot be solved using common language +specifications (`LL') into one unique common locale specification +(e.g., `bn', `pt', etc.). +

+ +
+
Function: cli_getRepoName NAME TYPE + +
+

Sanitate file names. +

+

Inside `centos-art.sh' script, specific functionalities rely both +in cli_getRepoName and repository file system organization to +achieve their goals. Consider cli_getRepoName function as +central place to manage file name convenctions for other functions +inside `centos-art.sh' script. +

+
Important

Important

cli_getRepoName function doesn't verify file +or directory existence, for that purpose use cli_checkFiles +function instead. +

+ +

The NAME variable contains the file name or directory name you +want to sanitate. +

+

The TYPE variable specifies what type of sanitation you want to +perform on NAME. The TYPE can be one of the following +values: +

+
+
`d'
+
`directory'
+

Sanitate directory NAMEs. +

+
`f'
+
`regular-file'
+

Sanitate regular file NAMEs. +

+
+ +

Use cli_getRepoName function to sanitate file names and +directory names before their utilization. +

+

Use cli_getRepoName when you need to change file name +convenctions inside `centos-art.sh' script. +

+

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 +inside the repository, each time we change name convenctions in the +repository (see section trunk/Scripts/Bash/Functions/Path, for more +information). +

+ +
+
Function: cli_getRepoStatus [LOCATION] + +
+

Request repository status. +

+

This function requests the status of a LOCATION inside the +working copy using the svn status command and returns the +first character in the output line, just as described in svn +help status. If LOCATION is not a regular file or a directory, +inside the working copy, the `centos-art.sh' script prints a +message and ends its execution. +

+

Use this function to perform verifications based a repository +LOCATION status. +

+ +
+
Function: cli_getTemporalFile NAME + +
+

Output absolute path to temporal file NAME. +

+

The cli_getTemporalFile function uses `/tmp' directory as +source location to store temporal files, the `centos-art.sh' +script name, and a random identification string to let you run more +than one `centos-art.sh' script simultaneously on the same user +session. For example, due the following temporal file defintion: +

+
cli_getTemporalFile $FILE
+
+

If FILE name is `instance.svg' and the unique random string +is `f16f7b51-ac12-4b7f-9e66-72df847f12de', the final temporal +file, built from previous temporal file definition, would be: +

+
/tmp/centos-art.sh-f16f7b51-ac12-4b7f-9e66-72df847f12de-instance.svg
+
+

When you use the cli_getTemporalFile 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: +

+
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
+
+

Use the cli_getTemporalFile function whenever you need to +create temporal files inside `centos-art.sh' script. +

+ +
+
Function: cli_getThemeName + +
+

Output theme name. +

+

In order for cli_getThemeName function to extract theme name +correctly, the ACTIONVAL variable must contain a directory path +under `trunk/Identity/Themes/Motifs/' directory structure. +Otherwise, cli_getThemeName returns an empty string. +

+ +
+
Function: cli_printMessage MESSAGE [FORMAT] + +
+

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, FORMAT can take one of the following values: +

+
+
`AsHeadingLine'
+

To print heading messages. +

----------------------------------------------------------------------
+$MESSAGE
+----------------------------------------------------------------------
+
+
+
`AsWarningLine'
+

To print warning messages. +

----------------------------------------------------------------------
+WARNING: $MESSAGE
+----------------------------------------------------------------------
+
+
+
`AsNoteLine'
+

To print note messages. +

----------------------------------------------------------------------
+NOTE: $MESSAGE
+----------------------------------------------------------------------
+
+
+
`AsUpdatingLine'
+

To print `Updating' messages on two-columns format. +

Updating        $MESSAGE
+
+
+
`AsRemovingLine'
+

To print `Removing' messages on two-columns format. +

Removing        $MESSAGE
+
+
+
`AsCheckingLine'
+

To print `Checking' messages on two-columns format. +

Checking        $MESSAGE
+
+
+
`AsCreatingLine'
+

To print `Creating' messages on two-columns format. +

Creating        $MESSAGE
+
+
+
`AsSavedAsLine'
+

To print `Saved as' messages on two-columns format. +

Saved as        $MESSAGE
+
+
+
`AsLinkToLine'
+

To print `Linked to' messages on two-columns format. +

Linked to       $MESSAGE
+
+
+
`AsMovedToLine'
+

To print `Moved to' messages on two-columns format. +

Moved to        $MESSAGE
+
+
+
`AsTranslationLine'
+

To print `Translation' messages on two-columns format. +

Translation     $MESSAGE
+
+
+
`AsConfigurationLine'
+

To print `Configuration' messages on two-columns format. +

Configuration   $MESSAGE
+
+
+
`AsResponseLine'
+

To print response messages on one-column format. +

--> $MESSAGE
+
+
+
`AsRequestLine'
+

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 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 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]:
+
+

and the confirmation answer would be `s', as it is on Spanish +`sí' word. +

+

Definition of which confirmation word to use is set on translation +messages for your specific locale information. See section trunk/Scripts/Bash/Functions/Locale, for more information about locale-specific +translation messages. +

+
+
`AsToKnowMoreLine'
+

To standardize `to know more, run the following command:' +messages. When the `AsToKnowMoreLine' option is used, the +MESSAGE value should be set to "$(caller)". caller +is a Bash builtin that returns the context of the current subroutine +call. `AsToKnowMoreLine' option uses caller builtin +output to build documentation entries dynamically. +

+
----------------------------------------------------------------------
+To know more, run the following command:
+centos-art manual --read='path/to/dir'
+----------------------------------------------------------------------
+
+

Use `AsToKnowMoreLine' option after errors and for intentional +script termination. +

+
+
`AsRegularLine'
+

To standardize regular messages on one-column format. +

+

When MESSAGE contains a colon inside (e.g., `description: +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. +

+
Info

Tip

To improve two-columns format, change the following file: +

trunk/Scripts/Bash/Styles/output_forTwoColumns.awk
+
+
-

3.38.3 Usage

+

3.38.3.3 Specific functions

- +

The following specific functions of `centos-art.sh' script, are +available for you to use: +

+ + + + + + + + + + +
3.39 trunk/Scripts/Bash/Functions/Html   +
3.40 trunk/Scripts/Bash/Functions/Locale   +
3.41 trunk/Scripts/Bash/Functions/Manual   +
3.42 trunk/Scripts/Bash/Functions/Path   +
3.43 trunk/Scripts/Bash/Functions/Render   +
3.44 trunk/Scripts/Bash/Functions/Render/Config   +
3.45 trunk/Scripts/Bash/Functions/Shell   +
3.46 trunk/Scripts/Bash/Functions/Svg   +
3.47 trunk/Scripts/Bash/Functions/Verify   +

3.38.4 See also

+ + + +
3.37 trunk/Scripts/Bash   +
3.48 trunk/Scripts/Bash/Locale   +
@@ -113,12 +1362,12 @@ ul.toc {list-style: none} - - + +
[ > ]   [ << ][ Up ][ >> ][ Up ][ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_42.html b/Manuals/en/Html/Repository/repository_42.html index b7a7351..6d1b581 100644 --- a/Manuals/en/Html/Repository/repository_42.html +++ b/Manuals/en/Html/Repository/repository_42.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.39 trunk/Scripts/Bash/Functions/Locale +The CentOS Artwork Repository: 3.39 trunk/Scripts/Bash/Functions/Html - - + + @@ -64,19 +59,19 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] - + -

3.39 trunk/Scripts/Bash/Functions/Locale

+

3.39 trunk/Scripts/Bash/Functions/Html

@@ -90,64 +85,6 @@ ul.toc {list-style: none}

3.39.2 Description

-

This command looks for `.sh' files inside Bash directory and -extracts translatable strings from files, using xgettext -command, in order to create a portable object template -(`centos-art.sh.pot') file for them. -

-

With the `centos-art.sh.pot' file up to date, the -centos-art command removes the temporal list of files sotred -inside `/tmp' directory and checks the current language of your -user's session to create a portable object file for it, in the -location `$CLI_LANG/$CLI_LANG.po'. -

-

The CLI_LANG variable discribes the locale language used to -output messages inside centos-art command. The locale -language used inside centos-art command is taken from the -LANG environment variable. The CLI_LANG variable has the -`LL_CC' format, where `LL' is a language code from the -ISO-639 standard, and `CC' a country code from the ISO-3166 -standard. -

-

The LANG environment variable is set when you do log in to your -system. If you are using a graphical session, change language to your -native language and do login. That would set and exoprt the LANG -environment variable to the correct value. On the other side, if you -are using a text session edit your `~/.bash_profile' file to set -and export the LANG environment variable to your native locale -as defines the locale -a command output; do logout, and do -login again. -

-

At this point, the LANG environment variable has the appropriate -value you need, in order to translate centos-art.sh messages -to your native language (the one set in LANG environment -variable). -

-

With the `$CLI_LANG/$CLI_LANG.po' file up to date, the -centos-art opens it for you to update translation strings. -The centos-art command uses the value of EDITOR -environment variable to determine your favorite text editor. If no -value is defined on EDITOR, the `/usr/bin/vim' text editor -is used as default. -

-

When you finish PO file's edition and quit text editor, the -centos-art command creates the related machine object in the -location `$CLI_LANG/LC_MESSAGES/$TEXTDOMAIN.mo'. -

-

At this point, all translations you made in the PO file should be -available to your language when runing centos-art.sh script. -

-

In order to make the centos-art.sh internationalization, the -centos-art.sh script was modified as described in the -gettext info documentation (info gettext). You -can find such modifications in the following files: -

- - @@ -156,16 +93,9 @@ can find such modifications in the following files:

3.39.3 Usage

-
-
`centos-art locale --edit'
-

Use this command to translate command-line interface output messages -in the current system locale you are using (as specified in LANG -environment variable). -

-
`centos-art locale --list'
-

Use this command to see the command-line interface locale report. -

-
+ @@ -179,11 +109,11 @@ environment variable).   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_43.html b/Manuals/en/Html/Repository/repository_43.html index f108ebc..f433949 100644 --- a/Manuals/en/Html/Repository/repository_43.html +++ b/Manuals/en/Html/Repository/repository_43.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.40 trunk/Scripts/Bash/Functions/Manual +The CentOS Artwork Repository: 3.40 trunk/Scripts/Bash/Functions/Locale - - + + @@ -64,19 +59,19 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] - + -

3.40 trunk/Scripts/Bash/Functions/Manual

+

3.40 trunk/Scripts/Bash/Functions/Locale

@@ -90,6 +85,64 @@ ul.toc {list-style: none}

3.40.2 Description

+

This command looks for `.sh' files inside Bash directory and +extracts translatable strings from files, using xgettext +command, in order to create a portable object template +(`centos-art.sh.pot') file for them. +

+

With the `centos-art.sh.pot' file up to date, the +centos-art command removes the temporal list of files sotred +inside `/tmp' directory and checks the current language of your +user's session to create a portable object file for it, in the +location `$CLI_LANG/$CLI_LANG.po'. +

+

The CLI_LANG variable discribes the locale language used to +output messages inside centos-art command. The locale +language used inside centos-art command is taken from the +LANG environment variable. The CLI_LANG variable has the +`LL_CC' format, where `LL' is a language code from the +ISO-639 standard, and `CC' a country code from the ISO-3166 +standard. +

+

The LANG environment variable is set when you do log in to your +system. If you are using a graphical session, change language to your +native language and do login. That would set and exoprt the LANG +environment variable to the correct value. On the other side, if you +are using a text session edit your `~/.bash_profile' file to set +and export the LANG environment variable to your native locale +as defines the locale -a command output; do logout, and do +login again. +

+

At this point, the LANG environment variable has the appropriate +value you need, in order to translate centos-art.sh messages +to your native language (the one set in LANG environment +variable). +

+

With the `$CLI_LANG/$CLI_LANG.po' file up to date, the +centos-art opens it for you to update translation strings. +The centos-art command uses the value of EDITOR +environment variable to determine your favorite text editor. If no +value is defined on EDITOR, the `/usr/bin/vim' text editor +is used as default. +

+

When you finish PO file's edition and quit text editor, the +centos-art command creates the related machine object in the +location `$CLI_LANG/LC_MESSAGES/$TEXTDOMAIN.mo'. +

+

At this point, all translations you made in the PO file should be +available to your language when runing centos-art.sh script. +

+

In order to make the centos-art.sh internationalization, the +centos-art.sh script was modified as described in the +gettext info documentation (info gettext). You +can find such modifications in the following files: +

+ + @@ -98,9 +151,16 @@ ul.toc {list-style: none}

3.40.3 Usage

- +
+
`centos-art locale --edit'
+

Use this command to translate command-line interface output messages +in the current system locale you are using (as specified in LANG +environment variable). +

+
`centos-art locale --list'
+

Use this command to see the command-line interface locale report. +

+
@@ -114,11 +174,11 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_44.html b/Manuals/en/Html/Repository/repository_44.html index 20b8da5..ad2bc90 100644 --- a/Manuals/en/Html/Repository/repository_44.html +++ b/Manuals/en/Html/Repository/repository_44.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.41 trunk/Scripts/Bash/Functions/Path +The CentOS Artwork Repository: 3.41 trunk/Scripts/Bash/Functions/Manual - - + + @@ -64,461 +59,61 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] - + -

3.41 trunk/Scripts/Bash/Functions/Path

+

3.41 trunk/Scripts/Bash/Functions/Manual

3.41.1 Goals

-

This section exists to organize files related to path -functiontionality of `centos-art.sh' script. The path -functionality of `centos-art.sh' script standardizes movement, -syncronization, branching, tagging, and general file maintainance -inside the repository. -

+ +

3.41.2 Description

-

"CentOS like trees, has roots, trunk, branches, leaves and -flowers. Day by day they work together in freedom, ruled by the laws -of nature and open standards, to show the beauty of its -existence." -

- - -

3.41.2.1 Repository layout

- -

The repository layout describes organization of files and directories -inside the repository. The repository layout provides the standard -backend required for automation scripts to work correctly. If such -layout changes unexpectedly, automation scripts may confuse themselves -and stop doing what we expect from them to do. -

-

As convenction, inside CentOS Artwork Repository, we organize files -and directories, related to CentOS corporate visual identity, under -three top level directories named `trunk/', `branches/', and -`tags/'. -

-
-

trunk/Identity/Models/Img/Scripts/Bash/Functions/Path/figure-6 - -

Figure 3.15: The CentOS Artwork Repository layout. - -

-

The `trunk/' directory (see section trunk) organizes the main -development line of CentOS corporate visual identity. Inside -`trunk/' directory structure, the CentOS corporate visual -identity concepts are implemented using directories. There is one -directory level for each relevant concept inside the repository. The -`trunk/' directory structure is mainly used to develop CentOS -corporate visual identity. -

-

The `branches/' directory (see section branches) oranizes parallel -development lines to `trunk/' directory. The `branches/' -directory is used to set points in time where develpment lines are -devided one from another taking separte and idependent lives that -share a common past from the point they were devided on. The -`branches/' directory is mainly used to perform quality assurance -on CentOS corporate visual identity. -

-

The `tags/' directory (see section tags) organizes parallel frozen -lines to `branches/' directory. The parallel frozen lines are -immutable, nothing change inside them once they has been created. The -`tags/' directory is mainly used to publish final releases of -CentOS corporate visual identity. -

-

The CentOS Artwork Repository layout is firmly grounded on a -Subversion base. Subversion (http://subversion.tigris.org) is a -version control system, which allows you to keep old versions of files -and directories (usually source code), keep a log of who, when, and -why changes occurred, etc., like CVS, RCS or SCCS. Subversion keeps a -single copy of the master sources. This copy is called the source -"repository"; it contains all the information to permit extracting -previous versions of those files at any time. -

+ - -

3.41.2.2 Repository name convenctions

- -

Repository name convenctions help us to maintain consistency of names -inside the repository. -

-

Repository name convenctions are applied to files and directories -inside the repository layout. As convenction, inside the repository -layout, file names are all written in lowercase -(`01-welcome.png', `splash.png', `anaconda_header.png', -etc.) and directory names are all written capitalized (e.g., -`Identity', `Themes', `Motifs', `TreeFlower', -etc.). -

-

Repository name convenctions are implemented inside the -cli_getRepoName function of `centos-art.sh' script. With -cli_getRepoName function we reduce the amount of commands and -convenctions to remember, concentrating them in just one single place -to look for fixes and improvements. -

- -

3.41.2.3 Repository work flow

- -

Repository work flow describes the steps and time intervals used to -produce CentOS corporate visual identity inside CentOS Artwork -Repository. -

-

To illustrate repository work flow let's consider themes' development -cycle. -

-

Initially, we start working themes on their trunk development line -(e.g., `trunk/Identity/Themes/Motifs/TreeFlower/'), here we -organize information that cannot be produced automatically (i.e., -background images, concepts, color information, screenshots, etc.). -

-

Later, when theme trunk development line is considered "ready" for -implementation (e.g., all required backgrounds have been designed), -we create a branch for it (e.g., -`branches/Identity/Themes/Motifs/TreeFlower/1/'). Once the -branch has been created, we forget that branch and continue working -the trunk development line while others (e.g., an artwork quality -assurance team) test the new branch for tunning it up. -

-

Once the branch has been tunned up, and considered "ready" for -release, it is freezed under `tags/' directory (e.g., -`tags/Identity/Themes/Motifs/TreeFower/1.0/') for packagers, -webmasters, promoters, and anyone who needs images from that CentOS -theme the tag was created for. -

-

Both branches and tags, inside CentOS Artwork Repository, use -numerical values to identify themselves under the same location. -Branches start at one (i.e., `1') and increment one unit for each -branch created from the same trunk development line. Tags start at -zero (i.e., `0') and increment one unit for each tag created from -the same branch development line. -

-
-

trunk/Identity/Models/Img/Scripts/Bash/Functions/Path/figure-1 - -

Figure 3.16: Name convention for tags and branches creation. - -

-
Convenction

Convenction

Do not freeze trunk development lines using tags -directly. If you think you need to freeze a trunk development line, -create a branch for it and then freeze that branch instead. -

- -

The trunk development line may introduce problems we cannot see -immediatly. Certainly, the high changable nature of trunk development -line complicates finding and fixing such problems. On the other hand, -the branched development lines provide a more predictable area where -only fixes/corrections to current content are commited up to -repository. -

-

If others find and fix bugs inside the branched development line, we -could merge such changes/experiences back to trunk development line -(not visversa) in order for future branches, created from trunk, to -benefit. -

-

Time intervals used to create branches and tags may vary, just as -different needs may arrive. For example, consider the release schema -of CentOS distribution: one major release every 2 years, security -updates every 6 months, support for 7 years long. Each time a CentOS -distribution is released, specially if it is a major release, there is -a theme need in order to cover CentOS distribution artwork -requirements. At this point, is where CentOS Artwork Repository comes -up to scene. -

-

Before releasing a new major release of CentOS distribution we create -a branch for one of several theme development lines available inside -the CentOS Artwork Repository, perform quality assurance on it, and -later, freeze that branch using tags. Once a the theme branch has been -frozen (under `tags/' directory), CentOS Packagers (the persons -whom build CentOS distribution) can use that frozen branch as source -location to fulfill CentOS distribution artwork needs. The same -applies to CentOS Webmasters (the persons whom build CentOS websites), -and any other visual manifestation required by the project. -

- - -

3.41.2.4 Parallel directories

- -

Inside CentOS Artwork Repository, parallel directories are simple -directory entries built from a common parent directory and placed in a -location different to that, the common parent directory is placed on. -Parallel directories are useful to create branches, tags, -translations, documentation, pre-rendering configuration script, and -similar directory structures. -

-

Parallel directories take their structure from one unique parent -directory. Inside CentOS Artwork Repository, this unique parent -directory is under `trunk/Identity' location. The -`trunk/Identity' location must be considered the reference for -whatever information you plan to create inside the repository. -

-

In some circumstances, parallel directories may be created removing -uncommon information from their paths. Uncommon path information -refers to those directory levels in the path which are not common for -other parallel directories. For example, when rendering -`trunk/Identity/Themes/Motifs/TreeFlower/Distro' directory -structure, the `centos-art.sh' script removes the -`Motifs/TreeFlower/' directory levels from path, in order to -build the parallel directory used to retrived translations, and -pre-rendering configuration scripts required by render -functionality. -

-

Another example where parallel directory removes the uncommon path -information is when we use the manual functionality. This time, -`centos-art.sh' script uses parallel directory information -(without uncommon directory levels) to build the documentation entry -required by Texinfo documentation system, inside the repository. -

-
-

trunk/Identity/Models/Img/Scripts/Bash/Functions/Path/figure-3 - -

Figure 3.17: Parallel directories removing uncommon information. - -

-

Othertimes, parallel directories may add uncommon information to their -paths. This is the case we use to create branches and tags. When we -create branches and tags, a numerical identifier is added to parallel -directory structure path. The place where the numerical identifier is -set on is relevant to corporate visual identity structure and should -be carefully considered where it will be. -

-
-

trunk/Identity/Models/Img/Scripts/Bash/Functions/Path/figure-4 - -

Figure 3.18: Parallel directories adding uncommon information. - -

-

When one parent directory changes, all their related parallel -directories need to be changed too. This is required in order for -parallel directories to retain their relation with the parent -directory structure. In the other hand, parallel directories should -never be modified under no reason but to satisfy the relation to their -parent directory structure. Liberal change of parallel directories -may suppresses the conceptual idea they were initially created for; -and certainly, things may stop working the way they should do. -

-
-

trunk/Identity/Models/Img/Scripts/Bash/Functions/Path/figure-5 - -

Figure 3.19: Wrong construction of parallel directories. - -

- - -

3.41.2.5 Syncronizing path information

- -

Creating parallel directories is very useful to keep repository -organized but introduce some complications. For instance, consider -what would happen to functionalities like manual (`trunk -Scripts Bash Functions Manual') that rely on parent directory -structures to create documentation entries (using parallel directory -structures) if one of those parent directory structures suddenly -changes after the documentation entry has been already created for it? -

-

If that is the case, functionalities like manual may confuse -themselves if path information is not updated to reflect the relation -with its parent directory. Such functionalities work with parent -directory structure as reference; if a parent directory changes, the -functionalities dont't even note it because they work with the last -parent directory structure available in the repository, no matter what -it is. -

-

In the specific case of documentation (the manual -functionality), the problem mentioned above provokes that older parent -directories, already documented, remain inside documentation directory -structures as long as you get your hands into the documentation -directory structure (`trunk/Manuals') and change what must be -changed to match the new parent directory structure. -

-

There is no way for manual, and similar functionalities that -use parent directories as reference, to know when and how directory -movements take place inside the repository. Such information is -available only when movement actions, like thoses achived by -rm or mv commands, take place inside the -repository. So, is there, at the moment of moving files, when we need -to syncronize parallel directories with their unique parent directory -structure. -

-

Syncronizing parallel directories with their respecitive parent -directory implies moving files inside the repository, i.e. we need to, -firstly, rebuild the path information for each parallel directory -inside the repository, using the current path of its parent directory -as reference, and later, use the new path information to move each old -parallel directory from its old location to its new location based on -an updated path information. -

-
Warning

Warning

Even Subversion supports URL to refere sources and -destinations of resources inside the central repository, the -`centos-art.sh' script does not. The `centos-art.sh' script -is designed to work inside working copies only. -

- -

As CentOS Artwork Repository is built over a version control system, -file movements inside the repository are considered repository -changes. In order for these repository changes to be versioned, we -need to, firstly, add changes related files into version control -system, and later, use commands from the version control system to -move those files already versioned. This configuration makes possible -for everyone to know about changes details inside the repository; and -if needed, revert or update them back to a previous revision. -

-

Finally, once all file corrections have been already made, the -syncronization action takes care of updating path references inside -related files. Updating path references inside related files is -specially important for documentation files where documentation nodes -are built using repository path information as reference. -

- - -

3.41.2.6 What is the right place to store it?

- -

Occasionly, you may find that new corporate visual identity components -need to be added to the repository. If that is your case, the first -question you need to ask yourself, before start to create directories -blindly all over, is: What is the right place to store it? -

-

The CentOS Community different free support vains (see: -http://wiki.centos.org/GettingHelp) are the best place to find -answers to your question, but going there with hands empty is not good -idea. It may give the impression you don't really care about. Instead, -consider the following suggestions to find your own comprehension and -so, make your propositions based on it. -

-

When we are looking for the correct place to store new files, to bear -in mind the corporate visual identity structure used inside the CentOS -Artwork Repository (see section trunk/Identity) would be probaly the best -advice we could offer, the rest is just matter of choosing appropriate -names. To illustrate this desition process let's consider the -`trunk/Identity/Themes/Motifs/TreeFlower' directory as -example. It is the trunk development line of TreeFlower's artistic -motif. Artistic motifs are considered part of themes, which in turn -are considered part of CentOS corporate visual identity. -

-

When building parent directory structures, you may find that reaching -an acceptable location may take some time, and as it uses to happen -most of time; once you've find it, that may be not a definite -solution. There are many concepts that you need to play with, in -order to find a result that match the conceptual idea you try to -implement in the new directory location. To know which these concepts -are, split the location in words and read its documentation entry from -less specific to more specific. -

-

For example, the `trunk/Identity/Themes/Motifs/TreeFlower' -location evolved through several months of contant work and there is -no certain it won't change in the future, even it fixes quite well the -concept we are trying to implement. The concepts used in -`trunk/Identity/Themes/Distro/Motifs/TreeFlower' location are -described in the following commands, respectively: -

-
centos-art manual --read=turnk/
-centos-art manual --read=turnk/Identity/
-centos-art manual --read=turnk/Identity/Themes/
-centos-art manual --read=turnk/Identity/Themes/Motifs/
-centos-art manual --read=turnk/Identity/Themes/Motifs/TreeFlower/
-
-

Other location concepts can be found similary as we did above, just -change the location we used above by the one you are trying to know -concepts for. -

- - +

3.41.3 Usage

-
-
centos-art path --copy=SRC --to=DST
-

Use this command to duplicate `SRC' in working copy, -remembering history. In this command, `SRC' and -`DST' can each be either a working copy (WC) path or -URL: -

-
-
`WC -> WC'
-

Copy and schedule for addition (with history). -

-
-
`WC -> URL (Not supported)'
-

Immediately commit a copy of WC to URL. -

-
-
`URL -> WC (Not supported)'
-

Check out URL into WC, schedule for addition. -

-
-
`URL -> URL (Not supported)'
-

Complete server-side copy; used to branch and tag. -

-
+
    +
  • ... +
-
-
centos-art path --move=SRC --to=DST
-
-
`WC -> WC'
-

Move and schedule for addition (with history). -

-
`URL -> URL (Not supported)'
-

Complete server-side rename. -

-
-
-
centos-art path --delete='SRC'
-

Use this command to remove files and directories from version control. -In this command, `SRC' can be a working copy (WC) path or URL. -

-
-
`WC'
-

Each item specified by a PATH is scheduled for deletion upon the next -commit. Files, and directories that have not been committed, are -immediately removed from the working copy. PATHs that are, or -contain, unversioned or modified items will not be removed unless the -`--force' option is given. -

-
-
`URL (Not supported)'
-

Each item specified by a URL is deleted from the repository via an -immediate commit. -

-
-
-
- - - +

3.41.4 See also

- - - -
3.36 trunk/Scripts/Bash   -
3.37 trunk/Scripts/Bash/Functions   -
- - + + - +
[ < ][ > ]
[ < ][ > ]   [ << ] [ Up ][ >> ][ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_45.html b/Manuals/en/Html/Repository/repository_45.html index e58b96f..f826ad0 100644 --- a/Manuals/en/Html/Repository/repository_45.html +++ b/Manuals/en/Html/Repository/repository_45.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.42 trunk/Scripts/Bash/Functions/Render +The CentOS Artwork Repository: 3.42 trunk/Scripts/Bash/Functions/Path - - + + @@ -59,55 +54,450 @@ ul.toc {list-style: none} - - + + - + - +
[ < ][ > ]
[ < ][ > ]   [ << ] [ Up ][ >> ][ >> ]         [Top] [Contents][Index][Index] [ ? ]
- + + +

3.42 trunk/Scripts/Bash/Functions/Path

+ + + +

3.42.1 Goals

+ +

This section exists to organize files related to path +functiontionality of `centos-art.sh' script. The path +functionality of `centos-art.sh' script standardizes movement, +syncronization, branching, tagging, and general file maintainance +inside the repository. +

+ + +

3.42.2 Description

+ +

"CentOS like trees, has roots, trunk, branches, leaves and +flowers. Day by day they work together in freedom, ruled by the laws +of nature and open standards, to show the beauty of its existence." +

+ + +

3.42.2.1 Repository layout

+ +

The repository layout describes organization of files and directories +inside the repository. The repository layout provides the standard +backend required for automation scripts to work correctly. If such +layout changes unexpectedly, automation scripts may confuse themselves +and stop doing what we expect from them to do. +

+

As convenction, inside CentOS Artwork Repository, we organize files +and directories, related to CentOS corporate visual identity, under +three top level directories named `trunk/', `branches/', and +`tags/'. +

+
+

trunk/Identity/Models/Img/Scripts/Bash/Functions/Path/figure-6 + +

Figure 3.15: The CentOS Artwork Repository layout. + +

+

The `trunk/' directory (see section trunk) organizes the main +development line of CentOS corporate visual identity. Inside +`trunk/' directory structure, the CentOS corporate visual +identity concepts are implemented using directories. There is one +directory level for each relevant concept inside the repository. The +`trunk/' directory structure is mainly used to develop CentOS +corporate visual identity. +

+

The `branches/' directory (see section branches) oranizes parallel +development lines to `trunk/' directory. The `branches/' +directory is used to set points in time where develpment lines are +devided one from another taking separte and idependent lives that +share a common past from the point they were devided on. The +`branches/' directory is mainly used to perform quality assurance +on CentOS corporate visual identity. +

+

The `tags/' directory (see section tags) organizes parallel frozen +lines to `branches/' directory. The parallel frozen lines are +immutable, nothing change inside them once they has been created. The +`tags/' directory is mainly used to publish final releases of +CentOS corporate visual identity. +

+

The CentOS Artwork Repository layout is firmly grounded on a +Subversion base. Subversion (http://subversion.tigris.org) is a +version control system, which allows you to keep old versions of files +and directories (usually source code), keep a log of who, when, and +why changes occurred, etc., like CVS, RCS or SCCS. Subversion keeps a +single copy of the master sources. This copy is called the source +"repository"; it contains all the information to permit extracting +previous versions of those files at any time. +

+ + +

3.42.2.2 Repository name convenctions

+ +

Repository name convenctions help us to maintain consistency of names +inside the repository. +

+

Repository name convenctions are applied to files and directories +inside the repository layout. As convenction, inside the repository +layout, file names are all written in lowercase +(`01-welcome.png', `splash.png', `anaconda_header.png', +etc.) and directory names are all written capitalized (e.g., +`Identity', `Themes', `Motifs', `TreeFlower', +etc.). +

+

Repository name convenctions are implemented inside the +cli_getRepoName function of `centos-art.sh' script. With +cli_getRepoName function we reduce the amount of commands and +convenctions to remember, concentrating them in just one single place +to look for fixes and improvements. +

+ + +

3.42.2.3 Repository work flow

+ +

Repository work flow describes the steps and time intervals used to +produce CentOS corporate visual identity inside CentOS Artwork +Repository. +

+

To illustrate repository work flow let's consider themes' development +cycle. +

+

Initially, we start working themes on their trunk development line +(e.g., `trunk/Identity/Themes/Motifs/TreeFlower/'), here we +organize information that cannot be produced automatically (i.e., +background images, concepts, color information, screenshots, etc.). +

+

Later, when theme trunk development line is considered "ready" for +implementation (e.g., all required backgrounds have been designed), +we create a branch for it (e.g., +`branches/Identity/Themes/Motifs/TreeFlower/1/'). Once the +branch has been created, we forget that branch and continue working +the trunk development line while others (e.g., an artwork quality +assurance team) test the new branch for tunning it up. +

+

Once the branch has been tunned up, and considered "ready" for +release, it is freezed under `tags/' directory (e.g., +`tags/Identity/Themes/Motifs/TreeFower/1.0/') for packagers, +webmasters, promoters, and anyone who needs images from that CentOS +theme the tag was created for. +

+

Both branches and tags, inside CentOS Artwork Repository, use +numerical values to identify themselves under the same location. +Branches start at one (i.e., `1') and increment one unit for each +branch created from the same trunk development line. Tags start at +zero (i.e., `0') and increment one unit for each tag created from +the same branch development line. +

+
+

trunk/Identity/Models/Img/Scripts/Bash/Functions/Path/figure-1 + +

Figure 3.16: Name convention for tags and branches creation. + +

+
Convenction

Convenction

Do not freeze trunk development lines using tags +directly. If you think you need to freeze a trunk development line, +create a branch for it and then freeze that branch instead. +

+ +

The trunk development line may introduce problems we cannot see +immediatly. Certainly, the high changable nature of trunk development +line complicates finding and fixing such problems. On the other hand, +the branched development lines provide a more predictable area where +only fixes/corrections to current content are commited up to +repository. +

+

If others find and fix bugs inside the branched development line, we +could merge such changes/experiences back to trunk development line +(not visversa) in order for future branches, created from trunk, to +benefit. +

+

Time intervals used to create branches and tags may vary, just as +different needs may arrive. For example, consider the release schema +of CentOS distribution: one major release every 2 years, security +updates every 6 months, support for 7 years long. Each time a CentOS +distribution is released, specially if it is a major release, there is +a theme need in order to cover CentOS distribution artwork +requirements. At this point, is where CentOS Artwork Repository comes +up to scene. +

+

Before releasing a new major release of CentOS distribution we create +a branch for one of several theme development lines available inside +the CentOS Artwork Repository, perform quality assurance on it, and +later, freeze that branch using tags. Once a the theme branch has been +frozen (under `tags/' directory), CentOS Packagers (the persons +whom build CentOS distribution) can use that frozen branch as source +location to fulfill CentOS distribution artwork needs. The same +applies to CentOS Webmasters (the persons whom build CentOS websites), +and any other visual manifestation required by the project. +

+ -

3.42 trunk/Scripts/Bash/Functions/Render

+

3.42.2.4 Parallel directories

+ +

Inside CentOS Artwork Repository, parallel directories are simple +directory entries built from a common parent directory and placed in a +location different to that, the common parent directory is placed on. +Parallel directories are useful to create branches, tags, +translations, documentation, pre-rendering configuration script, and +similar directory structures. +

+

Parallel directories take their structure from one unique parent +directory. Inside CentOS Artwork Repository, this unique parent +directory is under `trunk/Identity' location. The +`trunk/Identity' location must be considered the reference for +whatever information you plan to create inside the repository. +

+

In some circumstances, parallel directories may be created removing +uncommon information from their paths. Uncommon path information +refers to those directory levels in the path which are not common for +other parallel directories. For example, when rendering +`trunk/Identity/Themes/Motifs/TreeFlower/Distro' directory +structure, the `centos-art.sh' script removes the +`Motifs/TreeFlower/' directory levels from path, in order to +build the parallel directory used to retrived translations, and +pre-rendering configuration scripts required by render +functionality. +

+

Another example where parallel directory removes the uncommon path +information is when we use the manual functionality. This time, +`centos-art.sh' script uses parallel directory information +(without uncommon directory levels) to build the documentation entry +required by Texinfo documentation system, inside the repository. +

+
+

trunk/Identity/Models/Img/Scripts/Bash/Functions/Path/figure-3 + +

Figure 3.17: Parallel directories removing uncommon information. + +

+

Othertimes, parallel directories may add uncommon information to their +paths. This is the case we use to create branches and tags. When we +create branches and tags, a numerical identifier is added to parallel +directory structure path. The place where the numerical identifier is +set on is relevant to corporate visual identity structure and should +be carefully considered where it will be. +

+
+

trunk/Identity/Models/Img/Scripts/Bash/Functions/Path/figure-4 +

Figure 3.18: Parallel directories adding uncommon information. + +

+

When one parent directory changes, all their related parallel +directories need to be changed too. This is required in order for +parallel directories to retain their relation with the parent +directory structure. In the other hand, parallel directories should +never be modified under no reason but to satisfy the relation to their +parent directory structure. Liberal change of parallel directories +may suppresses the conceptual idea they were initially created for; +and certainly, things may stop working the way they should do. +

+
+

trunk/Identity/Models/Img/Scripts/Bash/Functions/Path/figure-5 + +

Figure 3.19: Wrong construction of parallel directories. + +

-

3.42.1 Goals

+

3.42.2.5 Syncronizing path information

- +

Creating parallel directories is very useful to keep repository +organized but introduce some complications. For instance, consider +what would happen to functionalities like manual (`trunk +Scripts Bash Functions Manual') that rely on parent directory +structures to create documentation entries (using parallel directory +structures) if one of those parent directory structures suddenly +changes after the documentation entry has been already created for it? +

+

If that is the case, functionalities like manual may confuse +themselves if path information is not updated to reflect the relation +with its parent directory. Such functionalities work with parent +directory structure as reference; if a parent directory changes, the +functionalities dont't even note it because they work with the last +parent directory structure available in the repository, no matter what +it is. +

+

In the specific case of documentation (the manual +functionality), the problem mentioned above provokes that older parent +directories, already documented, remain inside documentation directory +structures as long as you get your hands into the documentation +directory structure (`trunk/Manuals') and change what must be +changed to match the new parent directory structure. +

+

There is no way for manual, and similar functionalities that +use parent directories as reference, to know when and how directory +movements take place inside the repository. Such information is +available only when movement actions, like thoses achived by +rm or mv commands, take place inside the +repository. So, is there, at the moment of moving files, when we need +to syncronize parallel directories with their unique parent directory +structure. +

+

Syncronizing parallel directories with their respecitive parent +directory implies moving files inside the repository, i.e. we need to, +firstly, rebuild the path information for each parallel directory +inside the repository, using the current path of its parent directory +as reference, and later, use the new path information to move each old +parallel directory from its old location to its new location based on +an updated path information. +

+
Warning

Warning

Even Subversion supports URL to refere sources and +destinations of resources inside the central repository, the +`centos-art.sh' script does not. The `centos-art.sh' script +is designed to work inside working copies only. +

+

As CentOS Artwork Repository is built over a version control system, +file movements inside the repository are considered repository +changes. In order for these repository changes to be versioned, we +need to, firstly, add changes related files into version control +system, and later, use commands from the version control system to +move those files already versioned. This configuration makes possible +for everyone to know about changes details inside the repository; and +if needed, revert or update them back to a previous revision. +

+

Finally, once all file corrections have been already made, the +syncronization action takes care of updating path references inside +related files. Updating path references inside related files is +specially important for documentation files where documentation nodes +are built using repository path information as reference. +

-

3.42.2 Description

- - +

3.42.2.6 What is the right place to store it?

+

Occasionly, you may find that new corporate visual identity components +need to be added to the repository. If that is your case, the first +question you need to ask yourself, before start to create directories +blindly all over, is: What is the right place to store it? +

+

The CentOS Community different free support vains (see: +http://wiki.centos.org/GettingHelp) are the best place to find +answers to your question, but going there with hands empty is not good +idea. It may give the impression you don't really care about. Instead, +consider the following suggestions to find your own comprehension and +so, make your propositions based on it. +

+

When we are looking for the correct place to store new files, to bear +in mind the corporate visual identity structure used inside the CentOS +Artwork Repository (see section trunk/Identity) would be probaly the best +advice we could offer, the rest is just matter of choosing appropriate +names. To illustrate this desition process let's consider the +`trunk/Identity/Themes/Motifs/TreeFlower' directory as +example. It is the trunk development line of TreeFlower's artistic +motif. Artistic motifs are considered part of themes, which in turn +are considered part of CentOS corporate visual identity. +

+

When building parent directory structures, you may find that reaching +an acceptable location may take some time, and as it uses to happen +most of time; once you've find it, that may be not a definite +solution. There are many concepts that you need to play with, in +order to find a result that match the conceptual idea you try to +implement in the new directory location. To know which these concepts +are, split the location in words and read its documentation entry from +less specific to more specific. +

+

For example, the `trunk/Identity/Themes/Motifs/TreeFlower' +location evolved through several months of contant work and there is +no certain it won't change in the future, even it fixes quite well the +concept we are trying to implement. The concepts used in +`trunk/Identity/Themes/Distro/Motifs/TreeFlower' location are +described in the following commands, respectively: +

+
centos-art manual --read=turnk/
+centos-art manual --read=turnk/Identity/
+centos-art manual --read=turnk/Identity/Themes/
+centos-art manual --read=turnk/Identity/Themes/Motifs/
+centos-art manual --read=turnk/Identity/Themes/Motifs/TreeFlower/
+
+

Other location concepts can be found similary as we did above, just +change the location we used above by the one you are trying to know +concepts for. +

3.42.3 Usage

- +
+
centos-art path --copy=SRC --to=DST
+

Use this command to duplicate `SRC' in working copy, +remembering history. In this command, `SRC' and +`DST' can each be either a working copy (WC) path or +URL: +

+
+
`WC -> WC'
+

Copy and schedule for addition (with history). +

+
+
`WC -> URL (Not supported)'
+

Immediately commit a copy of WC to URL. +

+
+
`URL -> WC (Not supported)'
+

Check out URL into WC, schedule for addition. +

+
+
`URL -> URL (Not supported)'
+

Complete server-side copy; used to branch and tag. +

+
+ +
+
centos-art path --move=SRC --to=DST
+
+
`WC -> WC'
+

Move and schedule for addition (with history). +

+
`URL -> URL (Not supported)'
+

Complete server-side rename. +

+
+ +
+
centos-art path --delete='SRC'
+

Use this command to remove files and directories from version control. +In this command, `SRC' can be a working copy (WC) path or URL. +

+
+
`WC'
+

Each item specified by a PATH is scheduled for deletion upon the next +commit. Files, and directories that have not been committed, are +immediately removed from the working copy. PATHs that are, or +contain, unversioned or modified items will not be removed unless the +`--force' option is given. +

+
+
`URL (Not supported)'
+

Each item specified by a URL is deleted from the repository via an +immediate commit. +

+
+
+

3.42.4 See also

- +
3.43 trunk/Scripts/Bash/Functions/Render/Config   +
3.37 trunk/Scripts/Bash   +
3.38 trunk/Scripts/Bash/Functions  
@@ -117,12 +507,12 @@ ul.toc {list-style: none} [ > ]   [ << ] -[ Up ] -[ >> ] +[ Up ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_46.html b/Manuals/en/Html/Repository/repository_46.html index dbbbf83..ec3071f 100644 --- a/Manuals/en/Html/Repository/repository_46.html +++ b/Manuals/en/Html/Repository/repository_46.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.43 trunk/Scripts/Bash/Functions/Render/Config +The CentOS Artwork Repository: 3.43 trunk/Scripts/Bash/Functions/Render - - + + @@ -64,232 +59,65 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] - + -

3.43 trunk/Scripts/Bash/Functions/Render/Config

+

3.43 trunk/Scripts/Bash/Functions/Render

3.43.1 Goals

-

The `trunk/Scripts/Bash/Config' directory exists to oraganize -pre-rendering configuration scripts. -

+ +

3.43.2 Description

-

Pre-rendering configuration scripts let you customize the way -centos-art.sh script renders identity and translation -repository entries. Pre-rendering configuration scripts are -`render.conf.sh' files with render_loadConfig function -definition inside. -

-

There is one `render.conf.sh' file for each pre-rendering -configuration entry. Pre-rendering configuration entries can be based -both on identity and translation repository entires. Pre-rendering -configuration entries are required for each identity entry, but not -for translation entries. -

- - -

3.43.2.1 The `render.conf.sh' identity model

- -

Inside CentOS Artwork Repository, we consider identity entries to all -directories under `trunk/Identity' directory. Identity entries can be -image-based or text-based. When you render image-based identity -entries you need to use image-based pre-rendering configuration -scripts. Likewise, when you render text-based identity entries you -need to use text-based pre-rendering configuration scripts. -

-

Inside identity pre-rendering configuration scripts, image-based -pre-rendering configuration scripts look like the following: -

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

Inside identity pre-rendering configuration scripts, text-based -pre-rendering configuration scripts look like the following: -

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

When using identity pre-rendering configuration scripts, you can -extend both image-based and text-based pre-rendering configuration -scripts using image-based and text-based post-rendering actions, -respectively. -

- - -

3.43.2.2 The `render.conf.sh' translation model

- -

Translation pre-rendering configuration scripts take precedence before -default translation rendering action. Translation pre-rendering -actions are useful when default translation rendering action do not -fit itself to translation entry rendering requirements. -

+ - -

3.43.2.3 The `render.conf.sh' rendering actions

-

Inside both image-based and text-based identity pre-rendering -configuration scripts, we use the `ACTIONS' array variable to -define the way centos-art.sh script performs identity -rendering. Identity rendering is organized by one `BASE' action, -and optional `POST' and `LAST' rendering actions. -

-

The `BASE' action specifies what kind of rendering does the -centos-art.sh script will perform with the files related to -the pre-rendering configuration script. The `BASE' action is -required. Possible values to `BASE' action are either -`renderImage' or `renderText' only. -

-

To specify the `BASE' action you need to set the `BASE:' -string followed by one of the possible values. For example, if you -want to render images, consider the following definition of -`BASE' action: -

-
ACTIONS[0]='BASE:renderImage'
-
-

Only one `BASE' action must be specified. If more than one -`BASE' action is specified, the last one is used. If no -`BASE' action is specified at all, an error is triggered and the -centos-art.sh script ends its execution. -

-

The `POST' action specifies which action to apply for -each file rendered (at the rendering time). This action is optional. -You can set many different `POST' actions to apply many different -actions over the same already rendered file. Possible values to -`POST' action are `renderFormats', `renderSyslinux', -`renderGrub', etc. -

-

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

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

In the previous example, file organization takes place at the moment -of rendering, just after producing the `png' base file and before -going to the next file in the list of files to render. If you don't -want to organized the produced files in directories named as their own -extensions, just remove the `POST:groupByFormat' action line: -

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

The `LAST' action specifies which actions to apply once the last -file in the list of files to process has been rendered. The -`LAST' action is optional. Possible values for `LAST' -actions may be `groupByFormat', `renderGdmTgz', etc. -

-
info

Note

See section trunk/Scripts/Bash/Functions/Render, to know more -about possible values for `BASE', `POST' and `LAST' -action definitions. -

- -

To specify the `LAST' action, you need to set the `LAST:' -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: -

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

3.43.3 Usage

-

Use the following commands to administer both identity and translation -pre-rendering configuration scripts: -

-
-
`centos-art config --create='path/to/dir/''
-
-

Use this command to create `path/to/dir' related pre-rendering -configuration script. -

-
-
`centos-art config --edit='path/to/dir/''
-
-

Use this command to edit `path/to/dir' related pre-rendering -configuration script. -

-
-
`centos-art config --read='path/to/dir/''
-
-

Use this command to read `path/to/dir' related pre-rendering -configuration script. -

-
-
`centos-art config --remove='path/to/dir/''
-
-

Use this command to remove `path/to/dir' related pre-rendering -configuration script. -

-
-
+ -

In the commands above, `path/to/dir' refers to one renderable -directory path under `trunk/Identity' or -`trunk/Translations' structures only. -

- +

3.43.4 See also

- - -
3.36 trunk/Scripts/Bash   -
3.37 trunk/Scripts/Bash/Functions   -
3.42 trunk/Scripts/Bash/Functions/Render   +
3.44 trunk/Scripts/Bash/Functions/Render/Config  
- - + + - +
[ < ][ > ]
[ < ][ > ]   [ << ] [ Up ][ >> ][ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_47.html b/Manuals/en/Html/Repository/repository_47.html index b25aff4..d5a4d15 100644 --- a/Manuals/en/Html/Repository/repository_47.html +++ b/Manuals/en/Html/Repository/repository_47.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.44 trunk/Scripts/Bash/Functions/Shell +The CentOS Artwork Repository: 3.44 trunk/Scripts/Bash/Functions/Render/Config - - + + @@ -59,210 +54,222 @@ ul.toc {list-style: none} - - + + - + - +
[ < ][ > ]
[ < ][ > ]   [ << ] [ Up ][ >> ][ >> ]         [Top] [Contents][Index][Index] [ ? ]
- - -

3.44 trunk/Scripts/Bash/Functions/Shell

+ + +

3.44 trunk/Scripts/Bash/Functions/Render/Config

- +

3.44.1 Goals

-

This section exists to organize files related to shell -functionality of `centos-art.sh' script. +

The `trunk/Scripts/Bash/Config' directory exists to oraganize +pre-rendering configuration scripts.

- +

3.44.2 Description

-

The shell functionality of `centos-art.sh' script helps -you to maintain bash scripts inside repository. For example, suppose -you've created many functionalities for `centos-art.sh' script, -and you want to use a common copyright and license note for -consistency in all your script files. If you have a bunch of files, -doing this one by one wouldn't be a big deal. In contrast, if the -amount of files grows, updating the copyright and license note for all -of them would be a task rather tedious. The shell functionality -exists to solve maintainance tasks just as the one previously -mentioned. +

Pre-rendering configuration scripts let you customize the way +centos-art.sh script renders identity and translation +repository entries. Pre-rendering configuration scripts are +`render.conf.sh' files with render_loadConfig function +definition inside. +

+

There is one `render.conf.sh' file for each pre-rendering +configuration entry. Pre-rendering configuration entries can be based +both on identity and translation repository entires. Pre-rendering +configuration entries are required for each identity entry, but not +for translation entries. +

+ + +

3.44.2.1 The `render.conf.sh' identity model

+ +

Inside CentOS Artwork Repository, we consider identity entries to all +directories under `trunk/Identity' directory. Identity entries can be +image-based or text-based. When you render image-based identity +entries you need to use image-based pre-rendering configuration +scripts. Likewise, when you render text-based identity entries you +need to use text-based pre-rendering configuration scripts.

-

When you use shell functionality to update copyright inside -script files, it is required that your script files contain (at least) -the following top commentary structure: +

Inside identity pre-rendering configuration scripts, image-based +pre-rendering configuration scripts look like the following:

-
-
 1| #!/bin/bash
- 2| #
- 3| # doSomething.sh -- The function description goes here.
- 4| # 
- 5| # Copyright
- 6| #
- 7| # ...
- 8| #
- 9| # ----------------------------------------------------------------------
-10| # $Id$
-11| # ----------------------------------------------------------------------
-12|
-13| function doSomething {
-14|     
-15| }
+
#!/bin/bash
+
+function render_loadConfig {
+
+    # Define rendering actions.
+    ACTIONS[0]='BASE:renderImage'
+    ACTIONS[1]='POST:renderFormats: tif xpm pdf ppm'
+
+}
 

-

Figure 3.20: The functions script base comment structure - +

Inside identity pre-rendering configuration scripts, text-based +pre-rendering configuration scripts look like the following:

-

Relevant lines in the above structure are lines from 5 to 9. -Everything else in the file is left immutable. +

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

When using identity pre-rendering configuration scripts, you can +extend both image-based and text-based pre-rendering configuration +scripts using image-based and text-based post-rendering actions, +respectively.

-

When you are updating copyright through shell -functionality, the `centos-art.sh' script replaces everything -in-between line 5 --the first one matching `^# Copyright .+$' -string-- and line 9--the first long dash separator matching `^# --+$'-- with the content of copyright template instance. + + +

3.44.2.2 The `render.conf.sh' translation model

+ +

Translation pre-rendering configuration scripts take precedence before +default translation rendering action. Translation pre-rendering +actions are useful when default translation rendering action do not +fit itself to translation entry rendering requirements.

-
Caution

Caution

Be sure to add the long dash separator that matches -`^# -+$' regular expression before the function -definition. Otherwise, if the `Copyright' line is present but no -long dash separator exists, `centos-art.sh' will remove anything -in-between the `Copyright' line and the end of file. This way you -may lost your function definitions entirely. -

-

The copyright template instance is created from one copyright template -stored in the `Config/tpl_forCopyright.sed' file. The template -instance is created once, and later removed when no longer needed. At -this moment, when template instance is created, the -`centos-art.sh' script takes advantage of automation in order to -set copyright full name and date dynamically. + +

3.44.2.3 The `render.conf.sh' rendering actions

+ +

Inside both image-based and text-based identity pre-rendering +configuration scripts, we use the `ACTIONS' array variable to +define the way centos-art.sh script performs identity +rendering. Identity rendering is organized by one `BASE' action, +and optional `POST' and `LAST' rendering actions.

-

When you use shell functionality to update copyright, the first -thing `shell' functionality does is requesting copyright -information to user, and later, if values were left empty (i.e., no -value was typed before pressing RET key), the `shell' -functionality uses its own default values. +

The `BASE' action specifies what kind of rendering does the +centos-art.sh script will perform with the files related to +the pre-rendering configuration script. The `BASE' action is +required. Possible values to `BASE' action are either +`renderImage' or `renderText' only.

-

When shell functionality uses its own default values, the final -copyright note looks like the following: +

To specify the `BASE' action you need to set the `BASE:' +string followed by one of the possible values. For example, if you +want to render images, consider the following definition of +`BASE' action:

-
-
 1| #!/bin/bash
- 2| #
- 3| # doSomthing.sh -- The function description goes here.
- 4| #
- 5| # Copyright (C) 2003, 2010 The CentOS Project
- 6| # 
- 7| # This program is free software; you can redistribute it and/or modify
- 8| # it under the terms of the GNU General Public License as published by
- 9| # the Free Software Foundation; either version 2 of the License, or
-10| # (at your option) any later version.
-11| # 
-12| # This program is distributed in the hope that it will be useful, but
-13| # WITHOUT ANY WARRANTY; without even the implied warranty of
-14| # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-15| # General Public License for more details.
-16| #
-17| # You should have received a copy of the GNU General Public License
-18| # along with this program; if not, write to the Free Software
-19| # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
-20| # USA.
-21| #
-22| # ----------------------------------------------------------------------
-23| # $Id$
-24| # ----------------------------------------------------------------------
-25|
-26| function doSomething {
-27|
-28| }
+
ACTIONS[0]='BASE:renderImage'
 

-

Figure 3.21: The function script comment example - +

Only one `BASE' action must be specified. If more than one +`BASE' action is specified, the last one is used. If no +`BASE' action is specified at all, an error is triggered and the +centos-art.sh script ends its execution.

-

Relevant lines in the above structure are lines from 5 to 22. Pay -attention how the copyright line was built, and how the license was -added into the top comment where previously was just three dots. -Everything else in the file was left immutable. +

The `POST' action specifies which action to apply for +each file rendered (at the rendering time). This action is optional. +You can set many different `POST' actions to apply many different +actions over the same already rendered file. Possible values to +`POST' action are `renderFormats', `renderSyslinux', +`renderGrub', etc.

-

To change copyright information (i.e., full name or year information), -run the shell functionality over the root directory containing -the script files you want to update copyright in and enter the -appropriate information when it be requested. You can run the -shell functionality as many times as you need to. +

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

-

To change copyright license (i.e., the text in-between lines 7 and -20), you need to edit the `Config/tpl_forCopyright.sed' file, set -the appropriate information, and run the shell functionality -once again for changes to take effect over the files you specify. -

-
Important

Important

The `centos-art.sh' script is released as: +

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

In the previous example, file organization takes place at the moment +of rendering, just after producing the `png' base file and before +going to the next file in the list of files to render. If you don't +want to organized the produced files in directories named as their own +extensions, just remove the `POST:groupByFormat' action line:

-
GNU GENERAL PUBLIC LICENSE
-Version 2, June 1991
-
-Copyright (C) 1989, 1991 Free Software Foundation, Inc.
-59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
ACTIONS[0]='BASE:renderImage'
+ACTIONS[1]='POST:renderFormats: xpm jpg tif'
 

-
Do not change the license information under which `centos-art.sh'
-script is released. Instead, if you think a different license must be
-used, please share your reasons at CentOS Developers mailing list.
+
The `LAST' action specifies which actions to apply once the last
+file in the list of files to process has been rendered. The
+`LAST' action is optional. Possible values for `LAST'
+actions may be `groupByFormat', `renderGdmTgz', etc.
+

+
info
Note
 See section trunk/Scripts/Bash/Functions/Render, to know more
+about possible values for `BASE', `POST' and `LAST'
+action definitions.
 

 
+
To specify the `LAST' action, you need to set the `LAST:'
+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:
+

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

 
 
 
 3.44.3 Usage 

 
+
Use the following commands to administer both identity and translation
+pre-rendering configuration scripts:
+

 

-
 centos-art sh --update-copyright='path/to/dir'

-
 centos-art sh --update-copyright='path/to/dir' --filter='regex'

-
Use these commands to update copyright information in `.sh' files
-under `path/to/dir' directory. 
-

-

-
-
When you provide `--filter='regex'' argument, the list of files
-to process is reduced as specified in `regex' regular expression.
-Inside `centos-art.sh' script, the `regex' regular
-expression is used in combination with find command to look
-for files matching the regular expression path pattern.
+
 `centos-art config --create='path/to/dir/''

+

+
Use this command to create `path/to/dir' related pre-rendering
+configuration script.
 

-
Warning
Warning
 In order for `regex' regular expression to match
-a file, the `regex' regular expresion must match the whole file
-path not just the file name. 
-

-
-
For example, if you want to match all `render.conf.sh' files
-inside `path/to/dir', use the .+/render.conf regular
-expression.  Later, `centos-art.sh' script uses this value inside
-^$REGEX\.sh$ expression in order to build the final regular
-expression (i.e., ^.+/render.conf\.sh$) that is evaluated
-against available file paths inside the list of files to process.
+

+
 `centos-art config --edit='path/to/dir/''

+

+
Use this command to edit `path/to/dir' related pre-rendering
+configuration script.  
+

+

+
 `centos-art config --read='path/to/dir/''

+

+
Use this command to read `path/to/dir' related pre-rendering
+configuration script.  
 

-
Exceptionally, when you provide `--filter='regex'' in the way
-that `regex', appended to `path/to/dir/' (i.e.
-`path/to/dir/regex'), matches a regular file; the
-`centos-art.sh' script uses the file matching as only file in the
-list of files to process. 
+

+
 `centos-art config --remove='path/to/dir/''

+

+
Use this command to remove `path/to/dir' related pre-rendering
+configuration script.
+

+

+
+
+
In the commands above, `path/to/dir' refers to one renderable
+directory path under `trunk/Identity' or
+`trunk/Translations' structures only. 
 

 
 
 
 3.44.4 See also 

 
 
-
+
-
3.36 trunk/Scripts/Bash  
+
3.37 trunk/Scripts/Bash  
+
3.38 trunk/Scripts/Bash/Functions  
 
3.37 trunk/Scripts/Bash/Functions  
+
3.43 trunk/Scripts/Bash/Functions/Render  
 

 

 
@@ -272,12 +279,12 @@ list of files to process.
 [ > ]
    
 [ << ]
-[ Up ]
-[ >> ]
+[ Up ]
+[ >> ]
 
 

  
-  This document was generated on December, 26 2010 using texi2html 1.76.
+  This document was generated on January, 3 2011 using texi2html 1.76.
  
  

 
diff --git a/Manuals/en/Html/Repository/repository_48.html b/Manuals/en/Html/Repository/repository_48.html
index 67aabfe..b91d4b6 100644
--- a/Manuals/en/Html/Repository/repository_48.html
+++ b/Manuals/en/Html/Repository/repository_48.html
@@ -1,13 +1,8 @@
 
 
-
-
+
 
 
-CentOS Artwork Repository: 3.45 trunk/Scripts/Bash/Functions/Svg
+The CentOS Artwork Repository: 3.45 trunk/Scripts/Bash/Functions/Shell
 
-
-
+
+
 
 
 
@@ -64,202 +59,170 @@ ul.toc {list-style: none}
    
 [ << ]
 [ Up ]
-[ >> ]
+[ >> ]
    
    
    
    
 [Top]
 [Contents]
-[Index]
+[Index]
 [ ? ]
 
-
+
 
-
 3.45 trunk/Scripts/Bash/Functions/Svg 

+
 3.45 trunk/Scripts/Bash/Functions/Shell 

 
 
 
 
 3.45.1 Goals 

 
-
This section exists to organize files related to svg
+
This section exists to organize files related to shell
 functionality of `centos-art.sh' script.
 

 
 
 
 3.45.2 Description 

 
-
The svg functionality of `centos-art.sh' script helps you
-to maintain scalable vector graphics (SVG) inside repository. For
-example, suppose you've been working in CentOS default design models
-under `trunk/Identity/Themes/Models/', and you want to set common
-metadata to all of them, and later remove all unused SVG defintions
-from `*.svg' files. Doing so file by file may be a tedious task,
-so the `centos-art.sh' script provides the svg
-functionality to aid you maintain such actions.
-

-
-
-
-
 3.45.2.1 Metadata maintainance 

-
-
The metadata used is defined by Inkscape 0.46 using the SVG standard
-markup. The `centos-art.sh' script replaces everything
-in-between <metadata and </metadata> tags with a
-predefined metadata template we've set for this purpose.
-

-
The metadata template was created using the metadata information of a
-file which, using Inkscape 0.46, all metadata fields were set. This
-created a complete markup representation of how SVG metadata would
-look like. Later, we replaced every single static value with a
-translation marker in the form `=SOMETEXT=', where
-SOMETEXT is the name of its main opening tag. Later, we
-transform the metadata template into a sed replacement set of commads
-escaping new lines at the end of each line.
+
The shell functionality of `centos-art.sh' script helps
+you to maintain bash scripts inside repository. For example, suppose
+you've created many functionalities for `centos-art.sh' script,
+and you want to use a common copyright and license note for
+consistency in all your script files. If you have a bunch of files,
+doing this one by one wouldn't be a big deal. In contrast, if the
+amount of files grows, updating the copyright and license note for all
+of them would be a task rather tedious. The shell functionality
+exists to solve maintainance tasks just as the one previously
+mentioned.
 

-
With metadata template in place, the `centos-art.sh' script uses
-it to create a metadata template instance for the file being processed
-currently.  The metadata template instance contains the metadata
-portion of sed replacement commands with translation markers already
-traduced.  In this action, instance creation, is where we take
-advantage of automation and generate metadata values like title, date,
-keywords, source, identifier, and relation dynamically, based on the
-file path `centos-art.sh' script is currently creating metadata
-information for.
+
When you use shell functionality to update copyright inside
+script files, it is required that your script files contain (at least)
+the following top commentary structure:
 

-
With metadata template instance in place, the `centos-art.sh'
-script uses it to replace real values inside all `.svg' files
-under the current location you're running the `centos-art.sh'
-script on.  Default behaviour is to ask user to enter each metadatum
-required, one by one. If user leaves metadatum empty, by pressing
-RET key, `centos-art.sh' uses its default value.
+

+
 1| #!/bin/bash
+ 2| #
+ 3| # doSomething.sh -- The function description goes here.
+ 4| # 
+ 5| # Copyright
+ 6| #
+ 7| # ...
+ 8| #
+ 9| # ----------------------------------------------------------------------
+10| # $Id$
+11| # ----------------------------------------------------------------------
+12|
+13| function doSomething {
+14|     
+15| }
+

+
Figure 3.20: The functions script base comment structure
+
 

-
The `centos-art.sh' script modifies the following metadata:
+
Relevant lines in the above structure are lines from 5 to 9.
+Everything else in the file is left immutable.
 

-

-
 `Title'

-
Name by which this document is formally known. If no value is set
-here, `centos-art.sh' script uses the file name as title.
-

-

-
 `Date'

-
Date associated with the creation of this document (YYYY-MM-DD). If no
-value is set here, `centos-art.sh' script uses the current date
-information as in date +%Y-%m-%d.
-

-

-
 `Creator'

-
Name of entity primarily responsible for making the content of this
-document. If no value is set here, `centos-art.sh' script uses
-the string `The CentOS Project'.
+
When you are updating copyright through shell
+functionality,  the `centos-art.sh' script replaces everything
+in-between line 5 --the first one matching `^# Copyright .+$'
+string-- and line 9--the first long dash separator matching `^#
+-+$'-- with the content of copyright template instance.
 

-

-
 `Rights'

-
Name of entity with rights to the intellectual Property of this
-document. If no value is set here, `centos-art.sh' script uses
-the string `The CentOS Project'.
-

-

-
 `Publisher'

-
Name of entity responsible for making this document available. If no
-value is set here, `centos-art.sh' script uses the string
-`The CentOS Project'.
-

-

-
 `Identifier'

-
Unique URI to reference this document. If no value is set here,
-`centos-art.sh' script uses the current file path to build the
-related url that points to current file location inside repository
-central server.
+
Caution
Caution
 Be sure to add the long dash separator that matches
+`^# -+$' regular expression before the function
+definition. Otherwise, if the `Copyright' line is present but no
+long dash separator exists, `centos-art.sh' will remove anything
+in-between the `Copyright' line and the end of file. This way you
+may lost your function definitions entirely.
+

+
+
The copyright template instance is created from one copyright template
+stored in the `Config/tpl_forCopyright.sed' file.  The template
+instance is created once, and later removed when no longer needed. At
+this moment, when template instance is created, the
+`centos-art.sh' script takes advantage of automation in order to
+set copyright full name and date dynamically.
 

-

-
 `Source'

-
Unique URI to reference the source of this document. If no value is
-set here, `centos-art.sh' script uses current file path to build
-the related url that points to current file location inside repository
-central server.
+
When you use shell functionality to update copyright, the first
+thing `shell' functionality does is requesting copyright
+information to user, and later, if values were left empty (i.e., no
+value was typed before pressing RET key), the `shell'
+functionality uses its own default values.
 

-

-
 `Relation'

-
Unique URI to a related document. If no value is set here,
-`centos-art.sh' script uses current file path to build the
-related url that points to current file location inside repository
-central server.
+
When shell functionality uses its own default values, the final
+copyright note looks like the following:
 

-

-
 `Language'

-
Two-letter language tag with optional subtags for the language of this
-document. (e.g. `en-GB'). If no value is set here,
-`centos-art.sh' script uses the current locale information as in
-cli_getCurrentLocale function.
+

+
 1| #!/bin/bash
+ 2| #
+ 3| # doSomthing.sh -- The function description goes here.
+ 4| #
+ 5| # Copyright (C) 2003, 2010 The CentOS Project
+ 6| # 
+ 7| # This program is free software; you can redistribute it and/or modify
+ 8| # it under the terms of the GNU General Public License as published by
+ 9| # the Free Software Foundation; either version 2 of the License, or
+10| # (at your option) any later version.
+11| # 
+12| # This program is distributed in the hope that it will be useful, but
+13| # WITHOUT ANY WARRANTY; without even the implied warranty of
+14| # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+15| # General Public License for more details.
+16| #
+17| # You should have received a copy of the GNU General Public License
+18| # along with this program; if not, write to the Free Software
+19| # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+20| # USA.
+21| #
+22| # ----------------------------------------------------------------------
+23| # $Id$
+24| # ----------------------------------------------------------------------
+25|
+26| function doSomething {
+27|
+28| }
+

+
Figure 3.21: The function script comment example
+
 

-

-
 `Keywords'

-
The topic of this document as comma-separated key words, prhases, or
-classifications. If no value is set here, `centos-art.sh' script
-uses file path to build 
+
Relevant lines in the above structure are lines from 5 to 22.  Pay
+attention how the copyright line was built, and how the license was
+added into the top comment where previously was just three dots.
+Everything else in the file was left immutable. 
 

-

-
 `Coverage'

-
Extent or scope of this document. If no value is set here,
-`centos-art.sh' script uses the string `The CentOS Project'.
+
To change copyright information (i.e., full name or year information),
+run the shell functionality over the root directory containing
+the script files you want to update copyright in and enter the
+appropriate information when it be requested. You can run the
+shell functionality as many times as you need to.
 

-

-
 `Description'

-
Description about the document. If no value is set here,
-`centos-art.sh' script uses uses empty value as default.
+
To change copyright license (i.e., the text in-between lines 7 and
+20), you need to edit the `Config/tpl_forCopyright.sed' file, set
+the appropriate information, and run the shell functionality
+once again for changes to take effect over the files you specify.
 

-

-
 `Contributors'

-
People that contributes in the creation/maintainance of the document.
-If no value is set here, `centos-art.sh' script uses uses empty
-value as default.
-

-

-
-
The `License' metadatum is not set as a choise, by now. It is
-fixed Creative Common Attribution Share-Alike 3.0 License. This is done in order to
-grant license consistency among all SVG files we manage inside CentOS
-Artwork Repository.
+
Important
Important
 The `centos-art.sh' script is released as: 
 

-
+
GNU GENERAL PUBLIC LICENSE
+Version 2, June 1991
 
-
-
 3.45.2.2 Unused definitions 

+Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+

+
Do not change the license information under which `centos-art.sh'
+script is released. Instead, if you think a different license must be
+used, please share your reasons at CentOS Developers mailing list.
+

 
-
Many of the no-longer-used gradients, patterns, and markers (more
-precisely, those which you edited manually) remain in the
-corresponding palettes and can be reused for new objects. However if
-you want to optimize your document, use the `Vacuum Defs' command
-in `File' menu. It will remove any gradients, patterns, or
-markers which are not used by anything in the document, making the
-file smaller. 
-

-
If you have one or two couple of files, removing unused definitions
-using the graphical interface may be enough to you.  In contrast, if
-you have dozens or even houndreds of scalable vector graphics files to
-maintain it is not a fun task to use the graphical interface to remove
-unused definitions editing those files one by one.
-

-
To remove unused definitions from several scalable vector graphics
-files, the `centos-art.sh' script uses Inkscape's command-line
-interface, specifically with the `--vaccum-defs' option.
-

 
-
+
 
 3.45.3 Usage 

 
 

-
 centos-art svg --update-metadata='path/to/dir'

-
 centos-art svg --update-metadata='path/to/dir' --filter='regex'

-
Use these commands to update metadata information to `.svg' files
-under `path/to/dir' directory.
-

-

-
 centos-art svg --vacuum-defs='path/to/dir'

-
 centos-art svg --vacuum-defs='path/to/dir' --filter='regex'

-
Use these commands to remove unused definitions inside `.svg'
-files under `path/to/dir' directory. 
+
 centos-art sh --update-copyright='path/to/dir'

+
 centos-art sh --update-copyright='path/to/dir' --filter='regex'

+
Use these commands to update copyright information in `.sh' files
+under `path/to/dir' directory. 
 

 

 
@@ -274,12 +237,12 @@ a file, the `regex' regular expresion must match the whole file
 path not just the file name.
-

For example, if you want to match all `summary.svg' files inside -`path/to/dir', use the .+/summary regular expression. -Later, `centos-art.sh' script uses this value inside -^$REGEX\.svg$ expression in order to build the final regular -expression (i.e., ^.+/summary\.svg$) that is evaluated against -available file paths inside the list of files to process. +

For example, if you want to match all `render.conf.sh' files +inside `path/to/dir', use the .+/render.conf regular +expression. Later, `centos-art.sh' script uses this value inside +^$REGEX\.sh$ expression in order to build the final regular +expression (i.e., ^.+/render.conf\.sh$) that is evaluated +against available file paths inside the list of files to process.

Exceptionally, when you provide `--filter='regex'' in the way that `regex', appended to `path/to/dir/' (i.e. @@ -288,28 +251,28 @@ that `regex', appended to `path/to/dir/' (i.e. list of files to process.

- +

3.45.4 See also

- -
3.36 trunk/Scripts/Bash   +
3.37 trunk/Scripts/Bash  
3.37 trunk/Scripts/Bash/Functions   +
3.38 trunk/Scripts/Bash/Functions  
- - + + - +
[ < ][ > ]
[ < ][ > ]   [ << ] [ Up ][ >> ][ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_49.html b/Manuals/en/Html/Repository/repository_49.html index 3d6586e..29653ff 100644 --- a/Manuals/en/Html/Repository/repository_49.html +++ b/Manuals/en/Html/Repository/repository_49.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.46 trunk/Scripts/Bash/Functions/Verify +The CentOS Artwork Repository: 3.46 trunk/Scripts/Bash/Functions/Svg - - + + @@ -59,285 +54,257 @@ ul.toc {list-style: none} - - + + - + - +
[ < ][ > ]
[ < ][ > ]   [ << ] [ Up ][ >> ][ >> ]         [Top] [Contents][Index][Index] [ ? ]
- - -

3.46 trunk/Scripts/Bash/Functions/Verify

+ + +

3.46 trunk/Scripts/Bash/Functions/Svg

- +

3.46.1 Goals

-

This section exists to organize files related to `centos-art.sh' -script `verify' functionality. The `verify' -functionality of `centos-art.sh' script helps you to verify the -workstation configuration you are planning to use as host for your -working copy of CentOS Artwork Repository. +

This section exists to organize files related to svg +functionality of `centos-art.sh' script.

- +

3.46.2 Description

-

The first time you download CentOS Artwork Repository you need to -configure your workstation in order to use `centos-art.sh' -script. These preliminar configurations are based mainly on auxiliar -RPM packages installation, symbolic links creations, and environment -variables definitions. The `verify' functionality of -`centos-art.sh' script guides you through this preliminar -configuration process. -

-

If this is the first time you run `centos-art.sh' script, the -appropriate way to use its `verify' functionality is not using -the `centos-art.sh' script directly, but the absolute path to -centos-art.sh script instead (i.e., -`~/artwork/trunk/Scripts/Bash/centos-art.sh'). This is necessary -because `centos-art' symbolic link, under `~/bin/' -directory, has not been created yet. +

The svg functionality of `centos-art.sh' script helps you +to maintain scalable vector graphics (SVG) inside repository. For +example, suppose you've been working in CentOS default design models +under `trunk/Identity/Themes/Models/', and you want to set common +metadata to all of them, and later remove all unused SVG defintions +from `*.svg' files. Doing so file by file may be a tedious task, +so the `centos-art.sh' script provides the svg +functionality to aid you maintain such actions.

+ - -

3.46.2.1 Packages

+ +

3.46.2.1 Metadata maintainance

-

Installation of auxiliar RPM packages provides the software required -to manipulate files inside the repository (e.g., image files, -documentation files, translation files, script files, etc.). Most of -RPM packages centos-art.sh script uses are shipped with -CentOS distribution, and can be installed from CentOS base repository. -The only exception is `inkscape', the package we use to -manipulate SVG files. The `inkscape' package is not inside -CentOS distribution so it needs to be installed from third party -repositories. +

The metadata used is defined by Inkscape 0.46 using the SVG standard +markup. The `centos-art.sh' script replaces everything +in-between <metadata and </metadata> tags with a +predefined metadata template we've set for this purpose.

-
info

Note

Configuration of third party repositories inside CentOS -distribution is described in CentOS wiki, specifically in the -following URL: -http://wiki.centos.org/AdditionalResources/Repositories -

- -

Before installing packages, the `centos-art.sh' script uses -sudo to request root privileges to execute yum's -installation functionality. If your user isn't defined as a -privileged user--at least to run yum commands-- inside -`/etc/sudoers' configuration file, you will not be able to -perform package installation tasks as set in `centos-art.sh' -script `verify' functionality. +

The metadata template was created using the metadata information of a +file which, using Inkscape 0.46, all metadata fields were set. This +created a complete markup representation of how SVG metadata would +look like. Later, we replaced every single static value with a +translation marker in the form `=SOMETEXT=', where +SOMETEXT is the name of its main opening tag. Later, we +transform the metadata template into a sed replacement set of commads +escaping new lines at the end of each line.

-

Setting sudo privileges to users is an administrative task you have to -do by yourself. If you don't have experience with sudo -command, please read its man page running the command: man -sudo. This reading will be very useful, and with some practice, you -will be able to configure your users to have sudo -privileges. +

With metadata template in place, the `centos-art.sh' script uses +it to create a metadata template instance for the file being processed +currently. The metadata template instance contains the metadata +portion of sed replacement commands with translation markers already +traduced. In this action, instance creation, is where we take +advantage of automation and generate metadata values like title, date, +keywords, source, identifier, and relation dynamically, based on the +file path `centos-art.sh' script is currently creating metadata +information for.

- - -

3.46.2.2 Links

- -

Creation of symbolic links helps us to alternate between different -implementations of `centos-art.sh' script-line (e.g., -`centos-art.sh', for Bash implementation; `centos-art.py', -for Python implementation; `centos-art.pl', for Perl -implementation; and so on for other implementations). The -`centos-art.sh' script-line definition takes place inside your -personal binary (`~/bin/') directory in order to make the script -implementation --the one that `centos-art' links to-- available -to PATH environment variable. +

With metadata template instance in place, the `centos-art.sh' +script uses it to replace real values inside all `.svg' files +under the current location you're running the `centos-art.sh' +script on. Default behaviour is to ask user to enter each metadatum +required, one by one. If user leaves metadatum empty, by pressing +RET key, `centos-art.sh' uses its default value.

-

Creation of symbolic links helps us to reuse components from repository -working copy. For example, color information files maintained inside -your working copy must never be duplicated inside program-specific -configuration directories that uses them in your workstation (e.g., -Gimp, Inkscape, etc.). Instead, a symbolic link must be created for -each one of them, from program-specific configuration directories to -files in the working copy. In this configuration, when someone -commits changes to color information files up to central repository, -they--the changes committed-- will be immediatly available to your -programs the next time you update your working copy --the place -inside your workstation those color information files are stored--. +

The `centos-art.sh' script modifies the following metadata:

-

Creation of symbolic links helps us to make `centos-art.sh' -script functionalities available outside `trunk/' repository -directory structure, but at its same level in repository tree. This is -useful if you need to use the "render" functionality of -centos-art.sh under `branches/' repository directory -structure as you usually do inside `trunk/' repository directory -structure. As consequence of this configuration, automation scripts -cannot be branched under `branches/Scripts' directory structure. +

+
`Title'
+

Name by which this document is formally known. If no value is set +here, `centos-art.sh' script uses the file name as title.

- - -

3.46.2.3 Environment variables

- -

Definition of environemnt variables helps us to set default values to -our user session life. The user session environment variable defintion -takes place in the user's `~/.bash_profile' file. The -`verify' functionality of `centos-art.sh' script doesn't -modify your `~/.bash_profile' file. +

+
`Date'
+

Date associated with the creation of this document (YYYY-MM-DD). If no +value is set here, `centos-art.sh' script uses the current date +information as in date +%Y-%m-%d.

-

The `verify' functionality of `centos-art.sh' script -evaluates the following environment variables: +

+
`Creator'
+

Name of entity primarily responsible for making the content of this +document. If no value is set here, `centos-art.sh' script uses +the string `The CentOS Project'.

-
-
EDITOR
-

Default text editor. +

+
`Rights'
+

Name of entity with rights to the intellectual Property of this +document. If no value is set here, `centos-art.sh' script uses +the string `The CentOS Project'.

-

The `centos-art.sh' script uses default text EDITOR to edit -pre-commit subversion messages, translation files, configuration -files, script files, and similar text-based files. +

+
`Publisher'
+

Name of entity responsible for making this document available. If no +value is set here, `centos-art.sh' script uses the string +`The CentOS Project'.

-

If EDITOR environment variable is not set, `centos-art.sh' -script uses `/usr/bin/vim' as default text editor. Otherwise, the -following values are recognized by `centos-art.sh' script: +

+
`Identifier'
+

Unique URI to reference this document. If no value is set here, +`centos-art.sh' script uses the current file path to build the +related url that points to current file location inside repository +central server.

-
    -
  • `/usr/bin/vim' -
  • `/usr/bin/emacs' -
  • `/usr/bin/nano' -
- -

If no one of these values is set in EDITOR environment variable, -`centos-art.sh' uses `/usr/bin/vim' text editor by default. +

+
`Source'
+

Unique URI to reference the source of this document. If no value is +set here, `centos-art.sh' script uses current file path to build +the related url that points to current file location inside repository +central server.

-
TZ
-
-

Default time zone representation. +

`Relation'
+

Unique URI to a related document. If no value is set here, +`centos-art.sh' script uses current file path to build the +related url that points to current file location inside repository +central server.

-

Time representation inside repository server is set to Coordinated -Universal Time (UTC). Time represetation inside repository working -copies is set as their administrators personally define. +

+
`Language'
+

Two-letter language tag with optional subtags for the language of this +document. (e.g. `en-GB'). If no value is set here, +`centos-art.sh' script uses the current locale information as in +cli_getCurrentLocale function.

-

When repository working copies time representation be defined, it -would be a very good convention to follow if working copies -administrators would set their systems clock to use UTC. Otherwise it -would be difficult for working copies users to find out when changes -were committed up to repository server exactly in time. +

+
`Keywords'
+

The topic of this document as comma-separated key words, prhases, or +classifications. If no value is set here, `centos-art.sh' script +uses file path to build

-
Info

Tip

Coordinated Univeral Time (UTC) representation can be -configured when you install CentOS distribution; or later, runing the -system-config-date command at a shell prompt from your -graphical interface. -

- -
info

Note

If you set your system clock to use UTC representation, -you also need to set the TZ environment variable inside -`~/.bash_profile' as follows: -

export TZ=UTC
-

This is required in order for your terminal to display the correct -time information of your zone, taking UTC representation as reference. -

-
-
TEXTDOMAIN
-
-

Default domain used to retrieve translated messages. This value is -set in `initFunctions.sh' and shouldn't be changed. +

`Coverage'
+

Extent or scope of this document. If no value is set here, +`centos-art.sh' script uses the string `The CentOS Project'.

-
TEXTDOMAINDIR
-
-

Default directory used to retrieve translated messages. This value is -set in `initFunctions.sh' and shouldn't be changed. +

`Description'
+

Description about the document. If no value is set here, +`centos-art.sh' script uses uses empty value as default.

-
LANG
-
-

Default locale information. This value is set when you start your -session and can be changed using the `locale' functionality of -`centos-art.sh' script (see section trunk/Scripts/Bash/Functions/Locale, for more information). +

`Contributors'
+

People that contributes in the creation/maintainance of the document. +If no value is set here, `centos-art.sh' script uses uses empty +value as default.

- - -

3.46.3 Usage

- -
-
`centos-art verify --packages'
-

Verify required packages your workstation needs in order to run the -`centos-art.sh' script correctly. If there are missing packages, -the `centos-art.sh' script asks you to confirm their -installation. When installing packages, the `centos-art.sh' -script uses the yum application in order to achieve the -task. +

The `License' metadatum is not set as a choise, by now. It is +fixed Creative Common Attribution Share-Alike 3.0 License. This is done in order to +grant license consistency among all SVG files we manage inside CentOS +Artwork Repository.

-

In case all packages required by `centos-art.sh' script are -already installed in your workstation, the message `The required -packages are already installed.' is output for you to know. + + + +

3.46.2.2 Unused definitions

+ +

Many of the no-longer-used gradients, patterns, and markers (more +precisely, those which you edited manually) remain in the +corresponding palettes and can be reused for new objects. However if +you want to optimize your document, use the `Vacuum Defs' command +in `File' menu. It will remove any gradients, patterns, or +markers which are not used by anything in the document, making the +file smaller.

-
-
`centos-art verify --links'
-

Verify required links your workstation needs in order to run the -centos-art command correctly. If any required link is missing, the -centos-art.sh script asks you to confirm their installation. -To install required links, the centos-art.sh script uses the -ln command. +

If you have one or two couple of files, removing unused definitions +using the graphical interface may be enough to you. In contrast, if +you have dozens or even houndreds of scalable vector graphics files to +maintain it is not a fun task to use the graphical interface to remove +unused definitions editing those files one by one.

-

In case all links required by `centos-art.sh' script are already -created in your workstation, the message `The required links are -already installed.' is output for you to know. +

To remove unused definitions from several scalable vector graphics +files, the `centos-art.sh' script uses Inkscape's command-line +interface, specifically with the `--vaccum-defs' option.

-

In case a regular file exists with the same name of a required link, -the `centos-art.sh' script outputs the `Already exists as -regular file.' message when listing required links that will be -installed. Of course, as there is already a regular file where must be -a link, no link is created. In such cases the `centos-art.sh' -script will fall into a continue installation request for that missing -link. To end this continue request you can answer `No', or -remove the existent regular file to let `centos-art.sh' script -install the link on its place. + + +

3.46.3 Usage

+ +
+
centos-art svg --update-metadata='path/to/dir'
+
centos-art svg --update-metadata='path/to/dir' --filter='regex'
+

Use these commands to update metadata information to `.svg' files +under `path/to/dir' directory.

-
`centos-art verify --environment'
-
`centos-art verify --environment --filter='regex''
-

Output a brief description of environment variables used by -`centos-art.sh' script. -

-

If `--filter' option is provided, output is reduced as defined in -the `regex' regular expression value. If `--filter' option -is specified but `regex' value is not, the `centos-art.sh' -script outputs information as if `--filter' option had not been -provided at all. +

centos-art svg --vacuum-defs='path/to/dir'
+
centos-art svg --vacuum-defs='path/to/dir' --filter='regex'
+

Use these commands to remove unused definitions inside `.svg' +files under `path/to/dir' directory.

+

When you provide `--filter='regex'' argument, the list of files +to process is reduced as specified in `regex' regular expression. +Inside `centos-art.sh' script, the `regex' regular +expression is used in combination with find command to look +for files matching the regular expression path pattern. +

+
Warning

Warning

In order for `regex' regular expression to match +a file, the `regex' regular expresion must match the whole file +path not just the file name. +

+ +

For example, if you want to match all `summary.svg' files inside +`path/to/dir', use the .+/summary regular expression. +Later, `centos-art.sh' script uses this value inside +^$REGEX\.svg$ expression in order to build the final regular +expression (i.e., ^.+/summary\.svg$) that is evaluated against +available file paths inside the list of files to process. +

+

Exceptionally, when you provide `--filter='regex'' in the way +that `regex', appended to `path/to/dir/' (i.e. +`path/to/dir/regex'), matches a regular file; the +`centos-art.sh' script uses the file matching as only file in the +list of files to process. +

- +

3.46.4 See also

- -
3.36 trunk/Scripts/Bash   +
3.37 trunk/Scripts/Bash  
3.37 trunk/Scripts/Bash/Functions   +
3.38 trunk/Scripts/Bash/Functions  
- - + + - - + +
[ < ][ > ]
[ < ][ > ]   [ << ][ Up ][ >> ][ Up ][ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_5.html b/Manuals/en/Html/Repository/repository_5.html index 6d839ac..39ec48c 100644 --- a/Manuals/en/Html/Repository/repository_5.html +++ b/Manuals/en/Html/Repository/repository_5.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.2 trunk/Identity/Brands +The CentOS Artwork Repository: 3.2 trunk/Identity/Brands - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -106,11 +101,11 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_50.html b/Manuals/en/Html/Repository/repository_50.html index 86aca80..d236c61 100644 --- a/Manuals/en/Html/Repository/repository_50.html +++ b/Manuals/en/Html/Repository/repository_50.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.47 trunk/Scripts/Bash/Locale +The CentOS Artwork Repository: 3.47 trunk/Scripts/Bash/Functions/Verify - - + + @@ -59,58 +54,289 @@ ul.toc {list-style: none} - - + + - + - +
[ < ][ > ]
[ < ][ > ]   [ << ] [ Up ][ >> ][ >> ]         [Top] [Contents][Index][Index] [ ? ]
- + + +

3.47 trunk/Scripts/Bash/Functions/Verify

+ + + +

3.47.1 Goals

+ +

This section exists to organize files related to `centos-art.sh' +script `verify' functionality. The `verify' +functionality of `centos-art.sh' script helps you to verify the +workstation configuration you are planning to use as host for your +working copy of CentOS Artwork Repository. +

+ + +

3.47.2 Description

+ +

The first time you download CentOS Artwork Repository you need to +configure your workstation in order to use `centos-art.sh' +script. These preliminar configurations are based mainly on auxiliar +RPM packages installation, symbolic links creations, and environment +variables definitions. The `verify' functionality of +`centos-art.sh' script guides you through this preliminar +configuration process. +

+

If this is the first time you run `centos-art.sh' script, the +appropriate way to use its `verify' functionality is not using +the `centos-art.sh' script directly, but the absolute path to +centos-art.sh script instead (i.e., +`~/artwork/trunk/Scripts/Bash/centos-art.sh'). This is necessary +because `centos-art' symbolic link, under `~/bin/' +directory, has not been created yet. +

+ -

3.47 trunk/Scripts/Bash/Locale

+

3.47.2.1 Packages

+

Installation of auxiliar RPM packages provides the software required +to manipulate files inside the repository (e.g., image files, +documentation files, translation files, script files, etc.). Most of +RPM packages centos-art.sh script uses are shipped with +CentOS distribution, and can be installed from CentOS base repository. +The only exception is `inkscape', the package we use to +manipulate SVG files. The `inkscape' package is not inside +CentOS distribution so it needs to be installed from third party +repositories. +

+
info

Note

Configuration of third party repositories inside CentOS +distribution is described in CentOS wiki, specifically in the +following URL: +http://wiki.centos.org/AdditionalResources/Repositories +

+ +

Before installing packages, the `centos-art.sh' script uses +sudo to request root privileges to execute yum's +installation functionality. If your user isn't defined as a +privileged user--at least to run yum commands-- inside +`/etc/sudoers' configuration file, you will not be able to +perform package installation tasks as set in `centos-art.sh' +script `verify' functionality. +

+

Setting sudo privileges to users is an administrative task you have to +do by yourself. If you don't have experience with sudo +command, please read its man page running the command: man +sudo. This reading will be very useful, and with some practice, you +will be able to configure your users to have sudo +privileges. +

-

3.47.1 Goals

+

3.47.2.2 Links

-

This section exists to organize translation messages and templates -used by `centos-art.sh' script. +

Creation of symbolic links helps us to alternate between different +implementations of `centos-art.sh' script-line (e.g., +`centos-art.sh', for Bash implementation; `centos-art.py', +for Python implementation; `centos-art.pl', for Perl +implementation; and so on for other implementations). The +`centos-art.sh' script-line definition takes place inside your +personal binary (`~/bin/') directory in order to make the script +implementation --the one that `centos-art' links to-- available +to PATH environment variable. +

+

Creation of symbolic links helps us to reuse components from repository +working copy. For example, color information files maintained inside +your working copy must never be duplicated inside program-specific +configuration directories that uses them in your workstation (e.g., +Gimp, Inkscape, etc.). Instead, a symbolic link must be created for +each one of them, from program-specific configuration directories to +files in the working copy. In this configuration, when someone +commits changes to color information files up to central repository, +they--the changes committed-- will be immediatly available to your +programs the next time you update your working copy --the place +inside your workstation those color information files are stored--. +

+

Creation of symbolic links helps us to make `centos-art.sh' +script functionalities available outside `trunk/' repository +directory structure, but at its same level in repository tree. This is +useful if you need to use the "render" functionality of +centos-art.sh under `branches/' repository directory +structure as you usually do inside `trunk/' repository directory +structure. As consequence of this configuration, automation scripts +cannot be branched under `branches/Scripts' directory structure.

-

3.47.2 Description

+

3.47.2.3 Environment variables

-

Translated messages of `centos-art.sh' script are managed using -GNU gettext utilities. Most translation actions have been -automated through `centos-art.sh' script "locale" functionality -(see section trunk/Scripts/Bash/Functions/Locale). +

Definition of environemnt variables helps us to set default values to +our user session life. The user session environment variable defintion +takes place in the user's `~/.bash_profile' file. The +`verify' functionality of `centos-art.sh' script doesn't +modify your `~/.bash_profile' file. +

+

The `verify' functionality of `centos-art.sh' script +evaluates the following environment variables: +

+
+
EDITOR
+

Default text editor. +

+

The `centos-art.sh' script uses default text EDITOR to edit +pre-commit subversion messages, translation files, configuration +files, script files, and similar text-based files.

+

If EDITOR environment variable is not set, `centos-art.sh' +script uses `/usr/bin/vim' as default text editor. Otherwise, the +following values are recognized by `centos-art.sh' script: +

+
    +
  • `/usr/bin/vim' +
  • `/usr/bin/emacs' +
  • `/usr/bin/nano' +
+ +

If no one of these values is set in EDITOR environment variable, +`centos-art.sh' uses `/usr/bin/vim' text editor by default. +

+
+
TEXTDOMAIN
+
+

Default domain used to retrieve translated messages. This variable is +set in `initFunctions.sh' and shouldn't be changed. +

+
+
TEXTDOMAINDIR
+
+

Default directory used to retrieve translated messages. This variable +is set in `initFunctions.sh' and shouldn't be changed. +

+
+
LANG
+
+

Default locale information. +

+

This variable is initially set in the configuration process of CentOS +distribution installer (i.e., Anaconda), specifically in the +`Language' step; or once installed using the +system-config-language tool. +

+

The `centos-art.sh' script uses the LANG environment +variable to know in which language the script messages are printed +out. +

+
+
TZ
+
+

Default time zone representation. +

+

This variable is initially set in the configuration process of CentOS +distribution installer (i.e., Anaconda), specifically in the +`Date and time' step; or once installed using the +system-config-date tool. +

+

The `centos-art.sh' script doesn't use the TZ environment +variable information at all. Instead, this variable is used by the +system shell to show the time information according to your phisical +location on planet Earth. +

+

Inside your computer, the time information is firstly set in the BIOS +clock (which may need correction), and later in the configuration +process of CentOS distribution installer (or later, by any of the +related configuration tools inside CentOS distribution). Generally, +setting time information is a straight-forward task and configuration +tools available do cover most relevant location. However, if you need +a time precision not provided by the configuration tools available +inside CentOS distribution then, using TZ variable may be +necessary. +

+
Convenction

Convenction

In order to keep changes syncronized between +central repository and its working copies: configure both repository +server and workstations (i.e., the place where each working copy is +set on) to use Coordinated Universal Time (UTC) as base time +representation. Later, correct the time information for your specific +location using time zone correction. +

+ +

The format of TZ environment variable is described in +`tzset(3)' manual page. +

+
+
+

3.47.3 Usage

-

The content of `trunk/Scripts/Bash/Locale' directory should not -be managed manually. Instead, use the "locale" functionality of -`centos-art.sh' script. See section trunk/Scripts/Bash/Functions/Locale, for more information on how to use `centos-art.sh' -"locale" functionality. +

+
centos-art verify --packages
+
+

Verify required packages your workstation needs in order to run the +`centos-art.sh' script correctly. If there are missing packages, +the `centos-art.sh' script asks you to confirm their +installation. When installing packages, the `centos-art.sh' +script uses the yum application in order to achieve the +task. +

+

In case all packages required by `centos-art.sh' script are +already installed in your workstation, the message `The required +packages are already installed.' is output for you to know. +

+
+
centos-art verify --links
+
+

Verify required links your workstation needs in order to run the +centos-art command correctly. If any required link is missing, the +centos-art.sh script asks you to confirm their installation. +To install required links, the centos-art.sh script uses the +ln command.

+

In case all links required by `centos-art.sh' script are already +created in your workstation, the message `The required links are +already installed.' is output for you to know. +

+

In case a regular file exists with the same name of a required link, +the `centos-art.sh' script outputs the `Already exists as +regular file.' message when listing required links that will be +installed. Of course, as there is already a regular file where must be +a link, no link is created. In such cases the `centos-art.sh' +script will fall into a continue installation request for that missing +link. To end this continue request you can answer `No', or +remove the existent regular file to let `centos-art.sh' script +install the link on its place. +

+
+
centos-art verify --environment
+
centos-art verify --environment --filter='regex'
+
+

Output a brief description of environment variables used by +`centos-art.sh' script. +

+

If `--filter' option is provided, output is reduced as defined in +the `regex' regular expression value. If `--filter' option +is specified but `regex' value is not, the `centos-art.sh' +script outputs information as if `--filter' option had not been +provided at all. +

+
+
+

3.47.4 See also

- -
3.37 trunk/Scripts/Bash/Functions   +
3.37 trunk/Scripts/Bash  
3.35 trunk/Scripts   +
3.38 trunk/Scripts/Bash/Functions  
@@ -120,12 +346,12 @@ be managed manually. Instead, use the "locale" functionality of [ > ]   [ << ] -[ Up ] -[ >> ] +[ Up ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_51.html b/Manuals/en/Html/Repository/repository_51.html index 98d7bef..6e774e9 100644 --- a/Manuals/en/Html/Repository/repository_51.html +++ b/Manuals/en/Html/Repository/repository_51.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.48 trunk/Scripts/Perl +The CentOS Artwork Repository: 3.48 trunk/Scripts/Bash/Locale - - + + @@ -64,40 +59,55 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] - + -

3.48 trunk/Scripts/Perl

+

3.48 trunk/Scripts/Bash/Locale

3.48.1 Goals

-
    -
  • ... -
- +

This section exists to organize translation messages and templates +used by `centos-art.sh' script. +

3.48.2 Description

+

Translated messages of `centos-art.sh' script are managed using +GNU gettext utilities. Most translation actions have been +automated through `centos-art.sh' script "locale" functionality +(see section trunk/Scripts/Bash/Functions/Locale). +

3.48.3 Usage

+

The content of `trunk/Scripts/Bash/Locale' directory should not +be managed manually. Instead, use the "locale" functionality of +`centos-art.sh' script. See section trunk/Scripts/Bash/Functions/Locale, for more information on how to use `centos-art.sh' +"locale" functionality. +

3.48.4 See also

+ + + +
3.38 trunk/Scripts/Bash/Functions   +
3.36 trunk/Scripts   +
@@ -106,11 +116,11 @@ ul.toc {list-style: none} - +
  [ << ] [ Up ][ >> ][ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_52.html b/Manuals/en/Html/Repository/repository_52.html index 5c6cbd7..93a9777 100644 --- a/Manuals/en/Html/Repository/repository_52.html +++ b/Manuals/en/Html/Repository/repository_52.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.49 trunk/Scripts/Python +The CentOS Artwork Repository: 3.49 trunk/Scripts/Perl - - + + @@ -64,19 +59,19 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] - + -

3.49 trunk/Scripts/Python

+

3.49 trunk/Scripts/Perl

@@ -90,18 +85,10 @@ ul.toc {list-style: none}

3.49.2 Description

-
    -
  • ... -
-

3.49.3 Usage

-
    -
  • ... -
-

3.49.4 See also

@@ -114,11 +101,11 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_53.html b/Manuals/en/Html/Repository/repository_53.html index d0a3a23..3e9b5b7 100644 --- a/Manuals/en/Html/Repository/repository_53.html +++ b/Manuals/en/Html/Repository/repository_53.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.50 trunk/Translations +The CentOS Artwork Repository: 3.50 trunk/Scripts/Python - - + + @@ -64,672 +59,61 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] - + -

3.50 trunk/Translations

+

3.50 trunk/Scripts/Python

3.50.1 Goals

-

The `trunk/Translations' directory exists to: -

    -
  • Organize translation files. -
  • Organize translation templates used to produce translation files. +
  • ...

3.50.2 Description

-

When you create artwork for CentOS distribution you find that some -artworks need to be created for different major releases of CentOS -distribution and inside each major release they need to be created for -different locales. To get an approximate idea of how many files we are -talking about, consider the followig approximate statistic: -

    -
  • Inside CentOS distribution, there are around 30 images to -rebrand.(2) - -
  • There are near to four major releases of CentOS distribution to -rebrand in parallel development.(3) - -
  • Each CentOS distribution in parallel development supports more -than two hundreds locales.(4) +
  • ...
-

In order to aliviate maintainance of artwork production for such -environment, we divided artwork production in three production lines: -

-
    -
  1. See section trunk/Identity/Themes/Models, to define artworks -characteristics (e.g., dimensions, position on the screen, etc.). -
  2. See section trunk/Identity/Themes/Motifs, to define artworks visual -styles (e.g., the look and feel). -
  3. Translations, to define which major releases and locales -artworks are produced for. -
- -

Inside CentOS Artwork Repository, the artworks' translation production -line is stored under `trunk/Translations' directory. -

-

Inside `trunk/Translations' directory, we use "translation -entries" to organize artworks' "translation files" and artworks' -"translation templates". -

-

3.50.2.1 Translation Entries

- -

Translation entries exists for each artwork you want to produce. -Translation entries can be empty directories, or directories -containing translation files and translation templates. -

-

When translation entries are empty directories, the identity entry is -used as reference to create file names and directories layout for -rendered files. In this case, the centos-art script takes -one design template and outputs one non-translated file for each -design template available. This configuration is mainly used to -produce non-translatable artworks like themes' backgrounds. -

-

When translation entries contain translation files, the translation -entry implements the CentOS release schema and is used as reference to -create file names and directories layout for translated artworks. In -this case, the centos-art script applies one translation -file to one design template to create one translated instance which is -used to output one translated file. When the translated file is -rendered, the centos-art script remove the previous instance -and takes the next file in the list of translation files to repate the -whole process once again, and so on for all files in the list. This -configuration is mainly used to produce translatable artworks like -Anaconda's progress slide images. -

-

To find out correspondence between translation entries and identity -entries, you need to look the path of both translation entries and -identity entries. For example, if you are using the Modern's artisitic -motif, the identity entry for Anaconda progress artwork is: -

-
trunk/Identity/Themes/Motifs/Modern/Distro/Anaconda/Progress
-
-

and its translation entry is: -

-
trunk/Translations/Identity/Themes/Distro/Anaconda/Progress
-
-

Note how the `Translations/' directory prefixes `Identity/' -directory, also how static values (e.g., Identity, Themes, Distro, -etc.) in the identity's entry path remain in translation's entry path, -and how variable values like theme names (e.g., Modern) are stript out -from translation's entry path. The same convenction can be applied to -other identity entries in order to determine their translation -entries, or to other translation entries to determine their identity -entries. -

-
info

Note

Translation entries related to identity entries under -`trunk/Identity/Themes/Motifs' do not use `Motifs/' in the -path. We've done this because `trunk/Identity/Themes/Models' -structure, the other structure under `trunk/Identity/Themes', -doesn't require translation paths so far. So in the sake of saving -characters space when building translation entries for -`trunk/Identity/Themes/Motifs' structure, we organize Motifs -translation entries under `trunk/Translations/Identity/Themes/' -directly. -

-

If for some reason `trunk/Identity/Themes/Models' structure -requires translation entries, we need to re-oraganize the current -directory structure accordingly. -

- -

Translation entries, as described above, can be re-used by similar -identity entries. For example the following identity entries: -

-
trunk/Identity/Themes/Motifs/Modern/Distro/Anaconda/Progress/
-trunk/Identity/Themes/Motifs/TreeFlower/Distro/Anaconda/Progress/
-trunk/Identity/Themes/Motifs/Mettle/Distro/Anaconda/Progress/
-
-

are all valid identity entries able to re-use translation files inside -Anaconda progress translation entry (the one shown in our example -above). This way, you can create several identity entries and maintain -just one translation entry for all of them. Once you change the -translation files inside the common translation entry, changes inside -identity entries will take effect inside the next you render them. -

-

Trying to make things plain and simple: inside CentOS Artwork -Repository, graphic designers can concentrate their efforts in -artworks look and feel (the identity entries), and translators in -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 -translation. When you are rendering content using -centos-art script inisde `trunk/Identity' structure, -artistic motifs and translation files are applied to model designs to -produce translated content as result. In order to have the appropriate -translation in content rendered, markers defintion in translation -files should match markers in model designs exactly. -

-
-

Translation Markers - -

Figure 3.22: The image rendering flow. - -

-

Translation markers can be whatever text you want, but as convenction -we use the following to represent releases of CentOS distribution: -

-
-
`=MINOR_RELEASE='
-

Replace with minor release of CentOS distribution. In the schema M.N, the minor -release is represented by the N letter. -

-
`=MAJOR_RELEASE='
-

Replace with major release of CentOS distribution. In the schema M.N, -the major release is represented by the M letter. -

-
`=RELEASE='
-

Replace the full release of CentOS distribution. It is -`=MAJOR_RELEASE=.=MINOR_RELEASE=' basically. -

-
- -

Specific translation markers convenctions are described inside -specific translation entries. Read translation entries documentation -to know more about supported translation markers. -

-

Translation markers standardization creates a common point of -reference for translators and graphic designers. To have translation -markers well defined makes possible that translators and graphic -designers can work together but independently one another. -

- - -

3.50.2.3 Translation Files

- -

Translation files are text files with sed's commands inside, -replacement commands mainly. As convenction, translation file names -end in `.sed'. Translation files are used by centos-art -script to produce translated artworks for specific major releases of -CentOS Distribution. There are common translation files, specific -translation, and template translation files. -

-

For example, the Firstboot artwork of CentOS distribution uses the -images `splash-small.png' and `firstboot-left.png' as based -to control its visual style. The `splash-small.png' image -contains, in its graphic design, the release number information of -CentOS distribution. So the `splash-small.png' is -release-specific. In the other hand, the `firstboot-left.png' -doesn't contain release number information. So the -`firstboot-left.png' is not release-specific. -

-

If we want to produce Firstboot artwork for different major releases -of CentOS distribution, using a monolithic visual identity, all -Firstboot images should have the same visual style and, at the same -time, the release-specific information in the release-specific images. -

-
info

Note

The monolithic visual identity is implemented using -theme models (see section trunk/Identity/Themes/Models) and artistic -motifs (see section trunk/Identity/Themes/Motifs). -

- -

Assuming that both theme models and theme motifs are ready for using, -the initial translation entry to produce Firstboot artworks would look -like the following: -

-
trunk/Translations/Identity/Themes/Distro/BootUp/Firstboot/
-|-- Tpl
-|   `-- splash-small.sed
-`-- firstboot-left.sed
-
-

With the translation entry above, centos-art command is able -to produce the image `firstboot-left.png' only. To produce -`splash-small.png' images for major releases (e.g., 3, 4, 5, and -6) of CentOS distribution we need to produce the release-specific -translation files using the centos-art script as following: -

-
centos-art render --entry=/home/centos/artwork/trunk/Translations/Identity/Themes/BootUp/Firstboot --filter='3,4,5,6'
-
-

The above command produces the following translation entiry: -

-
trunk/Translations/Identity/Themes/Distro/BootUp/Firstboot/
-|-- 3
-|   `-- splash-small.sed
-|-- 4
-|   `-- splash-small.sed
-|-- 5
-|   `-- splash-small.sed
-|-- 6
-|   `-- splash-small.sed
-|-- Tpl
-|   `-- splash-small.sed
-`-- firstboot-left.sed
-
-

At this point centos-art is able to produce the Firstboot -artwork images for major releases of CentOS distribution. To add new -release-specific translation files, run the translation rendering -command with the release number you want to produce translation files -for in the `--filter='release-number'' argument. -

- - -

3.50.2.4 Template Translation Files

- -

Template translation files are translation files stored inside -translation template directory. Template translation files are used by -centos-art script to produce specific translation files -only. Template translation files may be empty or contain -sed's replacement commands. If template translation files -are empty files, the final specifc translation file built from it -contains release-specific replacement commands only. For example, -see the following translation entry: -

-
trunk/Translations/Identity/Themes/Distro/BootUp/Firstboot/
-|-- 3
-|   `-- splash-small.sed
-|-- 4
-|   `-- splash-small.sed
-|-- 5
-|   `-- splash-small.sed
-|-- 6
-|   `-- splash-small.sed
-|-- Tpl
-|   `-- splash-small.sed    <-- template translation file.
-`-- firstboot-left.sed
-
-

In the above exmaple, the `splash-small.sed' file is a template -translation file and looks like: -

-
# -------------------------------------
-# $Id: splash-small.sed 94 2010-09-18 10:59:42Z al $
-# -------------------------------------
-
-

In the above template translation file there are three comments lines, -but when you render it, the centos-art adds the -release-specific replacement commands. In our Firstboot example, after -rendering Firstboot translation entry, the `splash-small.sed' -translation file specific to CentOS 5, looks like the following: -

-
# Warning: Do not modify this file directly. This file is created
-# automatically using 'centos-art' command line interface.  Any change
-# you do in this file will be lost the next time you update
-# translation files using 'centos-art' command line interface. If you
-# want to improve the content of this translation file, improve its
-# template file instead and run the 'centos-art' command line
-# interface later to propagate your changes.
-# -------------------------------------
-# $Id: splash-small.sed 94 2010-09-18 10:59:42Z al $
-# -------------------------------------
-
-# Release number information.
-s!=RELEASE=!=MAJOR_RELEASE=.=MINOR_RELEASE=!g
-s!=MINOR_RELEASE=!0!g
-s!=MAJOR_RELEASE=!5!g
-
-

If template translation files are not empty, replacement commands -inside template translation files are preserved inside -release-specific translation files. For example, consider the English -template translation file of Anaconda progress welcome slide. The -translation template directory structure looks like the following: -

-
trunk/Translations/Identity/Themes/Distro/Anaconda/Progress/
-`-- Tpl
-    `-- en
-        `-- 01-welcome.sed
-
-

and if we render translation files for CentOS 4 and CentOS 5 major -releases, the translation entry would look like the following: -

-
trunk/Translations/Identity/Themes/Distro/Anaconda/Progress/
-|-- 4
-|   `-- en
-|       `-- 01-welcome.sed
-|-- 5
-|   `-- en
-|       `-- 01-welcome.sed
-`-- Tpl
-    `-- en
-        `-- 01-welcome.sed
-
-
info

Note

Release-specific translation directories preserve -template translation directory structure and file names. -

- -

In the example above, the template translation file looks like the -following: -

-
# ------------------------------------------------------------
-# $Id: 01-welcome.sed 94 2010-09-18 10:59:42Z al $
-# ------------------------------------------------------------
-s/=TITLE=/Welcome to CentOS =MAJOR_RELEASE= !/
-s/=TEXT1=/Thank you for installing CentOS =MAJOR_RELEASE=./
-s/=TEXT2=/CentOS is an enterprise-class Linux Distribution derived from sources freely provided to the public by a prominent North American Enterprise Linux vendor./
-s/=TEXT3=/CentOS conforms fully with the upstream vendors redistribution policy and aims to be 100% binary compatible. CentOS mainly changes packages to remove upstream vendor branding and artwork./
-s/=TEXT4=//
-s/=TEXT5=//
-s/=TEXT6=//
-s!=URL=!http://www.centos.org/!
-
-

and, after render the translation entry, specific translation files -look like the following: -

-
# Warning: Do not modify this file directly. This file is created
-# automatically using 'centos-art' command line interface.  Any change
-# you do in this file will be lost the next time you update
-# translation files using 'centos-art' command line interface. If you
-# want to improve the content of this translation file, improve its
-# template file instead and run the 'centos-art' command line
-# interface later to propagate your changes.
-# ------------------------------------------------------------
-# $Id: 01-welcome.sed 94 2010-09-18 10:59:42Z al $
-# ------------------------------------------------------------
-
-s/=TITLE=/Welcome to CentOS =MAJOR_RELEASE= !/
-s/=TEXT1=/Thank you for installing CentOS =MAJOR_RELEASE=./
-s/=TEXT2=/CentOS is an enterprise-class Linux Distribution derived from sources freely provided to the public by a prominen t North American Enterprise Linux vendor./
-s/=TEXT3=/CentOS conforms fully with the upstream vendors redistribution policy and aims to be 100% binary compatible. Cent OS mainly changes packages to remove upstream vendor branding and artwork./
-s/=TEXT4=//
-s/=TEXT5=//
-s/=TEXT6=//
-s!=URL=!http://www.centos.org/!
-
-# Release number information.
-s!=RELEASE=!=MAJOR_RELEASE=.=MINOR_RELEASE=!g
-s!=MINOR_RELEASE=!0!g
-s!=MAJOR_RELEASE=!5!g
-
-

In the example above, relevant lines begin with the `s' word -followed by a separation character (e.g., `/', `!', etc.). -These lines have the following format: -

-
s/REGEXP/REPLACEMENT/FLAGS
-
-

The `/' characters may be uniformly replaced by any other single -character within any given s command. The `/' -character (or whatever other character is used in its stead) can -appear in the REGEXP or REPLACEMENT only if it is preceded by a -`\' character. -

-

The s command is probably the most important in -sed and has a lot of different options. Its basic concept -is simple: the s command attempts to match the pattern space -against the supplied REGEXP; if the match is successful, then that -portion of the pattern space which was matched is replaced with -REPLACEMENT. -

-

In the context of our translation files, the REGEXP is where you -define translation markers and REPLACEMENT where you define the -translation text you want to have after artworks rendering. Sometimes -we use the FLAG component with the `g' command to apply the -replacements globally. -

-
Info

Tip

More information about how to use sed's -replacement commands and flags is available in sed's -documentation manual. To read sed's documentation manual type the -following command: -

info sed
-
- -

Inside translation files, you can use translation markers not only -inside the REGEXP but in the REPLACEMENT too. In order for this -configuration to work, the REPLACEMENT of translation markers needs to -be define after its definition. For example, see in the -release-specific translation file above, how the -`s!=MAJOR_RELASE=!5!g' replacement command is defined -after `=MAJOR_RELASE=' translation marker definition in -the REPLACEMENT of `=TITLE=' translation marker replacement -command. -

- - -

3.50.2.5 Common Translation Files

- -

Common translation files contain common translations or no -translation at all for their related artworks. They are in the root -directory of the translation entry. Common translation files create -common artworks for all major releases of CentOS Distribution. -

-

Translation entries, with common translation files inside, look like -the following: -

-
trunk/Translations/Identity/Themes/Distro/BootUp/Firstboot/
-|-- 3
-|   `-- splash-small.sed
-|-- 4
-|   `-- splash-small.sed
-|-- 5
-|   `-- splash-small.sed
-|-- 6
-|   `-- splash-small.sed
-|-- Tpl
-|   `-- splash-small.sed
-`-- firstboot-left.sed      <-- common translation file.
-
- - -

3.50.2.6 Specific Translation Files

- -

Specific translation files contain specific translations for their -related artworks. Specific translation files are not in the root -directory of the translation entry, but inside directories which -describe the type of translation they are doing. Specific translation -files are produced automatically using the centos-art -script. -

-
trunk/Translations/Identity/Themes/Distro/BootUp/Firstboot/
-|-- 3
-|   `-- splash-small.sed    <-- CentOS 3 specific translation file.
-|-- 4
-|   `-- splash-small.sed    <-- CentOS 4 specific translation file.
-|-- 5
-|   `-- splash-small.sed    <-- CentOS 5 specific translation file.
-|-- 6
-|   `-- splash-small.sed    <-- CentOS 6 specific translation file.
-|-- Tpl
-|   `-- splash-small.sed
-`-- firstboot-left.sed
-
- - -

3.50.2.7 Translation Rendering

- -

When rendering translations, the centos-art script checks -the translation entry to verify that it has a translation template -directory inside. The translation template directory (`Tpl/') -contains common translation files used to build release-specific -translation files. If the translation template directory doesn't exist -inside the translation entry the translation rendering fails. In this -case the centos-art script outputs a message and quits -script execution. -

- - -

3.50.2.8 Translation (Pre-)Rendering Configuration Scripts

- -

When the centos-art script finds a translation template -directory inside translation entry, it looks for translations -pre-rendering configuration scripts for that translation entry. -Translation pre-rendering configuration scripts let you extend -translation's default functionality (described below). -

-

Translation pre-rendering configuration scripts are stored under -`trunk/Scripts' directory, specifically under the appropriate -language implementation. If you are using centos-art Bash's -implementation, the translation pre-rendering scripts are store in the -`trunk/Scripts/Bash/Config' location; if you are using -centos-art Python's implementation, then translation -pre-rendering scripts are stored in the -`trunk/Scripts/Python/Config' location, and so on for other -implementations. -

-

Bash's translation pre-rendering configuration scripts look like the -following: -

-
#!/bin/bash
-#
-# render_loadConfig.sh -- brief description here.
-#
-# Copyright (C) YEAR YOURNAME
-# 
-# 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: render_loadConfig.sh 94 2010-09-18 10:59:42Z al $
-# ----------------------------------------------------------------------
-
-function render_loadConfig {
-...
-}
-
-

Translation pre-rendering scripts are function scripts loaded and -executed when rendering a translation entry. Translation pre-rendering -scripts are loaded using the translation entry being rendered as -reference. For example, suppose you are using the -centos-art Bash's implementation, and you are rendering -translations for CentOS brands, in this situation the translation -entry would be: -

-
trunk/Translations/Identity/Brands
-
-

and the entry inside the translation pre-rendering configuration -structure would be: -

-
trunk/Scripts/Bash/Config/Identity/Brands
-
-

Once the centos-art script detects that translation -pre-rendering configuration directory exists, the centos-art -script looks for the translation pre-rendering configuration file. If -the translation pre-rendering configuration file exists, it is loaded -and executed. Once the translation pre-rendering configuration file -has been executed the translation rendering process is over, and so -the script execution. -

-
info

Note

Translation pre-rendering configuration files have the -following form: -

render.conf.extension
-

where `extension' refers the programming language implementation -you are using. For example, `sh' for Bash's, `py' for -Python's, `pl' for Perl's, and so on for other implementations. -

- -

As we are using Bash implementation to describe the translation -pre-rendering configuration example, the translation pre-rendering -configuration file that centos-art looks for, inside the -above translation pre-rendering configuration directory, is -`render.conf.sh'. -

- - -

3.50.2.9 Translation Rendering Default Functionality

- -

In the other hand, if the translation pre-rendering configuration file -doesn't exist, or it isn't written as function script, the -centos-art script ignore translation pre-rendering -configuration functionality and passes to render translation using -default functionality instead. -

-

The translation rendering default functionality takes template -translation directory structure, duplicates it for each release number -specified in the `--filter='release-number'' argument and -produces release-specific directories. As part of template translation -duplication process take place, the centos-art script adds -release-specific replacement commands to each specific translation -file inside release-specific directories. As result, specific -translation files, inside release-specific directories, contain -template translation replacement commands plus, -release-specific replacement commands. -

-
info

Note

Release-specific replacement commands are standardized -inside centos-art script using predifined release -translation markers. Release translation markers are described in the -translation marker section -(see Translation Markers). -

- - - -

3.50.3 Usage

-
-
`centos-art render --entry='path/to/dir''
-
-

When `path/to/dir' refers one directory under -`trunk/Translations', this command orverwrites available -translation files using translation templates. -

-
-
`centos-art render --entry='path/to/dir' --filter='pattern''
-
-

When `path/to/dir' refers one directory under -`trunk/Translations', this command renders release-specific -translation files as you specify in the `--filter='pattern'' -argument. In this case, `pattern' not a regular expression but an -number (e.g., `5') or a list of numbers separated by commas -(e.g., `3,4,5,6') that specify the major release of CentOS -distribution you want to render translations for. -

-
+
    +
  • ... +
- +

3.50.4 See also

- - - - - - - -
3.52 trunk/Translations/Identity/Brands   -
3.54 trunk/Translations/Identity/Fonts   -
3.55 trunk/Translations/Identity/Models   -
3.56 trunk/Translations/Identity/Release   -
3.57 trunk/Translations/Identity/Themes   -
3.1 trunk/Identity   -
- - + + - +
[ < ][ > ]
[ < ][ > ]   [ << ] [ Up ][ >> ][ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_54.html b/Manuals/en/Html/Repository/repository_54.html index 6df6352..6c02d65 100644 --- a/Manuals/en/Html/Repository/repository_54.html +++ b/Manuals/en/Html/Repository/repository_54.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.51 trunk/Translations/Identity +The CentOS Artwork Repository: 3.51 trunk/Translations - - + + @@ -59,65 +54,660 @@ ul.toc {list-style: none} - - + + - + - +
[ < ][ > ]
[ < ][ > ]   [ << ] [ Up ][ >> ][ >> ]         [Top] [Contents][Index][Index] [ ? ]
- - -

3.51 trunk/Translations/Identity

+ + +

3.51 trunk/Translations

- +

3.51.1 Goals

+

The `trunk/Translations' directory exists to: +

    -
  • ... +
  • Organize translation files. +
  • Organize translation templates used to produce translation files.
- +

3.51.2 Description

+

When you create artwork for CentOS distribution you find that some +artworks need to be created for different major releases of CentOS +distribution and inside each major release they need to be created for +different locales. To get an approximate idea of how many files we are +talking about, consider the followig approximate statistic: +

    -
  • ... +
  • Inside CentOS distribution, there are around 30 images to +rebrand.(2) + +
  • There are near to four major releases of CentOS distribution to +rebrand in parallel development.(3) + +
  • Each CentOS distribution in parallel development supports more +than two hundreds locales.(4)
+

In order to aliviate maintainance of artwork production for such +environment, we divided artwork production in three production lines: +

+
    +
  1. See section trunk/Identity/Themes/Models, to define artworks +characteristics (e.g., dimensions, position on the screen, etc.). +
  2. See section trunk/Identity/Themes/Motifs, to define artworks visual +styles (e.g., the look and feel). +
  3. Translations, to define which major releases and locales +artworks are produced for. +
+ +

Inside CentOS Artwork Repository, the artworks' translation production +line is stored under `trunk/Translations' directory. +

+

Inside `trunk/Translations' directory, we use "translation +entries" to organize artworks' "translation files" and artworks' +"translation templates". +

+ + +

3.51.2.1 Translation Entries

+ +

Translation entries exists for each artwork you want to produce. +Translation entries can be empty directories, or directories +containing translation files and translation templates. +

+

When translation entries are empty directories, the identity entry is +used as reference to create file names and directories layout for +rendered files. In this case, the centos-art script takes +one design template and outputs one non-translated file for each +design template available. This configuration is mainly used to +produce non-translatable artworks like themes' backgrounds. +

+

When translation entries contain translation files, the translation +entry implements the CentOS release schema and is used as reference to +create file names and directories layout for translated artworks. In +this case, the centos-art script applies one translation +file to one design template to create one translated instance which is +used to output one translated file. When the translated file is +rendered, the centos-art script remove the previous instance +and takes the next file in the list of translation files to repate the +whole process once again, and so on for all files in the list. This +configuration is mainly used to produce translatable artworks like +Anaconda's progress slide images. +

+

To find out correspondence between translation entries and identity +entries, you need to look the path of both translation entries and +identity entries. For example, if you are using the Modern's artisitic +motif, the identity entry for Anaconda progress artwork is: +

+
trunk/Identity/Themes/Motifs/Modern/Distro/Anaconda/Progress
+
+

and its translation entry is: +

+
trunk/Translations/Identity/Themes/Distro/Anaconda/Progress
+
+

Note how the `Translations/' directory prefixes `Identity/' +directory, also how static values (e.g., Identity, Themes, Distro, +etc.) in the identity's entry path remain in translation's entry path, +and how variable values like theme names (e.g., Modern) are stript out +from translation's entry path. The same convenction can be applied to +other identity entries in order to determine their translation +entries, or to other translation entries to determine their identity +entries. +

+
info

Note

Translation entries related to identity entries under +`trunk/Identity/Themes/Motifs' do not use `Motifs/' in the +path. We've done this because `trunk/Identity/Themes/Models' +structure, the other structure under `trunk/Identity/Themes', +doesn't require translation paths so far. So in the sake of saving +characters space when building translation entries for +`trunk/Identity/Themes/Motifs' structure, we organize Motifs +translation entries under `trunk/Translations/Identity/Themes/' +directly. +

+

If for some reason `trunk/Identity/Themes/Models' structure +requires translation entries, we need to re-oraganize the current +directory structure accordingly. +

+ +

Translation entries, as described above, can be re-used by similar +identity entries. For example the following identity entries: +

+
trunk/Identity/Themes/Motifs/Modern/Distro/Anaconda/Progress/
+trunk/Identity/Themes/Motifs/TreeFlower/Distro/Anaconda/Progress/
+trunk/Identity/Themes/Motifs/Mettle/Distro/Anaconda/Progress/
+
+

are all valid identity entries able to re-use translation files inside +Anaconda progress translation entry (the one shown in our example +above). This way, you can create several identity entries and maintain +just one translation entry for all of them. Once you change the +translation files inside the common translation entry, changes inside +identity entries will take effect inside the next you render them. +

+

Trying to make things plain and simple: inside CentOS Artwork +Repository, graphic designers can concentrate their efforts in +artworks look and feel (the identity entries), and translators in +artworks translations (the translation entries). +

+ + +

3.51.2.2 Translation Markers

+

+ +

+

Translation markers are used in "Theme Model Designs" and +"Translation Files" as replacement patterns to commit content +translation. When you are rendering content using +centos-art script inisde `trunk/Identity' structure, +artistic motifs and translation files are applied to model designs to +produce translated content as result. In order to have the appropriate +translation in content rendered, markers defintion in translation +files should match markers in model designs exactly. +

+
+

Translation Markers + +

Figure 3.22: The image rendering flow. + +

+

Translation markers can be whatever text you want, but as convenction +we use the following to represent releases of CentOS distribution: +

+
+
`=MINOR_RELEASE='
+

Replace with minor release of CentOS distribution. In the schema M.N, the minor +release is represented by the N letter. +

+
`=MAJOR_RELEASE='
+

Replace with major release of CentOS distribution. In the schema M.N, +the major release is represented by the M letter. +

+
`=RELEASE='
+

Replace the full release of CentOS distribution. It is +`=MAJOR_RELEASE=.=MINOR_RELEASE=' basically. +

+
+ +

Specific translation markers convenctions are described inside +specific translation entries. Read translation entries documentation +to know more about supported translation markers. +

+

Translation markers standardization creates a common point of +reference for translators and graphic designers. To have translation +markers well defined makes possible that translators and graphic +designers can work together but independently one another. +

+ + +

3.51.2.3 Translation Files

+ +

Translation files are text files with sed's commands inside, +replacement commands mainly. As convenction, translation file names +end in `.sed'. Translation files are used by centos-art +script to produce translated artworks for specific major releases of +CentOS Distribution. There are common translation files, specific +translation, and template translation files. +

+

For example, the Firstboot artwork of CentOS distribution uses the +images `splash-small.png' and `firstboot-left.png' as based +to control its visual style. The `splash-small.png' image +contains, in its graphic design, the release number information of +CentOS distribution. So the `splash-small.png' is +release-specific. In the other hand, the `firstboot-left.png' +doesn't contain release number information. So the +`firstboot-left.png' is not release-specific. +

+

If we want to produce Firstboot artwork for different major releases +of CentOS distribution, using a monolithic visual identity, all +Firstboot images should have the same visual style and, at the same +time, the release-specific information in the release-specific images. +

+
info

Note

The monolithic visual identity is implemented using +theme models (see section trunk/Identity/Themes/Models) and artistic +motifs (see section trunk/Identity/Themes/Motifs). +

+ +

Assuming that both theme models and theme motifs are ready for using, +the initial translation entry to produce Firstboot artworks would look +like the following: +

+
trunk/Translations/Identity/Themes/Distro/BootUp/Firstboot/
+|-- Tpl
+|   `-- splash-small.sed
+`-- firstboot-left.sed
+
+

With the translation entry above, centos-art command is able +to produce the image `firstboot-left.png' only. To produce +`splash-small.png' images for major releases (e.g., 3, 4, 5, and +6) of CentOS distribution we need to produce the release-specific +translation files using the centos-art script as following: +

+
centos-art render --entry=/home/centos/artwork/trunk/Translations/Identity/Themes/BootUp/Firstboot --filter='3,4,5,6'
+
+

The above command produces the following translation entiry: +

+
trunk/Translations/Identity/Themes/Distro/BootUp/Firstboot/
+|-- 3
+|   `-- splash-small.sed
+|-- 4
+|   `-- splash-small.sed
+|-- 5
+|   `-- splash-small.sed
+|-- 6
+|   `-- splash-small.sed
+|-- Tpl
+|   `-- splash-small.sed
+`-- firstboot-left.sed
+
+

At this point centos-art is able to produce the Firstboot +artwork images for major releases of CentOS distribution. To add new +release-specific translation files, run the translation rendering +command with the release number you want to produce translation files +for in the `--filter='release-number'' argument. +

+ + +

3.51.2.4 Template Translation Files

+ +

Template translation files are translation files stored inside +translation template directory. Template translation files are used by +centos-art script to produce specific translation files +only. Template translation files may be empty or contain +sed's replacement commands. If template translation files +are empty files, the final specifc translation file built from it +contains release-specific replacement commands only. For example, +see the following translation entry: +

+
trunk/Translations/Identity/Themes/Distro/BootUp/Firstboot/
+|-- 3
+|   `-- splash-small.sed
+|-- 4
+|   `-- splash-small.sed
+|-- 5
+|   `-- splash-small.sed
+|-- 6
+|   `-- splash-small.sed
+|-- Tpl
+|   `-- splash-small.sed    <-- template translation file.
+`-- firstboot-left.sed
+
+

In the above exmaple, the `splash-small.sed' file is a template +translation file and looks like: +

+
# -------------------------------------
+# $Id: splash-small.sed 94 2010-09-18 10:59:42Z al $
+# -------------------------------------
+
+

In the above template translation file there are three comments lines, +but when you render it, the centos-art adds the +release-specific replacement commands. In our Firstboot example, after +rendering Firstboot translation entry, the `splash-small.sed' +translation file specific to CentOS 5, looks like the following: +

+
# Warning: Do not modify this file directly. This file is created
+# automatically using 'centos-art' command line interface.  Any change
+# you do in this file will be lost the next time you update
+# translation files using 'centos-art' command line interface. If you
+# want to improve the content of this translation file, improve its
+# template file instead and run the 'centos-art' command line
+# interface later to propagate your changes.
+# -------------------------------------
+# $Id: splash-small.sed 94 2010-09-18 10:59:42Z al $
+# -------------------------------------
+
+# Release number information.
+s!=RELEASE=!=MAJOR_RELEASE=.=MINOR_RELEASE=!g
+s!=MINOR_RELEASE=!0!g
+s!=MAJOR_RELEASE=!5!g
+
+

If template translation files are not empty, replacement commands +inside template translation files are preserved inside +release-specific translation files. For example, consider the English +template translation file of Anaconda progress welcome slide. The +translation template directory structure looks like the following: +

+
trunk/Translations/Identity/Themes/Distro/Anaconda/Progress/
+`-- Tpl
+    `-- en
+        `-- 01-welcome.sed
+
+

and if we render translation files for CentOS 4 and CentOS 5 major +releases, the translation entry would look like the following: +

+
trunk/Translations/Identity/Themes/Distro/Anaconda/Progress/
+|-- 4
+|   `-- en
+|       `-- 01-welcome.sed
+|-- 5
+|   `-- en
+|       `-- 01-welcome.sed
+`-- Tpl
+    `-- en
+        `-- 01-welcome.sed
+
+
info

Note

Release-specific translation directories preserve +template translation directory structure and file names. +

+ +

In the example above, the template translation file looks like the +following: +

+
# ------------------------------------------------------------
+# $Id: 01-welcome.sed 94 2010-09-18 10:59:42Z al $
+# ------------------------------------------------------------
+s/=TITLE=/Welcome to CentOS =MAJOR_RELEASE= !/
+s/=TEXT1=/Thank you for installing CentOS =MAJOR_RELEASE=./
+s/=TEXT2=/CentOS is an enterprise-class Linux Distribution derived from sources freely provided to the public by a prominent North American Enterprise Linux vendor./
+s/=TEXT3=/CentOS conforms fully with the upstream vendors redistribution policy and aims to be 100% binary compatible. CentOS mainly changes packages to remove upstream vendor branding and artwork./
+s/=TEXT4=//
+s/=TEXT5=//
+s/=TEXT6=//
+s!=URL=!http://www.centos.org/!
+
+

and, after render the translation entry, specific translation files +look like the following: +

+
# Warning: Do not modify this file directly. This file is created
+# automatically using 'centos-art' command line interface.  Any change
+# you do in this file will be lost the next time you update
+# translation files using 'centos-art' command line interface. If you
+# want to improve the content of this translation file, improve its
+# template file instead and run the 'centos-art' command line
+# interface later to propagate your changes.
+# ------------------------------------------------------------
+# $Id: 01-welcome.sed 94 2010-09-18 10:59:42Z al $
+# ------------------------------------------------------------
+
+s/=TITLE=/Welcome to CentOS =MAJOR_RELEASE= !/
+s/=TEXT1=/Thank you for installing CentOS =MAJOR_RELEASE=./
+s/=TEXT2=/CentOS is an enterprise-class Linux Distribution derived from sources freely provided to the public by a prominen t North American Enterprise Linux vendor./
+s/=TEXT3=/CentOS conforms fully with the upstream vendors redistribution policy and aims to be 100% binary compatible. Cent OS mainly changes packages to remove upstream vendor branding and artwork./
+s/=TEXT4=//
+s/=TEXT5=//
+s/=TEXT6=//
+s!=URL=!http://www.centos.org/!
+
+# Release number information.
+s!=RELEASE=!=MAJOR_RELEASE=.=MINOR_RELEASE=!g
+s!=MINOR_RELEASE=!0!g
+s!=MAJOR_RELEASE=!5!g
+
+

In the example above, relevant lines begin with the `s' word +followed by a separation character (e.g., `/', `!', etc.). +These lines have the following format: +

+
s/REGEXP/REPLACEMENT/FLAGS
+
+

The `/' characters may be uniformly replaced by any other single +character within any given s command. The `/' +character (or whatever other character is used in its stead) can +appear in the REGEXP or REPLACEMENT only if it is preceded by a +`\' character. +

+

The s command is probably the most important in +sed and has a lot of different options. Its basic concept +is simple: the s command attempts to match the pattern space +against the supplied REGEXP; if the match is successful, then that +portion of the pattern space which was matched is replaced with +REPLACEMENT. +

+

In the context of our translation files, the REGEXP is where you +define translation markers and REPLACEMENT where you define the +translation text you want to have after artworks rendering. Sometimes +we use the FLAG component with the `g' command to apply the +replacements globally. +

+
Info

Tip

More information about how to use sed's +replacement commands and flags is available in sed's +documentation manual. To read sed's documentation manual type the +following command: +

info sed
+
+ +

Inside translation files, you can use translation markers not only +inside the REGEXP but in the REPLACEMENT too. In order for this +configuration to work, the REPLACEMENT of translation markers needs to +be define after its definition. For example, see in the +release-specific translation file above, how the +`s!=MAJOR_RELASE=!5!g' replacement command is defined +after `=MAJOR_RELASE=' translation marker definition in +the REPLACEMENT of `=TITLE=' translation marker replacement +command. +

+ + +

3.51.2.5 Common Translation Files

+ +

Common translation files contain common translations or no +translation at all for their related artworks. They are in the root +directory of the translation entry. Common translation files create +common artworks for all major releases of CentOS Distribution. +

+

Translation entries, with common translation files inside, look like +the following: +

+
trunk/Translations/Identity/Themes/Distro/BootUp/Firstboot/
+|-- 3
+|   `-- splash-small.sed
+|-- 4
+|   `-- splash-small.sed
+|-- 5
+|   `-- splash-small.sed
+|-- 6
+|   `-- splash-small.sed
+|-- Tpl
+|   `-- splash-small.sed
+`-- firstboot-left.sed      <-- common translation file.
+
+ + +

3.51.2.6 Specific Translation Files

+ +

Specific translation files contain specific translations for their +related artworks. Specific translation files are not in the root +directory of the translation entry, but inside directories which +describe the type of translation they are doing. Specific translation +files are produced automatically using the centos-art +script. +

+
trunk/Translations/Identity/Themes/Distro/BootUp/Firstboot/
+|-- 3
+|   `-- splash-small.sed    <-- CentOS 3 specific translation file.
+|-- 4
+|   `-- splash-small.sed    <-- CentOS 4 specific translation file.
+|-- 5
+|   `-- splash-small.sed    <-- CentOS 5 specific translation file.
+|-- 6
+|   `-- splash-small.sed    <-- CentOS 6 specific translation file.
+|-- Tpl
+|   `-- splash-small.sed
+`-- firstboot-left.sed
+
+ + +

3.51.2.7 Translation Rendering

+ +

When rendering translations, the centos-art script checks +the translation entry to verify that it has a translation template +directory inside. The translation template directory (`Tpl/') +contains common translation files used to build release-specific +translation files. If the translation template directory doesn't exist +inside the translation entry the translation rendering fails. In this +case the centos-art script outputs a message and quits +script execution. +

+ + +

3.51.2.8 Translation (Pre-)Rendering Configuration Scripts

+ +

When the centos-art script finds a translation template +directory inside translation entry, it looks for translations +pre-rendering configuration scripts for that translation entry. +Translation pre-rendering configuration scripts let you extend +translation's default functionality (described below). +

+

Translation pre-rendering configuration scripts are stored under +`trunk/Scripts' directory, specifically under the appropriate +language implementation. If you are using centos-art Bash's +implementation, the translation pre-rendering scripts are store in the +`trunk/Scripts/Bash/Config' location; if you are using +centos-art Python's implementation, then translation +pre-rendering scripts are stored in the +`trunk/Scripts/Python/Config' location, and so on for other +implementations. +

+

Bash's translation pre-rendering configuration scripts look like the +following: +

+
#!/bin/bash
+#
+# render_loadConfig.sh -- brief description here.
+#
+# Copyright (C) YEAR YOURNAME
+# 
+# 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: render_loadConfig.sh 94 2010-09-18 10:59:42Z al $
+# ----------------------------------------------------------------------
+
+function render_loadConfig {
+...
+}
+
+

Translation pre-rendering scripts are function scripts loaded and +executed when rendering a translation entry. Translation pre-rendering +scripts are loaded using the translation entry being rendered as +reference. For example, suppose you are using the +centos-art Bash's implementation, and you are rendering +translations for CentOS brands, in this situation the translation +entry would be: +

+
trunk/Translations/Identity/Brands
+
+

and the entry inside the translation pre-rendering configuration +structure would be: +

+
trunk/Scripts/Bash/Config/Identity/Brands
+
+

Once the centos-art script detects that translation +pre-rendering configuration directory exists, the centos-art +script looks for the translation pre-rendering configuration file. If +the translation pre-rendering configuration file exists, it is loaded +and executed. Once the translation pre-rendering configuration file +has been executed the translation rendering process is over, and so +the script execution. +

+
info

Note

Translation pre-rendering configuration files have the +following form: +

render.conf.extension
+

where `extension' refers the programming language implementation +you are using. For example, `sh' for Bash's, `py' for +Python's, `pl' for Perl's, and so on for other implementations. +

+ +

As we are using Bash implementation to describe the translation +pre-rendering configuration example, the translation pre-rendering +configuration file that centos-art looks for, inside the +above translation pre-rendering configuration directory, is +`render.conf.sh'. +

+ + +

3.51.2.9 Translation Rendering Default Functionality

+ +

In the other hand, if the translation pre-rendering configuration file +doesn't exist, or it isn't written as function script, the +centos-art script ignore translation pre-rendering +configuration functionality and passes to render translation using +default functionality instead. +

+

The translation rendering default functionality takes template +translation directory structure, duplicates it for each release number +specified in the `--filter='release-number'' argument and +produces release-specific directories. As part of template translation +duplication process take place, the centos-art script adds +release-specific replacement commands to each specific translation +file inside release-specific directories. As result, specific +translation files, inside release-specific directories, contain +template translation replacement commands plus, +release-specific replacement commands. +

+
info

Note

Release-specific replacement commands are standardized +inside centos-art script using predifined release +translation markers. Release translation markers are described in the +translation marker section +(see Translation Markers). +

+ +

3.51.3 Usage

-
    -
  • ... -
+
+
`centos-art render --entry='path/to/dir''
+
+

When `path/to/dir' refers one directory under +`trunk/Translations', this command orverwrites available +translation files using translation templates. +

+
+
`centos-art render --entry='path/to/dir' --filter='pattern''
+
+

When `path/to/dir' refers one directory under +`trunk/Translations', this command renders release-specific +translation files as you specify in the `--filter='pattern'' +argument. In this case, `pattern' not a regular expression but an +number (e.g., `5') or a list of numbers separated by commas +(e.g., `3,4,5,6') that specify the major release of CentOS +distribution you want to render translations for. +

+

3.51.4 See also

- - - - - - @@ -129,12 +719,12 @@ ul.toc {list-style: none} - - + +
3.52 trunk/Translations/Identity/Brands   -
3.54 trunk/Translations/Identity/Fonts   +
3.53 trunk/Translations/Identity/Brands  
3.55 trunk/Translations/Identity/Models   +
3.55 trunk/Translations/Identity/Fonts  
3.56 trunk/Translations/Identity/Release   +
3.56 trunk/Translations/Identity/Models  
3.57 trunk/Translations/Identity/Themes   +
3.57 trunk/Translations/Identity/Release  
3.60 trunk/Translations/Identity/Widgets   +
3.58 trunk/Translations/Identity/Themes  
3.1 trunk/Identity  
[ > ]   [ << ][ Up ][ >> ][ Up ][ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_55.html b/Manuals/en/Html/Repository/repository_55.html index 8fad40b..4fe2e3a 100644 --- a/Manuals/en/Html/Repository/repository_55.html +++ b/Manuals/en/Html/Repository/repository_55.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.52 trunk/Translations/Identity/Brands +The CentOS Artwork Repository: 3.52 trunk/Translations/Identity - - + + @@ -64,147 +59,77 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] - + -

3.52 trunk/Translations/Identity/Brands

+

3.52 trunk/Translations/Identity

3.52.1 Goals

    -
  • Organize brands' translation files. +
  • ...

3.52.2 Description

-

Translation files, inside `trunk/Translations/Identity/Brands' -translation entry, don't use default rendering translation -functionality, they use the following translation pre-rendering -configuration file instead: -

-
/home/centos/artwork/trunk/Translation/Identity/Brands/render.conf.sh
-
-

Inside `trunk/Translations/Identity/Brands' translation entry, -translation files are symbolic links pointing to the common template -translation structure, inside the translation template (`Tpl/') -directory. -

-

Inside `trunk/Translations/Identity/Brands' translation entry, -translation files are created using identity design templates as -reference. The translation pre-rendering script creates a translation -structure where the translation template (`Tpl/') directory -structure applies to each single design template available. -

-

For example, if the brands' translation template (`Tpl/') -directory has 30 translation files, and there are 20 design templates; -the brands' translation pre-rendering script creates a translation -structure of symbolic links where the 30 translation files apply the -20 design templates one by one, producing 600 translation symbolic -links as result. At this point, when rendering identity, the -centos-art script considers translation symbolic links as -translation files. -

-

Translation file names, inside brands' translation template -(`Tpl') directory have special meaning: -

- - -

3.52.2.1 Conventional file names

- -

Convenctional file names look like `blue.sed', `2c-a.sed', -etc. Replacement commands inside translation file are applied to -design templates and translation file names are used as final image -name. The image dimensions use the same dimensions that design -template has. -

- - -

3.52.2.2 Numeric file names

- -

Numeric file names look like `300.sed', `200.sed', etc. -Replacements commands inside translation files are applied to design -templates, and translation file names are used as final image name. -The final image is saved using an specific `width' defined by the -number part of the translation file name. The image `height' is -automatically scaled based on the previous `width' definition to -maintain the design's ratio. -

-

For example, if your design template has 400x200 pixels of dimension, -and you apply a translation file named `300.sed' to it, the final -image you get as result will have 300x100 pixels of dimension. The -same is true if you use higher numbers like `1024.sed', `2048.sed', -etc. In these cases you have bigger images proportionally. -

-

As we are using scalable vector graphics to design identity templates, -the image size you produce is not limitted in size. You can use one -design template produced in 400x200 pixels to produce larger or -shorter PNG images using numeric translation files as described -above. -

- - -

3.52.2.3 Translation markers

- -

Inside `trunk/Translations/Identity/Brands/', translation files -combine the following translation markers: -

-
-
`#000000'
-
-

Specify which color to use when rendering brand images. -

-
info

Note

As translation files inside -`trunk/Translations/Identity/Brands' are symbolic links that -point to template translation files, translation markers are defined -inside template translation files. -

-
-
+
    +
  • ... +
- +

3.52.3 Usage

-

To render brands' translation files, use the following command: -

-
centos-art render --translation=/home/centos/artwork/trunk/Translations/Identity/Brands
-
+
    +
  • ... +
+ - +

3.52.4 See also

- + + + + + -
3.53 trunk/Translations/Identity/Brands/Tpl   +
3.53 trunk/Translations/Identity/Brands   +
3.55 trunk/Translations/Identity/Fonts   +
3.56 trunk/Translations/Identity/Models   +
3.57 trunk/Translations/Identity/Release   +
3.58 trunk/Translations/Identity/Themes   +
3.61 trunk/Translations/Identity/Widgets  
3.2 trunk/Identity/Brands   +
3.1 trunk/Identity  
- - + + - +
[ < ][ > ]
[ < ][ > ]   [ << ] [ Up ][ >> ][ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_56.html b/Manuals/en/Html/Repository/repository_56.html index 3a9e8c3..49dda56 100644 --- a/Manuals/en/Html/Repository/repository_56.html +++ b/Manuals/en/Html/Repository/repository_56.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.53 trunk/Translations/Identity/Brands/Tpl +The CentOS Artwork Repository: 3.53 trunk/Translations/Identity/Brands - - + + @@ -59,41 +54,139 @@ ul.toc {list-style: none} - - + + - + - +
[ < ][ > ]
[ < ][ > ]   [ << ] [ Up ][ >> ][ >> ]         [Top] [Contents][Index][Index] [ ? ]
- - -

3.53 trunk/Translations/Identity/Brands/Tpl

+ + +

3.53 trunk/Translations/Identity/Brands

- +

3.53.1 Goals

+
    +
  • Organize brands' translation files. +
- + +

3.53.2 Description

+

Translation files, inside `trunk/Translations/Identity/Brands' +translation entry, don't use default rendering translation +functionality, they use the following translation pre-rendering +configuration file instead: +

+
/home/centos/artwork/trunk/Translation/Identity/Brands/render.conf.sh
+
+

Inside `trunk/Translations/Identity/Brands' translation entry, +translation files are symbolic links pointing to the common template +translation structure, inside the translation template (`Tpl/') +directory. +

+

Inside `trunk/Translations/Identity/Brands' translation entry, +translation files are created using identity design templates as +reference. The translation pre-rendering script creates a translation +structure where the translation template (`Tpl/') directory +structure applies to each single design template available. +

+

For example, if the brands' translation template (`Tpl/') +directory has 30 translation files, and there are 20 design templates; +the brands' translation pre-rendering script creates a translation +structure of symbolic links where the 30 translation files apply the +20 design templates one by one, producing 600 translation symbolic +links as result. At this point, when rendering identity, the +centos-art script considers translation symbolic links as +translation files. +

+

Translation file names, inside brands' translation template +(`Tpl') directory have special meaning: +

+ + +

3.53.2.1 Conventional file names

+ +

Convenctional file names look like `blue.sed', `2c-a.sed', +etc. Replacement commands inside translation file are applied to +design templates and translation file names are used as final image +name. The image dimensions use the same dimensions that design +template has. +

+ + +

3.53.2.2 Numeric file names

+ +

Numeric file names look like `300.sed', `200.sed', etc. +Replacements commands inside translation files are applied to design +templates, and translation file names are used as final image name. +The final image is saved using an specific `width' defined by the +number part of the translation file name. The image `height' is +automatically scaled based on the previous `width' definition to +maintain the design's ratio. +

+

For example, if your design template has 400x200 pixels of dimension, +and you apply a translation file named `300.sed' to it, the final +image you get as result will have 300x100 pixels of dimension. The +same is true if you use higher numbers like `1024.sed', `2048.sed', +etc. In these cases you have bigger images proportionally. +

+

As we are using scalable vector graphics to design identity templates, +the image size you produce is not limitted in size. You can use one +design template produced in 400x200 pixels to produce larger or +shorter PNG images using numeric translation files as described +above. +

+ + +

3.53.2.3 Translation markers

+ +

Inside `trunk/Translations/Identity/Brands/', translation files +combine the following translation markers: +

+
+
`#000000'
+
+

Specify which color to use when rendering brand images. +

+
info

Note

As translation files inside +`trunk/Translations/Identity/Brands' are symbolic links that +point to template translation files, translation markers are defined +inside template translation files. +

+
+
+

3.53.3 Usage

+

To render brands' translation files, use the following command: +

+
centos-art render --translation=/home/centos/artwork/trunk/Translations/Identity/Brands
+

3.53.4 See also

+ + + +
3.54 trunk/Translations/Identity/Brands/Tpl   +
3.2 trunk/Identity/Brands   +
@@ -101,12 +194,12 @@ ul.toc {list-style: none} - - + +
[ > ]   [ << ][ Up ][ >> ][ Up ][ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_57.html b/Manuals/en/Html/Repository/repository_57.html index 5b0d3b3..472efe1 100644 --- a/Manuals/en/Html/Repository/repository_57.html +++ b/Manuals/en/Html/Repository/repository_57.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.54 trunk/Translations/Identity/Fonts +The CentOS Artwork Repository: 3.54 trunk/Translations/Identity/Brands/Tpl - - + + @@ -64,103 +59,49 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] - + -

3.54 trunk/Translations/Identity/Fonts

+

3.54 trunk/Translations/Identity/Brands/Tpl

3.54.1 Goals

-

This section exists to organize fonts translation files. -

+

3.54.2 Description

-

Translation files, inside `trunk/Translations/Fonts', have the -following structure: -

-
s!font-family:Denmark!font-family:DejaVu LGC Sans!
-s!font-weight:normal!font-weight:bold!
-s!font-style:normal!font-style:italic!
-
-

Inside `trunk/Translations/Fonts', there is one translation file -for each font preview image you want to produce. This way, we create -one translation file for each font-family we use somewhere inside -CentOS visual identity. -

-
Important

Important

Do not create translation files for font-families -not used somewhere inside CentOS visual identity. The font's identity -entry (see section trunk/Identity/Fonts) is used as reference when someone -needs to know which font-families are allowed to use inside CentOS -visual identity. -

- -

3.54.2.1 Translation Markers

- -

Inside `trunk/Translations/Identity/Fonts', translation files -combine the following translation markers: -

-
-
`font-family:Denmark'
-

Specify which font family to use when rendering font preview images. -

-
`font-weight:normal'
-

Specify which font weight to use when rendering font preview images. -

-
`font-style:normal'
-

Specify which font style to use when rendering font preview images. -

-
- - -

3.54.3 Usage

-

Inside `trunk/Translations/Fonts' you use your favorite text -editor to create translation files. Inside -`trunk/Translations/Fonts' there is not translation template -directory (`Tpl/'), nor translation rendering using -centos-art script. For example, to create the -`dejavu_lgc_sans-boldoblique.sed' translation file using -vim editor, type the following command: -

-
vim /home/centos/artwork/trunk/Translations/Fonts/dejavu_lgc_sans-boldoblique.sed
-
- +

3.54.4 See also

- - -
3.3 trunk/Identity/Fonts   -
- - - + + - +
[ < ][ > ]
[ < ][ > ]   [ << ] [ Up ][ >> ][ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_58.html b/Manuals/en/Html/Repository/repository_58.html index 60c3c79..026998b 100644 --- a/Manuals/en/Html/Repository/repository_58.html +++ b/Manuals/en/Html/Repository/repository_58.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.55 trunk/Translations/Identity/Models +The CentOS Artwork Repository: 3.55 trunk/Translations/Identity/Fonts - - + + @@ -59,41 +54,95 @@ ul.toc {list-style: none} - - + + - + - +
[ < ][ > ]
[ < ][ > ]   [ << ] [ Up ][ >> ][ >> ]         [Top] [Contents][Index][Index] [ ? ]
- - -

3.55 trunk/Translations/Identity/Models

+ + +

3.55 trunk/Translations/Identity/Fonts

- +

3.55.1 Goals

+

This section exists to organize fonts translation files. +

+ +

3.55.2 Description

+ +

Translation files, inside `trunk/Translations/Fonts', have the +following structure: +

+
s!font-family:Denmark!font-family:DejaVu LGC Sans!
+s!font-weight:normal!font-weight:bold!
+s!font-style:normal!font-style:italic!
+
+

Inside `trunk/Translations/Fonts', there is one translation file +for each font preview image you want to produce. This way, we create +one translation file for each font-family we use somewhere inside +CentOS visual identity. +

+
Important

Important

Do not create translation files for font-families +not used somewhere inside CentOS visual identity. The font's identity +entry (see section trunk/Identity/Fonts) is used as reference when someone +needs to know which font-families are allowed to use inside CentOS +visual identity. +

+ -

3.55.2 Description

+

3.55.2.1 Translation Markers

+ +

Inside `trunk/Translations/Identity/Fonts', translation files +combine the following translation markers: +

+
+
`font-family:Denmark'
+

Specify which font family to use when rendering font preview images. +

+
`font-weight:normal'
+

Specify which font weight to use when rendering font preview images. +

+
`font-style:normal'
+

Specify which font style to use when rendering font preview images. +

+

3.55.3 Usage

+

Inside `trunk/Translations/Fonts' you use your favorite text +editor to create translation files. Inside +`trunk/Translations/Fonts' there is not translation template +directory (`Tpl/'), nor translation rendering using +centos-art script. For example, to create the +`dejavu_lgc_sans-boldoblique.sed' translation file using +vim editor, type the following command: +

+
vim /home/centos/artwork/trunk/Translations/Fonts/dejavu_lgc_sans-boldoblique.sed
+

3.55.4 See also

+ + +
3.3 trunk/Identity/Fonts   +
+ @@ -101,12 +150,12 @@ ul.toc {list-style: none} - - + +
[ > ]   [ << ][ Up ][ >> ][ Up ][ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_59.html b/Manuals/en/Html/Repository/repository_59.html index 091eb86..827db75 100644 --- a/Manuals/en/Html/Repository/repository_59.html +++ b/Manuals/en/Html/Repository/repository_59.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.56 trunk/Translations/Identity/Release +The CentOS Artwork Repository: 3.56 trunk/Translations/Identity/Models - - + + @@ -64,19 +59,19 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] - + -

3.56 trunk/Translations/Identity/Release

+

3.56 trunk/Translations/Identity/Models

@@ -102,11 +97,11 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_6.html b/Manuals/en/Html/Repository/repository_6.html index 7d71f86..13fff20 100644 --- a/Manuals/en/Html/Repository/repository_6.html +++ b/Manuals/en/Html/Repository/repository_6.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.3 trunk/Identity/Fonts +The CentOS Artwork Repository: 3.3 trunk/Identity/Fonts - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -172,11 +167,11 @@ improve this section with your reasons.   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_60.html b/Manuals/en/Html/Repository/repository_60.html index 32c04e5..8e64194 100644 --- a/Manuals/en/Html/Repository/repository_60.html +++ b/Manuals/en/Html/Repository/repository_60.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.57 trunk/Translations/Identity/Themes +The CentOS Artwork Repository: 3.57 trunk/Translations/Identity/Release - - + + @@ -64,19 +59,19 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] - + -

3.57 trunk/Translations/Identity/Themes

+

3.57 trunk/Translations/Identity/Release

@@ -102,11 +97,11 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_61.html b/Manuals/en/Html/Repository/repository_61.html index 2982a51..7857bd9 100644 --- a/Manuals/en/Html/Repository/repository_61.html +++ b/Manuals/en/Html/Repository/repository_61.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.58 trunk/Translations/Identity/Themes/Backgrounds +The CentOS Artwork Repository: 3.58 trunk/Translations/Identity/Themes - - + + @@ -64,44 +59,32 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] - + -

3.58 trunk/Translations/Identity/Themes/Backgrounds

+

3.58 trunk/Translations/Identity/Themes

3.58.1 Goals

-
    -
  • ... -
-

3.58.2 Description

-
    -
  • ... -
-

3.58.3 Usage

-
    -
  • ... -
-

3.58.4 See also

@@ -114,11 +97,11 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_62.html b/Manuals/en/Html/Repository/repository_62.html index b3be7d6..250cc8d 100644 --- a/Manuals/en/Html/Repository/repository_62.html +++ b/Manuals/en/Html/Repository/repository_62.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.59 trunk/Translations/Identity/Themes/Distro/Anaconda/Progress +The CentOS Artwork Repository: 3.59 trunk/Translations/Identity/Themes/Backgrounds - - + + @@ -64,129 +59,61 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] - + -

3.59 trunk/Translations/Identity/Themes/Distro/Anaconda/Progress

+

3.59 trunk/Translations/Identity/Themes/Backgrounds

3.59.1 Goals

    -
  • Organize Anaconda progress translation templates. -
  • Organize Anaconda progress translation files in several -languages and major releases of CentOS distribution. +
  • ...

3.59.2 Description

-

Use the following command to produce translation files based: -

-
 
trunk/Translations/Identity/Themes/Distro/Anaconda/Progress
-`-- Tpl
-    |-- en
-    |   |-- 01-welcome.sed
-    |   |-- 02-donate.sed
-    |   `-- 03-yum.sed
-    `-- es
-        |-- 01-welcome.sed
-        |-- 02-donate.sed
-        `-- 03-yum.sed
-
-

In order to produce the slide images in PNG format we need to have the -translation files first. So we use the following commands to create -translation files for CentOS 3, 4, and 5 major releases: -

-
 
centos-art render --translation --filter='3,4,5'
-
-

The above commands will produce the following translation structure: -

-
 
trunk/Translations/Identity/Themes/Distro/Anaconda/Progress
-|-- 3
-|   |-- en
-|   |   |-- 01-welcome.sed
-|   |   |-- 02-donate.sed
-|   |   `-- 03-yum.sed
-|   `-- es
-|       |-- 01-welcome.sed
-|       |-- 02-donate.sed
-|       `-- 03-yum.sed
-|-- 4
-|   |-- en
-|   |   |-- 01-welcome.sed
-|   |   |-- 02-donate.sed
-|   |   `-- 03-yum.sed
-|   `-- es
-|       |-- 01-welcome.sed
-|       |-- 02-donate.sed
-|       `-- 03-yum.sed
-|-- 5
-|   |-- en
-|   |   |-- 01-welcome.sed
-|   |   |-- 02-donate.sed
-|   |   `-- 03-yum.sed
-|   `-- es
-|       |-- 01-welcome.sed
-|       |-- 02-donate.sed
-|       `-- 03-yum.sed
-`-- Tpl
-    |-- en
-    |   |-- 01-welcome.sed
-    |   |-- 02-donate.sed
-    |   `-- 03-yum.sed
-    `-- es
-        |-- 01-welcome.sed
-        |-- 02-donate.sed
-        `-- 03-yum.sed
-
-

At this point we have all the translation files we need to produce -Anaconda progress welcome, donate and yum slides images; in English -and Spanish languages; for CentOS 3, CentOS 4, and CentOS 5. That is, -a sum of 18 images around. -

-

Now, with translation files in place, let's move to -`trunk/Identity' structure and render them. -

3.59.3 Usage

-

Translation rendering is described in `trunk/Translations' -documentation entry (see section trunk/Translations). -

+
    +
  • ... +

3.59.4 See also

+ - +
[ < ] [ > ]   [ << ] [ Up ][ >> ][ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_63.html b/Manuals/en/Html/Repository/repository_63.html index c22672e..1d5ac84 100644 --- a/Manuals/en/Html/Repository/repository_63.html +++ b/Manuals/en/Html/Repository/repository_63.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.60 trunk/Translations/Identity/Widgets +The CentOS Artwork Repository: 3.60 trunk/Translations/Identity/Themes/Distro/Anaconda/Progress - - + + @@ -64,56 +59,117 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] - + -

3.60 trunk/Translations/Identity/Widgets

+

3.60 trunk/Translations/Identity/Themes/Distro/Anaconda/Progress

3.60.1 Goals

    -
  • ... +
  • Organize Anaconda progress translation templates. +
  • Organize Anaconda progress translation files in several +languages and major releases of CentOS distribution.

3.60.2 Description

+

Use the following command to produce translation files based: +

+
 
trunk/Translations/Identity/Themes/Distro/Anaconda/Progress
+`-- Tpl
+    |-- en
+    |   |-- 01-welcome.sed
+    |   |-- 02-donate.sed
+    |   `-- 03-yum.sed
+    `-- es
+        |-- 01-welcome.sed
+        |-- 02-donate.sed
+        `-- 03-yum.sed
+
+

In order to produce the slide images in PNG format we need to have the +translation files first. So we use the following commands to create +translation files for CentOS 3, 4, and 5 major releases: +

+
 
centos-art render --translation --filter='3,4,5'
+
+

The above commands will produce the following translation structure: +

+
 
trunk/Translations/Identity/Themes/Distro/Anaconda/Progress
+|-- 3
+|   |-- en
+|   |   |-- 01-welcome.sed
+|   |   |-- 02-donate.sed
+|   |   `-- 03-yum.sed
+|   `-- es
+|       |-- 01-welcome.sed
+|       |-- 02-donate.sed
+|       `-- 03-yum.sed
+|-- 4
+|   |-- en
+|   |   |-- 01-welcome.sed
+|   |   |-- 02-donate.sed
+|   |   `-- 03-yum.sed
+|   `-- es
+|       |-- 01-welcome.sed
+|       |-- 02-donate.sed
+|       `-- 03-yum.sed
+|-- 5
+|   |-- en
+|   |   |-- 01-welcome.sed
+|   |   |-- 02-donate.sed
+|   |   `-- 03-yum.sed
+|   `-- es
+|       |-- 01-welcome.sed
+|       |-- 02-donate.sed
+|       `-- 03-yum.sed
+`-- Tpl
+    |-- en
+    |   |-- 01-welcome.sed
+    |   |-- 02-donate.sed
+    |   `-- 03-yum.sed
+    `-- es
+        |-- 01-welcome.sed
+        |-- 02-donate.sed
+        `-- 03-yum.sed
+
+

At this point we have all the translation files we need to produce +Anaconda progress welcome, donate and yum slides images; in English +and Spanish languages; for CentOS 3, CentOS 4, and CentOS 5. That is, +a sum of 18 images around. +

+

Now, with translation files in place, let's move to +`trunk/Identity' structure and render them. +

3.60.3 Usage

-
    -
  • ... -
+

Translation rendering is described in `trunk/Translations' +documentation entry (see section trunk/Translations). +

3.60.4 See also

- - -
3.60 trunk/Translations/Identity/Widgets   -
- - - - @@ -121,11 +177,11 @@ ul.toc {list-style: none} - +
[ < ]   [ << ] [ Up ][ >> ][ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_64.html b/Manuals/en/Html/Repository/repository_64.html index 46100fd..9fb1cf0 100644 --- a/Manuals/en/Html/Repository/repository_64.html +++ b/Manuals/en/Html/Repository/repository_64.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: Index +The CentOS Artwork Repository: 3.61 trunk/Translations/Identity/Widgets - - + + @@ -60,165 +55,72 @@ ul.toc {list-style: none} - + - - + + - +
[ < ][ > ][ > ]   [ << ][ Up ][ >> ][ Up ][ >> ]         [Top] [Contents][Index][Index] [ ? ]
- + -

Index

-
Jump to:   B -   -C -   -H -   -M -   -S -   -T -   -U -   -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +

3.61 trunk/Translations/Identity/Widgets

+ + + +

3.61.1 Goals

+ +
    +
  • ... +
+ + + +

3.61.2 Description

+ +
    +
  • ... +
+ + + +

3.61.3 Usage

+ +
    +
  • ... +
+ + + +

3.61.4 See also

+ +
Index Entry Section
B
branches1. branches
C
Common translation files3.50.2.5 Common Translation Files
H
How to render brands' translation files3.52.3 Usage
How to render fonts' translation files3.54.3 Usage
How to render translation files3.50.3 Usage
M
Metadata maintainance3.45.2 Description
S
Specific translation files3.50.2.6 Specific Translation Files
T
tags2. tags
Template translation files3.50.2.4 Template Translation Files
Translation brands file names3.52.2.1 Conventional file names
Translation brands file names3.52.2.2 Numeric file names
Translation configuration scripts3.50.2.8 Translation (Pre-)Rendering Configuration Scripts
Translation entries3.50.2.1 Translation Entries
Translation files3.50.2.3 Translation Files
Translation markers3.50.2.2 Translation Markers
Translation paths3.50.2.1 Translation Entries
Translation pre-rendering configuration scripts3.50.2.8 Translation (Pre-)Rendering Configuration Scripts
Translation rendering3.50.2.7 Translation Rendering
Translation rendering default functionality3.50.2.9 Translation Rendering Default Functionality
trunk3. trunk
trunk Identity3.1 trunk/Identity
trunk Identity Brands3.2 trunk/Identity/Brands
trunk Identity Fonts3.3 trunk/Identity/Fonts
trunk Identity Icons3.4 trunk/Identity/Icons
trunk Identity Isolinux3.5 trunk/Identity/Isolinux
trunk Identity Models3.6 trunk/Identity/Models
trunk Identity Models Css3.7 trunk/Identity/Models/Css
trunk Identity Models Html3.8 trunk/Identity/Models/Html
trunk Identity Models Img Promo Web3.9 trunk/Identity/Models/Img/Promo/Web
trunk Identity Models Tpl3.10 trunk/Identity/Models/Tpl
trunk Identity Models Tpl Promo Web3.11 trunk/Identity/Models/Tpl/Promo/Web
trunk Identity Models Xcf3.12 trunk/Identity/Models/Xcf
trunk Identity Release3.13 trunk/Identity/Release
trunk Identity Themes3.14 trunk/Identity/Themes
trunk Identity Themes Models3.15 trunk/Identity/Themes/Models
trunk Identity Themes Models Alternative3.16 trunk/Identity/Themes/Models/Alternative
trunk Identity Themes Models Default3.17 trunk/Identity/Themes/Models/Default
trunk Identity Themes Models Default Distro3.18 trunk/Identity/Themes/Models/Default/Distro
trunk Identity Themes Models Default Distro Anaconda3.19 trunk/Identity/Themes/Models/Default/Distro/Anaconda
trunk Identity Themes Models Default Promo3.20 trunk/Identity/Themes/Models/Default/Promo
trunk Identity Themes Models Default Web3.21 trunk/Identity/Themes/Models/Default/Web
trunk Identity Themes Motifs3.22 trunk/Identity/Themes/Motifs
trunk Identity Themes Motifs Flame3.23 trunk/Identity/Themes/Motifs/Flame
trunk Identity Themes Motifs Modern3.24 trunk/Identity/Themes/Motifs/Modern
trunk Identity Themes Motifs Modern Backgrounds3.25 trunk/Identity/Themes/Motifs/Modern/Backgrounds
trunk Identity Themes Motifs Modern Backgrounds Img3.26 trunk/Identity/Themes/Motifs/Modern/Backgrounds/Img
trunk Identity Themes Motifs Modern Backgrounds Tpl3.27 trunk/Identity/Themes/Motifs/Modern/Backgrounds/Tpl
trunk Identity Themes Motifs Modern Backgrounds Xcf3.28 trunk/Identity/Themes/Motifs/Modern/Backgrounds/Xcf
trunk Identity Themes Motifs Modern Distro Anaconda Progress3.29 trunk/Identity/Themes/Motifs/Modern/Distro/Anaconda/Progress
trunk Identity Themes Motifs Modern Palettes3.30 trunk/Identity/Themes/Motifs/Modern/Palettes
trunk Identity Themes Motifs TreeFlower3.31 trunk/Identity/Themes/Motifs/TreeFlower
trunk Identity Themes Motifs TreeFlower Backgrounds3.32 trunk/Identity/Themes/Motifs/TreeFlower/Backgrounds
trunk Identity Widgets3.33 trunk/Identity/Widgets
trunk Manuals3.34 trunk/Manuals
trunk Scripts3.35 trunk/Scripts
trunk Scripts Bash3.36 trunk/Scripts/Bash
trunk Scripts Bash Functions3.37 trunk/Scripts/Bash/Functions
trunk Scripts Bash Functions Html3.38 trunk/Scripts/Bash/Functions/Html
trunk Scripts Bash Functions Locale3.39 trunk/Scripts/Bash/Functions/Locale
trunk Scripts Bash Functions Manual3.40 trunk/Scripts/Bash/Functions/Manual
trunk Scripts Bash Functions Path3.41 trunk/Scripts/Bash/Functions/Path
trunk Scripts Bash Functions Render3.42 trunk/Scripts/Bash/Functions/Render
trunk Scripts Bash Functions Render Config3.43 trunk/Scripts/Bash/Functions/Render/Config
trunk Scripts Bash Functions Shell3.44 trunk/Scripts/Bash/Functions/Shell
trunk Scripts Bash Functions Svg3.45 trunk/Scripts/Bash/Functions/Svg
trunk Scripts Bash Functions Verify3.46 trunk/Scripts/Bash/Functions/Verify
trunk Scripts Bash Locale3.47 trunk/Scripts/Bash/Locale
trunk Scripts Perl3.48 trunk/Scripts/Perl
trunk Scripts Python3.49 trunk/Scripts/Python
trunk Translations3.50 trunk/Translations
trunk Translations Identity3.51 trunk/Translations/Identity
trunk Translations Identity Brands3.52 trunk/Translations/Identity/Brands
trunk Translations Identity Brands Tpl3.53 trunk/Translations/Identity/Brands/Tpl
trunk Translations Identity Fonts3.54 trunk/Translations/Identity/Fonts
trunk Translations Identity Models3.55 trunk/Translations/Identity/Models
trunk Translations Identity Release3.56 trunk/Translations/Identity/Release
trunk Translations Identity Themes3.57 trunk/Translations/Identity/Themes
trunk Translations Identity Themes Backgrounds3.58 trunk/Translations/Identity/Themes/Backgrounds
trunk Translations Identity Themes Distro Anaconda Progress3.59 trunk/Translations/Identity/Themes/Distro/Anaconda/Progress
trunk Translations Identity Widgets3.60 trunk/Translations/Identity/Widgets
U
Unused definitions3.45.2.1 Metadata maintainance
+
3.61 trunk/Translations/Identity/Widgets   +
-
Jump to:   B -   -C -   -H -   -M -   -S -   -T -   -U -   -
+ + + - - + + - - + +
[ < ][ > ]
[ < ][ > ]   [ << ][ Up ][ >> ][ Up ][ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_65.html b/Manuals/en/Html/Repository/repository_65.html index d8affbe..f404ee7 100644 --- a/Manuals/en/Html/Repository/repository_65.html +++ b/Manuals/en/Html/Repository/repository_65.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: List of Figures +The CentOS Artwork Repository: Index - - + + @@ -59,83 +54,167 @@ ul.toc {list-style: none} - - + + - + - + - +
[ < ][ > ]
[ < ][ > ]   [ << ][ << ] [ Up ][ >> ][ >> ]         [Top] [Contents][Index][Index] [ ? ]
- - -

List of Figures

-
-
Figure 3.1

The CentOS web customization design model. -

-
Figure 3.2

The CentOS web customization using promotion design model. -

-
Figure 3.3

Web environment html definitions -

-
Figure 3.4

The CentOS web navigation design model. -

-
Figure 3.5

The Flame artistic motif. -

-
Figure 3.6

The Flame artistic motif construction step 1. -

-
Figure 3.7

The Flame artistic motif construction step 2. -

-
Figure 3.8

The Flame artistic motif construction step 3. -

-
Figure 3.9

The Flame artistic motif construction step 4. -

-
Figure 3.10

The Modern artistic motif. -

-
Figure 3.11

The TreeFlower artistic motif. -

-
Figure 3.12

The functionalities initialization environment. -

-
Figure 3.13

The actions initialization environment. -

-
Figure 3.14

The cli_commitRepoChanges function output. -

-
Figure 3.15

The CentOS Artwork Repository layout. -

-
Figure 3.16

Name convention for tags and branches creation. -

-
Figure 3.17

Parallel directories removing uncommon information. -

-
Figure 3.18

Parallel directories adding uncommon information. -

-
Figure 3.19

Wrong construction of parallel directories. -

-
Figure 3.20

The functions script base comment structure -

-
Figure 3.21

The function script comment example -

-
Figure 3.22

The image rendering flow. -

-
+ + +

Index

+
Jump to:   B +   +C +   +H +   +M +   +S +   +T +   +U +   +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Index Entry Section
B
branches1. branches
C
Common translation files3.51.2.5 Common Translation Files
H
How to render brands' translation files3.53.3 Usage
How to render fonts' translation files3.55.3 Usage
How to render translation files3.51.3 Usage
M
Metadata maintainance3.46.2 Description
S
Specific translation files3.51.2.6 Specific Translation Files
T
tags2. tags
Template translation files3.51.2.4 Template Translation Files
Translation brands file names3.53.2.1 Conventional file names
Translation brands file names3.53.2.2 Numeric file names
Translation configuration scripts3.51.2.8 Translation (Pre-)Rendering Configuration Scripts
Translation entries3.51.2.1 Translation Entries
Translation files3.51.2.3 Translation Files
Translation markers3.51.2.2 Translation Markers
Translation paths3.51.2.1 Translation Entries
Translation pre-rendering configuration scripts3.51.2.8 Translation (Pre-)Rendering Configuration Scripts
Translation rendering3.51.2.7 Translation Rendering
Translation rendering default functionality3.51.2.9 Translation Rendering Default Functionality
trunk3. trunk
trunk Identity3.1 trunk/Identity
trunk Identity Brands3.2 trunk/Identity/Brands
trunk Identity Fonts3.3 trunk/Identity/Fonts
trunk Identity Icons3.4 trunk/Identity/Icons
trunk Identity Isolinux3.5 trunk/Identity/Isolinux
trunk Identity Models3.6 trunk/Identity/Models
trunk Identity Models Css3.7 trunk/Identity/Models/Css
trunk Identity Models Html3.8 trunk/Identity/Models/Html
trunk Identity Models Img Promo Web3.9 trunk/Identity/Models/Img/Promo/Web
trunk Identity Models Tpl3.10 trunk/Identity/Models/Tpl
trunk Identity Models Tpl Promo Web3.11 trunk/Identity/Models/Tpl/Promo/Web
trunk Identity Models Xcf3.12 trunk/Identity/Models/Xcf
trunk Identity Release3.13 trunk/Identity/Release
trunk Identity Themes3.14 trunk/Identity/Themes
trunk Identity Themes Models3.15 trunk/Identity/Themes/Models
trunk Identity Themes Models Alternative3.16 trunk/Identity/Themes/Models/Alternative
trunk Identity Themes Models Default3.17 trunk/Identity/Themes/Models/Default
trunk Identity Themes Models Default Distro3.18 trunk/Identity/Themes/Models/Default/Distro
trunk Identity Themes Models Default Distro Anaconda3.19 trunk/Identity/Themes/Models/Default/Distro/Anaconda
trunk Identity Themes Models Default Promo3.20 trunk/Identity/Themes/Models/Default/Promo
trunk Identity Themes Models Default Web3.21 trunk/Identity/Themes/Models/Default/Web
trunk Identity Themes Motifs3.22 trunk/Identity/Themes/Motifs
trunk Identity Themes Motifs Flame3.23 trunk/Identity/Themes/Motifs/Flame
trunk Identity Themes Motifs Modern3.24 trunk/Identity/Themes/Motifs/Modern
trunk Identity Themes Motifs Modern Backgrounds3.25 trunk/Identity/Themes/Motifs/Modern/Backgrounds
trunk Identity Themes Motifs Modern Backgrounds Img3.26 trunk/Identity/Themes/Motifs/Modern/Backgrounds/Img
trunk Identity Themes Motifs Modern Backgrounds Tpl3.27 trunk/Identity/Themes/Motifs/Modern/Backgrounds/Tpl
trunk Identity Themes Motifs Modern Backgrounds Xcf3.28 trunk/Identity/Themes/Motifs/Modern/Backgrounds/Xcf
trunk Identity Themes Motifs Modern Distro Anaconda Progress3.29 trunk/Identity/Themes/Motifs/Modern/Distro/Anaconda/Progress
trunk Identity Themes Motifs Modern Palettes3.30 trunk/Identity/Themes/Motifs/Modern/Palettes
trunk Identity Themes Motifs TreeFlower3.31 trunk/Identity/Themes/Motifs/TreeFlower
trunk Identity Themes Motifs TreeFlower Backgrounds3.32 trunk/Identity/Themes/Motifs/TreeFlower/Backgrounds
trunk Identity Widgets3.33 trunk/Identity/Widgets
trunk Identity Widgets23.34 trunk/Identity/Widgets2
trunk Manuals3.35 trunk/Manuals
trunk Scripts3.36 trunk/Scripts
trunk Scripts Bash3.37 trunk/Scripts/Bash
trunk Scripts Bash Functions3.38 trunk/Scripts/Bash/Functions
trunk Scripts Bash Functions Html3.39 trunk/Scripts/Bash/Functions/Html
trunk Scripts Bash Functions Locale3.40 trunk/Scripts/Bash/Functions/Locale
trunk Scripts Bash Functions Manual3.41 trunk/Scripts/Bash/Functions/Manual
trunk Scripts Bash Functions Path3.42 trunk/Scripts/Bash/Functions/Path
trunk Scripts Bash Functions Render3.43 trunk/Scripts/Bash/Functions/Render
trunk Scripts Bash Functions Render Config3.44 trunk/Scripts/Bash/Functions/Render/Config
trunk Scripts Bash Functions Shell3.45 trunk/Scripts/Bash/Functions/Shell
trunk Scripts Bash Functions Svg3.46 trunk/Scripts/Bash/Functions/Svg
trunk Scripts Bash Functions Verify3.47 trunk/Scripts/Bash/Functions/Verify
trunk Scripts Bash Locale3.48 trunk/Scripts/Bash/Locale
trunk Scripts Perl3.49 trunk/Scripts/Perl
trunk Scripts Python3.50 trunk/Scripts/Python
trunk Translations3.51 trunk/Translations
trunk Translations Identity3.52 trunk/Translations/Identity
trunk Translations Identity Brands3.53 trunk/Translations/Identity/Brands
trunk Translations Identity Brands Tpl3.54 trunk/Translations/Identity/Brands/Tpl
trunk Translations Identity Fonts3.55 trunk/Translations/Identity/Fonts
trunk Translations Identity Models3.56 trunk/Translations/Identity/Models
trunk Translations Identity Release3.57 trunk/Translations/Identity/Release
trunk Translations Identity Themes3.58 trunk/Translations/Identity/Themes
trunk Translations Identity Themes Backgrounds3.59 trunk/Translations/Identity/Themes/Backgrounds
trunk Translations Identity Themes Distro Anaconda Progress3.60 trunk/Translations/Identity/Themes/Distro/Anaconda/Progress
trunk Translations Identity Widgets3.61 trunk/Translations/Identity/Widgets
U
Unused definitions3.46.2.1 Metadata maintainance
+
Jump to:   B +   +C +   +H +   +M +   +S +   +T +   +U +   +
- - + + - + - +
[ < ][ > ]
[ < ][ > ]   [ << ][ << ] [ Up ][ >> ][ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_66.html b/Manuals/en/Html/Repository/repository_66.html index e9b338b..703cc31 100644 --- a/Manuals/en/Html/Repository/repository_66.html +++ b/Manuals/en/Html/Repository/repository_66.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: List of Figures +The CentOS Artwork Repository: List of Figures - - + + @@ -78,37 +73,49 @@ ul.toc {list-style: none}

List of Figures

-
Figure 3.1

The CentOS Type. +

Figure 3.1

The CentOS web customization design model. +

+
Figure 3.2

The CentOS web customization using promotion design model. +

+
Figure 3.3

Web environment html definitions +

+
Figure 3.4

The CentOS web navigation design model. +

+
Figure 3.5

The Flame artistic motif. +

+
Figure 3.6

The Flame artistic motif construction step 1. +

+
Figure 3.7

The Flame artistic motif construction step 2.

-
Figure 3.2

The CentOS Type plus release information (i.e., CentOS Release Brand). +

Figure 3.8

The Flame artistic motif construction step 3.

-
Figure 3.3

The CentOS Type plus release information plus description (i.e., CentOS Release Brand with description). +

Figure 3.9

The Flame artistic motif construction step 4.

-
Figure 3.4

The CentOS web customization design model. +

Figure 3.10

The Modern artistic motif.

-
Figure 3.5

The CentOS web customization using promotion design model. +

Figure 3.11

The TreeFlower artistic motif.

-
Figure 3.6

Web environment html definitions +

Figure 3.12

The functionalities initialization environment.

-
Figure 3.7

The CentOS web navigation design model. +

Figure 3.13

The actions initialization environment.

-
Figure 3.8

The functionalities initialization environment. +

Figure 3.14

The cli_commitRepoChanges function output.

-
Figure 3.9

The actions initialization environment. +

Figure 3.15

The CentOS Artwork Repository layout.

-
Figure 3.10

The cli_commitRepoChanges function output. +

Figure 3.16

Name convention for tags and branches creation.

-
Figure 3.11

The CentOS Artwork Repository layout. +

Figure 3.17

Parallel directories removing uncommon information.

-
Figure 3.12

Name convention for tags and branches creation. +

Figure 3.18

Parallel directories adding uncommon information.

-
Figure 3.13

Parallel directories removing uncommon information. +

Figure 3.19

Wrong construction of parallel directories.

-
Figure 3.14

Parallel directories adding uncommon information. +

Figure 3.20

The functions script base comment structure

-
Figure 3.15

Wrong construction of parallel directories. +

Figure 3.21

The function script comment example

-
Figure 3.16

The image rendering flow. +

Figure 3.22

The image rendering flow.

@@ -123,7 +130,7 @@ ul.toc {list-style: none}

- This document was generated on December, 22 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_7.html b/Manuals/en/Html/Repository/repository_7.html index 8a2c5c3..be015eb 100644 --- a/Manuals/en/Html/Repository/repository_7.html +++ b/Manuals/en/Html/Repository/repository_7.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.4 trunk/Identity/Icons +The CentOS Artwork Repository: 3.4 trunk/Identity/Icons - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -106,11 +101,11 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_8.html b/Manuals/en/Html/Repository/repository_8.html index d14f346..e372128 100644 --- a/Manuals/en/Html/Repository/repository_8.html +++ b/Manuals/en/Html/Repository/repository_8.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.5 trunk/Identity/Isolinux +The CentOS Artwork Repository: 3.5 trunk/Identity/Isolinux - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -106,11 +101,11 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_9.html b/Manuals/en/Html/Repository/repository_9.html index 6135cd4..84e6c38 100644 --- a/Manuals/en/Html/Repository/repository_9.html +++ b/Manuals/en/Html/Repository/repository_9.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: 3.6 trunk/Identity/Models +The CentOS Artwork Repository: 3.6 trunk/Identity/Models - - + + @@ -64,14 +59,14 @@ ul.toc {list-style: none}   [ << ] [ Up ] -[ >> ] +[ >> ]         [Top] [Contents] -[Index] +[Index] [ ? ] @@ -117,11 +112,11 @@ to build artworks.   [ << ] [ Up ] -[ >> ] +[ >> ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_abt.html b/Manuals/en/Html/Repository/repository_abt.html index 4ff420c..d5a2037 100644 --- a/Manuals/en/Html/Repository/repository_abt.html +++ b/Manuals/en/Html/Repository/repository_abt.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: About This Document +The CentOS Artwork Repository: About This Document - - + + @@ -62,12 +57,12 @@ ul.toc {list-style: none} - +
[Top] [Contents][Index][Index] [ ? ]

About This Document

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.

The buttons in the navigation panels have the following meaning: @@ -170,12 +165,12 @@ ul.toc {list-style: none} - +
[Top] [Contents][Index][Index] [ ? ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_fot.html b/Manuals/en/Html/Repository/repository_fot.html index 1aef18d..068b049 100644 --- a/Manuals/en/Html/Repository/repository_fot.html +++ b/Manuals/en/Html/Repository/repository_fot.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: Footnotes +The CentOS Artwork Repository: Footnotes - - + + @@ -62,32 +57,32 @@ ul.toc {list-style: none} - +
[Top] [Contents][Index][Index] [ ? ]

Footnotes

(1)

Mailman's theme support may be introduced in mailman-3.x.x release. -

(2)

+

(2)

This number is an approximate value and may change. It is mainly based on CentOS 5 rebranding experience. -

(3)

+

(3)

This value was taken from CentOS release schema. -

(4)

+

(4)

This value was taken from the locale -a command's output.

- +
[Top] [Contents][Index][Index] [ ? ]

- This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
diff --git a/Manuals/en/Html/Repository/repository_toc.html b/Manuals/en/Html/Repository/repository_toc.html index cf618ae..48db235 100644 --- a/Manuals/en/Html/Repository/repository_toc.html +++ b/Manuals/en/Html/Repository/repository_toc.html @@ -1,13 +1,8 @@ - - + -CentOS Artwork Repository: Table of Contents +The CentOS Artwork Repository: Table of Contents - - + + @@ -62,7 +57,7 @@ ul.toc {list-style: none} - +
[Top] [Contents][Index][Index] [ ? ]

Table of Contents

@@ -346,257 +341,264 @@ ul.toc {list-style: none}
  • 3.33.3 Usage
  • 3.33.4 See also
    • -
  • 3.34 trunk/Manuals +
  • 3.34 trunk/Identity/Widgets2
    • -
  • 3.35 trunk/Scripts +
  • 3.35 trunk/Manuals
    • -
  • 3.36 trunk/Scripts/Bash +
  • 3.36 trunk/Scripts
    • -
  • 3.37 trunk/Scripts/Bash/Functions +
  • 3.37 trunk/Scripts/Bash
    • -
  • 3.38 trunk/Scripts/Bash/Functions/Html +
  • 3.38 trunk/Scripts/Bash/Functions
    • -
  • 3.39 trunk/Scripts/Bash/Functions/Locale +
  • 3.39 trunk/Scripts/Bash/Functions/Html
    • -
  • 3.40 trunk/Scripts/Bash/Functions/Manual +
  • 3.40 trunk/Scripts/Bash/Functions/Locale
    • -
  • 3.41 trunk/Scripts/Bash/Functions/Path +
  • 3.41 trunk/Scripts/Bash/Functions/Manual
    • -
  • 3.42 trunk/Scripts/Bash/Functions/Render +
  • 3.42 trunk/Scripts/Bash/Functions/Path
    • -
  • 3.43 trunk/Scripts/Bash/Functions/Render/Config +
  • 3.43 trunk/Scripts/Bash/Functions/Render
    • -
  • 3.44 trunk/Scripts/Bash/Functions/Shell +
  • 3.44 trunk/Scripts/Bash/Functions/Render/Config
    • -
  • 3.45 trunk/Scripts/Bash/Functions/Svg +
  • 3.45 trunk/Scripts/Bash/Functions/Shell
    • -
  • 3.46 trunk/Scripts/Bash/Functions/Verify +
  • 3.46 trunk/Scripts/Bash/Functions/Svg
    • -
  • 3.47 trunk/Scripts/Bash/Locale +
  • 3.47 trunk/Scripts/Bash/Functions/Verify
    • -
  • 3.48 trunk/Scripts/Perl +
  • 3.48 trunk/Scripts/Bash/Locale
    • -
  • 3.49 trunk/Scripts/Python +
  • 3.49 trunk/Scripts/Perl
    • -
  • 3.50 trunk/Translations +
  • 3.50 trunk/Scripts/Python
    • -
  • 3.51 trunk/Translations/Identity +
  • 3.51 trunk/Translations
    • -
  • 3.52 trunk/Translations/Identity/Brands +
  • 3.52 trunk/Translations/Identity
    • -
  • 3.53 trunk/Translations/Identity/Brands/Tpl +
  • 3.53 trunk/Translations/Identity/Brands
    • -
  • 3.54 trunk/Translations/Identity/Fonts +
  • 3.54 trunk/Translations/Identity/Brands/Tpl
    • -
  • 3.55 trunk/Translations/Identity/Models +
  • 3.55 trunk/Translations/Identity/Fonts
    • -
  • 3.56 trunk/Translations/Identity/Release +
  • 3.56 trunk/Translations/Identity/Models
    • -
  • 3.57 trunk/Translations/Identity/Themes +
  • 3.57 trunk/Translations/Identity/Release
    • -
  • 3.58 trunk/Translations/Identity/Themes/Backgrounds +
  • 3.58 trunk/Translations/Identity/Themes
    • -
  • 3.59 trunk/Translations/Identity/Themes/Distro/Anaconda/Progress +
  • 3.59 trunk/Translations/Identity/Themes/Backgrounds
    • -
  • 3.60 trunk/Translations/Identity/Widgets +
  • 3.60 trunk/Translations/Identity/Themes/Distro/Anaconda/Progress
    • +
  • 3.61 trunk/Translations/Identity/Widgets +
    • -
  • Index
    • -
  • List of Figures
    • +
  • Index
    • +
  • List of Figures
    • - +
    [Top] [Contents][Index][Index] [ ? ]

    - This document was generated on December, 26 2010 using texi2html 1.76. + This document was generated on January, 3 2011 using texi2html 1.76.
    diff --git a/Manuals/en/Info/Repository/repository.info.bz2 b/Manuals/en/Info/Repository/repository.info.bz2 index 37766b2..ed079e5 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/Pdf/Repository/repository.pdf b/Manuals/en/Pdf/Repository/repository.pdf index 5ba15b6..14e9146 100644 Binary files a/Manuals/en/Pdf/Repository/repository.pdf and b/Manuals/en/Pdf/Repository/repository.pdf differ diff --git a/Manuals/en/Plaintext/Repository/repository.txt b/Manuals/en/Plaintext/Repository/repository.txt index 60f5f2f..c1541db 100644 --- a/Manuals/en/Plaintext/Repository/repository.txt +++ b/Manuals/en/Plaintext/Repository/repository.txt @@ -200,171 +200,176 @@ CentOS Artwork Repository 3.33.2 Description 3.33.3 Usage 3.33.4 See also - 3.34 trunk/Manuals + 3.34 trunk/Identity/Widgets2 3.34.1 Goals 3.34.2 Description 3.34.3 Usage 3.34.4 See also - 3.35 trunk/Scripts + 3.35 trunk/Manuals 3.35.1 Goals 3.35.2 Description 3.35.3 Usage 3.35.4 See also - 3.36 trunk/Scripts/Bash + 3.36 trunk/Scripts 3.36.1 Goals 3.36.2 Description 3.36.3 Usage 3.36.4 See also - 3.37 trunk/Scripts/Bash/Functions + 3.37 trunk/Scripts/Bash 3.37.1 Goals 3.37.2 Description 3.37.3 Usage - 3.37.3.1 Global variables - 3.37.3.2 Global functions - 3.37.3.3 Specific functions 3.37.4 See also - 3.38 trunk/Scripts/Bash/Functions/Html + 3.38 trunk/Scripts/Bash/Functions 3.38.1 Goals 3.38.2 Description 3.38.3 Usage + 3.38.3.1 Global variables + 3.38.3.2 Global functions + 3.38.3.3 Specific functions 3.38.4 See also - 3.39 trunk/Scripts/Bash/Functions/Locale + 3.39 trunk/Scripts/Bash/Functions/Html 3.39.1 Goals 3.39.2 Description 3.39.3 Usage 3.39.4 See also - 3.40 trunk/Scripts/Bash/Functions/Manual + 3.40 trunk/Scripts/Bash/Functions/Locale 3.40.1 Goals 3.40.2 Description 3.40.3 Usage 3.40.4 See also - 3.41 trunk/Scripts/Bash/Functions/Path + 3.41 trunk/Scripts/Bash/Functions/Manual 3.41.1 Goals 3.41.2 Description - 3.41.2.1 Repository layout - 3.41.2.2 Repository name convenctions - 3.41.2.3 Repository work flow - 3.41.2.4 Parallel directories - 3.41.2.5 Syncronizing path information - 3.41.2.6 What is the right place to store it? 3.41.3 Usage 3.41.4 See also - 3.42 trunk/Scripts/Bash/Functions/Render + 3.42 trunk/Scripts/Bash/Functions/Path 3.42.1 Goals 3.42.2 Description + 3.42.2.1 Repository layout + 3.42.2.2 Repository name convenctions + 3.42.2.3 Repository work flow + 3.42.2.4 Parallel directories + 3.42.2.5 Syncronizing path information + 3.42.2.6 What is the right place to store it? 3.42.3 Usage 3.42.4 See also - 3.43 trunk/Scripts/Bash/Functions/Render/Config + 3.43 trunk/Scripts/Bash/Functions/Render 3.43.1 Goals 3.43.2 Description - 3.43.2.1 The `render.conf.sh' identity model - 3.43.2.2 The `render.conf.sh' translation model - 3.43.2.3 The `render.conf.sh' rendering actions 3.43.3 Usage 3.43.4 See also - 3.44 trunk/Scripts/Bash/Functions/Shell + 3.44 trunk/Scripts/Bash/Functions/Render/Config 3.44.1 Goals 3.44.2 Description + 3.44.2.1 The `render.conf.sh' identity model + 3.44.2.2 The `render.conf.sh' translation model + 3.44.2.3 The `render.conf.sh' rendering actions 3.44.3 Usage 3.44.4 See also - 3.45 trunk/Scripts/Bash/Functions/Svg + 3.45 trunk/Scripts/Bash/Functions/Shell 3.45.1 Goals 3.45.2 Description - 3.45.2.1 Metadata maintainance - 3.45.2.2 Unused definitions 3.45.3 Usage 3.45.4 See also - 3.46 trunk/Scripts/Bash/Functions/Verify + 3.46 trunk/Scripts/Bash/Functions/Svg 3.46.1 Goals 3.46.2 Description - 3.46.2.1 Packages - 3.46.2.2 Links - 3.46.2.3 Environment variables + 3.46.2.1 Metadata maintainance + 3.46.2.2 Unused definitions 3.46.3 Usage 3.46.4 See also - 3.47 trunk/Scripts/Bash/Locale + 3.47 trunk/Scripts/Bash/Functions/Verify 3.47.1 Goals 3.47.2 Description + 3.47.2.1 Packages + 3.47.2.2 Links + 3.47.2.3 Environment variables 3.47.3 Usage 3.47.4 See also - 3.48 trunk/Scripts/Perl + 3.48 trunk/Scripts/Bash/Locale 3.48.1 Goals 3.48.2 Description 3.48.3 Usage 3.48.4 See also - 3.49 trunk/Scripts/Python + 3.49 trunk/Scripts/Perl 3.49.1 Goals 3.49.2 Description 3.49.3 Usage 3.49.4 See also - 3.50 trunk/Translations + 3.50 trunk/Scripts/Python 3.50.1 Goals 3.50.2 Description - 3.50.2.1 Translation Entries - 3.50.2.2 Translation Markers - 3.50.2.3 Translation Files - 3.50.2.4 Template Translation Files - 3.50.2.5 Common Translation Files - 3.50.2.6 Specific Translation Files - 3.50.2.7 Translation Rendering - 3.50.2.8 Translation (Pre-)Rendering Configuration Scripts - 3.50.2.9 Translation Rendering Default Functionality 3.50.3 Usage 3.50.4 See also - 3.51 trunk/Translations/Identity + 3.51 trunk/Translations 3.51.1 Goals 3.51.2 Description + 3.51.2.1 Translation Entries + 3.51.2.2 Translation Markers + 3.51.2.3 Translation Files + 3.51.2.4 Template Translation Files + 3.51.2.5 Common Translation Files + 3.51.2.6 Specific Translation Files + 3.51.2.7 Translation Rendering + 3.51.2.8 Translation (Pre-)Rendering Configuration Scripts + 3.51.2.9 Translation Rendering Default Functionality 3.51.3 Usage 3.51.4 See also - 3.52 trunk/Translations/Identity/Brands + 3.52 trunk/Translations/Identity 3.52.1 Goals 3.52.2 Description - 3.52.2.1 Conventional file names - 3.52.2.2 Numeric file names - 3.52.2.3 Translation markers 3.52.3 Usage 3.52.4 See also - 3.53 trunk/Translations/Identity/Brands/Tpl + 3.53 trunk/Translations/Identity/Brands 3.53.1 Goals 3.53.2 Description + 3.53.2.1 Conventional file names + 3.53.2.2 Numeric file names + 3.53.2.3 Translation markers 3.53.3 Usage 3.53.4 See also - 3.54 trunk/Translations/Identity/Fonts + 3.54 trunk/Translations/Identity/Brands/Tpl 3.54.1 Goals 3.54.2 Description - 3.54.2.1 Translation Markers 3.54.3 Usage 3.54.4 See also - 3.55 trunk/Translations/Identity/Models + 3.55 trunk/Translations/Identity/Fonts 3.55.1 Goals 3.55.2 Description + 3.55.2.1 Translation Markers 3.55.3 Usage 3.55.4 See also - 3.56 trunk/Translations/Identity/Release + 3.56 trunk/Translations/Identity/Models 3.56.1 Goals 3.56.2 Description 3.56.3 Usage 3.56.4 See also - 3.57 trunk/Translations/Identity/Themes + 3.57 trunk/Translations/Identity/Release 3.57.1 Goals 3.57.2 Description 3.57.3 Usage 3.57.4 See also - 3.58 trunk/Translations/Identity/Themes/Backgrounds + 3.58 trunk/Translations/Identity/Themes 3.58.1 Goals 3.58.2 Description 3.58.3 Usage 3.58.4 See also - 3.59 trunk/Translations/Identity/Themes/Distro/Anaconda/Progress + 3.59 trunk/Translations/Identity/Themes/Backgrounds 3.59.1 Goals 3.59.2 Description 3.59.3 Usage 3.59.4 See also - 3.60 trunk/Translations/Identity/Widgets + 3.60 trunk/Translations/Identity/Themes/Distro/Anaconda/Progress 3.60.1 Goals 3.60.2 Description 3.60.3 Usage 3.60.4 See also + 3.61 trunk/Translations/Identity/Widgets + 3.61.1 Goals + 3.61.2 Description + 3.61.3 Usage + 3.61.4 See also Index List of Figures @@ -372,13 +377,9 @@ List of Figures CentOS Artwork Repository ************************* -This manual describes the CentOS Artwork Repository. +The CentOS Artwork Repository user guide. - The CentOS Artwork Repository exists to organize and automate The -CentOS Project corporate visual identity (*note trunk Identity::, to -start on). - - Copyright (C) 2009, 2010 Alain Reguera Delgado. All rights reserved. + Copyright (C) 2009, 2010, 2011 Alain Reguera Delgado Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or @@ -2621,8 +2622,8 @@ following `syslinux.hex' file: 3.33.4 See also --------------- -3.34 trunk/Manuals -================== +3.34 trunk/Identity/Widgets2 +============================ 3.34.1 Goals ------------ @@ -2632,9 +2633,26 @@ following `syslinux.hex' file: 3.34.2 Description ------------------ +3.34.3 Usage +------------ + +3.34.4 See also +--------------- + +3.35 trunk/Manuals +================== + +3.35.1 Goals +------------ + * ... -3.34.3 Usage +3.35.2 Description +------------------ + + * ... + +3.35.3 Usage ------------ `centos-art help --read='path/to/dir'' @@ -2672,13 +2690,13 @@ following `syslinux.hex' file: Use this command to remove file documentation as specified in `path/to/dir/filename' combination. -3.34.4 See also +3.35.4 See also --------------- -3.35 trunk/Scripts +3.36 trunk/Scripts ================== -3.35.1 Goals +3.36.1 Goals ------------ The `trunk/Scripts' directory exists to: @@ -2686,23 +2704,23 @@ The `trunk/Scripts' directory exists to: * Organize the "trunk" development line of automation scripts by programming language. -3.35.2 Description +3.36.2 Description ------------------ * ... -3.35.3 Usage +3.36.3 Usage ------------ * ... -3.35.4 See also +3.36.4 See also --------------- -3.36 trunk/Scripts/Bash +3.37 trunk/Scripts/Bash ======================= -3.36.1 Goals +3.37.1 Goals ------------ The `trunk/Scripts/Bash' directory exists to organize the trunk @@ -2710,7 +2728,7 @@ development line of `centos-art.sh' automation script. The `centos-art.sh' script standardizes frequent tasks inside your working copy of CentOS Artwork Repository. -3.36.2 Description +3.37.2 Description ------------------ The best way to understand `centos-art.sh' automation script is @@ -2839,25 +2857,25 @@ functions defined inside function environment. Figure 3.13: The actions initialization environment. -3.36.3 Usage +3.37.3 Usage ------------ The `centos-art.sh' script usage information is described inside each specific function documentation (*note trunk Scripts Bash Functions::). -3.36.4 See also +3.37.4 See also --------------- -3.37 trunk/Scripts/Bash/Functions +3.38 trunk/Scripts/Bash/Functions ================================= -3.37.1 Goals +3.38.1 Goals ------------ The `trunk/Scripts/Bash/Functions' directory exists to organize `centos-art.sh' specific functionalities. -3.37.2 Description +3.38.2 Description ------------------ The specific functions of `centos-art.sh' script are designed with @@ -3136,10 +3154,10 @@ specific functionalities. By the way, the `greet' functionality doesn't exist inside `centos-art.sh' script yet. Would you like to create it? -3.37.3 Usage +3.38.3 Usage ------------ -3.37.3.1 Global variables +3.38.3.1 Global variables ......................... The following global variables of `centos-art.sh' script, are available @@ -3168,6 +3186,14 @@ for you to use inside specific functions: When first argument is not provided, the `centos-art.sh' script immediatly ends its execution. + -- Variable: FUNCDIR + + -- Variable: FUNCDIRNAME + + -- Variable: FUNCSCRIPT + + -- Variable: FUNCCONFIG + -- Variable: ACTIONNAM Define action name. @@ -3186,23 +3212,9 @@ for you to use inside specific functions: Define action value. Action values are associated to just one action name. Action values - contain the repository entry over which its associated action will - be performed in. Repository entries can be directories, files, or - URLs refering the repository structure. - - When action value is not specified as repository entry, the - `centos-art.sh' script evaluates the current directory it was - executed from. If such directory is under the repository structure - (i.e., `/home/centos/artwork/'), the `centos-art.sh' script uses - that directory as value to ACTIONVAL variable. Otherwise, if - outside the repository structure, the `centos-art.sh' script - prints the message `The path provided can't be processed.' and, - after it, immediatly ends script execution. - - Default action value is passed as second argument in - `centos-art.sh' command-line interface. For example, in the - command `centos-art render --entry=path/to/dir --filter=regex', - the ACTIONVAL passed to `centos-art.sh' script is `path/to/dir'. + 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. -- Variable: REGEX Define regular expression used as pattern to build the list of @@ -3327,7 +3339,7 @@ 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 Global functions +3.38.3.2 Global functions ......................... Function scripts stored directly under `trunk/Scripts/Bash/Functions/' @@ -3345,28 +3357,9 @@ global functions you can use inside `centos-art.sh' script. 2. Path to one file inside the local working copy, - 3. URL to one directory inside the remote central repository, - - 4. URL to one file inside the remote central repository. - If another value different from that specified above is passed to action value variable, the `centos-art.sh' script prints an error - message and ends script execution. Notice that when you provide a - URL there is no verification in order to determine the directory - or file you refered on it is valid or not. That verification is - done by the command that receives the location inside the - functionality. The only verification `centos-art.sh' script makes - with URL is granting that they begin with - `https://projects.centos.org/svn/artwork'. - - `cli_checkActionArguments' is called from `cli_getArguments' - function and, probably, there is not other use for - `cli_checkActionArguments' but to be called from - `cli_getArguments' function. - - Update `cli_checkActionArguments' function if you need to improve - action value (ACTIONVAL) variable input validation. - + message and ends script execution. -- Function: cli_checkFiles FILE [TYPE] Verify file existence. @@ -3973,45 +3966,45 @@ global functions you can use inside `centos-art.sh' script. file: trunk/Scripts/Bash/Styles/output_forTwoColumns.awk -3.37.3.3 Specific functions +3.38.3.3 Specific functions ........................... The following specific functions of `centos-art.sh' script, are available for you to use: -3.37.4 See also +3.38.4 See also --------------- -3.38 trunk/Scripts/Bash/Functions/Html +3.39 trunk/Scripts/Bash/Functions/Html ====================================== -3.38.1 Goals +3.39.1 Goals ------------ * ... -3.38.2 Description +3.39.2 Description ------------------ * ... -3.38.3 Usage +3.39.3 Usage ------------ * ... -3.38.4 See also +3.39.4 See also --------------- -3.39 trunk/Scripts/Bash/Functions/Locale +3.40 trunk/Scripts/Bash/Functions/Locale ======================================== -3.39.1 Goals +3.40.1 Goals ------------ * ... -3.39.2 Description +3.40.2 Description ------------------ This command looks for `.sh' files inside Bash directory and extracts @@ -4069,7 +4062,7 @@ following files: * ... -3.39.3 Usage +3.40.3 Usage ------------ `centos-art locale --edit' @@ -4080,34 +4073,34 @@ following files: `centos-art locale --list' Use this command to see the command-line interface locale report. -3.39.4 See also +3.40.4 See also --------------- -3.40 trunk/Scripts/Bash/Functions/Manual +3.41 trunk/Scripts/Bash/Functions/Manual ======================================== -3.40.1 Goals +3.41.1 Goals ------------ * ... -3.40.2 Description +3.41.2 Description ------------------ * ... -3.40.3 Usage +3.41.3 Usage ------------ * ... -3.40.4 See also +3.41.4 See also --------------- -3.41 trunk/Scripts/Bash/Functions/Path +3.42 trunk/Scripts/Bash/Functions/Path ====================================== -3.41.1 Goals +3.42.1 Goals ------------ This section exists to organize files related to `path' @@ -4115,14 +4108,14 @@ functiontionality of `centos-art.sh' script. The `path' functionality of `centos-art.sh' script standardizes movement, syncronization, branching, tagging, and general file maintainance inside the repository. -3.41.2 Description +3.42.2 Description ------------------ _"CentOS like trees, has roots, trunk, branches, leaves and flowers. Day by day they work together in freedom, ruled by the laws of nature and open standards, to show the beauty of its existence."_ -3.41.2.1 Repository layout +3.42.2.1 Repository layout .......................... The repository layout describes organization of files and directories @@ -4169,7 +4162,7 @@ single copy of the master sources. This copy is called the source "repository"; it contains all the information to permit extracting previous versions of those files at any time. -3.41.2.2 Repository name convenctions +3.42.2.2 Repository name convenctions ..................................... Repository name convenctions help us to maintain consistency of names @@ -4188,7 +4181,7 @@ etc.). convenctions to remember, concentrating them in just one single place to look for fixes and improvements. -3.41.2.3 Repository work flow +3.42.2.3 Repository work flow ............................. Repository work flow describes the steps and time intervals used to @@ -4262,7 +4255,7 @@ location to fulfill CentOS distribution artwork needs. The same applies to CentOS Webmasters (the persons whom build CentOS websites), and any other visual manifestation required by the project. -3.41.2.4 Parallel directories +3.42.2.4 Parallel directories ............................. Inside CentOS Artwork Repository, parallel directories are simple @@ -4322,7 +4315,7 @@ certainly, things may stop working the way they should do. Figure 3.19: Wrong construction of parallel directories. -3.41.2.5 Syncronizing path information +3.42.2.5 Syncronizing path information ...................................... Creating parallel directories is very useful to keep repository @@ -4384,7 +4377,7 @@ related files. Updating path references inside related files is specially important for documentation files where documentation nodes are built using repository path information as reference. -3.41.2.6 What is the right place to store it? +3.42.2.6 What is the right place to store it? ............................................. Occasionly, you may find that new corporate visual identity components @@ -4436,7 +4429,7 @@ centos-art manual --read=turnk/Identity/Themes/Motifs/TreeFlower/ change the location we used above by the one you are trying to know concepts for. -3.41.3 Usage +3.42.3 Usage ------------ `centos-art path --copy=SRC --to=DST' @@ -4480,40 +4473,40 @@ concepts for. Each item specified by a URL is deleted from the repository via an immediate commit. -3.41.4 See also +3.42.4 See also --------------- -3.42 trunk/Scripts/Bash/Functions/Render +3.43 trunk/Scripts/Bash/Functions/Render ======================================== -3.42.1 Goals +3.43.1 Goals ------------ * ... -3.42.2 Description +3.43.2 Description ------------------ * ... -3.42.3 Usage +3.43.3 Usage ------------ * ... -3.42.4 See also +3.43.4 See also --------------- -3.43 trunk/Scripts/Bash/Functions/Render/Config +3.44 trunk/Scripts/Bash/Functions/Render/Config =============================================== -3.43.1 Goals +3.44.1 Goals ------------ The `trunk/Scripts/Bash/Config' directory exists to oraganize pre-rendering configuration scripts. -3.43.2 Description +3.44.2 Description ------------------ Pre-rendering configuration scripts let you customize the way @@ -4527,7 +4520,7 @@ both on identity and translation repository entires. Pre-rendering configuration entries are required for each identity entry, but not for translation entries. -3.43.2.1 The `render.conf.sh' identity model +3.44.2.1 The `render.conf.sh' identity model ............................................ Inside CentOS Artwork Repository, we consider identity entries to all @@ -4570,7 +4563,7 @@ extend both image-based and text-based pre-rendering configuration scripts using image-based and text-based post-rendering actions, respectively. -3.43.2.2 The `render.conf.sh' translation model +3.44.2.2 The `render.conf.sh' translation model ............................................... Translation pre-rendering configuration scripts take precedence before @@ -4578,7 +4571,7 @@ default translation rendering action. Translation pre-rendering actions are useful when default translation rendering action do not fit itself to translation entry rendering requirements. -3.43.2.3 The `render.conf.sh' rendering actions +3.44.2.3 The `render.conf.sh' rendering actions ............................................... Inside both image-based and text-based identity pre-rendering @@ -4652,7 +4645,7 @@ ACTIONS[0]='BASE:renderImage' ACTIONS[1]='POST:renderFormats: xpm jpg tif' ACTIONS[2]='LAST:groupByformat: png xpm jpg tif' -3.43.3 Usage +3.44.3 Usage ------------ Use the following commands to administer both identity and translation @@ -4679,19 +4672,19 @@ pre-rendering configuration scripts: directory path under `trunk/Identity' or `trunk/Translations' structures only. -3.43.4 See also +3.44.4 See also --------------- -3.44 trunk/Scripts/Bash/Functions/Shell +3.45 trunk/Scripts/Bash/Functions/Shell ======================================= -3.44.1 Goals +3.45.1 Goals ------------ This section exists to organize files related to `shell' functionality of `centos-art.sh' script. -3.44.2 Description +3.45.2 Description ------------------ The `shell' functionality of `centos-art.sh' script helps you to @@ -4821,7 +4814,7 @@ for changes to take effect over the files you specify. be used, please share your reasons at CentOS Developers mailing list . -3.44.3 Usage +3.45.3 Usage ------------ `centos-art sh --update-copyright='path/to/dir'' @@ -4851,19 +4844,19 @@ inside the list of files to process. matches a regular file; the `centos-art.sh' script uses the file matching as only file in the list of files to process. -3.44.4 See also +3.45.4 See also --------------- -3.45 trunk/Scripts/Bash/Functions/Svg +3.46 trunk/Scripts/Bash/Functions/Svg ===================================== -3.45.1 Goals +3.46.1 Goals ------------ This section exists to organize files related to `svg' functionality of `centos-art.sh' script. -3.45.2 Description +3.46.2 Description ------------------ The `svg' functionality of `centos-art.sh' script helps you to maintain @@ -4875,7 +4868,7 @@ files. Doing so file by file may be a tedious task, so the `centos-art.sh' script provides the `svg' functionality to aid you maintain such actions. -3.45.2.1 Metadata maintainance +3.46.2.1 Metadata maintainance .............................. The metadata used is defined by Inkscape 0.46 using the SVG standard @@ -4982,7 +4975,7 @@ Creative Common Attribution Share-Alike 3.0 License to grant license consistency among all SVG files we manage inside CentOS Artwork Repository. -3.45.2.2 Unused definitions +3.46.2.2 Unused definitions ........................... Many of the no-longer-used gradients, patterns, and markers (more @@ -5002,7 +4995,7 @@ unused definitions editing those files one by one. files, the `centos-art.sh' script uses Inkscape's command-line interface, specifically with the `--vaccum-defs' option. -3.45.3 Usage +3.46.3 Usage ------------ `centos-art svg --update-metadata='path/to/dir'' @@ -5039,13 +5032,13 @@ inside the list of files to process. matches a regular file; the `centos-art.sh' script uses the file matching as only file in the list of files to process. -3.45.4 See also +3.46.4 See also --------------- -3.46 trunk/Scripts/Bash/Functions/Verify +3.47 trunk/Scripts/Bash/Functions/Verify ======================================== -3.46.1 Goals +3.47.1 Goals ------------ This section exists to organize files related to `centos-art.sh' script @@ -5054,7 +5047,7 @@ script helps you to verify the workstation configuration you are planning to use as host for your working copy of CentOS Artwork Repository. -3.46.2 Description +3.47.2 Description ------------------ The first time you download CentOS Artwork Repository you need to @@ -5072,7 +5065,7 @@ appropriate way to use its `verify' functionality is not using the because `centos-art' symbolic link, under `~/bin/' directory, has not been created yet. -3.46.2.1 Packages +3.47.2.1 Packages ................. Installation of auxiliar RPM packages provides the software required to @@ -5102,7 +5095,7 @@ please read its man page running the command: `man sudo'. This reading will be very useful, and with some practice, you will be able to configure your users to have `sudo' privileges. -3.46.2.2 Links +3.47.2.2 Links .............. Creation of symbolic links helps us to alternate between different @@ -5136,7 +5129,7 @@ you need to use the "render" functionality of `centos-art.sh' under configuration, automation scripts cannot be branched under `branches/Scripts' directory structure. -3.46.2.3 Environment variables +3.47.2.3 Environment variables .............................. Definition of environemnt variables helps us to set default values to @@ -5168,48 +5161,61 @@ following environment variables: If no one of these values is set in `EDITOR' environment variable, `centos-art.sh' uses `/usr/bin/vim' text editor by default. -`TZ' - Default time zone representation. - - Time representation inside repository server is set to Coordinated - Universal Time (UTC). Time represetation inside repository working - copies is set as their administrators personally define. - - When repository working copies time representation be defined, it - would be a very good convention to follow if working copies - administrators would set their systems clock to use UTC. - Otherwise it would be difficult for working copies users to find - out when changes were committed up to repository server exactly in - time. - - *Tip* Coordinated Univeral Time (UTC) representation can be - configured when you install CentOS distribution; or later, - runing the `system-config-date' command at a shell prompt - from your graphical interface. - - *Note* If you set your system clock to use UTC representation, - you also need to set the `TZ' environment variable inside - `~/.bash_profile' as follows: - export TZ=UTC - This is required in order for your terminal to display the - correct time information of your zone, taking UTC - representation as reference. - `TEXTDOMAIN' - Default domain used to retrieve translated messages. This value is - set in `initFunctions.sh' and shouldn't be changed. + Default domain used to retrieve translated messages. This + variable is set in `initFunctions.sh' and shouldn't be changed. `TEXTDOMAINDIR' - Default directory used to retrieve translated messages. This value - is set in `initFunctions.sh' and shouldn't be changed. + Default directory used to retrieve translated messages. This + variable is set in `initFunctions.sh' and shouldn't be changed. `LANG' - Default locale information. This value is set when you start your - session and can be changed using the `locale' functionality of - `centos-art.sh' script (*note trunk Scripts Bash Functions - Locale::, for more information). + Default locale information. -3.46.3 Usage + This variable is initially set in the configuration process of + CentOS distribution installer (i.e., Anaconda), specifically in the + `Language' step; or once installed using the + `system-config-language' tool. + + The `centos-art.sh' script uses the LANG environment variable to + know in which language the script messages are printed out. + +`TZ' + Default time zone representation. + + This variable is initially set in the configuration process of + CentOS distribution installer (i.e., Anaconda), specifically in the + `Date and time' step; or once installed using the + `system-config-date' tool. + + The `centos-art.sh' script doesn't use the TZ environment variable + information at all. Instead, this variable is used by the system + shell to show the time information according to your phisical + location on planet Earth. + + Inside your computer, the time information is firstly set in the + BIOS clock (which may need correction), and later in the + configuration process of CentOS distribution installer (or later, + by any of the related configuration tools inside CentOS + distribution). Generally, setting time information is a + straight-forward task and configuration tools available do cover + most relevant location. However, if you need a time precision not + provided by the configuration tools available inside CentOS + distribution then, using TZ variable may be necessary. + + *Convenction* In order to keep changes syncronized between + central repository and its working copies: configure both + repository server and workstations (i.e., the place where + each working copy is set on) to use Coordinated Universal + Time (UTC) as base time representation. Later, correct the + time information for your specific location using time zone + correction. + + The format of TZ environment variable is described in `tzset(3)' + manual page. + + +3.47.3 Usage ------------ `centos-art verify --packages' @@ -5255,19 +5261,20 @@ following environment variables: outputs information as if `--filter' option had not been provided at all. -3.46.4 See also + +3.47.4 See also --------------- -3.47 trunk/Scripts/Bash/Locale +3.48 trunk/Scripts/Bash/Locale ============================== -3.47.1 Goals +3.48.1 Goals ------------ This section exists to organize translation messages and templates used by `centos-art.sh' script. -3.47.2 Description +3.48.2 Description ------------------ Translated messages of `centos-art.sh' script are managed using GNU @@ -5275,7 +5282,7 @@ Translated messages of `centos-art.sh' script are managed using GNU through `centos-art.sh' script "locale" functionality (*note trunk Scripts Bash Functions Locale::). -3.47.3 Usage +3.48.3 Usage ------------ The content of `trunk/Scripts/Bash/Locale' directory should not be @@ -5284,51 +5291,51 @@ managed manually. Instead, use the "locale" functionality of for more information on how to use `centos-art.sh' "locale" functionality. -3.47.4 See also +3.48.4 See also --------------- -3.48 trunk/Scripts/Perl +3.49 trunk/Scripts/Perl ======================= -3.48.1 Goals +3.49.1 Goals ------------ * ... -3.48.2 Description +3.49.2 Description ------------------ -3.48.3 Usage +3.49.3 Usage ------------ -3.48.4 See also +3.49.4 See also --------------- -3.49 trunk/Scripts/Python +3.50 trunk/Scripts/Python ========================= -3.49.1 Goals +3.50.1 Goals ------------ * ... -3.49.2 Description +3.50.2 Description ------------------ * ... -3.49.3 Usage +3.50.3 Usage ------------ * ... -3.49.4 See also +3.50.4 See also --------------- -3.50 trunk/Translations +3.51 trunk/Translations ======================= -3.50.1 Goals +3.51.1 Goals ------------ The `trunk/Translations' directory exists to: @@ -5337,7 +5344,7 @@ The `trunk/Translations' directory exists to: * Organize translation templates used to produce translation files. -3.50.2 Description +3.51.2 Description ------------------ When you create artwork for CentOS distribution you find that some @@ -5374,7 +5381,7 @@ production line is stored under `trunk/Translations' directory. to organize artworks' "translation files" and artworks' "translation templates". -3.50.2.1 Translation Entries +3.51.2.1 Translation Entries ............................ Translation entries exists for each artwork you want to produce. @@ -5455,7 +5462,7 @@ Repository, graphic designers can concentrate their efforts in artworks look and feel (the identity entries), and translators in artworks translations (the translation entries). -3.50.2.2 Translation Markers +3.51.2.2 Translation Markers ............................ Translation markers are used in "Theme Model Designs" and "Translation @@ -5490,7 +5497,7 @@ reference for translators and graphic designers. To have translation markers well defined makes possible that translators and graphic designers can work together but independently one another. -3.50.2.3 Translation Files +3.51.2.3 Translation Files .......................... Translation files are text files with `sed''s commands inside, @@ -5558,7 +5565,7 @@ release-specific translation files, run the translation rendering command with the release number you want to produce translation files for in the `--filter='release-number'' argument. -3.50.2.4 Template Translation Files +3.51.2.4 Template Translation Files ................................... Template translation files are translation files stored inside @@ -5728,7 +5735,7 @@ replacement command is defined _after_ `=MAJOR_RELASE=' translation marker definition in the REPLACEMENT of `=TITLE=' translation marker replacement command. -3.50.2.5 Common Translation Files +3.51.2.5 Common Translation Files ................................. Common translation files contain common translations or no translation @@ -5753,7 +5760,7 @@ trunk/Translations/Identity/Themes/Distro/BootUp/Firstboot/ | `-- splash-small.sed `-- firstboot-left.sed <-- common translation file. -3.50.2.6 Specific Translation Files +3.51.2.6 Specific Translation Files ................................... Specific translation files contain specific translations for their @@ -5776,7 +5783,7 @@ trunk/Translations/Identity/Themes/Distro/BootUp/Firstboot/ | `-- splash-small.sed `-- firstboot-left.sed -3.50.2.7 Translation Rendering +3.51.2.7 Translation Rendering .............................. When rendering translations, the `centos-art' script checks the @@ -5787,7 +5794,7 @@ files. If the translation template directory doesn't exist inside the translation entry the translation rendering fails. In this case the `centos-art' script outputs a message and quits script execution. -3.50.2.8 Translation (Pre-)Rendering Configuration Scripts +3.51.2.8 Translation (Pre-)Rendering Configuration Scripts .......................................................... When the `centos-art' script finds a translation template directory @@ -5873,7 +5880,7 @@ pre-rendering configuration example, the translation pre-rendering configuration file that `centos-art' looks for, inside the above translation pre-rendering configuration directory, is `render.conf.sh'. -3.50.2.9 Translation Rendering Default Functionality +3.51.2.9 Translation Rendering Default Functionality .................................................... In the other hand, if the translation pre-rendering configuration file @@ -5898,7 +5905,7 @@ commands. translation marker section (*note Translation Markers: trunk:Translations:TranslationMarkers.). -3.50.3 Usage +3.51.3 Usage ------------ `centos-art render --entry='path/to/dir'' @@ -5915,7 +5922,7 @@ commands. `3,4,5,6') that specify the major release of CentOS distribution you want to render translations for. -3.50.4 See also +3.51.4 See also --------------- ---------- Footnotes ---------- @@ -5927,36 +5934,36 @@ mainly based on CentOS 5 rebranding experience. (3) This value was taken from the `locale -a' command's output. -3.51 trunk/Translations/Identity +3.52 trunk/Translations/Identity ================================ -3.51.1 Goals +3.52.1 Goals ------------ * ... -3.51.2 Description +3.52.2 Description ------------------ * ... -3.51.3 Usage +3.52.3 Usage ------------ * ... -3.51.4 See also +3.52.4 See also --------------- -3.52 trunk/Translations/Identity/Brands +3.53 trunk/Translations/Identity/Brands ======================================= -3.52.1 Goals +3.53.1 Goals ------------ * Organize brands' translation files. -3.52.2 Description +3.53.2 Description ------------------ Translation files, inside `trunk/Translations/Identity/Brands' @@ -5989,7 +5996,7 @@ script considers translation symbolic links as translation files. Translation file names, inside brands' translation template (`Tpl') directory have special meaning: -3.52.2.1 Conventional file names +3.53.2.1 Conventional file names ................................ Convenctional file names look like `blue.sed', `2c-a.sed', etc. @@ -5997,7 +6004,7 @@ Replacement commands inside translation file are applied to design templates and translation file names are used as final image name. The image dimensions use the same dimensions that design template has. -3.52.2.2 Numeric file names +3.53.2.2 Numeric file names ........................... Numeric file names look like `300.sed', `200.sed', etc. Replacements @@ -6018,7 +6025,7 @@ templates, the image size you produce is not limitted in size. You can use one design template produced in 400x200 pixels to produce larger or shorter PNG images using numeric translation files as described above. -3.52.2.3 Translation markers +3.53.2.3 Translation markers ............................ Inside `trunk/Translations/Identity/Brands/', translation files combine @@ -6032,7 +6039,7 @@ the following translation markers: point to template translation files, translation markers are defined inside template translation files. -3.52.3 Usage +3.53.3 Usage ------------ To render brands' translation files, use the following command: @@ -6040,33 +6047,33 @@ To render brands' translation files, use the following command: centos-art render --translation=/home/centos/artwork/trunk/Translations/Identity/Brands -3.52.4 See also +3.53.4 See also --------------- -3.53 trunk/Translations/Identity/Brands/Tpl +3.54 trunk/Translations/Identity/Brands/Tpl =========================================== -3.53.1 Goals +3.54.1 Goals ------------ -3.53.2 Description +3.54.2 Description ------------------ -3.53.3 Usage +3.54.3 Usage ------------ -3.53.4 See also +3.54.4 See also --------------- -3.54 trunk/Translations/Identity/Fonts +3.55 trunk/Translations/Identity/Fonts ====================================== -3.54.1 Goals +3.55.1 Goals ------------ This section exists to organize fonts translation files. -3.54.2 Description +3.55.2 Description ------------------ Translation files, inside `trunk/Translations/Fonts', have the @@ -6088,7 +6095,7 @@ visual identity. someone needs to know which font-families are allowed to use inside CentOS visual identity. -3.54.2.1 Translation Markers +3.55.2.1 Translation Markers ............................ Inside `trunk/Translations/Identity/Fonts', translation files combine @@ -6105,7 +6112,7 @@ the following translation markers: `font-style:normal' Specify which font style to use when rendering font preview images. -3.54.3 Usage +3.55.3 Usage ------------ Inside `trunk/Translations/Fonts' you use your favorite text editor to @@ -6118,79 +6125,79 @@ type the following command: vim /home/centos/artwork/trunk/Translations/Fonts/dejavu_lgc_sans-boldoblique.sed -3.54.4 See also +3.55.4 See also --------------- -3.55 trunk/Translations/Identity/Models +3.56 trunk/Translations/Identity/Models ======================================= -3.55.1 Goals +3.56.1 Goals ------------ -3.55.2 Description +3.56.2 Description ------------------ -3.55.3 Usage +3.56.3 Usage ------------ -3.55.4 See also +3.56.4 See also --------------- -3.56 trunk/Translations/Identity/Release +3.57 trunk/Translations/Identity/Release ======================================== -3.56.1 Goals +3.57.1 Goals ------------ -3.56.2 Description +3.57.2 Description ------------------ -3.56.3 Usage +3.57.3 Usage ------------ -3.56.4 See also +3.57.4 See also --------------- -3.57 trunk/Translations/Identity/Themes +3.58 trunk/Translations/Identity/Themes ======================================= -3.57.1 Goals +3.58.1 Goals ------------ -3.57.2 Description +3.58.2 Description ------------------ -3.57.3 Usage +3.58.3 Usage ------------ -3.57.4 See also +3.58.4 See also --------------- -3.58 trunk/Translations/Identity/Themes/Backgrounds +3.59 trunk/Translations/Identity/Themes/Backgrounds =================================================== -3.58.1 Goals +3.59.1 Goals ------------ * ... -3.58.2 Description +3.59.2 Description ------------------ * ... -3.58.3 Usage +3.59.3 Usage ------------ * ... -3.58.4 See also +3.59.4 See also --------------- -3.59 trunk/Translations/Identity/Themes/Distro/Anaconda/Progress +3.60 trunk/Translations/Identity/Themes/Distro/Anaconda/Progress ================================================================ -3.59.1 Goals +3.60.1 Goals ------------ * Organize Anaconda progress translation templates. @@ -6198,7 +6205,7 @@ vim /home/centos/artwork/trunk/Translations/Fonts/dejavu_lgc_sans-boldoblique.se * Organize Anaconda progress translation files in several languages and major releases of CentOS distribution. -3.59.2 Description +3.60.2 Description ------------------ Use the following command to produce translation files based: @@ -6271,127 +6278,128 @@ structure and render them. * *Note trunk Identity Themes Motifs Modern Distro Anaconda Progress::. -3.59.3 Usage +3.60.3 Usage ------------ Translation rendering is described in `trunk/Translations' documentation entry (*note trunk Translations::). -3.59.4 See also +3.60.4 See also --------------- -3.60 trunk/Translations/Identity/Widgets +3.61 trunk/Translations/Identity/Widgets ======================================== -3.60.1 Goals +3.61.1 Goals ------------ * ... -3.60.2 Description +3.61.2 Description ------------------ * ... -3.60.3 Usage +3.61.3 Usage ------------ * ... -3.60.4 See also +3.61.4 See also --------------- Index ***** -branches: See 1. (line 393) -Common translation files: See 3.50.2.5. (line 5734) -How to render brands' translation files: See 3.52.3. (line 6038) -How to render fonts' translation files: See 3.54.3. (line 6111) -How to render translation files: See 3.50.3. (line 5904) -Metadata maintainance: See 3.45.2. (line 4878) -Specific translation files: See 3.50.2.6. (line 5759) -tags: See 2. (line 396) -Template translation files: See 3.50.2.4. (line 5564) -Translation brands file names: See 3.52.2.1. (line 5995) -Translation configuration scripts: See 3.50.2.8. (line 5793) -Translation entries: See 3.50.2.1. (line 5380) -Translation files: See 3.50.2.3. (line 5496) -Translation markers: See 3.50.2.2. (line 5461) -Translation paths: See 3.50.2.1. (line 5380) -Translation pre-rendering configuration scripts:See 3.50.2.8. - (line 5793) -Translation rendering: See 3.50.2.7. (line 5782) -Translation rendering default functionality: See 3.50.2.9. (line 5879) -trunk: See 3. (line 399) -trunk Identity: See 3.1. (line 402) -trunk Identity Brands: See 3.2. (line 822) -trunk Identity Fonts: See 3.3. (line 839) -trunk Identity Icons: See 3.4. (line 916) -trunk Identity Isolinux: See 3.5. (line 933) -trunk Identity Models: See 3.6. (line 950) -trunk Identity Models Css: See 3.7. (line 970) -trunk Identity Models Html: See 3.8. (line 992) -trunk Identity Models Img Promo Web: See 3.9. (line 1013) -trunk Identity Models Tpl: See 3.10. (line 1034) -trunk Identity Models Tpl Promo Web: See 3.11. (line 1055) -trunk Identity Models Xcf: See 3.12. (line 1385) -trunk Identity Release: See 3.13. (line 1406) -trunk Identity Themes: See 3.14. (line 1423) -trunk Identity Themes Models: See 3.15. (line 1448) -trunk Identity Themes Models Alternative: See 3.16. (line 1481) -trunk Identity Themes Models Default: See 3.17. (line 1508) -trunk Identity Themes Models Default Distro: See 3.18. (line 1540) +branches: See 1. (line 394) +Common translation files: See 3.51.2.5. (line 5741) +How to render brands' translation files: See 3.53.3. (line 6045) +How to render fonts' translation files: See 3.55.3. (line 6118) +How to render translation files: See 3.51.3. (line 5911) +Metadata maintainance: See 3.46.2. (line 4871) +Specific translation files: See 3.51.2.6. (line 5766) +tags: See 2. (line 397) +Template translation files: See 3.51.2.4. (line 5571) +Translation brands file names: See 3.53.2.1. (line 6002) +Translation configuration scripts: See 3.51.2.8. (line 5800) +Translation entries: See 3.51.2.1. (line 5387) +Translation files: See 3.51.2.3. (line 5503) +Translation markers: See 3.51.2.2. (line 5468) +Translation paths: See 3.51.2.1. (line 5387) +Translation pre-rendering configuration scripts:See 3.51.2.8. + (line 5800) +Translation rendering: See 3.51.2.7. (line 5789) +Translation rendering default functionality: See 3.51.2.9. (line 5886) +trunk: See 3. (line 400) +trunk Identity: See 3.1. (line 403) +trunk Identity Brands: See 3.2. (line 823) +trunk Identity Fonts: See 3.3. (line 840) +trunk Identity Icons: See 3.4. (line 917) +trunk Identity Isolinux: See 3.5. (line 934) +trunk Identity Models: See 3.6. (line 951) +trunk Identity Models Css: See 3.7. (line 971) +trunk Identity Models Html: See 3.8. (line 993) +trunk Identity Models Img Promo Web: See 3.9. (line 1014) +trunk Identity Models Tpl: See 3.10. (line 1035) +trunk Identity Models Tpl Promo Web: See 3.11. (line 1056) +trunk Identity Models Xcf: See 3.12. (line 1386) +trunk Identity Release: See 3.13. (line 1407) +trunk Identity Themes: See 3.14. (line 1424) +trunk Identity Themes Models: See 3.15. (line 1449) +trunk Identity Themes Models Alternative: See 3.16. (line 1482) +trunk Identity Themes Models Default: See 3.17. (line 1509) +trunk Identity Themes Models Default Distro: See 3.18. (line 1541) trunk Identity Themes Models Default Distro Anaconda:See 3.19. - (line 1624) -trunk Identity Themes Models Default Promo: See 3.20. (line 1641) -trunk Identity Themes Models Default Web: See 3.21. (line 1667) -trunk Identity Themes Motifs: See 3.22. (line 1692) -trunk Identity Themes Motifs Flame: See 3.23. (line 1796) -trunk Identity Themes Motifs Modern: See 3.24. (line 2007) -trunk Identity Themes Motifs Modern Backgrounds:See 3.25. (line 2026) + (line 1625) +trunk Identity Themes Models Default Promo: See 3.20. (line 1642) +trunk Identity Themes Models Default Web: See 3.21. (line 1668) +trunk Identity Themes Motifs: See 3.22. (line 1693) +trunk Identity Themes Motifs Flame: See 3.23. (line 1797) +trunk Identity Themes Motifs Modern: See 3.24. (line 2008) +trunk Identity Themes Motifs Modern Backgrounds:See 3.25. (line 2027) trunk Identity Themes Motifs Modern Backgrounds Img:See 3.26. - (line 2148) + (line 2149) trunk Identity Themes Motifs Modern Backgrounds Tpl:See 3.27. - (line 2169) + (line 2170) trunk Identity Themes Motifs Modern Backgrounds Xcf:See 3.28. - (line 2190) + (line 2191) trunk Identity Themes Motifs Modern Distro Anaconda Progress:See 3.29. - (line 2217) -trunk Identity Themes Motifs Modern Palettes: See 3.30. (line 2273) -trunk Identity Themes Motifs TreeFlower: See 3.31. (line 2295) + (line 2218) +trunk Identity Themes Motifs Modern Palettes: See 3.30. (line 2274) +trunk Identity Themes Motifs TreeFlower: See 3.31. (line 2296) trunk Identity Themes Motifs TreeFlower Backgrounds:See 3.32. - (line 2314) -trunk Identity Widgets: See 3.33. (line 2610) -trunk Manuals: See 3.34. (line 2627) -trunk Scripts: See 3.35. (line 2681) -trunk Scripts Bash: See 3.36. (line 2705) -trunk Scripts Bash Functions: See 3.37. (line 2854) -trunk Scripts Bash Functions Html: See 3.38. (line 3988) -trunk Scripts Bash Functions Locale: See 3.39. (line 4009) -trunk Scripts Bash Functions Manual: See 3.40. (line 4089) -trunk Scripts Bash Functions Path: See 3.41. (line 4110) -trunk Scripts Bash Functions Render: See 3.42. (line 4489) -trunk Scripts Bash Functions Render Config: See 3.43. (line 4510) -trunk Scripts Bash Functions Shell: See 3.44. (line 4688) -trunk Scripts Bash Functions Svg: See 3.45. (line 4860) -trunk Scripts Bash Functions Verify: See 3.46. (line 5048) -trunk Scripts Bash Locale: See 3.47. (line 5264) -trunk Scripts Perl: See 3.48. (line 5293) -trunk Scripts Python: See 3.49. (line 5310) -trunk Translations: See 3.50. (line 5331) -trunk Translations Identity: See 3.51. (line 5933) -trunk Translations Identity Brands: See 3.52. (line 5954) -trunk Translations Identity Brands Tpl: See 3.53. (line 6049) -trunk Translations Identity Fonts: See 3.54. (line 6064) -trunk Translations Identity Models: See 3.55. (line 6127) -trunk Translations Identity Release: See 3.56. (line 6142) -trunk Translations Identity Themes: See 3.57. (line 6157) -trunk Translations Identity Themes Backgrounds:See 3.58. (line 6172) -trunk Translations Identity Themes Distro Anaconda Progress:See 3.59. - (line 6193) -trunk Translations Identity Widgets: See 3.60. (line 6286) -Unused definitions: See 3.45.2.1. (line 4985) + (line 2315) +trunk Identity Widgets: See 3.33. (line 2611) +trunk Identity Widgets2: See 3.34. (line 2628) +trunk Manuals: See 3.35. (line 2645) +trunk Scripts: See 3.36. (line 2699) +trunk Scripts Bash: See 3.37. (line 2723) +trunk Scripts Bash Functions: See 3.38. (line 2872) +trunk Scripts Bash Functions Html: See 3.39. (line 3981) +trunk Scripts Bash Functions Locale: See 3.40. (line 4002) +trunk Scripts Bash Functions Manual: See 3.41. (line 4082) +trunk Scripts Bash Functions Path: See 3.42. (line 4103) +trunk Scripts Bash Functions Render: See 3.43. (line 4482) +trunk Scripts Bash Functions Render Config: See 3.44. (line 4503) +trunk Scripts Bash Functions Shell: See 3.45. (line 4681) +trunk Scripts Bash Functions Svg: See 3.46. (line 4853) +trunk Scripts Bash Functions Verify: See 3.47. (line 5041) +trunk Scripts Bash Locale: See 3.48. (line 5271) +trunk Scripts Perl: See 3.49. (line 5300) +trunk Scripts Python: See 3.50. (line 5317) +trunk Translations: See 3.51. (line 5338) +trunk Translations Identity: See 3.52. (line 5940) +trunk Translations Identity Brands: See 3.53. (line 5961) +trunk Translations Identity Brands Tpl: See 3.54. (line 6056) +trunk Translations Identity Fonts: See 3.55. (line 6071) +trunk Translations Identity Models: See 3.56. (line 6134) +trunk Translations Identity Release: See 3.57. (line 6149) +trunk Translations Identity Themes: See 3.58. (line 6164) +trunk Translations Identity Themes Backgrounds:See 3.59. (line 6179) +trunk Translations Identity Themes Distro Anaconda Progress:See 3.60. + (line 6200) +trunk Translations Identity Widgets: See 3.61. (line 6293) +Unused definitions: See 3.46.2.1. (line 4978) List of Figures *************** diff --git a/Manuals/en/Texinfo/Repository/repository.texi b/Manuals/en/Texinfo/Repository/repository.texi index 27698f9..8e14122 100644 --- a/Manuals/en/Texinfo/Repository/repository.texi +++ b/Manuals/en/Texinfo/Repository/repository.texi @@ -2,21 +2,16 @@ @c $Id: repository.texi 33 2010-09-13 11:36:41Z al $ @c %**start of header @setfilename repository.info -@settitle CentOS Artwork Repository +@settitle The CentOS Artwork Repository @afourpaper @finalout @c %**end of header @c -- Summary Description and Copyright ----------------------- @copying -This manual describes the CentOS Artwork Repository. +The CentOS Artwork Repository user guide. -The CentOS Artwork Repository exists to organize and automate The -CentOS Project corporate visual identity (@pxref{trunk Identity}, to -start on). - -Copyright @copyright{} 2009, 2010 Alain Reguera Delgado. All rights -reserved. +Copyright @copyright{} 2009, 2010, 2011 Alain Reguera Delgado Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or @@ -29,8 +24,8 @@ Documentation License. @c -- Titlepage, Contents, Copyright --------------------------- @titlepage -@title CentOS Artwork Repository -@subtitle Reference Manual. +@title The CentOS Artwork Repository +@subtitle User guide @author Alain Reguera Delgado (@email{alain.reguera@@gmail.com}) @c The following two commands start the copyright page. diff --git a/Manuals/en/Texinfo/Repository/trunk/Identity/Widgets2.texi b/Manuals/en/Texinfo/Repository/trunk/Identity/Widgets2.texi new file mode 100644 index 0000000..9cf9a6e --- /dev/null +++ b/Manuals/en/Texinfo/Repository/trunk/Identity/Widgets2.texi @@ -0,0 +1,14 @@ +@subsection Goals + +@itemize +@item ... +@end itemize + +@subsection Description + +@subsection Usage + +@subsection See also + +@menu +@end menu diff --git a/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions.texi b/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions.texi index 2ef832d..03c5913 100644 --- a/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions.texi +++ b/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions.texi @@ -336,6 +336,18 @@ When first argument is not provided, the @file{centos-art.sh} script immediatly ends its execution. @end defvar +@defvar FUNCDIR +@end defvar + +@defvar FUNCDIRNAME +@end defvar + +@defvar FUNCSCRIPT +@end defvar + +@defvar FUNCCONFIG +@end defvar + @defvar ACTIONNAM Define action name. @@ -356,24 +368,9 @@ immediatly ends its execution. Define action value. Action values are associated to just one action name. Action values -contain the repository entry over which its associated action will be -performed in. Repository entries can be directories, files, or URLs -refering the repository structure. - -When action value is not specified as repository entry, the -@file{centos-art.sh} script evaluates the current directory it was -executed from. If such directory is under the repository structure -(i.e., @file{/home/centos/artwork/}), the @file{centos-art.sh} script -uses that directory as value to @var{ACTIONVAL} variable. Otherwise, -if outside the repository structure, the @file{centos-art.sh} script -prints the message @samp{The path provided can't be processed.} and, -after it, immediatly ends script execution. - -Default action value is passed as second argument in -@file{centos-art.sh} command-line interface. For example, in the -command @samp{centos-art render --entry=path/to/dir --filter=regex}, -the @var{ACTIONVAL} passed to @file{centos-art.sh} script is -@option{path/to/dir}. +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. @end defvar @defvar REGEX @@ -524,27 +521,11 @@ The action value variable can take one of the following values: @enumerate @item Path to one directory inside the local working copy, @item Path to one file inside the local working copy, -@item URL to one directory inside the remote central repository, -@item URL to one file inside the remote central repository. @end enumerate If another value different from that specified above is passed to action value variable, the @file{centos-art.sh} script prints an error -message and ends script execution. Notice that when you provide a URL -there is no verification in order to determine the directory or file -you refered on it is valid or not. That verification is done by the -command that receives the location inside the functionality. The only -verification @file{centos-art.sh} script makes with URL is granting -that they begin with @samp{https://projects.centos.org/svn/artwork}. - -@code{cli_checkActionArguments} is called from -@code{cli_getArguments} function and, probably, there is not -other use for @code{cli_checkActionArguments} but to be called from -@code{cli_getArguments} function. - -Update @code{cli_checkActionArguments} function if you need to improve -action value (@var{ACTIONVAL}) variable input validation. - +message and ends script execution. @end defun @defun cli_checkFiles FILE [TYPE] diff --git a/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions/Path.texi b/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions/Path.texi index 3b5fdec..cf3a136 100644 --- a/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions/Path.texi +++ b/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions/Path.texi @@ -10,8 +10,7 @@ inside the repository. @emph{''CentOS like trees, has roots, trunk, branches, leaves and flowers. Day by day they work together in freedom, ruled by the laws -of nature and open standards, to show the beauty of its -existence.''} +of nature and open standards, to show the beauty of its existence.''} @subsubsection Repository layout diff --git a/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions/Verify.texi b/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions/Verify.texi index 8804130..7f6591f 100644 --- a/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions/Verify.texi +++ b/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions/Verify.texi @@ -123,60 +123,73 @@ following values are recognized by @file{centos-art.sh} script: 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. -@item TZ +@item TEXTDOMAIN -Default time zone representation. +Default domain used to retrieve translated messages. This variable is +set in @file{initFunctions.sh} and shouldn't be changed. -Time representation inside repository server is set to Coordinated -Universal Time (UTC). Time represetation inside repository working -copies is set as their administrators personally define. +@item TEXTDOMAINDIR -When repository working copies time representation be defined, it -would be a very good convention to follow if working copies -administrators would set their systems clock to use UTC. Otherwise it -would be difficult for working copies users to find out when changes -were committed up to repository server exactly in time. +Default directory used to retrieve translated messages. This variable +is set in @file{initFunctions.sh} and shouldn't be changed. -@quotation -@strong{Tip} Coordinated Univeral Time (UTC) representation can be -configured when you install CentOS distribution; or later, runing the -@command{system-config-date} command at a shell prompt from your -graphical interface. -@end quotation +@item LANG -@quotation -@strong{Note} If you set your system clock to use UTC representation, -you also need to set the @env{TZ} environment variable inside -@file{~/.bash_profile} as follows: -@verbatim -export TZ=UTC -@end verbatim -This is required in order for your terminal to display the correct -time information of your zone, taking UTC representation as reference. -@end quotation +Default locale information. -@item TEXTDOMAIN +This variable is initially set in the configuration process of CentOS +distribution installer (i.e., Anaconda), specifically in the +@samp{Language} step; or once installed using the +@command{system-config-language} tool. -Default domain used to retrieve translated messages. This value is -set in @file{initFunctions.sh} and shouldn't be changed. +The @file{centos-art.sh} script uses the @var{LANG} environment +variable to know in which language the script messages are printed +out. -@item TEXTDOMAINDIR +@item TZ -Default directory used to retrieve translated messages. This value is -set in @file{initFunctions.sh} and shouldn't be changed. +Default time zone representation. -@item LANG +This variable is initially set in the configuration process of CentOS +distribution installer (i.e., Anaconda), specifically in the +@samp{Date and time} step; or once installed using the +@command{system-config-date} tool. + +The @file{centos-art.sh} script doesn't use the @var{TZ} environment +variable information at all. Instead, this variable is used by the +system shell to show the time information according to your phisical +location on planet Earth. + +Inside your computer, the time information is firstly set in the BIOS +clock (which may need correction), and later in the configuration +process of CentOS distribution installer (or later, by any of the +related configuration tools inside CentOS distribution). Generally, +setting time information is a straight-forward task and configuration +tools available do cover most relevant location. However, if you need +a time precision not provided by the configuration tools available +inside CentOS distribution then, using @var{TZ} variable may be +necessary. + +@quotation +@strong{Convenction} In order to keep changes syncronized between +central repository and its working copies: configure both repository +server and workstations (i.e., the place where each working copy is +set on) to use Coordinated Universal Time (UTC) as base time +representation. Later, correct the time information for your specific +location using time zone correction. +@end quotation + +The format of @var{TZ} environment variable is described in +@file{tzset(3)} manual page. -Default locale information. This value is set when you start your -session and can be changed using the @samp{locale} functionality of -@file{centos-art.sh} script (@pxref{trunk Scripts Bash Functions -Locale}, for more information). @end table @subsection Usage -@table @samp +@table @command + @item centos-art verify --packages + Verify required packages your workstation needs in order to run the @file{centos-art.sh} script correctly. If there are missing packages, the @file{centos-art.sh} script asks you to confirm their @@ -189,6 +202,7 @@ already installed in your workstation, the message @samp{The required packages are already installed.} is output for you to know. @item centos-art verify --links + Verify required links your workstation needs in order to run the centos-art command correctly. If any required link is missing, the @command{centos-art.sh} script asks you to confirm their installation. @@ -211,6 +225,7 @@ install the link on its place. @item centos-art verify --environment @itemx centos-art verify --environment --filter='regex' + Output a brief description of environment variables used by @file{centos-art.sh} script. @@ -218,7 +233,8 @@ If @samp{--filter} option is provided, output is reduced as defined in the @samp{regex} regular expression value. If @samp{--filter} option is specified but @samp{regex} value is not, the @file{centos-art.sh} script outputs information as if @samp{--filter} option had not been -provided at all. +provided at all. + @end table @subsection See also diff --git a/Manuals/en/Texinfo/Repository/trunk/chapter-menu.texi b/Manuals/en/Texinfo/Repository/trunk/chapter-menu.texi index 523cade..b8d20ab 100644 --- a/Manuals/en/Texinfo/Repository/trunk/chapter-menu.texi +++ b/Manuals/en/Texinfo/Repository/trunk/chapter-menu.texi @@ -32,6 +32,7 @@ * trunk Identity Themes Motifs TreeFlower:: * trunk Identity Themes Motifs TreeFlower Backgrounds:: * trunk Identity Widgets:: +* trunk Identity Widgets2:: * trunk Manuals:: * trunk Scripts:: * trunk Scripts Bash:: diff --git a/Manuals/en/Texinfo/Repository/trunk/chapter-nodes.texi b/Manuals/en/Texinfo/Repository/trunk/chapter-nodes.texi index a6cb77f..6028cd1 100644 --- a/Manuals/en/Texinfo/Repository/trunk/chapter-nodes.texi +++ b/Manuals/en/Texinfo/Repository/trunk/chapter-nodes.texi @@ -163,6 +163,11 @@ @cindex trunk Identity Widgets @include trunk/Identity/Widgets.texi +@node trunk Identity Widgets2 +@section trunk/Identity/Widgets2 +@cindex trunk Identity Widgets2 +@include trunk/Identity/Widgets2.texi + @node trunk Manuals @section trunk/Manuals @cindex trunk Manuals