From 78cdd23104dcb67b4d30e7092bcb48f1e6af77c2 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: May 01 2011 16:32:56 +0000 Subject: Update repository documentation manual. --- diff --git a/Manual/Directories/chapter-nodes.texi b/Manual/Directories/chapter-nodes.texi index bf37f6b..1736d0b 100644 --- a/Manual/Directories/chapter-nodes.texi +++ b/Manual/Directories/chapter-nodes.texi @@ -134,29 +134,29 @@ @include Directories/trunk/Identity/Themes/Models/Default/Posters.texi @node Directories trunk Identity Themes Motifs -@section The @file{trunk/Identity/Themes/Motifs} Directory +@section The @file{trunk/Identity/Images/Themes} Directory @cindex Directories trunk Identity Themes Motifs -@include Directories/trunk/Identity/Themes/Motifs.texi +@include Directories/trunk/Identity/Images/Themes.texi @node Directories trunk Identity Themes Motifs Flame -@section The @file{trunk/Identity/Themes/Motifs/Flame} Directory +@section The @file{trunk/Identity/Images/Themes/Flame} Directory @cindex Directories trunk Identity Themes Motifs Flame -@include Directories/trunk/Identity/Themes/Motifs/Flame.texi +@include Directories/trunk/Identity/Images/Themes/Flame.texi @node Directories trunk Identity Themes Motifs Modern -@section The @file{trunk/Identity/Themes/Motifs/Modern} Directory +@section The @file{trunk/Identity/Images/Themes/Modern} Directory @cindex Directories trunk Identity Themes Motifs Modern -@include Directories/trunk/Identity/Themes/Motifs/Modern.texi +@include Directories/trunk/Identity/Images/Themes/Modern.texi @node Directories trunk Identity Themes Motifs Pipes -@section The @file{trunk/Identity/Themes/Motifs/Pipes} Directory +@section The @file{trunk/Identity/Images/Themes/Pipes} Directory @cindex Directories trunk Identity Themes Motifs Pipes -@include Directories/trunk/Identity/Themes/Motifs/Pipes.texi +@include Directories/trunk/Identity/Images/Themes/Pipes.texi @node Directories trunk Identity Themes Motifs TreeFlower -@section The @file{trunk/Identity/Themes/Motifs/TreeFlower} Directory +@section The @file{trunk/Identity/Images/Themes/TreeFlower} Directory @cindex Directories trunk Identity Themes Motifs TreeFlower -@include Directories/trunk/Identity/Themes/Motifs/TreeFlower.texi +@include Directories/trunk/Identity/Images/Themes/TreeFlower.texi @node Directories trunk Identity Webenv @section The @file{trunk/Identity/Webenv} Directory diff --git a/Manual/Directories/trunk/Identity/Brushes.texi b/Manual/Directories/trunk/Identity/Brushes.texi index 49210e7..2747d2a 100755 --- a/Manual/Directories/trunk/Identity/Brushes.texi +++ b/Manual/Directories/trunk/Identity/Brushes.texi @@ -17,7 +17,7 @@ source file. @verbatim 1. Common brushes 2. Theme-specific brushes ---------------------- ----------------------------------------------------------- -trunk/Identity/Brushes trunk/Identity/Themes/Motifs/THEMENAME/THEMEVERSION/Brushes +trunk/Identity/Brushes trunk/Identity/Images/Themes/THEMENAME/THEMEVERSION/Brushes |-- Xcf |-- Xcf | |-- 1.xcf | |-- 1.xcf | |-- 2.xcf | |-- 2.xcf @@ -71,7 +71,7 @@ trunk/Identity/Brushes @end verbatim @verbatim -trunk/Identity/Themes/Motifs/THEMENAME/THEMEVERSION/Brushes +trunk/Identity/Images/Themes/THEMENAME/THEMEVERSION/Brushes |-- 1.gbr (file) <-- ~/.gimp-2.2/brushes/centos-THEMENAME-THEMEVERSION-1.gbr (link) |-- 2.gbr (file) <-- ~/.gimp-2.2/brushes/centos-THEMENAME-THEMEVERSION-2.gbr (link) `-- 3.gbr (file) <-- ~/.gimp-2.2/brushes/centos-THEMENAME-THEMEVERSION-3.gbr (link) diff --git a/Manual/Directories/trunk/Identity/Themes.texi b/Manual/Directories/trunk/Identity/Themes.texi index 6783cfa..1951e39 100644 --- a/Manual/Directories/trunk/Identity/Themes.texi +++ b/Manual/Directories/trunk/Identity/Themes.texi @@ -6,21 +6,21 @@ production of CentOS themes. @subheading Description Initially, we start working themes on their trunk development line -(e.g., @file{trunk/Identity/Themes/Motifs/TreeFlower/}), here we +(e.g., @file{trunk/Identity/Images/Themes/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., -@file{branches/Identity/Themes/Motifs/TreeFlower/1/}). Once the +@file{branches/Identity/Images/Themes/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 @file{tags/} directory (e.g., -@file{tags/Identity/Themes/Motifs/TreeFower/1.0/}) for packagers, +@file{tags/Identity/Images/Themes/TreeFower/1.0/}) for packagers, webmasters, promoters, and anyone who needs images from that CentOS theme the tag was created for. diff --git a/Manual/Directories/trunk/Identity/Themes/Motifs.texi b/Manual/Directories/trunk/Identity/Themes/Motifs.texi index e59547e..4b91b89 100644 --- a/Manual/Directories/trunk/Identity/Themes/Motifs.texi +++ b/Manual/Directories/trunk/Identity/Themes/Motifs.texi @@ -1,6 +1,6 @@ @subheading Goals -The @file{trunk/Identity/Themes/Motifs} directory exists to: +The @file{trunk/Identity/Images/Themes} directory exists to: @itemize @item Organize CentOS themes' artistic motifs. @@ -29,7 +29,7 @@ Modern, squares and circles flowing up. If you have new conceptual ideas for CentOS, then you can say that you want to create a new artistic motif for CentOS. To create a new artistic motif you need to create a directory under -@file{Identity/Themes/Motifs/} using a name coherent with your +@file{Identity/Images/Themes/} using a name coherent with your conceptual idea. That name will be the name of your artistic motif. If possible, when creating new conceptual ideas for CentOS, think about what CentOS means for you, what does it makes you feel, take your @@ -42,7 +42,7 @@ organize your graphic design projects. To add a new motif structure to CentOS Artwork Repository, you need to use the @command{centos-art} command line in the -@file{Identity/Themes/Motifs/} directory as described below: +@file{Identity/Images/Themes/} directory as described below: @example centos-art add --motif=ThemeName @@ -53,7 +53,7 @@ you. The basic structure produced by @command{centos-art} command is illustrated in the following figure: @example -trunk/Identity/Themes/Motifs/$ThemeName/ +trunk/Identity/Images/Themes/$ThemeName/ |-- Backgrounds | |-- Img | `-- Tpl @@ -75,7 +75,7 @@ used as value wherever theme variable (@b{$THEME}) or translation marker (@b{=THEME=}) is. Optionally, you can add a description about inspiration and concepts behind your work. -@item Use the location @file{trunk/Identity/Themes/Motifs/$THEME/} to +@item Use the location @file{trunk/Identity/Images/Themes/$THEME/} to store your work. If it doesn't exist create it. Note that this require you to have previous commit access in CentOS Artwork Repository. diff --git a/Manual/Directories/trunk/Identity/Themes/Motifs/Flame.texi b/Manual/Directories/trunk/Identity/Themes/Motifs/Flame.texi index 8947136..22ca756 100644 --- a/Manual/Directories/trunk/Identity/Themes/Motifs/Flame.texi +++ b/Manual/Directories/trunk/Identity/Themes/Motifs/Flame.texi @@ -105,9 +105,9 @@ directory structure. @ifhtml @subheading Screenshots -@image{trunk/Identity/Themes/Motifs/Flame/1/Concept/motif-thumb-250,,,,jpg} -@image{trunk/Identity/Themes/Motifs/Flame/2/Concept/motif-thumb-250,,,,jpg} -@image{trunk/Identity/Themes/Motifs/Flame/3/Concept/motif-thumb-250,,,,jpg} +@image{trunk/Identity/Images/Themes/Flame/1/Concept/motif-thumb-250,,,,jpg} +@image{trunk/Identity/Images/Themes/Flame/2/Concept/motif-thumb-250,,,,jpg} +@image{trunk/Identity/Images/Themes/Flame/3/Concept/motif-thumb-250,,,,jpg} @end ifhtml @subheading See also diff --git a/Manual/Directories/trunk/Identity/Themes/Motifs/Modern.texi b/Manual/Directories/trunk/Identity/Themes/Motifs/Modern.texi index ac27109..df12723 100644 --- a/Manual/Directories/trunk/Identity/Themes/Motifs/Modern.texi +++ b/Manual/Directories/trunk/Identity/Themes/Motifs/Modern.texi @@ -15,7 +15,7 @@ @ifhtml @subheading Screenshots -@image{trunk/Identity/Themes/Motifs/Modern/1/Concept/motif-thumb-250,,,,jpg} +@image{trunk/Identity/Images/Themes/Modern/1/Concept/motif-thumb-250,,,,jpg} @end ifhtml @subheading See also diff --git a/Manual/Directories/trunk/Identity/Themes/Motifs/Pipes.texi b/Manual/Directories/trunk/Identity/Themes/Motifs/Pipes.texi index 8e7ddc7..80f2bcc 100755 --- a/Manual/Directories/trunk/Identity/Themes/Motifs/Pipes.texi +++ b/Manual/Directories/trunk/Identity/Themes/Motifs/Pipes.texi @@ -19,7 +19,7 @@ @ifhtml @subheading Screenshots -@image{trunk/Identity/Themes/Motifs/Pipes/1/Concept/motif-thumb-250,,,,jpg} +@image{trunk/Identity/Images/Themes/Pipes/1/Concept/motif-thumb-250,,,,jpg} @end ifhtml @subheading See also diff --git a/Manual/Directories/trunk/Identity/Themes/Motifs/TreeFlower.texi b/Manual/Directories/trunk/Identity/Themes/Motifs/TreeFlower.texi index d10f820..9c31afb 100644 --- a/Manual/Directories/trunk/Identity/Themes/Motifs/TreeFlower.texi +++ b/Manual/Directories/trunk/Identity/Themes/Motifs/TreeFlower.texi @@ -5,10 +5,10 @@ @ifhtml @subheading Screenshots -@image{trunk/Identity/Themes/Motifs/TreeFlower/1/Concept/motif-thumb-250,,,,jpg} -@image{trunk/Identity/Themes/Motifs/TreeFlower/2/Concept/motif-thumb-250,,,,jpg} -@image{trunk/Identity/Themes/Motifs/TreeFlower/3/Concept/motif-thumb-250,,,,jpg} -@image{trunk/Identity/Themes/Motifs/TreeFlower/4/Concept/motif-thumb-250,,,,jpg} +@image{trunk/Identity/Images/Themes/TreeFlower/1/Concept/motif-thumb-250,,,,jpg} +@image{trunk/Identity/Images/Themes/TreeFlower/2/Concept/motif-thumb-250,,,,jpg} +@image{trunk/Identity/Images/Themes/TreeFlower/3/Concept/motif-thumb-250,,,,jpg} +@image{trunk/Identity/Images/Themes/TreeFlower/4/Concept/motif-thumb-250,,,,jpg} @end ifhtml @subheading Usage diff --git a/Manual/Directories/trunk/Identity/Webenv.texi b/Manual/Directories/trunk/Identity/Webenv.texi index 57decbb..5736d03 100755 --- a/Manual/Directories/trunk/Identity/Webenv.texi +++ b/Manual/Directories/trunk/Identity/Webenv.texi @@ -79,7 +79,7 @@ following compenents: @table @strong @item Webenv header background @verbatim -trunk/Identity/Themes/Motifs/$THEME/Backgrounds/Img/1024x250.png +trunk/Identity/Images/Themes/$THEME/Backgrounds/Img/1024x250.png @end verbatim @item CSS definitions @@ -94,10 +94,10 @@ The visual style of CentOS web environment is defined in the following files: @verbatim -trunk/Identity/Themes/Motifs/$THEME/Backgrounds/Xcf/1024x250.xcf -trunk/Identity/Themes/Motifs/$THEME/Backgrounds/Img/1024x250.png -trunk/Identity/Themes/Motifs/$THEME/Backgrounds/Img/1024x250-bg.png -trunk/Identity/Themes/Motifs/$THEME/Backgrounds/Tpl/1024x250.svg +trunk/Identity/Images/Themes/$THEME/Backgrounds/Xcf/1024x250.xcf +trunk/Identity/Images/Themes/$THEME/Backgrounds/Img/1024x250.png +trunk/Identity/Images/Themes/$THEME/Backgrounds/Img/1024x250-bg.png +trunk/Identity/Images/Themes/$THEME/Backgrounds/Tpl/1024x250.svg @end verbatim As graphic designer you use @file{1024x250.xcf} file to produce @@ -108,7 +108,7 @@ your vectorial design. When you consider you artwork ready, use the visual style controller images of CentOS web environment. @verbatim -centos-art render --entry=trunk/Identity/Themes/Motifs/$THEME/Backgrounds --filter='1024x250' +centos-art render --entry=trunk/Identity/Images/Themes/$THEME/Backgrounds --filter='1024x250' @end verbatim Once you have rendered required image files, changing the visual style diff --git a/Manual/Directories/trunk/Scripts/Functions/Render.texi b/Manual/Directories/trunk/Scripts/Functions/Render.texi index 1d8f1d1..31238fa 100644 --- a/Manual/Directories/trunk/Scripts/Functions/Render.texi +++ b/Manual/Directories/trunk/Scripts/Functions/Render.texi @@ -1,10 +1,26 @@ -@subheading Goals +@subheading NAME This section describes the @code{render} functionality of @command{centos-art.sh} script and general examples about content rendition inside a working copy of CentOS Artwork Repository. -@subheading Description +@subheading SYNOPSIS + +@command{centos-art render [] 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. + +@subheading DESCRIPTION The @code{render} functionlity of @command{centos-art.sh} script standardizes rendition tasks inside the working copy of CentOS Artwork @@ -49,9 +65,9 @@ In theme-specific rendition, there is one directory structure to store 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/Themes/Motifs}) and one +to store artistic motifs (@file{trunk/Identity/Images/Themes}) and one directory structure to store output files -(@file{trunk/Identity/Themes/Motifs}). +(@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 @@ -170,23 +186,7 @@ of the input file. Translation messages are stored under functionality of @command{centos-art.sh} script (@pxref{Directories trunk Scripts Functions Locale}). -@subheading Usage - -@command{centos-art render [OPTIONS] path/to/dir} - -@subsubheading Synopsis - -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. +@subheading OPTIONS The @code{render} functionality of @command{centos-art.sh} script accepts the following optios: @@ -269,9 +269,13 @@ motifs. @table @command @item centos-art render trunk/Identity/Images/Brands @item centos-art render trunk/Identity/Images/Brands --filter="symbol" -@item centos-art render trunk/Identity/Themes/Motifs/Flame/2 +@item centos-art render trunk/Identity/Images/Themes/Flame/2 @end table +@subheading AUTHOR + +Copyright @copyright{} 2009, 2010, 2011 Alain Reguera Delgado. + @subheading See also @itemize