From c2929c5adaf0a1e429c000292ed74957243ef112 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Apr 05 2011 01:47:10 +0000 Subject: Update repository documentation manual. --- diff --git a/Manual/Introduction/repo-convenctions.texi b/Manual/Introduction/repo-convenctions.texi index 9d00aa4..a36e3ba 100644 --- a/Manual/Introduction/repo-convenctions.texi +++ b/Manual/Introduction/repo-convenctions.texi @@ -58,56 +58,86 @@ Repository name convenctions are implemented inside the convenctions to remember are reduced and concentrated in just one single place to look for fixes and improvements. -@subsection Worklines - -In this section describes a serie of normalized steps used to produce -contents inside the CentOS Artwork Repository. +@subsection Work lines + +Work lines describe different areas of content production inside +CentOS Artwork Repository. Content production inside these specific +areas may vary as much as persons be working on them. Producing +content in too many different ways may result innapropriate in a +collaborative environment like CentOS Artwork Repository where content +produced in one area depends somehow from content produced in another +different area. To produce content in a syncronized but descentralized +way, it is required to define a content production standard for each +work line that everyone uses as reference to realize their work. + +The standard way of producing content inside CentOS Artwork Repository +is implemented through @command{centos-art.sh} script and described in +@command{centos-art.sh} script related documentation entry +(@pxref{Directories trunk Scripts}). + +Inside CentOS Artwork Repository, work lines are organized in +@emph{Graphic design}, @emph{Documentation}, @emph{Localization} and +@emph{Automation}. @subsubsection Graphic design This work line exists to cover brand design, typography design and -theme design. Other areas that could be included here are icon design -and illustration design for documentation. - -Graphic design production is automated by means of @emph{direct -rendition} and @emph{theme rendition}. Content rendition, in general, -is the action through which The CentOS Project Corporate Identity is -produced inside the repository. The CentOS Project Corporate Identity -is made, in part, of several visual manifestations. These visual -manifestations implement the Corporate Identity by mean of images -placed in key areas of their visual space. - -As work flow to produce these images, we decompose them in design -models and artistic motifs. Design models provide the image structure -(i.e., dimension, translation markers, common designs, etc.) and -artistic motifs the visual style (i.e., the background information -provide the look and feel). +theme design. Additionally, some auxiliar areas like icon design, +illustration design for documentation, brushes design, pattern designs +and palettes with color definitions could be included here for +completeness. + +Inside CentOS Artwork Repository, graphic design is performed through +Inkscape and GIMP program. Inkscape is used create and manipulate +scalable vector graphics and export them to PNG format; it also +provides a command-line interface that we use to automate the +exportation process so you can perform massive exportation of SVG +files to PNG files. On the other hand, GIMP is used to create and +manipulate rastered images, create brushes, patterns and palettes of +colors. Notice that each program provides very specific +functionalities and posibilities that when combined can let you +produce very beautiful images. + +The CentOS Project Corporate Identity is made of several visual +manifestations. These visual manifestations implement the Corporate +Identity by mean of images placed in key areas of their visual space. +To produce these images, we decompose image production in @emph{design +models} and @emph{artistic motifs}. Design models provide the image +structure (i.e., dimension, translation markers, common designs, etc.) +and are generally produced as scalable vector graphics generally. On +the other hand, artistic motifs provide the visual style (i.e., the +background information, the look and feel) and are generally produced +as rastered images. Design models are created for each visual manifestation the CentOS Project is made of. This way we describe the visual manifestation and provide a template system for it where several artistic motifs can be applied. Artistic motifs are created with design models in mind, not -the visual manifestation such design models is built for. - -The combination of one design models with one artistic motifs is what -we know as one @emph{theme}. Inside themes directory structure, you -can find several design models and several artistic motifs, apart one -another, that can be albitrarily combined one another through -@emph{theme rendition}, a flexible way to produce images for different -visual manifestations inside CentOS Artwork Repository. Theme -rendition takes place in @file{trunk/Identity/Themes/Models} and -@file{trunk/Identity/Themes/Motifs} directory structures. +the visual manifestation that design models are built for. + +The result produced by combining one design model with one artistic +motif is what we know as a @emph{theme}. Inside themes directory +structure (@pxref{Directories trunk Identity Themes}), you can find +several design models and several artistic motifs, apart one another, +that can be albitrarily combined one another through @emph{theme +rendition}, a flexible way to produce images for different visual +manifestations inside CentOS Artwork Repository. Inside themes +directory structure, theme rendition is performed in +@file{trunk/Identity/Themes/Motifs} directory structures and takes +design models from @file{trunk/Identity/Themes/Models} directory +structure. In addition to theme rendition, you can find another way of image production, a more direct way of image production where there is no artistic motif at all, but design models only. Such configuration is named @emph{direct rendition} and is very useful to produce simple -content that doesn't need specific background information like icons -and illustrations used in documentation. Direct rendition takes place -in @file{trunk/Identity/Models} and @file{trunk/Identity/Images} +content that doesn't need specific background information (e.g., icons +and illustrations for documentation). Direct rendition takes place in +@file{trunk/Identity/Models} and @file{trunk/Identity/Images} directory structures. -@xref{Directories trunk Identity}, for more information. +@xref{Directories trunk Identity}, for more information on graphic +design. @subsubsection Documentation @@ -115,7 +145,7 @@ This work line exists to describe what each directory structure inside the CentOS Artwork Repository is for and how to produce content inside it. -@xref{Directories trunk Manual}, for more information. +@xref{Directories trunk Manual}, for more information on documentation. @subsubsection Localization @@ -206,7 +236,7 @@ for you to manifest yourself. This restrictions are necessary to protect our work from spammers. @end quotation -@xref{Directories trunk Scripts}, for more information. +@xref{Directories trunk Scripts}, for more information on automation. @subsection Parallel directories diff --git a/Manual/repository.info.bz2 b/Manual/repository.info.bz2 index 4f446fe..f33cd67 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 4fa37d1..c3e9de7 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 3c52f72..bf01f75 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 691c578..6d93d89 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 4960488..40e8d98 100644 --- a/Manual/repository.xml +++ b/Manual/repository.xml @@ -296,8 +296,7 @@ manual_deleteCrossReferences.sh manual_searchIndex.sh Introduction
Repository Convenctions - Repository convenctions”CentOS like trees, has roots, trunk, branches, leaves and flowers. Day by day they work together in freedom, ruled by the laws of nature and open standards, to show the beauty of its existence.” - This section describes the organization of files and directories inside the CentOS Artwork Repository, the names convenctions, how to extend the current layout and the way content is produced, as well. + Repository convenctionsThis section describes the organization of files and directories inside the CentOS Artwork Repository, the names convenctions, how to extend the current layout and the way content is produced, as well. The repository layout is used as standard backend for automation scripts to work correctly. If repository layout changes unexpectedly, automation scripts may get confuse themselves and stop doing what you may expect from them to do. As convenction, inside CentOS Artwork Repository, files and directories related to CentOS corporate visual identity are organized under three top level directories named: trunk/, branches/, and tags/. The trunk/ directory (see Directories trunk) organizes the main development line of CentOS corporate visual identity. Inside trunk/ directory structure, the CentOS corporate visual identity concepts are implemented using directories. There is one directory level for each relevant concept inside the repository. The trunk/ directory structure is mainly used to perform development tasks related to CentOS corporate visual identity. @@ -312,21 +311,31 @@ manual_deleteCrossReferences.sh manual_searchIndex.sh - Repository work flow - As repository work flow we understand a serie of normalized steps used to produce contents inside CentOS Artwork Repository. There are three remarkable actions inside the repository that we need to provide a normalized work flow for, they are: Rendition, Localization and Programming. + Work lines + Work lines describe different areas of content production inside CentOS Artwork Repository. Content production inside these specific areas may vary as much as persons be working on them. Producing content in too many different ways may result innapropriate in a collaborative environment like CentOS Artwork Repository where content produced in one area depends somehow from content produced in another different area. To produce content in a syncronized but descentralized way, it is required to define a content production standard for each work line that everyone uses as reference to realize their work. + The standard way of producing content inside CentOS Artwork Repository is implemented through centos-art.sh script and described in centos-art.sh script related documentation entry (see Directories trunk Scripts). + Inside CentOS Artwork Repository, work lines are organized in Graphic design, Documentation, Localization and Automation. - Rendition - Rendition is the action through which The CentOS Project Corporate Identity is produced inside the repository. The CentOS Project Corporate Identityis is made, in part, of several visual manifestations. These visual manifestations implement the Corporate Identity by mean of images placed in key areas of their visual space. - As work flow to produce these images, we decompose them in design models and artistic motifs. Design models provide the image structure (i.e., dimension, translation markers, common designs, etc.) and artistic motifs the visual style (i.e., the background information provide the look and feel). - Design models are created for each visual manifestation the CentOS Project is made of. This way we describe the visual manifestation and provide a template system for it where several artistic motifs can be applied. Artistic motifs are created with design models in mind, not the visual manifestation such design models is built for. - The combination of one design models with one artistic motifs is what we know as one theme. Inside themes directory structure, you can find several design models and several artistic motifs, apart one another, that can be albitrarily combined one another through theme rendition, a flexible way to produce images for different visual manifestations inside CentOS Artwork Repository. Theme rendition takes place in trunk/Identity/Themes/Models and trunk/Identity/Themes/Motifs directory structures. - In addition to theme rendition, you can find another way of image production, a more direct way of image production where there is no artistic motif at all, but design models only. Such configuration is named direct rendition and is very useful to produce simple content that doesn't need specific background information like icons and illustrations used in documentation. Direct rendition takes place in trunk/Identity/Models and trunk/Identity/Images directory structures. - See Directories trunk Identity, for more information. + Graphic design + This work line exists to cover brand design, typography design and theme design. Additionally, some auxiliar areas like icon design, illustration design for documentation, brushes design, pattern designs and palettes with color definitions could be included here for completeness. + Inside CentOS Artwork Repository, graphic design is performed through Inkscape and GIMP program. Inkscape is used create and manipulate scalable vector graphics and export them to PNG format; it also provides a command-line interface that we use to automate the exportation process so you can perform massive exportation of SVG files to PNG files. On the other hand, GIMP is used to create and manipulate rastered images, create brushes, patterns and palettes of colors. Notice that each program provides very specific functionalities and posibilities that when combined can let you produce very beautiful images. + The CentOS Project Corporate Identity is made of several visual manifestations. These visual manifestations implement the Corporate Identity by mean of images placed in key areas of their visual space. To produce these images, we decompose image production in design models and artistic motifs. Design models provide the image structure (i.e., dimension, translation markers, common designs, etc.) and are generally produced as scalable vector graphics generally. On the other hand, artistic motifs provide the visual style (i.e., the background information, the look and feel) and are generally produced as rastered images. + Design models are created for each visual manifestation the CentOS Project is made of. This way we describe the visual manifestation and provide a template system for it where several artistic motifs can be applied. Artistic motifs are created with design models in mind, not the visual manifestation that design models are built for. + The result produced by combining one design model with one artistic motif is what we know as a theme. Inside themes directory structure (see Directories trunk Identity Themes), you can find several design models and several artistic motifs, apart one another, that can be albitrarily combined one another through theme rendition, a flexible way to produce images for different visual manifestations inside CentOS Artwork Repository. Inside themes directory structure, theme rendition is performed in trunk/Identity/Themes/Motifs directory structures and takes design models from trunk/Identity/Themes/Models directory structure. + In addition to theme rendition, you can find another way of image production, a more direct way of image production where there is no artistic motif at all, but design models only. Such configuration is named direct rendition and is very useful to produce simple content that doesn't need specific background information (e.g., icons and illustrations for documentation). Direct rendition takes place in trunk/Identity/Models and trunk/Identity/Images directory structures. + See Directories trunk Identity, for more information on graphic design. + + + + Documentation + This work line exists to describe what each directory structure inside the CentOS Artwork Repository is for and how to produce content inside it. + See Directories trunk Manual, for more information on documentation. Localization + This work line exists to localize corporate design and documentation source files, so they can be produced in different languages. Whatever content rendition you perform, sometimes you need to produce content in different languages. Production of content in different languages is known as localization or l10n for short. Inside CentOS Artwork Repository, content localization is performed using the processed provided by gettext internationalization standard. Basically, the gettext internationalization standard consists on retriving translatable strings from source files and creating Portable Objects and Machine Objects. Portable Objects contain the information used by translators to do their work, they are files that can be edited by any convenctional text editor like Vim, Emacs or Nano. On the other hand, Machine Objects are produced to be machine-redable as its name implies, and are produced from Portable Objects. Since gettext needs to extract translatable strings form source files in order to let translators to localize them, the types of source files we use inside the repository are limitted to the file types supported by gettext program. Most of source files supported by gettext are those from programming languages like C, C++, Bash, Python and Perl just to mention a few ones from the long list of supported formats. However, formats like SVG, XHTML and Docbook don't figure as supported in the long list of gettext supported source files. For these formats we use the xml2po program that come in the gnome-doc-utils package instead. The xml2po program reads one XML based file and extracts translatable strings from it and creates one Portable Object that is use to create a translated XML based file with the same definition of the source file where translatable strings were taken from (e.g., if we extract translatable strings from a SVG file, as result we get the same SVG file but with translatable strings already localized —obviously, for this to happen translators need to localize translatable strings inside the Portable Object first, localization won't appear as art of magic—). When using xml2po, the Machine Object file is used just temporally to produce the final translated XML based file. @@ -337,49 +346,19 @@ manual_deleteCrossReferences.sh manual_searchIndex.sh - Programming + Automation + This work line exists to standardize corporate design, documentation and localization processes and automate their production. There is no need to repeat several tasks time after time if they can be programmed in just one for you to execute. If you need to improve the way content is produced, look inside automation scripts and make your improvement there for every one to benefit. So far, we've seen a conceptual view of how image production inside CentOS Artwork Repository is performed, but how all this is implemented, what is the practical view? The practical view can be found through centos-art.sh script, a bash script specially designed to automate most frequent tasks inside CentOS Artwork Repository. The centos-art.sh script is stored in trunk/Scripts directory structure and is there where the main development for centos-art.sh script takes place. Basically, the centos-art.sh script is divided in several functionalities that perform specific tasks inside the repository. Such functionalities relay on repository organization to work as expected. Maiking the centos-art.sh script to automate tasks is the only possible work flow that I can think about right now. If you are a programmer, take a functionality from centos-art.sh script, study it, look how to improve it and share your ideas at centos-devel@centos.org mailing list. Note As default configuration, everyone is denied from committing changes up to CentOS Artwork Repository. In order to gain commit rights, you need to prove your interest in contributing and maintaining that contribution. Otherwise, if you only want to comment your ideas, the centos-devel@centos.org mailing list exists for you to manifest yourself. This restrictions are necessary to protect our work from spammers. - See Directories trunk Scripts, for more information. + See Directories trunk Scripts, for more information on automation. - Work lines - The CentOS Artwork Repository is organized using the Rendition, Localization and Programming concepts described above. These concepts suggest three different work lines to get focused in: - - - Graphic design - - This work line exists to cover the corporate design (e.g., brand design, typography design and theme design). Other areas that could be included here are icon design and illustration design for documentation. - - - - Documentation - - This work line exists to describe what each directory structure inside the CentOS Artwork Repository is for and how to produce content inside it. - - - - Translation - - This work line exists to localize corporate design and documentation source files, so they can be produced in different languages. - - - - Automation - - This work line exists to standardize corporate design, documentation and localization processes and automate their production. There is no need to repeat several tasks time after time if they can be programmed in just one for you to execute. If you need to improve the way content is produced, look inside automation scripts and make your improvement there for every one to benefit. - - -
- - - Parallel directories Inside CentOS Artwork Repository, parallel directories are simple directory entries built from a common parent directory and placed in a location different to that, the common parent directory is placed on. Parallel directories are useful to create branches, tags, translations, documentation, pre-rendering configuration script, and similar directory structures. Parallel directories take their structure from one unique parent directory. Inside CentOS Artwork Repository, this unique parent directory is under trunk/Identity location. The trunk/Identity location must be considered the reference for whatever information you plan to create inside the repository. @@ -471,11 +450,6 @@ centos-art manual --read=turnk/Identity/Themes/Motifs/TreeFlower/ - Directories trunk Identity Manual - Directories trunk Identity Manual - - - Directories trunk Identity Palettes Directories trunk Identity Palettes @@ -591,6 +565,11 @@ centos-art manual --read=turnk/Identity/Themes/Motifs/TreeFlower/ + Directories trunk Manual + Directories trunk Manual + + + Directories trunk Scripts Directories trunk Scripts @@ -823,7 +802,7 @@ centos-art manual --read=turnk/Identity/Themes/Motifs/TreeFlower/ Manual This section organizes the CentOS Artwork Repository Manual (i.e., the documentation manual you're reading right now). If you are interested on improving The CentOS Artwork Repository Manual, in this place you'll find the Texinfo documentation structure you need to work with. - See Directories trunk Identity Manual, for more information. + See Directories trunk Manual, for more information. @@ -941,7 +920,7 @@ centos-art render trunk/Identity/Path/To/Dir Directories trunk Identity Fonts - Directories trunk Identity Manual + Directories trunk Identity Palettes Directories trunk Identity Brands Directories
@@ -991,54 +970,9 @@ centos-art render trunk/Identity/Path/To/Dir
- Directories trunk Identity Manual - Directories trunk Identity Palettes - Directories trunk Identity Fonts - Directories -
- The <file>trunk/Identity/Manual</file> Directory - Directories trunk Identity Manual - - Goals - - • - - ... - - - - - - Description - - • - - ... - - - - - - Usage - - • - - ... - - - - - - See also - - - -
- - Directories trunk Identity Palettes Directories trunk Identity Themes - Directories trunk Identity Manual + Directories trunk Identity Fonts Directories
The <file>trunk/Identity/Palettes</file> Directory @@ -2411,7 +2345,7 @@ priority=10 Directories trunk Locales - Directories trunk Scripts + Directories trunk Manual Directories trunk Identity Webenv Directories
@@ -2434,9 +2368,54 @@ priority=10
+ Directories trunk Manual + Directories trunk Scripts + Directories trunk Locales + Directories +
+ The <file>trunk/Manual</file> Directory + Directories trunk Manual + + Goals + + • + + ... + + + + + + Description + + • + + ... + + + + + + Usage + + • + + ... + + + + + + See also + + + +
+ + Directories trunk Scripts Directories trunk Scripts Functions - Directories trunk Locales + Directories trunk Manual Directories
The <file>trunk/Scripts</file> Directory @@ -2543,8 +2522,12 @@ centos-art function path/to/dir --options Directories trunk Scripts Directories trunk Scripts + + + + Directories trunk Scripts Functions + Directories trunk Scripts Functions - @@ -3503,13 +3486,29 @@ trunk/Scripts/Bash/Styles/output_forTwoColumns.awk The following specific functions of centos-art.sh script, are available for you to use: - - - - - - - + + Directories trunk Scripts Functions Locale + Directories trunk Scripts Functions Locale + + + + + Directories trunk Scripts Functions Path + Directories trunk Scripts Functions Path + + + + Directories trunk Scripts Functions Render + Directories trunk Scripts Functions Render + + + + Directories trunk Scripts Functions Render Config + Directories trunk Scripts Functions Render Config + + + + Directories trunk Scripts Functions Prepare Directories trunk Scripts Functions Prepare @@ -3767,8 +3766,12 @@ centos-art manual --read=turnk/Identity/Themes/Motifs/TreeFlower/ Directories trunk Scripts Directories trunk Scripts - - + + + + Directories trunk Scripts Functions + Directories trunk Scripts Functions + @@ -4382,7 +4385,11 @@ function render_loadConfig { See also - + + Directories trunk Scripts Functions Render Config + Directories trunk Scripts Functions Render Config + +
@@ -4511,9 +4518,17 @@ ACTIONS[2]='LAST:groupByformat: png xpm jpg tif' Directories trunk Scripts Directories trunk Scripts - - - + + + + Directories trunk Scripts Functions + Directories trunk Scripts Functions + + + + Directories trunk Scripts Functions Render + Directories trunk Scripts Functions Render +