From 4578cc70caae1d40e92aeaab13229f88204faaa0 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: May 13 2011 20:48:15 +0000 Subject: Update repository documentation manual. --- diff --git a/Manual/Directories/branches.texi b/Manual/Directories/branches.texi index 231ff96..e8639d1 100755 --- a/Manual/Directories/branches.texi +++ b/Manual/Directories/branches.texi @@ -16,8 +16,8 @@ The @file{branches/} directory structure is unused, so far. @subheading See also -@itemize -@item @ref{Directories tags}. +@itemize +@item @ref{Directories tags}. @item @ref{Directories trunk}. -@item The Subversion book (@url{http://svnbook.red-bean.com/}). +@item The Subversion book (@url{http://svnbook.red-bean.com/}). @end itemize diff --git a/Manual/Directories/chapter-menu.texi b/Manual/Directories/chapter-menu.texi index 59669fb..ee6dfcd 100644 --- a/Manual/Directories/chapter-menu.texi +++ b/Manual/Directories/chapter-menu.texi @@ -19,6 +19,7 @@ * Directories trunk Identity Models Themes Default Concept:: * Directories trunk Identity Models Themes Default Distro:: * Directories trunk Identity Models Themes Default Distro 5:: +* Directories trunk Identity Models Themes Default Distro 5.5 Notes Release:: * Directories trunk Identity Models Themes Default Distro 5 Anaconda:: * Directories trunk Identity Models Themes Default Distro 5 Firstboot:: * Directories trunk Identity Models Themes Default Distro 5 Gdm:: diff --git a/Manual/Directories/chapter-nodes.texi b/Manual/Directories/chapter-nodes.texi index b8b0a71..e5b0444 100644 --- a/Manual/Directories/chapter-nodes.texi +++ b/Manual/Directories/chapter-nodes.texi @@ -98,6 +98,11 @@ @cindex Directories trunk Identity Models Themes Default Distro 5 @include Directories/trunk/Identity/Models/Themes/Default/Distro/5.texi +@node Directories trunk Identity Models Themes Default Distro 5.5 Notes Release +@section The @file{trunk/Identity/Models/Themes/Default/Distro/5.5/Notes/Release} Directory +@cindex Directories trunk Identity Models Themes Default Distro 5.5 Notes Release +@include Directories/trunk/Identity/Models/Themes/Default/Distro/5.5/Notes/Release.texi + @node Directories trunk Identity Models Themes Default Distro 5 Anaconda @section The @file{trunk/Identity/Models/Themes/Default/Distro/5/Anaconda} Directory @cindex Directories trunk Identity Models Themes Default Distro 5 Anaconda diff --git a/Manual/Directories/trunk/Identity/Models/Themes/Default/Distro/5.5/Notes/Release.texi b/Manual/Directories/trunk/Identity/Models/Themes/Default/Distro/5.5/Notes/Release.texi new file mode 100755 index 0000000..d6bb628 --- /dev/null +++ b/Manual/Directories/trunk/Identity/Models/Themes/Default/Distro/5.5/Notes/Release.texi @@ -0,0 +1,23 @@ +@subheading Goals + +@itemize +@item ... +@end itemize + +@subheading Description + +@itemize +@item ... +@end itemize + +@subheading Usage + +@itemize +@item ... +@end itemize + +@subheading See also + +@itemize +@item ... +@end itemize diff --git a/Manual/Directories/trunk/Identity/Models/Themes/Default/Distro/5/Gdm.texi b/Manual/Directories/trunk/Identity/Models/Themes/Default/Distro/5/Gdm.texi index e226b31..53ef237 100755 --- a/Manual/Directories/trunk/Identity/Models/Themes/Default/Distro/5/Gdm.texi +++ b/Manual/Directories/trunk/Identity/Models/Themes/Default/Distro/5/Gdm.texi @@ -6,9 +6,17 @@ @subheading Description -@itemize -@item ... -@end itemize +Another example of using last-rendition flow is that related to GDM +and KDM @file{tar.gz} file construction. Each @file{tar.gz} file is +made of several files that need to be put together in order to make +them installable. In the very specific case of GDM and KDM some of the +required files are retrived from design models directory structure and +others from artistic motifs directory structure after had been +produced through base-rendition. In this case, the action of grouping +files and packing them is realized through last-rendition action. This +couldn't be possible through post-rendition because we need to wait to +have two images first (produced through base-rendition) before we +could grouping them all into the @file{tar.gz} package. @subheading Usage diff --git a/Manual/Directories/trunk/Identity/Models/Themes/Default/Distro/5/Ksplash.texi b/Manual/Directories/trunk/Identity/Models/Themes/Default/Distro/5/Ksplash.texi index e226b31..02aa8be 100755 --- a/Manual/Directories/trunk/Identity/Models/Themes/Default/Distro/5/Ksplash.texi +++ b/Manual/Directories/trunk/Identity/Models/Themes/Default/Distro/5/Ksplash.texi @@ -6,9 +6,12 @@ @subheading Description -@itemize -@item ... -@end itemize +The @file{Preview.png} image of Ksplash which is made of three +different images. In order to build the @file{Preview.png} image, we +need to create the three images the @file{Preview.png} image is made +of first (e.g., through base-rendition) and then, combine them all +together into one new image, the @file{Preview.png} image in this +case. @subheading Usage diff --git a/Manual/Directories/trunk/Scripts/Functions/Prepare.texi b/Manual/Directories/trunk/Scripts/Functions/Prepare.texi index 6675605..d46f6dc 100644 --- a/Manual/Directories/trunk/Scripts/Functions/Prepare.texi +++ b/Manual/Directories/trunk/Scripts/Functions/Prepare.texi @@ -1,25 +1,94 @@ -@subheading Goals +@subheading Name -This section describes the @code{prepare} functionality of -@command{centos-art.sh} script and the preliminar steps you need to -follow in order to get your workstation ready for using a working copy -of CentOS Artwork Repository. +The @strong{@code{prepare}} functionality is part of the +@command{centos-art.sh} script and standardizes configuration of +preliminar steps you need to follow in order to get your workstation +ready for using a working copy of CentOS Artwork Repository. -@subheading Description +@subheading Synopsis + +@command{centos-art @strong{prepare} [OPTIONS]} + +There is no need to specify @file{path/to/dir} information in this +functionality. Most actions are performed through options. + +The @strong{@code{prepare}} functionality of centos-art.sh script +accepts the following options: -The @code{prepare} functionality of @command{centos-art.sh} script -provides the standard way of configuring the workstation you plan to -use for storing the working copy of CentOS Artwork Repository. +@table @option + +@item --quiet + +Supress all output messages except error messages. When this option +is passed, all confirmation requests are supressed as well and a +possitive answer is assumed for them, just as if the +@option{--answer-yes} option had been provided. + +@item --answer-yes + +Assume @samp{yes} to all confirmation requests. + +@item --packages -The @code{prepare} functionality of @command{centos-art.sh} script is -part of the CentOS Artwork Repository. So, in order to execute the -@code{prepare} functionality of @command{centos-art.sh} script you -need to have access to a working copy of CentOS Artwork Repository, -first. Working copies of CentOS Artwork Repository are downloaded -from the source repository and made available to you by mean of -workstations. A workstation is a computer that you install and -configure (prepare) to do something. In this case, you pick up a -computer and prepare it for working on the CentOS Artwork Repository. +Install/update software packages required by the working copy of +CentOS Artwork Repository. + +The process of software installation takes place through @command{sudo +yum} and the repository configuration currently set in your +workstation. + +Most of the software packages required by the working copy of CentOS +Artwork Repository are available on The CentOS Distribution and can be +installed using The CentOS Distribution installation media. The only +exception is Inkscape, the program used to manipulate +@acronym{SVG,Scalable Vector Graphics} files in the working copy. + +The @file{inkscape} package isn't inside The CentOS Distribution or +any of The CentOS Project repositories neither, so you need to install +it from a third party repository like @samp{RPMForge} or @samp{EPEL}. +See page +@url{http://wiki.centos.org/AdditionalResources/Repositories/,The +CentOS Repositories}, to know how to configure third party +repositories in The CentOS Distribution. + +@item --link + +This option uses symbolic links to install/update the connection +between components inside the working copy and components outside the +working copy. Among the components that need to be connected figure +out the command-line internface of @command{centos-art.sh} script; +fonts, brushes, palettes and patterns used by programs like GIMP and +Inkscape; and configuration files of text editors. + +The main purpose of such connection is to adapt the working copy to +the CentOS Distribution filesystem layout (e.g., @file{~/bin} +directory is for storing personal programs, @file{~/gimp-2.2/brushes} +is for storing GIMP brushes for personal use, etc.) and, at the same +time, to provide a way of sharing changes made to connected components +to other workstations (e.g., if I update a GIMP brush in my +workstation, you'll receive the change the next you update your +working copy and then will be immediatly available for you to use in +GIMP). + +@item --environment + +Print the name and value of some of the environment variables used by +@command{centos-art.sh} scripts. + +@end table + +@subheading Description + +The @strong{@code{prepare}} functionality of @command{centos-art.sh} +script is part of the CentOS Artwork Repository. So, in order to +execute the @strong{@code{prepare}} functionality of +@command{centos-art.sh} script you need to have access to a working +copy of CentOS Artwork Repository, first. Working copies of CentOS +Artwork Repository are downloaded from the source repository and made +available to you by mean of workstations. A workstation is a computer +that you install and configure (prepare) to do something. In this +case, you pick up a computer and prepare it for working on the CentOS +Artwork Repository. @subsubheading Installing the workstation @@ -41,9 +110,9 @@ need to download the ISO files related to the media you plan to use The CentOS Distribution ISO files can be downloaded from @url{http://mirrors.centos.org/} and, if you chosen CD or DVD as your prefered installation medium, you can burn the ISO files using the -@command{K3B} application to create the installation media you'll use. -Of course, in order to download the ISO files and create the -installation media, you need to have an already installed CentOS +@command{K3B} application so as to create the installation media +you'll use. Of course, in order to download the ISO files and create +the installation media, you need to have an already installed CentOS workstation where you can realized all the work. @subsubheading Configuring the workstation @@ -99,8 +168,9 @@ in the @samp{Language} step; or once installed using the The @command{centos-art.sh} script uses the @env{LANG} environment variable to determine what language to use for printing output -messages. Moreover, the @code{locale} functionality uses the -@env{LANG} to determine what translation messages to udpate or edit. +messages. Another use of @env{LANG} variable inside +@command{centos-art.sh} script is to determine what translation file +to update or edit when input files are localized. @item Default time zone representation: @@ -113,11 +183,11 @@ know when things happened. The CentOS Artwork Repository is made of one server and several workstations spread around the world. In order for all these workstations to know when changes in the server took place, it is -required that all the workstations set their system clocks to use the -same time information (i.e., @acronym{UTC,Coordinated Universal Time}) -and set the time correction for their countries in the operating -system. Otherwise, it'd be hard to know when something exactly -happened. +required that they all set their system clocks to use the same time +information (i.e., @acronym{UTC,Coordinated Universal Time}) and set +the time correction for their specific countries in the operating +system. Otherwise, it would be difficult to know when something +exactly happened. Generally, setting the time information is a straight-forward task and configuration tools provided by The CentOS Distribution do cover time @@ -164,9 +234,9 @@ sudo yum install subversion @subsubheading Configuring the working copy Once you have a working copy of CentOS Artwork Repository in your -workstation, you can go and run the @code{prepare} functionality of -@command{centos-art.sh} script to realize the remaining configuration -stuff. +workstation, you can go and run the @strong{@code{prepare}} +functionality of @command{centos-art.sh} script to realize the +remaining configuration stuff. Assuming this is the very first time you run the @command{centos-art.sh} script, you'll find that there is no @@ -179,17 +249,17 @@ the @command{centos-art.sh} script using its absolute path: ~/artwork/trunk/Scripts/centos-art.sh prepare [OPTIONS] @end verbatim -Assuming you've already run the @code{prepare} functionality before, -there is no need for you to use the absolute path again. Instead, you -can use the @command{centos-art} command-line interface directly, as -the following example describes: +Assuming you've already run the @strong{@code{prepare}} functionality +before, there is no need for you to use the absolute path again. +Instead, you can use the @command{centos-art} command-line interface +directly, as the following example describes: @verbatim centos-art.sh prepare [OPTIONS] @end verbatim -Notice that you can execute the @code{prepare} functionality more than -once. This is specially useful to keep the link information +Notice that you can execute the @strong{@code{prepare}} functionality +more than once. This is specially useful to keep the link information syncronized. For example, considering you've added new brushes to or removed old brushes from your working copy of CentOS Artwork Repository, the link information related to those files need to be @@ -198,80 +268,7 @@ addition/deletion change that took place in your working copy can be reflected there, as well. The same is true for other similar components like fonts, patterns and palettes components. -@subheading Usage - -@subsubheading Synopsis - -@command{centos-art prepare [OPTIONS]} - -@subsubheading Options - -@table @option -@item --packages - -Install/update software packages required by the working copy of -CentOS Artwork Repository. - -The process of software installation takes place through @command{sudo -yum} and the repository configuration currently set in your -workstation. - -Most of the software packages required by the working copy of CentOS -Artwork Repository are available on The CentOS Distribution and can be -installed using The CentOS Distribution installation media. The only -exception is Inkscape, the program used to manipulate -@acronym{SVG,Scalable Vector Graphics} files in the working copy. - -The @file{inkscape} package isn't inside The CentOS Distribution or -any of The CentOS Project repositories neither, so you need to install -it from a third party repository like @samp{RPMForge} or @samp{EPEL}. -See page -@url{http://wiki.centos.org/AdditionalResources/Repositories/,The -CentOS Repositories}, to know how to configure third party -repositories in The CentOS Distribution. - -@item --link - -Install/update connection between working copy and workstation through -symbolic links. - -This option creates the @command{centos-art} command-line interface of -@command{centos-art.sh} script through a symbolic link. There is no -need for you to type the full path to @command{centos-art.sh} script -each time you need to execute it. Instead, you use the -@command{centos-art} command which is much shorter and faster to type. - -This option connects design compenents like fonts, brushes, patterns -and palettes inside your working copy of CentOS Artwork Repository -with programs like @acronym{GIMP, GNU Image Manipulation Program} and -Inkscape outside it. This way, all your modifications on these -components will take place inside the repository and will be shared to -all other working copies the next time you commit the changes up to -source repository. - -This option standardizes width, tabulation, indentation, and line -numbering for text editors in your workstation. The configuration -file where these definitions are set, is versioned inside your working -copy and linked from the appropriate place in the workstation to make -it valid to your default text editor. - -@item --environment - -Print the name and value of some of the environment variables used by -@command{centos-art.sh} scripts. - -@item --quiet - -Supress all output messages, including confirmation question. Use this -option with care. - -@item --answer-yes - -Assume @samp{yes} to all confirmation questions. - -@end table - -@subsubheading Examples +@subheading Examples @table @command @item centos-art prepare --packages --link @@ -284,6 +281,22 @@ Update connection between the workstation and the working copy of CentOS Artwork Repository, using no output. @end table +@subheading Author + +Written by Alain Reguera Delgado. + +@subheading Reporting bugs + +Report bugs to @email{centos-artwork@@centos.org} mailing list. + +@subheading Copyright + +Copyright @copyright{} 2009, 2010, 2011 The CentOS Project. + +This is free software. You may redistribute copies of it under the +terms of the GNU General Public License (@pxref{GNU General Public +License}). There is NO WARRANTY, to the extent permitted by law. + @subheading See also @itemize diff --git a/Manual/Directories/trunk/Scripts/Functions/Render.texi b/Manual/Directories/trunk/Scripts/Functions/Render.texi index 946c864..a4a2a0e 100644 --- a/Manual/Directories/trunk/Scripts/Functions/Render.texi +++ b/Manual/Directories/trunk/Scripts/Functions/Render.texi @@ -6,19 +6,11 @@ the working copy of CentOS Artwork Repository. @subheading Synopsis -@command{centos-art} @code{@strong{render}} @code{[OPTION] path/to/dir} +@command{centos-art} @code{@strong{render}} @code{[OPTIONS] path/to/dir} -The @file{path/to/dir} parameter refers the path information related -to the directory structure inside the working copy of CentOS Artwork -Repository you'r going to produce. This path information defines -whether to perform direct or theme-specific rendition. - -You can use the @file{path/to/dir} information to control the amount -of components you'll produce inside a specific renderable location. -The more deep you go inside the path the more specific you are when -producing theme components. Sometimes, you can also combine the use of -@file{path/to/dir} with the @option{--filter} option to have a finer -control over the files you produce. +The @file{path/to/dir} parameter specifies what directory structure +inside the working copy of CentOS Artwork Repository you want to +produce. The @code{render} functionality of @command{centos-art.sh} script accepts the following options: @@ -26,74 +18,65 @@ accepts the following options: @table @option @item --quiet -Supress all output messages, including confirmation question. Use this -option with care. +Supress all output messages except error messages. When this option +is passed, all confirmation requests are supressed as well and a +possitive answer is assumed for them, just as if the +@option{--answer-yes} option had been provided. -@item --filter="REGEX" +@item --answer-yes -Reduce the list of files to process using @samp{REGEX} as pattern. +Assume `yes' to all confirmation requests. -@item --answer-yes +@item --filter="REGEX" -Assume `yes' to all confirmation questions. +Reduce the list of files to process using @samp{REGEX} as pattern. +You can use this option in combination with @file{path/to/dir} in +order to control the amount of files you want to produce as +base-rendition. The deeper you go into the directory structure the +more specific you'll be about the component you want to produce. When +you cannot go deeper into the directory structure, you can use +@option{--filter} option to reduce the list of files. @item --dont-commit-changes -Supress all commit and update actions realized over files already -processed, before and after the action itself had took place in the -working copy. +Supress all commit and update actions realized over files, before and +after the action itself had took place over files in the working copy. @item --releasever="STRING" -Produce content for the release version specified in @samp{STRING}. -This option is generaly used in direct rendition, where design models -aren't organized using release versions and architectures as -reference. +This option expands release-specific translation makers to +@samp{STRING}. Use this option when no releasae-specific information +can be retrived from the path of the directory structure you are +currently rendering. @item --basearch="STRING" -Produce content for the architecture specified in @samp{STRING}. This -option is generaly used in direct rendition, where design models aren't -organized using release versions and architectures as reference. - -@item --convert="STRING" - -Uses post-rendition to convert output produced by base-rendition to -any image format specified in @samp{STRING}. This option is an -interface for the @command{convert} command of ImageMagick tool set, -so it is applicable to images output only. - -@item --rotate="STRING" +This option expands architecture-specific translation makers to +@samp{STRING}. Use this option when no architecture-specific +information can be retrived from the path of the directory structure +you are currently rendering. -Uses post-rendition to rotate output produced by base-rendition to any -angle specified in @samp{STRING}. This option is an interface for the -@command{convert} command of ImageMagick tool set, so it is -applicable to images output only. +@item --theme-model="STRING" -@item --resize="STRING" +Specify the name of the theme model you want to use to produce theme +artistic motifs. By default, if this option is not passed, the +@samp{Default} theme model is used as reference to produce theme +motifs. -Uses post-rendition to resize the base-rendition output to any angle -specified in @samp{STRING}. This option is an interface for the -@command{convert} command of ImageMagick tool set, so it is applicable -to images output only. +@item --post-rendition="STRING" -@item --group-by="STRING" +This option let you apply a command as post-rendition action. In this +case, the @samp{STRING} represents the command string you want to +execute in order to perform in-place modifications to base-rendition +output. -Group base output files inside directories. Directories used to stored -base output files are named using the file extension of base output -files. For example: if the base output file is a @file{.png} file, it -is moved inside a @file{Png/} directory; if the current file is a -@file{.jpg} file, it is stored inside a @file{Jpg/} directory, and so -on. +@item --last-rendition="STRING" -Directories used to group files are created in the same location that -base output files would normaly do. +This option let you apply a command as last-rendition action. In this +case, the @samp{STRING} represents the command string you want to +execute in order to perform in-place modifications to base-rendition, +post-rendition and directory-specific rendition outputs. -@item --theme-model="STRING" -Specify, in the @samp{STRING}, the name of the theme model you want to -use to produce theme motifs. By default, if this option is not passed, -the @samp{Default} theme model is used as reference to produce theme -motifs. @end table @subheading Description @@ -134,12 +117,12 @@ location of the output file, as well. @item Theme-specific rendition In theme-specific rendition, there is one directory structure to store -input files @file{trunk/Identity/Themes/Models}, one directory +input files (@file{trunk/Identity/Themes/Models}), one directory structure to store translation files -(@file{trunk/Locales/Identity/Themes/Models/}), one directory structure -to store artistic motifs (@file{trunk/Identity/Images/Themes}) and one -directory structure to store output files -(@file{trunk/Identity/Images/Themes}). +(@file{trunk/Locales/Identity/Themes/Models/}), one directory +structure to store artistic motifs +(@file{trunk/Identity/Images/Themes}) and one directory structure to +store output files (@file{trunk/Identity/Images/Themes}). In theme-specific rendition, when the @code{render} functionality of @command{centos-art.sh} script is executed, it uses the input @@ -154,8 +137,8 @@ specially interesting because it is possible to create different artistic motifs and one unique design model in order to produce one unique theme structure with different visual styles. Or the opposite, to create different theme structures and apply one unique visual style -to produce different visual styles with the same theme structure. Or -even push a bit farther and experiment with arbitrary combinations +to produce one unique visual styles on different theme structure. Or +even get a bit farther and experiment with arbitrary combinations among them all. @end table @@ -176,76 +159,123 @@ The base-rendition flow is the first rendition flow of all rendition flows available and takes place immediatly after executing the @code{render} functionality of @command{centos-art.sh} script. -The base-rendition consist on producing different output formats in -different languages from one single input format. This is, one input -file produces one output file. Inside the @code{render} functionality -of @command{centos-art.sh} script, the input format is always an XML -file (e.g., SVG, XHTML, Docbook) and the output format depends on the -input file provided. +The base-rendition produces different outputs from one unique input +format. This is, one input file is used to produce one ore more output +files. When translation files are available for input files, the +base-rendition applies the translation file to the input file in order +to produce a translated instance of it, then this translated instance +is used as input file to produce one or more output files. + +Inside the @code{render} functionality of @command{centos-art.sh} +script, the input format is always XML (e.g., SVG, XHTML, Docbook), +the translation files are always portable objects (e.g., PO) and the +output format depends on the input file provided (e.g., when the +input format is a SVG file, the base output is a PNG file; when the +input format is XHTML the base output is an XHTML file; when the input +format is a Docbook file the base output might be either HTML, RTF, PS +or PDF). + +As application example of base-rendition flow, consider the +description of the following sections: -For example, when the input format is a SVG file, the base output is a -PNG file; when the input format is XHTML the base output is an XHTML -file; when the input format is a Docbook file the base output is an -XHTML file. +@itemize +@item @ref{Directories trunk Identity Models Themes Default Distro 5 +Anaconda} +@item @ref{Directories trunk Identity Models Themes Default Distro 5.5 +Notes Release} +@end itemize @subsubheading The post-rendition flow -The post-rendition flow takes place after base-rendition and is -applied to create modified copies of the file produced by -base-rendition in the same directory structure. +The post-rendition flow is performed immediatly after base-rendition +flow to extend the base-rendition flow by applying in-place +modifications to base-rendition output. In-place modifications can be +performed either through the @option{--post-rendition} command-line +option of @command{centos-art.sh} script or through directory-specific +rendition. -For example, when the input format is a SVG file and the output is a -PNG file, we can use post-rendition to extend the base output to other -image formats. In fact, it is possible to do anything permitted by the -ImageMagick and Netpbm programs (e.g., resize, rotate, reduce color, -etc.) over the base output. +Actions commanded through @option{--post-rendition} option are applied +first and directory-specific actions later. This order is required to +propagate in-place changes commited to base-rendition output to +modified copies (i.e., new files) of it created through +directory-specific rendition. Creation of modified copies is +something specific to directory-specific rendition only. It is not +possible for the @option{--post-rendition} option to create modified +copies of base-rendition flow because commands passed through it are +applied to the base-rendition output file directly in a disposition +that don't support creation of new files, but in-place modifications +only. + +The command passed to @option{--post-rendition} option can be changed +everytime you run the @command{centos-art.sh} script, but actions +specified in directory-specific rendition cannot be changed in the +same way. Direcctory-specific rendition is set inside +@command{centos-art.sh} script to perform specific tasks that cannot +be achived through @option{--post-rendition} option. + +As application example of post-rendition flow, consider the +description of the following sections: + +@itemize +@item @ref{Directories trunk Identity Models Themes Default Distro 5 +Syslinux} +@item @ref{Directories trunk Identity Models Themes Default Distro 5 +Grub} +@end itemize @subsubheading The last-rendition flow -The last-rendition flow takes place after post-rendition and is -applied to all files produced as result of both base-rendition and -post-rendition flows in the same directory structure, just before -passing to process a different directory structure. - -For example, consider the @file{Preview.png} image of Ksplash which is -made of three different images. In order to build the -@file{Preview.png} image, we need to create the three images the -@file{Preview.png} image is made of first (e.g., through -base-rendition) and then, combine them all together into one new -image, the @file{Preview.png} image in this case. - -Another example of using last-rendition flow is that related to GDM -and KDM @file{tar.gz} file construction. Each @file{tar.gz} file is -made of several files that need to be put together in order to make -them installable. In the very specific case of GDM and KDM some of the -required files are retrived from design models directory structure and -others from artistic motifs directory structure after had been -produced through base-rendition. In this case, the action of grouping -files and packing them is realized through last-rendition action. This -couldn't be possible through post-rendition because we need to wait to -have two images first (produced through base-rendition) before we -could grouping them all into the @file{tar.gz} package. +The last-rendition flow takes place after post-rendition and applies +in-place modifications to all files produced as result of both +base-rendition and post-rendition flows in the same directory +structure, just before passing to process a different directory +structure. In-place modifications can be performed either through the +@option{--last-rendition} command-line option of +@command{centos-art.sh} script or through directory-specific +rendition. + +Actions commanded through @option{--last-rendition} option are applied +after directory-specific actions. This order is required to prevent +last-rendition actions commanded from directory-specifc rendition to +overlap last-rendition actions commanded from +@option{--last-rendition} option. + +The command passed to @option{--last-rendition} option can be changed +everytime you run the @command{centos-art.sh} script, but actions +specified in directory-specific rendition cannot be changed in the +same way. Actions commanded from directory-specific rendition are set +inside @command{centos-art.sh} script to perform specific tasks that +cannot be achived through @option{--last-rendition} option. + +As application example of last-rendition flow, consider the +description of the following sections: + +@itemize +@item @ref{Directories trunk Identity Models Themes Default Distro 5 +Ksplash} +@item @ref{Directories trunk Identity Models Themes Default Distro 5 +Gdm} +@end itemize @subsubheading The directory-specific rendition flow -The directory-specific rendition flow isn't a rendition flow by itself -but a combination of rendition flows that are applied to specific -directories at rendition time. - -Inside the working copy of CentOS Artwork Repository there are some -directories structures that exist to achieve specific tasks every time -they are produced. The directory-specific rendition flow provides a -way for the @code{render} functionality of @command{centos-art.sh} -script to know what actions to apply to what directory structure when -producing them. - -The directory-specific rendition flow combines the base-rendition, -post-rendition and last-rendition flows in specific ways and applies -them to specific directory structures when they are detected. Using -this configuration can speed up production of different components -like Syslinux, Grub, Gdm, Kdm and Ksplash that require intermediate -formats or even several independent files, in order for the final -content to be created. +Inside the working copy of CentOS Artwork Repository, some directory +structure (e.g., @file{Syslinux}, @file{Gurb}, @file{Gdm}, @file{Kdm} +and @file{KSplash}) required more than base-rendition or even the +commands you could pass through the @option{--post-rendition} and +@option{--last-rendition} options, in order for their final files to +be produced. In these situations, we make use of directory-specific +rendition flow. + +The directory-specific rendition flow applies specific actions to +specific directory structures when they enter into the rendition flow. +Using this configuration speeds up production of all those components +that require intermediate formats or even several independent files, +in order for the final content to be created. + +The directory-specific rendition flow is generally used in combination +with post-rendition and last-rendition flows inside +@command{centos-art.sh} script. @subsubheading Translations @@ -258,19 +288,44 @@ of the input file. Translation messages are stored under functionality of @command{centos-art.sh} script (@pxref{Directories trunk Scripts Functions Locale}). +Translation files are optional. When no translation file is available +for the input file, the base-rendition output is produced using the +same language of the input file. + @subheading Examples -@verbatim -centos-art render trunk/Identity/Images/Brands -@end verbatim +@table @command +@item centos-art render trunk/Identity/Images/Brands -@verbatim -centos-art render trunk/Identity/Images/Brands --filter="symbol" -@end verbatim +This command produces all branding information related to The CentOS +Project (e.g., symbols, logos and variants of them). -@verbatim -centos-art render trunk/Identity/Images/Themes/Flame/2 -@end verbatim +@item centos-art render trunk/Identity/Images/Brands --filter="symbol" + +This command produces all branding information, related to The CentOS +Project, which file names contain the @samp{symbol} string on it. + +@item centos-art render trunk/Identity/Images/Themes/Flame/2 + +This command produces all visual manifestations related to version 2 of +Flame artistic motif (e.g., Distribution, Posters, etc.) as specified +by default design models. + +@item centos-art render trunk/Identity/Images/Themes/Flame/2/Distro + +This command produces the Distribution visual manifestations related +to version 2 of Flame artistic motif (e.g., Anaconda, Syslinux, Grub, +Firstboot, Gdm, Kdm, Gsplash, Ksplash, and Rhgb) as specified by +default design models. + +@item centos-art render trunk/Identity/Images/Themes --filter='Distro/5/Anaconda' + +This command produces all the images related to Anaconda component +from Distribution visual manifestations on its major release number +five, for all the artistic motifs available and as specified by +default design models. + +@end table @subheading Author diff --git a/Manual/Directories/trunk/Scripts/Functions/Tuneup.texi b/Manual/Directories/trunk/Scripts/Functions/Tuneup.texi index 253225c..68611bb 100755 --- a/Manual/Directories/trunk/Scripts/Functions/Tuneup.texi +++ b/Manual/Directories/trunk/Scripts/Functions/Tuneup.texi @@ -1,14 +1,50 @@ -@subheading Goals +@subheading Name -This section describes the @code{tuneup} functionality of -@command{centos-art.sh} script and general examples about file -maintainance inside a working copy of CentOS Artwork Repository. +The @strong{@code{tuneup}} functionlity is part of +@command{centos-art.sh} script and standardizes tasks related to file +maintainance inside the working copy of CentOS Artwork Repository. -@subheading Description +@subheading Synopsis + +@command{centos-art} @code{@strong{tuneup}} @code{[OPTIONS] path/to/dir} + +The @file{path/to/dir} parameter specifies what directory structure +inside the working copy of CentOS Artwork Repository you want to +process. The @code{tuneup} functionality of @command{centos-art.sh} script -provides the standard way of maintaining files inside the working copy -of CentOS Artwork Repository. +accepts the following options: + +@table @option +@item --quiet + +Supress all output messages except error messages. When this option +is passed, all confirmation requests are supressed as well and a +possitive answer is assumed for them, just as if the +@option{--answer-yes} option had been provided. + +@item --answer-yes + +Assume `yes' to all confirmation requests. + +@item --filter="REGEX" + +Reduce the list of files to process using @samp{REGEX} as pattern. +You can use this option in combination with @file{path/to/dir} in +order to control the amount of files you want to produce as +base-rendition. The deeper you go into the directory structure the +more specific you'll be about the component you want to produce. When +you cannot go deeper into the directory structure, you can use +@option{--filter} option to reduce the list of files. + +@item --dont-commit-changes + +Supress all commit and update actions realized over files, before and +after the action itself had took place over files in the working copy. + +@end table + +@subheading Description Tasks related to file maintainance are repetitive. You might find yourself doing them time after time inside the working copy of CentOS @@ -111,29 +147,7 @@ used to build the heading reference changes, you need to run the the @code{tuneup} functionality of @command{centos-art.sh} script in order for the anchor elements to use the correct information. -@subheading Usage - -@subsubheading Synopsis - -@command{centos-art tuneup [OPTIONS] path/to/dir} - -@subsubheading Options - -@table @option -@item --quiet -Supress all output messages, including confirmation question. Use this -option with care. -@item --filter='regex' -Reduce the amount of files to process using @samp{regex} as pattern. -@item --answer-yes -Assume `yes' to all confirmation questions. -@item --dont-commit-changes -Supress all @code{commit} and @code{update} actions realized over -files already processed, before and after the action itself had took -place in the working copy. -@end table - -@subsubheading Examples +@subheading Examples @table @command @item centos-art tuneup trunk/Scripts @@ -151,6 +165,22 @@ Update headings and the related table of contents to all web pages inside @file{trunk/Identity/Webenv/App/Home}, recusively. @end table +@subheading Author + +Written by Alain Reguera Delgado. + +@subheading Reporting bugs + +Report bugs to @email{centos-artwork@@centos.org} mailing list. + +@subheading Copyright + +Copyright @copyright{} 2009, 2010, 2011 The CentOS Project. + +This is free software. You may redistribute copies of it under the +terms of the GNU General Public License (@pxref{GNU General Public +License}). There is NO WARRANTY, to the extent permitted by law. + @subheading See also @itemize diff --git a/Manual/repository.info.bz2 b/Manual/repository.info.bz2 index 64d7844..b3c76f3 100644 Binary files a/Manual/repository.info.bz2 and b/Manual/repository.info.bz2 differ diff --git a/Manual/repository.pdf b/Manual/repository.pdf index 2e08d92..06de91b 100644 Binary files a/Manual/repository.pdf and b/Manual/repository.pdf differ diff --git a/Manual/repository.txt.bz2 b/Manual/repository.txt.bz2 index ac8ccc9..c700a5b 100644 Binary files a/Manual/repository.txt.bz2 and b/Manual/repository.txt.bz2 differ diff --git a/Manual/repository.xhtml.tar.bz2 b/Manual/repository.xhtml.tar.bz2 index ac18233..447a9ba 100644 Binary files a/Manual/repository.xhtml.tar.bz2 and b/Manual/repository.xhtml.tar.bz2 differ diff --git a/Manual/repository.xml b/Manual/repository.xml index 163529f..425267c 100644 --- a/Manual/repository.xml +++ b/Manual/repository.xml @@ -650,6 +650,11 @@ centos-art help --read turnk/Identity/Images/Themes/TreeFlower/3 + Directories trunk Identity Models Themes Default Distro 5.5 Notes Release + Directories trunk Identity Models Themes Default Distro 5.5 Notes Release + + + Directories trunk Identity Models Themes Default Distro 5 Anaconda Directories trunk Identity Models Themes Default Distro 5 Anaconda @@ -1675,7 +1680,7 @@ trunk/Identity/Images/Themes/THEMENAME/THEMEVERSION/Brushes Directories trunk Identity Models Themes Default Distro 5 - Directories trunk Identity Models Themes Default Distro 5 Anaconda + Directories trunk Identity Models Themes Default Distro 5.5 Notes Release Directories trunk Identity Models Themes Default Distro Directories
@@ -1748,9 +1753,47 @@ trunk/Identity/Images/Themes/THEMENAME/THEMEVERSION/Brushes
+ Directories trunk Identity Models Themes Default Distro 5.5 Notes Release + Directories trunk Identity Models Themes Default Distro 5 Anaconda + Directories trunk Identity Models Themes Default Distro 5 + Directories +
+ The <file>trunk/Identity/Models/Themes/Default/Distro/5.5/Notes/Release</file> Directory + Directories trunk Identity Models Themes Default Distro 5.5 Notes Release + Goals + + • + + ... + + + Description + + • + + ... + + + Usage + + • + + ... + + + See also + + • + + ... + + +
+ + Directories trunk Identity Models Themes Default Distro 5 Anaconda Directories trunk Identity Models Themes Default Distro 5 Firstboot - Directories trunk Identity Models Themes Default Distro 5 + Directories trunk Identity Models Themes Default Distro 5.5 Notes Release Directories
The <file>trunk/Identity/Models/Themes/Default/Distro/5/Anaconda</file> Directory @@ -1819,12 +1862,7 @@ trunk/Identity/Images/Themes/THEMENAME/THEMEVERSION/Brushes Description - - • - - ... - - + Another example of using last-rendition flow is that related to GDM and KDM tar.gz file construction. Each tar.gz file is made of several files that need to be put together in order to make them installable. In the very specific case of GDM and KDM some of the required files are retrived from design models directory structure and others from artistic motifs directory structure after had been produced through base-rendition. In this case, the action of grouping files and packing them is realized through last-rendition action. This couldn't be possible through post-rendition because we need to wait to have two images first (produced through base-rendition) before we could grouping them all into the tar.gz package. Usage • @@ -1955,12 +1993,7 @@ trunk/Identity/Images/Themes/THEMENAME/THEMEVERSION/Brushes Description - - • - - ... - - + The Preview.png image of Ksplash which is made of three different images. In order to build the Preview.png image, we need to create the three images the Preview.png image is made of first (e.g., through base-rendition) and then, combine them all together into one new image, the Preview.png image in this case. Usage • @@ -2831,15 +2864,54 @@ centos-art locale --edit trunk/Scripts
The <file>trunk/Scripts/Functions/Prepare</file> Directory Directories trunk Scripts Functions Prepare - Goals - This section describes the prepare functionality of centos-art.sh script and the preliminar steps you need to follow in order to get your workstation ready for using a working copy of CentOS Artwork Repository. + Name + The prepare functionality is part of the centos-art.sh script and standardizes configuration of preliminar steps you need to follow in order to get your workstation ready for using a working copy of CentOS Artwork Repository. + Synopsis + centos-art prepare [OPTIONS] + There is no need to specify path/to/dir information in this functionality. Most actions are performed through options. + The prepare functionality of centos-art.sh script accepts the following options: + + + + + Supress all output messages except error messages. When this option is passed, all confirmation requests are supressed as well and a possitive answer is assumed for them, just as if the option had been provided. + + + + + + Assume yes to all confirmation requests. + + + + + + Install/update software packages required by the working copy of CentOS Artwork Repository. + The process of software installation takes place through sudo yum and the repository configuration currently set in your workstation. + Most of the software packages required by the working copy of CentOS Artwork Repository are available on The CentOS Distribution and can be installed using The CentOS Distribution installation media. The only exception is Inkscape, the program used to manipulate SVGScalable Vector Graphics files in the working copy. + The inkscape package isn't inside The CentOS Distribution or any of The CentOS Project repositories neither, so you need to install it from a third party repository like RPMForge or EPEL. See page http://wiki.centos.org/AdditionalResources/Repositories/The CentOS Repositories, to know how to configure third party repositories in The CentOS Distribution. + + + + + + This option uses symbolic links to install/update the connection between components inside the working copy and components outside the working copy. Among the components that need to be connected figure out the command-line internface of centos-art.sh script; fonts, brushes, palettes and patterns used by programs like GIMP and Inkscape; and configuration files of text editors. + The main purpose of such connection is to adapt the working copy to the CentOS Distribution filesystem layout (e.g., ~/bin directory is for storing personal programs, ~/gimp-2.2/brushes is for storing GIMP brushes for personal use, etc.) and, at the same time, to provide a way of sharing changes made to connected components to other workstations (e.g., if I update a GIMP brush in my workstation, you'll receive the change the next you update your working copy and then will be immediatly available for you to use in GIMP). + + + + + + Print the name and value of some of the environment variables used by centos-art.sh scripts. + + +
Description - The prepare functionality of centos-art.sh script provides the standard way of configuring the workstation you plan to use for storing the working copy of CentOS Artwork Repository. - The prepare functionality of centos-art.sh script is part of the CentOS Artwork Repository. So, in order to execute the prepare functionality of centos-art.sh script you need to have access to a working copy of CentOS Artwork Repository, first. Working copies of CentOS Artwork Repository are downloaded from the source repository and made available to you by mean of workstations. A workstation is a computer that you install and configure (prepare) to do something. In this case, you pick up a computer and prepare it for working on the CentOS Artwork Repository. + The prepare functionality of centos-art.sh script is part of the CentOS Artwork Repository. So, in order to execute the prepare functionality of centos-art.sh script you need to have access to a working copy of CentOS Artwork Repository, first. Working copies of CentOS Artwork Repository are downloaded from the source repository and made available to you by mean of workstations. A workstation is a computer that you install and configure (prepare) to do something. In this case, you pick up a computer and prepare it for working on the CentOS Artwork Repository. Installing the workstation Installing the workstation is the first step you need to do. In this step you make your computer functional through an operating system. In this case, The Community Enterprise Operating System; which is also know as The CentOS Distribution or just CentOS, for short. To install The CentOS Distribution you need to have the installation media somehow (e.g., CDs, DVDs, Pendrives, etc.). There are several different ways to perform the installation process of CentOS distribution, but generally, you put the installation media in your media reader, boot the computer from it, and follow the installer intructions. That simple. - If you don't have the installation media of CentOS distribution, you need to download the ISO files related to the media you plan to use (e.g., CD or DVD) and then create the installation media by yourself. The CentOS Distribution ISO files can be downloaded from http://mirrors.centos.org/ and, if you chosen CD or DVD as your prefered installation medium, you can burn the ISO files using the K3B application to create the installation media you'll use. Of course, in order to download the ISO files and create the installation media, you need to have an already installed CentOS workstation where you can realized all the work. + If you don't have the installation media of CentOS distribution, you need to download the ISO files related to the media you plan to use (e.g., CD or DVD) and then create the installation media by yourself. The CentOS Distribution ISO files can be downloaded from http://mirrors.centos.org/ and, if you chosen CD or DVD as your prefered installation medium, you can burn the ISO files using the K3B application so as to create the installation media you'll use. Of course, in order to download the ISO files and create the installation media, you need to have an already installed CentOS workstation where you can realized all the work. Configuring the workstation Once you've installed the workstation and it is up and running, login as root user, create a username (e.g., centos) and set a password for it. This is the username you must use for everyday work inside your working copy of the CentOS Artwork Repository. @@ -2863,7 +2935,7 @@ centos-art locale --edit trunk/Scripts /usr/bin/nano - + If no one of these values is set in the EDITOR environment variable, the centos-art.sh script uses /usr/bin/vim text editor, the one installed by default in The CentOS Distribution. @@ -2871,14 +2943,14 @@ centos-art locale --edit trunk/Scripts Default locale information: The default locale information is controlled by the LANG environment variable. This variable is initially set in the configuration process of CentOS distribution installer, 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 determine what language to use for printing output messages. Moreover, the locale functionality uses the LANG to determine what translation messages to udpate or edit. + The centos-art.sh script uses the LANG environment variable to determine what language to use for printing output messages. Another use of LANG variable inside centos-art.sh script is to determine what translation file to update or edit when input files are localized. Default time zone representation: The time zone representation is a time correction applied to the system time (stored in the BIOS clock) based on your country location. This correction is specially useful to distributed computers around the world that work together and need to be syncronized in time to know when things happened. - The CentOS Artwork Repository is made of one server and several workstations spread around the world. In order for all these workstations to know when changes in the server took place, it is required that all the workstations set their system clocks to use the same time information (i.e., UTCCoordinated Universal Time) and set the time correction for their countries in the operating system. Otherwise, it'd be hard to know when something exactly happened. + The CentOS Artwork Repository is made of one server and several workstations spread around the world. In order for all these workstations to know when changes in the server took place, it is required that they all set their system clocks to use the same time information (i.e., UTCCoordinated Universal Time) and set the time correction for their specific countries in the operating system. Otherwise, it would be difficult to know when something exactly happened. Generally, setting the time information is a straight-forward task and configuration tools provided by The CentOS Distribution do cover time correction for most of the countries around the world. However, if you need a time precision not provided by any of the date and time configuration tools provided by The CentOS Distribution then, you need to use the TZ environment variable to correct the time information by yourself. The format of TZ environment variable is described in tzset(3) manual page. @@ -2897,59 +2969,17 @@ sudo yum install subversion ]]> Configuring the working copy - Once you have a working copy of CentOS Artwork Repository in your workstation, you can go and run the prepare functionality of centos-art.sh script to realize the remaining configuration stuff. + Once you have a working copy of CentOS Artwork Repository in your workstation, you can go and run the prepare functionality of centos-art.sh script to realize the remaining configuration stuff. Assuming this is the very first time you run the centos-art.sh script, you'll find that there is no centos-art command-line interface for it in your workstation. This is correct. In order to have the centos-art command-line in your workstation, you need to run the centos-art.sh script using its absolute path: - Assuming you've already run the prepare functionality before, there is no need for you to use the absolute path again. Instead, you can use the centos-art command-line interface directly, as the following example describes: + Assuming you've already run the prepare functionality before, there is no need for you to use the absolute path again. Instead, you can use the centos-art command-line interface directly, as the following example describes: - Notice that you can execute the prepare functionality more than once. This is specially useful to keep the link information syncronized. For example, considering you've added new brushes to or removed old brushes from your working copy of CentOS Artwork Repository, the link information related to those files need to be updated in the ~/.gimp-2.2/brushes directory too, in a way the addition/deletion change that took place in your working copy can be reflected there, as well. The same is true for other similar components like fonts, patterns and palettes components. - Usage - Synopsis - centos-art prepare [OPTIONS] - Options - - - - - Install/update software packages required by the working copy of CentOS Artwork Repository. - The process of software installation takes place through sudo yum and the repository configuration currently set in your workstation. - Most of the software packages required by the working copy of CentOS Artwork Repository are available on The CentOS Distribution and can be installed using The CentOS Distribution installation media. The only exception is Inkscape, the program used to manipulate SVGScalable Vector Graphics files in the working copy. - The inkscape package isn't inside The CentOS Distribution or any of The CentOS Project repositories neither, so you need to install it from a third party repository like RPMForge or EPEL. See page http://wiki.centos.org/AdditionalResources/Repositories/The CentOS Repositories, to know how to configure third party repositories in The CentOS Distribution. - - - - - - Install/update connection between working copy and workstation through symbolic links. - This option creates the centos-art command-line interface of centos-art.sh script through a symbolic link. There is no need for you to type the full path to centos-art.sh script each time you need to execute it. Instead, you use the centos-art command which is much shorter and faster to type. - This option connects design compenents like fonts, brushes, patterns and palettes inside your working copy of CentOS Artwork Repository with programs like GIMPGNU Image Manipulation Program and Inkscape outside it. This way, all your modifications on these components will take place inside the repository and will be shared to all other working copies the next time you commit the changes up to source repository. - This option standardizes width, tabulation, indentation, and line numbering for text editors in your workstation. The configuration file where these definitions are set, is versioned inside your working copy and linked from the appropriate place in the workstation to make it valid to your default text editor. - - - - - - Print the name and value of some of the environment variables used by centos-art.sh scripts. - - - - - - Supress all output messages, including confirmation question. Use this option with care. - - - - - - Assume yes to all confirmation questions. - - -
- Examples + Notice that you can execute the prepare functionality more than once. This is specially useful to keep the link information syncronized. For example, considering you've added new brushes to or removed old brushes from your working copy of CentOS Artwork Repository, the link information related to those files need to be updated in the ~/.gimp-2.2/brushes directory too, in a way the addition/deletion change that took place in your working copy can be reflected there, as well. The same is true for other similar components like fonts, patterns and palettes components. + Examples centos-art prepare --packages --link @@ -2964,6 +2994,13 @@ centos-art.sh prepare [OPTIONS]
+ Author + Written by Alain Reguera Delgado. + Reporting bugs + Report bugs to centos-artwork@centos.org mailing list. + Copyright + Copyright ©right; 2009, 2010, 2011 The CentOS Project. + This is free software. You may redistribute copies of it under the terms of the GNU General Public License (see GNU General Public License). There is NO WARRANTY, to the extent permitted by law. See also • @@ -2990,76 +3027,62 @@ centos-art.sh prepare [OPTIONS] Name The render functionlity is part of centos-art.sh script and standardizes rendition tasks inside the working copy of CentOS Artwork Repository. Synopsis - centos-art render [OPTION] path/to/dir - The path/to/dir parameter refers the path information related to the directory structure inside the working copy of CentOS Artwork Repository you'r going to produce. This path information defines whether to perform direct or theme-specific rendition. - You can use the path/to/dir information to control the amount of components you'll produce inside a specific renderable location. The more deep you go inside the path the more specific you are when producing theme components. Sometimes, you can also combine the use of path/to/dir with the option to have a finer control over the files you produce. + centos-art render [OPTIONS] path/to/dir + The path/to/dir parameter specifies what directory structure inside the working copy of CentOS Artwork Repository you want to produce. The render functionality of centos-art.sh script accepts the following options: - Supress all output messages, including confirmation question. Use this option with care. + Supress all output messages except error messages. When this option is passed, all confirmation requests are supressed as well and a possitive answer is assumed for them, just as if the option had been provided. - + - Reduce the list of files to process using REGEX as pattern. + Assume `yes' to all confirmation requests. - + - Assume `yes' to all confirmation questions. + Reduce the list of files to process using REGEX as pattern. You can use this option in combination with path/to/dir in order to control the amount of files you want to produce as base-rendition. The deeper you go into the directory structure the more specific you'll be about the component you want to produce. When you cannot go deeper into the directory structure, you can use option to reduce the list of files. - Supress all commit and update actions realized over files already processed, before and after the action itself had took place in the working copy. + Supress all commit and update actions realized over files, before and after the action itself had took place over files in the working copy. - Produce content for the release version specified in STRING. This option is generaly used in direct rendition, where design models aren't organized using release versions and architectures as reference. + This option expands release-specific translation makers to STRING. Use this option when no releasae-specific information can be retrived from the path of the directory structure you are currently rendering. - Produce content for the architecture specified in STRING. This option is generaly used in direct rendition, where design models aren't organized using release versions and architectures as reference. - - - - - - Uses post-rendition to convert output produced by base-rendition to any image format specified in STRING. This option is an interface for the convert command of ImageMagick tool set, so it is applicable to images output only. + This option expands architecture-specific translation makers to STRING. Use this option when no architecture-specific information can be retrived from the path of the directory structure you are currently rendering. - - - Uses post-rendition to rotate output produced by base-rendition to any angle specified in STRING. This option is an interface for the convert command of ImageMagick tool set, so it is applicable to images output only. - - - - + - Uses post-rendition to resize the base-rendition output to any angle specified in STRING. This option is an interface for the convert command of ImageMagick tool set, so it is applicable to images output only. + Specify the name of the theme model you want to use to produce theme artistic motifs. By default, if this option is not passed, the Default theme model is used as reference to produce theme motifs. - + - Group base output files inside directories. Directories used to stored base output files are named using the file extension of base output files. For example: if the base output file is a .png file, it is moved inside a Png/ directory; if the current file is a .jpg file, it is stored inside a Jpg/ directory, and so on. - Directories used to group files are created in the same location that base output files would normaly do. + This option let you apply a command as post-rendition action. In this case, the STRING represents the command string you want to execute in order to perform in-place modifications to base-rendition output. - + - Specify, in the STRING, the name of the theme model you want to use to produce theme motifs. By default, if this option is not passed, the Default theme model is used as reference to produce theme motifs. + This option let you apply a command as last-rendition action. In this case, the STRING represents the command string you want to execute in order to perform in-place modifications to base-rendition, post-rendition and directory-specific rendition outputs.
@@ -3079,9 +3102,9 @@ centos-art.sh prepare [OPTIONS] Theme-specific rendition - In theme-specific rendition, there is one directory structure to store input files trunk/Identity/Themes/Models, one directory structure to store translation files (trunk/Locales/Identity/Themes/Models/), one directory structure to store artistic motifs (trunk/Identity/Images/Themes) and one directory structure to store output files (trunk/Identity/Images/Themes). + In theme-specific rendition, there is one directory structure to store input files (trunk/Identity/Themes/Models), one directory structure to store translation files (trunk/Locales/Identity/Themes/Models/), one directory structure to store artistic motifs (trunk/Identity/Images/Themes) and one directory structure to store output files (trunk/Identity/Images/Themes). In theme-specific rendition, when the render functionality of centos-art.sh script is executed, it uses the input directory structure to build a list of files to process, which is used as reference to determine the location of the translation file and the location of the output file, as well. - In contrast with direct rendition, when we use theme-specific rendition, it is possible to combine both design models and artistic motifs to produce output in an arbitrary way. This configuration is specially interesting because it is possible to create different artistic motifs and one unique design model in order to produce one unique theme structure with different visual styles. Or the opposite, to create different theme structures and apply one unique visual style to produce different visual styles with the same theme structure. Or even push a bit farther and experiment with arbitrary combinations among them all. + In contrast with direct rendition, when we use theme-specific rendition, it is possible to combine both design models and artistic motifs to produce output in an arbitrary way. This configuration is specially interesting because it is possible to create different artistic motifs and one unique design model in order to produce one unique theme structure with different visual styles. Or the opposite, to create different theme structures and apply one unique visual style to produce one unique visual styles on different theme structure. Or even get a bit farther and experiment with arbitrary combinations among them all. @@ -3089,31 +3112,86 @@ centos-art.sh prepare [OPTIONS] In both direct and theme-specific rendition, if the input related translation file doesn't exist, the render functionality of centos-art.sh script will produce the output in the same language of its input file. The base-rendition flow The base-rendition flow is the first rendition flow of all rendition flows available and takes place immediatly after executing the render functionality of centos-art.sh script. - The base-rendition consist on producing different output formats in different languages from one single input format. This is, one input file produces one output file. Inside the render functionality of centos-art.sh script, the input format is always an XML file (e.g., SVG, XHTML, Docbook) and the output format depends on the input file provided. - For example, when the input format is a SVG file, the base output is a PNG file; when the input format is XHTML the base output is an XHTML file; when the input format is a Docbook file the base output is an XHTML file. + The base-rendition produces different outputs from one unique input format. This is, one input file is used to produce one ore more output files. When translation files are available for input files, the base-rendition applies the translation file to the input file in order to produce a translated instance of it, then this translated instance is used as input file to produce one or more output files. + Inside the render functionality of centos-art.sh script, the input format is always XML (e.g., SVG, XHTML, Docbook), the translation files are always portable objects (e.g., PO) and the output format depends on the input file provided (e.g., when the input format is a SVG file, the base output is a PNG file; when the input format is XHTML the base output is an XHTML file; when the input format is a Docbook file the base output might be either HTML, RTF, PS or PDF). + As application example of base-rendition flow, consider the description of the following sections: + + • + + Directories trunk Identity Models Themes Default Distro 5 Anaconda + + + Directories trunk Identity Models Themes Default Distro 5.5 Notes Release + + The post-rendition flow - The post-rendition flow takes place after base-rendition and is applied to create modified copies of the file produced by base-rendition in the same directory structure. - For example, when the input format is a SVG file and the output is a PNG file, we can use post-rendition to extend the base output to other image formats. In fact, it is possible to do anything permitted by the ImageMagick and Netpbm programs (e.g., resize, rotate, reduce color, etc.) over the base output. + The post-rendition flow is performed immediatly after base-rendition flow to extend the base-rendition flow by applying in-place modifications to base-rendition output. In-place modifications can be performed either through the command-line option of centos-art.sh script or through directory-specific rendition. + Actions commanded through option are applied first and directory-specific actions later. This order is required to propagate in-place changes commited to base-rendition output to modified copies (i.e., new files) of it created through directory-specific rendition. Creation of modified copies is something specific to directory-specific rendition only. It is not possible for the option to create modified copies of base-rendition flow because commands passed through it are applied to the base-rendition output file directly in a disposition that don't support creation of new files, but in-place modifications only. + The command passed to option can be changed everytime you run the centos-art.sh script, but actions specified in directory-specific rendition cannot be changed in the same way. Direcctory-specific rendition is set inside centos-art.sh script to perform specific tasks that cannot be achived through option. + As application example of post-rendition flow, consider the description of the following sections: + + • + + Directories trunk Identity Models Themes Default Distro 5 Syslinux + + + Directories trunk Identity Models Themes Default Distro 5 Grub + + The last-rendition flow - The last-rendition flow takes place after post-rendition and is applied to all files produced as result of both base-rendition and post-rendition flows in the same directory structure, just before passing to process a different directory structure. - For example, consider the Preview.png image of Ksplash which is made of three different images. In order to build the Preview.png image, we need to create the three images the Preview.png image is made of first (e.g., through base-rendition) and then, combine them all together into one new image, the Preview.png image in this case. - Another example of using last-rendition flow is that related to GDM and KDM tar.gz file construction. Each tar.gz file is made of several files that need to be put together in order to make them installable. In the very specific case of GDM and KDM some of the required files are retrived from design models directory structure and others from artistic motifs directory structure after had been produced through base-rendition. In this case, the action of grouping files and packing them is realized through last-rendition action. This couldn't be possible through post-rendition because we need to wait to have two images first (produced through base-rendition) before we could grouping them all into the tar.gz package. + The last-rendition flow takes place after post-rendition and applies in-place modifications to all files produced as result of both base-rendition and post-rendition flows in the same directory structure, just before passing to process a different directory structure. In-place modifications can be performed either through the command-line option of centos-art.sh script or through directory-specific rendition. + Actions commanded through option are applied after directory-specific actions. This order is required to prevent last-rendition actions commanded from directory-specifc rendition to overlap last-rendition actions commanded from option. + The command passed to option can be changed everytime you run the centos-art.sh script, but actions specified in directory-specific rendition cannot be changed in the same way. Actions commanded from directory-specific rendition are set inside centos-art.sh script to perform specific tasks that cannot be achived through option. + As application example of last-rendition flow, consider the description of the following sections: + + • + + Directories trunk Identity Models Themes Default Distro 5 Ksplash + + + Directories trunk Identity Models Themes Default Distro 5 Gdm + + The directory-specific rendition flow - The directory-specific rendition flow isn't a rendition flow by itself but a combination of rendition flows that are applied to specific directories at rendition time. - Inside the working copy of CentOS Artwork Repository there are some directories structures that exist to achieve specific tasks every time they are produced. The directory-specific rendition flow provides a way for the render functionality of centos-art.sh script to know what actions to apply to what directory structure when producing them. - The directory-specific rendition flow combines the base-rendition, post-rendition and last-rendition flows in specific ways and applies them to specific directory structures when they are detected. Using this configuration can speed up production of different components like Syslinux, Grub, Gdm, Kdm and Ksplash that require intermediate formats or even several independent files, in order for the final content to be created. + Inside the working copy of CentOS Artwork Repository, some directory structure (e.g., Syslinux, Gurb, Gdm, Kdm and KSplash) required more than base-rendition or even the commands you could pass through the and options, in order for their final files to be produced. In these situations, we make use of directory-specific rendition flow. + The directory-specific rendition flow applies specific actions to specific directory structures when they enter into the rendition flow. Using this configuration speeds up production of all those components that require intermediate formats or even several independent files, in order for the final content to be created. + The directory-specific rendition flow is generally used in combination with post-rendition and last-rendition flows inside centos-art.sh script. Translations To translate output files, the render functionality of centos-art.sh script creates a translated instance of the input file and uses it then to create the base output file. The translated instance is created using the related translation messages of the input file. Translation messages are stored under trunk/Locales and are created using the locale functionality of centos-art.sh script (see Directories trunk Scripts Functions Locale). + Translation files are optional. When no translation file is available for the input file, the base-rendition output is produced using the same language of the input file. Examples - - - + + + centos-art render trunk/Identity/Images/Brands + + This command produces all branding information related to The CentOS Project (e.g., symbols, logos and variants of them). + + + + centos-art render trunk/Identity/Images/Brands --filter="symbol" + + This command produces all branding information, related to The CentOS Project, which file names contain the symbol string on it. + + + + centos-art render trunk/Identity/Images/Themes/Flame/2 + + This command produces all visual manifestations related to version 2 of Flame artistic motif (e.g., Distribution, Posters, etc.) as specified by default design models. + + + + centos-art render trunk/Identity/Images/Themes/Flame/2/Distro + + This command produces the Distribution visual manifestations related to version 2 of Flame artistic motif (e.g., Anaconda, Syslinux, Grub, Firstboot, Gdm, Kdm, Gsplash, Ksplash, and Rhgb) as specified by default design models. + + + + centos-art render trunk/Identity/Images/Themes --filter='Distro/5/Anaconda' + + This command produces all the images related to Anaconda component from Distribution visual manifestations on its major release number five, for all the artistic motifs available and as specified by default design models. + + +
Author Written by Alain Reguera Delgado. Reporting bugs @@ -3143,10 +3221,39 @@ centos-art render trunk/Identity/Images/Themes/Flame/2
The <file>trunk/Scripts/Functions/Tuneup</file> Directory Directories trunk Scripts Functions Tuneup - Goals - This section describes the tuneup functionality of centos-art.sh script and general examples about file maintainance inside a working copy of CentOS Artwork Repository. + Name + The tuneup functionlity is part of centos-art.sh script and standardizes tasks related to file maintainance inside the working copy of CentOS Artwork Repository. + Synopsis + centos-art tuneup [OPTIONS] path/to/dir + The path/to/dir parameter specifies what directory structure inside the working copy of CentOS Artwork Repository you want to process. + The tuneup functionality of centos-art.sh script accepts the following options: + + + + + Supress all output messages except error messages. When this option is passed, all confirmation requests are supressed as well and a possitive answer is assumed for them, just as if the option had been provided. + + + + + + Assume `yes' to all confirmation requests. + + + + + + Reduce the list of files to process using REGEX as pattern. You can use this option in combination with path/to/dir in order to control the amount of files you want to produce as base-rendition. The deeper you go into the directory structure the more specific you'll be about the component you want to produce. When you cannot go deeper into the directory structure, you can use option to reduce the list of files. + + + + + + Supress all commit and update actions realized over files, before and after the action itself had took place over files in the working copy. + + +
Description - The tuneup functionality of centos-art.sh script provides the standard way of maintaining files inside the working copy of CentOS Artwork Repository. Tasks related to file maintainance are repetitive. You might find yourself doing them time after time inside the working copy of CentOS Artwork Repository. Some of these maintainance tasks do update top comments on shell scripts, create table of contents for web pages, update metadata related to design models and remove unused definitions from design models. When you execute the tuneup functionality of centos-art.sh script, it looks for all files that match the supported extensions (e.g., .sh, .svg and .xhtml) in the directory specified, builds a list with them and applies the maintainance tasks using file extensions as reference. Maintaining .sh files @@ -3184,37 +3291,7 @@ centos-art render trunk/Identity/Images/Themes/Flame/2

Title

]]> In the example above, h1 can vary from h1 to h6. Closing tag must be present and also match the openning tag. The value of and options from the anchor element are set dynamically using the md5sum output of combining the page location, the head- string and the heading string. If any of the components used to build the heading reference changes, you need to run the the tuneup functionality of centos-art.sh script in order for the anchor elements to use the correct information. - Usage - Synopsis - centos-art tuneup [OPTIONS] path/to/dir - Options - - - - - Supress all output messages, including confirmation question. Use this option with care. - - - - - - Reduce the amount of files to process using regex as pattern. - - - - - - Assume `yes' to all confirmation questions. - - - - - - Supress all commit and update actions realized over files already processed, before and after the action itself had took place in the working copy. - - -
- Examples + Examples centos-art tuneup trunk/Scripts @@ -3235,6 +3312,13 @@ centos-art render trunk/Identity/Images/Themes/Flame/2
+ Author + Written by Alain Reguera Delgado. + Reporting bugs + Report bugs to centos-artwork@centos.org mailing list. + Copyright + Copyright ©right; 2009, 2010, 2011 The CentOS Project. + This is free software. You may redistribute copies of it under the terms of the GNU General Public License (see GNU General Public License). There is NO WARRANTY, to the extent permitted by law. See also •