Automation of these tasks is achived through @pxref{trunk Scripts Bash -centos-art Functions Locales}, for more information. +
Automation of these tasks is achived through see section trunk/Scripts/Bash/centos-art/Functions/Locale, for more information.
diff --git a/Manuals/Filesystem/filesystem.info.bz2 b/Manuals/Filesystem/filesystem.info.bz2 index 92b8727..a6240ec 100644 Binary files a/Manuals/Filesystem/filesystem.info.bz2 and b/Manuals/Filesystem/filesystem.info.bz2 differ diff --git a/Manuals/Filesystem/filesystem.pdf b/Manuals/Filesystem/filesystem.pdf index af9fcf6..7bd1702 100644 Binary files a/Manuals/Filesystem/filesystem.pdf and b/Manuals/Filesystem/filesystem.pdf differ diff --git a/Manuals/Filesystem/filesystem.txt b/Manuals/Filesystem/filesystem.txt index 75455b1..4b99bc4 100644 --- a/Manuals/Filesystem/filesystem.txt +++ b/Manuals/Filesystem/filesystem.txt @@ -194,19 +194,6 @@ CentOS Artwork Repository - Filesystem 3.33.3 Usage 3.33.4 See also 3.34 trunk/Locales - 3.34.1 Goals - 3.34.2 Description - 3.34.2.1 Translation Entries - 3.34.2.2 Translation Markers - 3.34.2.3 Translation Files - 3.34.2.4 Template Translation Files - 3.34.2.5 Common Translation Files - 3.34.2.6 Specific Translation Files - 3.34.2.7 Translation Rendering - 3.34.2.8 Translation (Pre-)Rendering Configuration Scripts - 3.34.2.9 Translation Rendering Default Functionality - 3.34.3 Usage - 3.34.4 See also 3.35 trunk/Locales/Identity 3.35.1 Goals 3.35.2 Description @@ -276,86 +263,82 @@ CentOS Artwork Repository - Filesystem 3.47.2 Description 3.47.3 Usage 3.47.4 See also - 3.48 trunk/Scripts/Bash/Functions - 3.48.1 Goals - 3.48.2 Description - 3.48.3 Usage - 3.48.3.1 Global variables - 3.48.3.2 Global functions - 3.48.3.3 Specific functions - 3.48.4 See also - 3.49 trunk/Scripts/Bash/Functions/Html + 3.48 trunk/Scripts/Bash/centos-art + 3.49 trunk/Scripts/Bash/centos-art/Functions 3.49.1 Goals 3.49.2 Description 3.49.3 Usage + 3.49.3.1 Global variables + 3.49.3.2 Global functions + 3.49.3.3 Specific functions 3.49.4 See also - 3.50 trunk/Scripts/Bash/Functions/Locale + 3.50 trunk/Scripts/Bash/centos-art/Functions/Help 3.50.1 Goals 3.50.2 Description 3.50.3 Usage 3.50.4 See also - 3.51 trunk/Scripts/Bash/Functions/Manual + 3.51 trunk/Scripts/Bash/centos-art/Functions/Html 3.51.1 Goals 3.51.2 Description 3.51.3 Usage 3.51.4 See also - 3.52 trunk/Scripts/Bash/Functions/Path + 3.52 trunk/Scripts/Bash/centos-art/Functions/Locale 3.52.1 Goals 3.52.2 Description - 3.52.2.1 Repository layout - 3.52.2.2 Repository name convenctions - 3.52.2.3 Repository work flow - 3.52.2.4 Parallel directories - 3.52.2.5 Syncronizing path information - 3.52.2.6 What is the right place to store it? 3.52.3 Usage 3.52.4 See also - 3.53 trunk/Scripts/Bash/Functions/Render - 3.53.1 Renderable identity directory structures - 3.53.1.1 Design template without translation - 3.53.1.2 Design template with translation (one-to-one) - 3.53.1.3 Design template with translation (optimized) - 3.53.1.4 Design template with translation (optimized+flexibility) - 3.53.2 Renderable translation directory structures - 3.53.3 Copying renderable directory structures - 3.53.4 Usage - 3.53.5 See also - 3.54 trunk/Scripts/Bash/Functions/Render/Config + 3.53 trunk/Scripts/Bash/centos-art/Functions/Manual + 3.53.1 Goals + 3.53.2 Description + 3.53.3 Usage + 3.53.4 See also + 3.54 trunk/Scripts/Bash/centos-art/Functions/Path 3.54.1 Goals 3.54.2 Description - 3.54.2.1 The `render.conf.sh' identity model - 3.54.2.2 The `render.conf.sh' translation model - 3.54.2.3 The `render.conf.sh' rendering actions + 3.54.2.1 Repository layout + 3.54.2.2 Repository name convenctions + 3.54.2.3 Repository work flow + 3.54.2.4 Parallel directories + 3.54.2.5 Syncronizing path information + 3.54.2.6 What is the right place to store it? 3.54.3 Usage 3.54.4 See also - 3.55 trunk/Scripts/Bash/Functions/Shell - 3.55.1 Goals - 3.55.2 Description - 3.55.3 Usage - 3.55.4 See also - 3.56 trunk/Scripts/Bash/Functions/Svg + 3.55 trunk/Scripts/Bash/centos-art/Functions/Render + 3.55.1 Renderable identity directory structures + 3.55.1.1 Design template without translation + 3.55.1.2 Design template with translation (one-to-one) + 3.55.1.3 Design template with translation (optimized) + 3.55.1.4 Design template with translation (optimized+flexibility) + 3.55.2 Renderable translation directory structures + 3.55.3 Copying renderable directory structures + 3.55.4 Usage + 3.55.5 See also + 3.56 trunk/Scripts/Bash/centos-art/Functions/Render/Config 3.56.1 Goals 3.56.2 Description - 3.56.2.1 Metadata maintainance - 3.56.2.2 Unused definitions + 3.56.2.1 The `render.conf.sh' identity model + 3.56.2.2 The `render.conf.sh' translation model + 3.56.2.3 The `render.conf.sh' rendering actions 3.56.3 Usage 3.56.4 See also - 3.57 trunk/Scripts/Bash/Functions/Verify + 3.57 trunk/Scripts/Bash/centos-art/Functions/Shell 3.57.1 Goals 3.57.2 Description - 3.57.2.1 Packages - 3.57.2.2 Links - 3.57.2.3 Environment variables 3.57.3 Usage 3.57.4 See also - 3.58 trunk/Scripts/Bash/Locale + 3.58 trunk/Scripts/Bash/centos-art/Functions/Svg 3.58.1 Goals 3.58.2 Description + 3.58.2.1 Metadata maintainance + 3.58.2.2 Unused definitions 3.58.3 Usage 3.58.4 See also - 3.59 trunk/Scripts/Perl + 3.59 trunk/Scripts/Bash/centos-art/Functions/Verify 3.59.1 Goals 3.59.2 Description + 3.59.2.1 Packages + 3.59.2.2 Links + 3.59.2.3 Environment variables 3.59.3 Usage 3.59.4 See also 3.60 trunk/Scripts/Python @@ -2281,604 +2264,55 @@ following `syslinux.hex' file: 3.34 trunk/Locales ================== -3.34.1 Goals ------------- - -The `trunk/Translations' directory exists to: - - * Organize translation files. - - * Organize translation templates used to produce translation files. - -3.34.2 Description ------------------- - -When you create artwork for CentOS distribution you find that some -artworks need to be created for different major releases of CentOS -distribution and inside each major release that needs to be created for -different locales. To get an approximate idea of how many files we are -talking about, consider the followig approximate statistic: - - * Inside CentOS distribution, there are around 30 images to - rebrand.(1) - - * There are near to four major releases of CentOS distribution to - rebrand in parallel development.(2) - - * Each CentOS distribution in parallel development supports more - than two hundreds locales.(3) - - In order to aliviate maintainance of artwork production for such -environment, we divided artwork production in three production lines: - - 1. *Note trunk Identity Themes Models::, to define artworks - characteristics (e.g., dimensions, position on the screen, etc.). - - 2. *Note trunk Identity Themes Motifs::, to define artworks visual - styles (e.g., the look and feel). - - 3. Translations, to define which major releases and locales artworks - are produced for. - - Inside CentOS Artwork Repository, the artworks' translation -production line is stored under `trunk/Translations' directory. - - Inside `trunk/Translations' directory, we use "translation entries" -to organize artworks' "translation files" and artworks' "translation -templates". - -3.34.2.1 Translation Entries -............................ - -Translation entries exists for each artwork you want to produce. -Translation entries can be empty directories, or directories containing -translation files and translation templates. - - When translation entries are empty directories, the identity entry is -used as reference to create file names and directories layout for -rendered files. In this case, the `centos-art' script takes one design -template and outputs one non-translated file for each design template -available. This configuration is mainly used to produce -non-translatable artworks like themes' backgrounds. - - When translation entries contain translation files, the translation -entry implements the CentOS release schema and is used as reference to -create file names and directories layout for translated artworks. In -this case, the `centos-art' script applies one translation file to one -design template to create one translated instance which is used to -output one translated file. When the translated file is rendered, the -`centos-art' script remove the previous instance and takes the next -file in the list of translation files to repate the whole process once -again, and so on for all files in the list. This configuration is -mainly used to produce translatable artworks like Anaconda progress -slide images. - - To find out correspondence between translation entries and identity -entries, you need to look the path of both translation entries and -identity entries. For example, if you are using the _Modern_ artisitic -motif, the identity entry for Anaconda progress artwork is: - - -trunk/Identity/Themes/Motifs/Modern/Distro/Anaconda/Progress - - and its translation entry is: - - -trunk/Translations/Identity/Themes/Distro/Anaconda/Progress - - Note how the `Translations/' directory prefixes `Identity/' -directory, also how static values (e.g., Identity, Themes, Distro, -etc.) in the identity entry path remain in translation entry path, and -how variable values like theme names (e.g., _Modern_) are stript out -from translation entry path. The same convenction can be applied to -other identity entries in order to determine their translation entries, -or to other translation entries to determine their identity entries. - - *Note* Translation entries related to identity entries under - `trunk/Identity/Themes/Motifs' do not use `Motifs/' in the path. - We've done this because `trunk/Identity/Themes/Models' structure, - the other structure under `trunk/Identity/Themes', doesn't require - translation paths so far. So in the sake of saving characters - space when building translation entries for - `trunk/Identity/Themes/Motifs' structure, we organize Motifs - translation entries under `trunk/Translations/Identity/Themes/' - directly. - - If for some reason `trunk/Identity/Themes/Models' structure - requires translation entries, we need to re-oraganize the current - directory structure accordingly. - - Translation entries, as described above, can be re-used by similar -identity entries. For example the following identity entries: - - -trunk/Identity/Themes/Motifs/Modern/Distro/Anaconda/Progress/ -trunk/Identity/Themes/Motifs/TreeFlower/Distro/Anaconda/Progress/ -trunk/Identity/Themes/Motifs/Mettle/Distro/Anaconda/Progress/ - - are all valid identity entries able to re-use translation files -inside Anaconda progress translation entry (the one shown in our example -above). This way, you can create several identity entries and maintain -just one translation entry for all of them. Once you change the -translation files inside the common translation entry, changes inside -identity entries will take effect inside the next you render them. - - Trying to make things plain and simple: inside CentOS Artwork -Repository, graphic designers can concentrate their efforts in artworks -look and feel (the identity entries), and translators in artworks -translations (the translation entries). - -3.34.2.2 Translation Markers -............................ - -Translation markers are used in "Theme Model Designs" and "Translation -Files" as replacement patterns to commit content translation. When you -are rendering content using `centos-art' script inisde `trunk/Identity' -structure, artistic motifs and translation files are applied to model -designs to produce translated content as result. In order to have the -appropriate translation in content rendered, markers defintion in -translation files should match markers in model designs exactly. - - Translation markers can be whatever text you want, but as convenction -we use the following to represent releases of CentOS distribution: - -`=MINOR_RELEASE=' - Replace with minor release of CentOS distribution. In the schema - M.N, the minor release is represented by the N letter. - -`=MAJOR_RELEASE=' - Replace with major release of CentOS distribution. In the schema - M.N, the major release is represented by the M letter. - -`=RELEASE=' - Replace the full release of CentOS distribution. It is - `=MAJOR_RELEASE=.=MINOR_RELEASE=' basically. - - Specific translation markers convenctions are described inside -specific translation entries. Read translation entries documentation to -know more about supported translation markers. - - Translation markers standardization creates a common point of -reference for translators and graphic designers. To have translation -markers well defined makes possible that translators and graphic -designers can work together but independently one another. - -3.34.2.3 Translation Files -.......................... - -Translation files are text files with `sed' commands inside, -replacement commands mainly. As convenction, translation file names end -in `.sed'. Translation files are used by `centos-art' script to produce -translated artworks for specific major releases of CentOS Distribution. -There are common translation files, specific translation, and template -translation files. - - For example, the Firstboot artwork of CentOS distribution uses the -images `splash-small.png' and `firstboot-left.png' as based to control -its visual style. The `splash-small.png' image contains, in its graphic -design, the release number information of CentOS distribution. So the -`splash-small.png' is release-specific. In the other hand, the -`firstboot-left.png' doesn't contain release number information. So the -`firstboot-left.png' is not release-specific. - - If we want to produce Firstboot artwork for different major releases -of CentOS distribution, using a monolithic visual identity, all -Firstboot images should have the same visual style and, at the same -time, the release-specific information in the release-specific images. - - *Note* The monolithic visual identity is implemented using theme - models (*note trunk Identity Themes Models::) and artistic motifs - (*note trunk Identity Themes Motifs::). - - Assuming that both theme models and theme motifs are ready for using, -the initial translation entry to produce Firstboot artworks would look -like the following: - - -trunk/Translations/Identity/Themes/Distro/BootUp/Firstboot/ -|-- Tpl -| `-- splash-small.sed -`-- firstboot-left.sed - - With the translation entry above, `centos-art' command is able to -produce the image `firstboot-left.png' only. To produce -`splash-small.png' images for major releases (e.g., 3, 4, 5, and 6) of -CentOS distribution we need to produce the release-specific translation -files using the `centos-art' script as following: - - -centos-art render --entry=/home/centos/artwork/trunk/Translations/Identity/Themes/BootUp/Firstboot --filter='3,4,5,6' - - The above command produces the following translation entiry: - - -trunk/Translations/Identity/Themes/Distro/BootUp/Firstboot/ -|-- 3 -| `-- splash-small.sed -|-- 4 -| `-- splash-small.sed -|-- 5 -| `-- splash-small.sed -|-- 6 -| `-- splash-small.sed -|-- Tpl -| `-- splash-small.sed -`-- firstboot-left.sed - - At this point `centos-art' is able to produce the Firstboot artwork -images for major releases of CentOS distribution. To add new -release-specific translation files, run the translation rendering -command with the release number you want to produce translation files -for in the `--filter='release-number'' argument. - -3.34.2.4 Template Translation Files -................................... - -Template translation files are translation files stored inside -translation template directory. Template translation files are used by -`centos-art' script to produce specific translation files only. -Template translation files may be empty or contain `sed' replacement -commands. If template translation files are empty files, the final -specifc translation file built from it contains release-specific -replacement commands only. For example, see the following translation -entry: - - -trunk/Translations/Identity/Themes/Distro/BootUp/Firstboot/ -|-- 3 -| `-- splash-small.sed -|-- 4 -| `-- splash-small.sed -|-- 5 -| `-- splash-small.sed -|-- 6 -| `-- splash-small.sed -|-- Tpl -| `-- splash-small.sed <-- template translation file. -`-- firstboot-left.sed - - In the above exmaple, the `splash-small.sed' file is a template -translation file and looks like: - - -# ------------------------------------- -# $Id: splash-small.sed 94 2010-09-18 10:59:42Z al $ -# ------------------------------------- - - In the above template translation file there are three comments -lines, but when you render it, the `centos-art' adds the -release-specific replacement commands. In our Firstboot example, after -rendering Firstboot translation entry, the `splash-small.sed' -translation file specific to CentOS 5, looks like the following: - - -# Warning: Do not modify this file directly. This file is created -# automatically using 'centos-art' command line interface. Any change -# you do in this file will be lost the next time you update -# translation files using 'centos-art' command line interface. If you -# want to improve the content of this translation file, improve its -# template file instead and run the 'centos-art' command line -# interface later to propagate your changes. -# ------------------------------------- -# $Id: splash-small.sed 94 2010-09-18 10:59:42Z al $ -# ------------------------------------- - -# Release number information. -s!=RELEASE=!=MAJOR_RELEASE=.=MINOR_RELEASE=!g -s!=MINOR_RELEASE=!0!g -s!=MAJOR_RELEASE=!5!g - - If template translation files are not empty, replacement commands -inside template translation files are preserved inside release-specific -translation files. For example, consider the English template -translation file of Anaconda progress welcome slide. The translation -template directory structure looks like the following: - - -trunk/Translations/Identity/Themes/Distro/Anaconda/Progress/ -`-- Tpl - `-- en - `-- 01-welcome.sed - - and if we render translation files for CentOS 4 and CentOS 5 major -releases, the translation entry would look like the following: - - -trunk/Translations/Identity/Themes/Distro/Anaconda/Progress/ -|-- 4 -| `-- en -| `-- 01-welcome.sed -|-- 5 -| `-- en -| `-- 01-welcome.sed -`-- Tpl - `-- en - `-- 01-welcome.sed - - *Note* Release-specific translation directories preserve template - translation directory structure and file names. - - In the example above, the template translation file looks like the -following: - - -# ------------------------------------------------------------ -# $Id: 01-welcome.sed 94 2010-09-18 10:59:42Z al $ -# ------------------------------------------------------------ -s/=TITLE=/Welcome to CentOS =MAJOR_RELEASE= !/ -s/=TEXT1=/Thank you for installing CentOS =MAJOR_RELEASE=./ -s/=TEXT2=/CentOS is an enterprise-class Linux Distribution derived from sources freely provided to the public by a prominent North American Enterprise Linux vendor./ -s/=TEXT3=/CentOS conforms fully with the upstream vendors redistribution policy and aims to be 100% binary compatible. CentOS mainly changes packages to remove upstream vendor branding and artwork./ -s/=TEXT4=// -s/=TEXT5=// -s/=TEXT6=// -s!=URL=!http://www.centos.org/! - - and, after render the translation entry, specific translation files -look like the following: - - -# Warning: Do not modify this file directly. This file is created -# automatically using 'centos-art' command line interface. Any change -# you do in this file will be lost the next time you update -# translation files using 'centos-art' command line interface. If you -# want to improve the content of this translation file, improve its -# template file instead and run the 'centos-art' command line -# interface later to propagate your changes. -# ------------------------------------------------------------ -# $Id: 01-welcome.sed 94 2010-09-18 10:59:42Z al $ -# ------------------------------------------------------------ - -s/=TITLE=/Welcome to CentOS =MAJOR_RELEASE= !/ -s/=TEXT1=/Thank you for installing CentOS =MAJOR_RELEASE=./ -s/=TEXT2=/CentOS is an enterprise-class Linux Distribution derived from sources freely provided to the public by a prominen t North American Enterprise Linux vendor./ -s/=TEXT3=/CentOS conforms fully with the upstream vendors redistribution policy and aims to be 100% binary compatible. Cent OS mainly changes packages to remove upstream vendor branding and artwork./ -s/=TEXT4=// -s/=TEXT5=// -s/=TEXT6=// -s!=URL=!http://www.centos.org/! - -# Release number information. -s!=RELEASE=!=MAJOR_RELEASE=.=MINOR_RELEASE=!g -s!=MINOR_RELEASE=!0!g -s!=MAJOR_RELEASE=!5!g - - In the example above, relevant lines begin with the `s' word -followed by a separation character (e.g., `/', `!', etc.). These lines -have the following format: - - -s/REGEXP/REPLACEMENT/FLAGS - - The `/' characters may be uniformly replaced by any other single -character within any given `s' command. The `/' character (or whatever -other character is used in its stead) can appear in the REGEXP or -REPLACEMENT only if it is preceded by a `\' character. - - The `s' command is probably the most important in `sed' and has a -lot of different options. Its basic concept is simple: the `s' command -attempts to match the pattern space against the supplied REGEXP; if the -match is successful, then that portion of the pattern space which was -matched is replaced with REPLACEMENT. - - In the context of our translation files, the REGEXP is where you -define translation markers and REPLACEMENT where you define the -translation text you want to have after artworks rendering. Sometimes -we use the FLAG component with the `g' command to apply the -replacements globally. - - *Tip* More information about how to use `sed' replacement commands - and flags is available in `sed' documentation manual. To read - `sed' documentation manual type the following command: - info sed - - Inside translation files, you can use translation markers not only -inside the REGEXP but in the REPLACEMENT too. In order for this -configuration to work, the REPLACEMENT of translation markers needs to -be define _after_ its definition. For example, see in the -release-specific translation file above, how the `s!=MAJOR_RELASE=!5!g' -replacement command is defined _after_ `=MAJOR_RELASE=' translation -marker definition in the REPLACEMENT of `=TITLE=' translation marker -replacement command. - -3.34.2.5 Common Translation Files -................................. - -Common translation files contain common translations or no translation -at all for their related artworks. They are in the root directory of -the translation entry. Common translation files create common artworks -for all major releases of CentOS Distribution. - - Translation entries, with common translation files inside, look like -the following: - - -trunk/Translations/Identity/Themes/Distro/BootUp/Firstboot/ -|-- 3 -| `-- splash-small.sed -|-- 4 -| `-- splash-small.sed -|-- 5 -| `-- splash-small.sed -|-- 6 -| `-- splash-small.sed -|-- Tpl -| `-- splash-small.sed -`-- firstboot-left.sed <-- common translation file. - -3.34.2.6 Specific Translation Files -................................... - -Specific translation files contain specific translations for their -related artworks. Specific translation files are not in the root -directory of the translation entry, but inside directories which -describe the type of translation they are doing. Specific translation -files are produced automatically using the `centos-art' script. - - -trunk/Translations/Identity/Themes/Distro/BootUp/Firstboot/ -|-- 3 -| `-- splash-small.sed <-- CentOS 3 specific translation file. -|-- 4 -| `-- splash-small.sed <-- CentOS 4 specific translation file. -|-- 5 -| `-- splash-small.sed <-- CentOS 5 specific translation file. -|-- 6 -| `-- splash-small.sed <-- CentOS 6 specific translation file. -|-- Tpl -| `-- splash-small.sed -`-- firstboot-left.sed - -3.34.2.7 Translation Rendering -.............................. - -When rendering translations, the `centos-art' script checks the -translation entry to verify that it has a translation template -directory inside. The translation template directory (`Tpl/') contains -common translation files used to build release-specific translation -files. If the translation template directory doesn't exist inside the -translation entry the translation rendering fails. In this case the -`centos-art' script outputs a message and quits script execution. - -3.34.2.8 Translation (Pre-)Rendering Configuration Scripts -.......................................................... - -When the `centos-art' script finds a translation template directory -inside translation entry, it looks for translations pre-rendering -configuration scripts for that translation entry. Translation -pre-rendering configuration scripts let you extend translation default -functionality (described below). - - Translation pre-rendering configuration scripts are stored under -`trunk/Scripts' directory, specifically under the appropriate language -implementation. If you are using `centos-art' Bash implementation, the -translation pre-rendering scripts are store in the -`trunk/Scripts/Bash/Config' location; if you are using `centos-art' -Python implementation, then translation pre-rendering scripts are -stored in the `trunk/Scripts/Python/Config' location, and so on for -other implementations. - - Bash translation pre-rendering configuration scripts look like the -following: - - -#!/bin/bash -# -# render_loadConfig.sh -- brief description here. -# -# Copyright (C) YEAR YOURNAME -# -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 2 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, but -# WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program; if not, write to the Free Software -# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 -# USA. -# -# ---------------------------------------------------------------------- -# $Id: render_loadConfig.sh 94 2010-09-18 10:59:42Z al $ -# ---------------------------------------------------------------------- - -function render_loadConfig { -... -} - - Translation pre-rendering scripts are function scripts loaded and -executed when rendering a translation entry. Translation pre-rendering -scripts are loaded using the translation entry being rendered as -reference. For example, suppose you are using the `centos-art' Bash -implementation, and you are rendering translations for CentOS brands, -in this situation the translation entry would be: - - -trunk/Translations/Identity/Brands - - and the entry inside the translation pre-rendering configuration -structure would be: - - -trunk/Scripts/Bash/Config/Identity/Brands - - Once the `centos-art' script detects that translation pre-rendering -configuration directory exists, the `centos-art' script looks for the -translation pre-rendering configuration file. If the translation -pre-rendering configuration file exists, it is loaded and executed. -Once the translation pre-rendering configuration file has been executed -the translation rendering process is over, and so the script execution. - - *Note* Translation pre-rendering configuration files have the - following form: - render.conf.extension - where `extension' refers the programming language implementation - you are using. For example, `sh' for Bash, `py' for Python, `pl' - for Perl, and so on for other implementations. - - As we are using Bash implementation to describe the translation -pre-rendering configuration example, the translation pre-rendering -configuration file that `centos-art' looks for, inside the above -translation pre-rendering configuration directory, is `render.conf.sh'. - -3.34.2.9 Translation Rendering Default Functionality -.................................................... - -In the other hand, if the translation pre-rendering configuration file -doesn't exist, or it isn't written as function script, the `centos-art' -script ignore translation pre-rendering configuration functionality and -passes to render translation using default functionality instead. - - The translation rendering default functionality takes template -translation directory structure, duplicates it for each release number -specified in the `--filter='release-number'' argument and produces -release-specific directories. As part of template translation -duplication process take place, the `centos-art' script adds -release-specific replacement commands for each specific translation -file inside release-specific directories. As result, specific -translation files, inside release-specific directories, contain -template translation replacement commands _plus_, release-specific -replacement commands. - - *Note* Release-specific replacement commands are standardized - inside `centos-art' script using predifined release translation - markers. Release translation markers are described in the - translation marker section (*note Translation Markers: - trunk:Translations:TranslationMarkers.). - -3.34.3 Usage ------------- - -`centos-art render --entry='path/to/dir'' - When `path/to/dir' refers one directory under - `trunk/Translations', this command orverwrites available - translation files using translation templates. - -`centos-art render --entry='path/to/dir' --filter='pattern'' - When `path/to/dir' refers one directory under - `trunk/Translations', this command renders release-specific - translation files as you specify in the `--filter='pattern'' - argument. In this case, `pattern' not a regular expression but an - number (e.g., `5') or a list of numbers separated by commas (e.g., - `3,4,5,6') that specify the major release of CentOS distribution - you want to render translations for. - -3.34.4 See also ---------------- - ----------- Footnotes ---------- - - (1) This number is an approximate value and may change. It is -mainly based on CentOS 5 rebranding experience. - - (2) This value was taken from CentOS release schema. - - (3) This value was taken from the output of `locale -a' command. +The `trunk/Locales' directory exists to store the translation messages +used to produce content in different languages. + + Translation messages are organized using the directory structure of +the component being translated. For example, if we want to provide +translation messages for `trunk/Manuals/Filesystem', then the +`trunk/Locales/Manuals/Filesystem' directory needs to be created. + + Once the locale directory exists for the component we want to provide +translation messages for, it is necessary to create the translation +files where translation messages are. The translation files follows the +concepts of `xml2po' and GNU `gettext' tools. + + The basic translation process is as follow: first, translatable +strings are extracted from files and a portable object template (.pot) +is created or updated with the information. Using the portable object +template, a portable object (.po) is created or updated for translator +to locale the messages retrived. Finally, a machine object (.mo) is +created from portable object to sotore the translated messages. + + Inside the repository there are two ways to retrive translatable +strings from files. The first one is through `xml2po' command and the +second through `xgettext' command. The `xml2po' is used to retrive +translatable strings from XML files (e.g., Scalable Vector Graphics, +DocBook, etc.) and the `xgettext' command is used to retrive +translatable strings from shell scripts files (e.g., the files that +make the `centos-art.sh' command-line interface). + + When translatable strings are retrived from XML files, using the +`xml2po' command, there is no need to create the machine object as we +do when translatable strings ar retrived from shell files, using the +`xgettext' command. The `xml2po' produces a temporal machine object in +order to create a translated XML file. Once the translated XML file has +been created the machine object is no longer needed. On the other hand, +the machine object produced by the `xgettext' command is required by +the system in order for the show shell script localized messages. + + Another difference between `xml2po' and `xgettext' we need to be +aware of is the directory structure used to store machine objects. In +`xml2po', the machine object is created in the current working +directory as `.xml2po.mo' and can be safetly removed once the +translated XML file has been created. In the case of `xgettext', the +machine object needs to be stored in the +`$TEXTDOMAIN/$LOCALE/LL_MESSAGES/$TEXTDOMAIN.mo' file in order for the +system to interpret it and should not be removed since it is the file +that contain the translation messages themselves. + + Automation of these tasks is achived through *note trunk Scripts +Bash centos-art Functions Locale::, for more information. 3.35 trunk/Locales/Identity =========================== @@ -3327,11 +2761,11 @@ operating system trys to execute that command. In order to execute the command, the operating system needs to know where it is, so the operating system uses the PATH environment variable to look for that command location. If your system was prepared to use CentOS Artwork -Repository correctly (*note trunk Scripts Bash Functions Verify::), you -should have a symbolic link inside `~/bin/' directory that points to -the `centos-art.sh' script file. As `~/bin/' directory is, by default, -inside PATH environment variable, the execution of `centos-art' command -runs the `centos-art.sh' script. +Repository correctly (-- *Removed*(pxref:trunk Scripts Bash Functions +Verify) --), you should have a symbolic link inside `~/bin/' directory +that points to the `centos-art.sh' script file. As `~/bin/' directory +is, by default, inside PATH environment variable, the execution of +`centos-art' command runs the `centos-art.sh' script. When `centos-art.sh' script is executed, the first it does is executing the `trunk/Scripts/Bash/initEnvironment.sh' script to @@ -3345,8 +2779,8 @@ environment. Once global variables and function scripts have been loaded, `centos-art.sh' script executes the `cli' global function from `cli.sh' function script to retrive command-line arguments and define some -default values that may be used later by specific function scripts -(*note trunk Scripts Bash Functions::). +default values that may be used later by specific function scripts (-- +*Removed*(pxref:trunk Scripts Bash Functions) --). As convenction, the `centos-art.sh' command-line arguments have the following format: @@ -3443,21 +2877,25 @@ Figure 3.2: The actions initialization environment. ------------ The `centos-art.sh' script usage information is described inside each -specific function documentation (*note trunk Scripts Bash Functions::). +specific function documentation (-- *Removed*(pxref:trunk Scripts Bash +Functions) --). 3.47.4 See also --------------- -3.48 trunk/Scripts/Bash/Functions -================================= +3.48 trunk/Scripts/Bash/centos-art +================================== -3.48.1 Goals +3.49 trunk/Scripts/Bash/centos-art/Functions +============================================ + +3.49.1 Goals ------------ The `trunk/Scripts/Bash/Functions' directory exists to organize `centos-art.sh' specific functionalities. -3.48.2 Description +3.49.2 Description ------------------ The specific functions of `centos-art.sh' script are designed with @@ -3683,9 +3121,9 @@ change it to have a little fun. Now that we have a specific function that works as we expect, it is time to document it. To document `greet' specific functionality, we -use its directory path and the `manual' functionality (*note trunk -Scripts Bash Functions Manual::) of `centos-art.sh' script, just as the -following command illustrates: +use its directory path and the `manual' functionality (-- +*Removed*(pxref:trunk Scripts Bash Functions Manual) --) of +`centos-art.sh' script, just as the following command illustrates: centos-art manual --edit=trunk/Scripts/Bash/Functions/Greet @@ -3701,8 +3139,9 @@ such function and requests user to create it right at that time. Now that we have documented our function, it is time to translate its output messages to different languages. To translate specific functionality output messages to different languages we use the -`locale' functionality (*note trunk Scripts Bash Functions Locale::) of -`centos-art.sh' script, just as the following command illustrates: +`locale' functionality (-- *Removed*(pxref:trunk Scripts Bash Functions +Locale) --) of `centos-art.sh' script, just as the following command +illustrates: centos-art locale --edit @@ -3736,10 +3175,10 @@ specific functionalities. By the way, the `greet' functionality doesn't exist inside `centos-art.sh' script yet. Would you like to create it? -3.48.3 Usage +3.49.3 Usage ------------ -3.48.3.1 Global variables +3.49.3.1 Global variables ......................... The following global variables of `centos-art.sh' script, are available @@ -3921,7 +3360,7 @@ for you to use inside specific functions: If no one of these values is set in `EDITOR' environment variable, `centos-art.sh' uses `/usr/bin/vim' text editor by default. -3.48.3.2 Global functions +3.49.3.2 Global functions ......................... Function scripts stored directly under `trunk/Scripts/Bash/Functions/' @@ -4356,8 +3795,8 @@ global functions you can use inside `centos-art.sh' script. file name (e.g., a function name), it is necessary to update all files where such file name is placed on. This may require a massive substitution inside the repository, each time we change - name convenctions in the repository (*note trunk Scripts Bash - Functions Path::, for more information). + name convenctions in the repository (-- *Removed*(pxref:trunk + Scripts Bash Functions Path) --, for more information). -- Function: cli_getRepoStatus [LOCATION] Request repository status. @@ -4513,9 +3952,9 @@ global functions you can use inside `centos-art.sh' script. `sí' word. Definition of which confirmation word to use is set on - translation messages for your specific locale information. - *Note trunk Scripts Bash Functions Locale::, for more - information about locale-specific translation messages. + translation messages for your specific locale information. -- + *Removed*(xref:trunk Scripts Bash Functions Locale) --, for + more information about locale-specific translation messages. `AsToKnowMoreLine' To standardize `to know more, run the following command:' @@ -4548,45 +3987,66 @@ global functions you can use inside `centos-art.sh' script. file: trunk/Scripts/Bash/Styles/output_forTwoColumns.awk -3.48.3.3 Specific functions +3.49.3.3 Specific functions ........................... The following specific functions of `centos-art.sh' script, are available for you to use: -3.48.4 See also +3.49.4 See also --------------- -3.49 trunk/Scripts/Bash/Functions/Html -====================================== +3.50 trunk/Scripts/Bash/centos-art/Functions/Help +================================================= -3.49.1 Goals +3.50.1 Goals ------------ * ... -3.49.2 Description +3.50.2 Description ------------------ * ... -3.49.3 Usage +3.50.3 Usage ------------ * ... -3.49.4 See also +3.50.4 See also --------------- -3.50 trunk/Scripts/Bash/Functions/Locale -======================================== +3.51 trunk/Scripts/Bash/centos-art/Functions/Html +================================================= -3.50.1 Goals +3.51.1 Goals ------------ * ... -3.50.2 Description +3.51.2 Description +------------------ + + * ... + +3.51.3 Usage +------------ + + * ... + +3.51.4 See also +--------------- + +3.52 trunk/Scripts/Bash/centos-art/Functions/Locale +=================================================== + +3.52.1 Goals +------------ + + * ... + +3.52.2 Description ------------------ This command looks for `.sh' files inside Bash directory and extracts @@ -4644,7 +4104,7 @@ following files: * ... -3.50.3 Usage +3.52.3 Usage ------------ `centos-art locale --edit' @@ -4655,34 +4115,34 @@ following files: `centos-art locale --list' Use this command to see the command-line interface locale report. -3.50.4 See also +3.52.4 See also --------------- -3.51 trunk/Scripts/Bash/Functions/Manual -======================================== +3.53 trunk/Scripts/Bash/centos-art/Functions/Manual +=================================================== -3.51.1 Goals +3.53.1 Goals ------------ * ... -3.51.2 Description +3.53.2 Description ------------------ * ... -3.51.3 Usage +3.53.3 Usage ------------ * ... -3.51.4 See also +3.53.4 See also --------------- -3.52 trunk/Scripts/Bash/Functions/Path -====================================== +3.54 trunk/Scripts/Bash/centos-art/Functions/Path +================================================= -3.52.1 Goals +3.54.1 Goals ------------ This section exists to organize files related to `path' @@ -4690,14 +4150,14 @@ functiontionality. The `path' functionality standardizes movement, syncronization, branching, tagging, and general file maintainance inside the repository. -3.52.2 Description +3.54.2 Description ------------------ _"CentOS like trees, has roots, trunk, branches, leaves and flowers. Day by day they work together in freedom, ruled by the laws of nature and open standards, to show the beauty of its existence."_ -3.52.2.1 Repository layout +3.54.2.1 Repository layout .......................... The repository layout describes organization of files and directories @@ -4741,7 +4201,7 @@ single copy of the master sources. This copy is called the source "repository"; it contains all the information to permit extracting previous versions of those files at any time. -3.52.2.2 Repository name convenctions +3.54.2.2 Repository name convenctions ..................................... Repository name convenctions help us to maintain consistency of names @@ -4760,7 +4220,7 @@ etc.). convenctions to remember, concentrating them in just one single place to look for fixes and improvements. -3.52.2.3 Repository work flow +3.54.2.3 Repository work flow ............................. Repository work flow describes the steps and time intervals used to @@ -4830,7 +4290,7 @@ location to fulfill CentOS distribution artwork needs. The same applies to CentOS Webmasters (the persons whom build CentOS websites), and any other visual manifestation required by the project. -3.52.2.4 Parallel directories +3.54.2.4 Parallel directories ............................. Inside CentOS Artwork Repository, parallel directories are simple @@ -4878,7 +4338,7 @@ directory structure. Liberal change of parallel directories may suppresses the conceptual idea they were initially created for; and certainly, things may stop working the way they should do. -3.52.2.5 Syncronizing path information +3.54.2.5 Syncronizing path information ...................................... Parallel directories are very useful to keep repository organized but @@ -4933,7 +4393,7 @@ Texinfo to produce error messages at export time. So, the `centos-art.sh' script needs to know when such changes happen, in a way they could be noted and handled without producing errors. -3.52.2.6 What is the right place to store it? +3.54.2.6 What is the right place to store it? ............................................. Occasionly, you may find that new corporate visual identity components @@ -4985,7 +4445,7 @@ centos-art manual --read=turnk/Identity/Themes/Motifs/TreeFlower/ change the location we used above by the one you are trying to know concepts for. -3.52.3 Usage +3.54.3 Usage ------------ `centos-art path --copy='SRC' --to='DST'' @@ -4999,11 +4459,11 @@ concepts for. first. In this command, `SRC' is a working copy (WC) entry. -3.52.4 See also +3.54.4 See also --------------- -3.53 trunk/Scripts/Bash/Functions/Render -======================================== +3.55 trunk/Scripts/Bash/centos-art/Functions/Render +=================================================== The `render' functionality exists to produce both identity and translation files on different levels of information (i.e., different @@ -5014,7 +4474,7 @@ structures" to produce files. Renderable directory structures can be either "identity directory structures" or "translation directory structures" with special directories inside. -3.53.1 Renderable identity directory structures +3.55.1 Renderable identity directory structures ----------------------------------------------- Renderable identity directory structures are the starting point of @@ -5044,7 +4504,7 @@ configuration does one thing only (e.g., to produce untranslated images), but it can be extended (e.g., adding translation files) to achieve different needs (e.g., to produce translated images). -3.53.1.1 Design template without translation +3.55.1.1 Design template without translation ............................................ The design template without translation configuration is based on a @@ -5110,8 +4570,8 @@ following configuration: (Portable Network Graphics) files with the `.png' extension. Once the base image format has been produced, it is possible for `centos-art.sh' to use it in order to automatically create other - image formats that may be needed (*note trunk Scripts Bash - Functions Render Config::). + image formats that may be needed (-- *Removed*(pxref:trunk Scripts + Bash Functions Render Config) --). Inside the working copy, you can find an example of "design template without translation" configuration at @@ -5222,10 +4682,10 @@ following configuration: whole production flow once again (design template by design template), until all design templates be processed. - *Note trunk Scripts Bash Functions Render Config::, for more - information. + -- *Removed*(xref:trunk Scripts Bash Functions Render Config) --, + for more information. -3.53.1.2 Design template with translation (one-to-one) +3.55.1.2 Design template with translation (one-to-one) ...................................................... Producing untranslated images is fine in many cases, but not always. @@ -5291,7 +4751,7 @@ trunk/Identity/NewDir/Img/file.png ------------------------------------------------- 4 | Remove design template instance. -3.53.1.3 Design template with translation (optimized) +3.55.1.3 Design template with translation (optimized) ..................................................... Producing translated images satisfies almost all our production images @@ -5395,7 +4855,7 @@ know how translation files are applied to design templates. design template, but `03-docs.png' using the list-based design template. -3.53.1.4 Design template with translation (optimized+flexibility) +3.55.1.4 Design template with translation (optimized+flexibility) ................................................................. In the production models we've seen so far, there are design templates @@ -5540,7 +5000,7 @@ later create combinations among them using `centos-art.sh'. The production flow of "optimize+flexibility" configuration... -3.53.2 Renderable translation directory structures +3.55.2 Renderable translation directory structures -------------------------------------------------- Translation directory structures are auxiliar structures of renderable @@ -5571,7 +5031,7 @@ translation templates. Inside renderable translation directory structures, `centos-art.sh' can produce text-based files only. -3.53.3 Copying renderable directory structures +3.55.3 Copying renderable directory structures ---------------------------------------------- A renderable layout is formed by design models, design images, @@ -5692,24 +5152,24 @@ still in need of it. directly involved in rendition process only. Once such directories have been duplicated, the functionality stops thereat. -3.53.4 Usage +3.55.4 Usage ------------ * ... -3.53.5 See also +3.55.5 See also --------------- -3.54 trunk/Scripts/Bash/Functions/Render/Config -=============================================== +3.56 trunk/Scripts/Bash/centos-art/Functions/Render/Config +========================================================== -3.54.1 Goals +3.56.1 Goals ------------ The `trunk/Scripts/Bash/Config' directory exists to oraganize pre-rendering configuration scripts. -3.54.2 Description +3.56.2 Description ------------------ Pre-rendering configuration scripts let you customize the way @@ -5723,7 +5183,7 @@ both on identity and translation repository entires. Pre-rendering configuration entries are required for each identity entry, but not for translation entries. -3.54.2.1 The `render.conf.sh' identity model +3.56.2.1 The `render.conf.sh' identity model ............................................ Inside CentOS Artwork Repository, we consider identity entries to all @@ -5766,7 +5226,7 @@ extend both image-based and text-based pre-rendering configuration scripts using image-based and text-based post-rendering actions, respectively. -3.54.2.2 The `render.conf.sh' translation model +3.56.2.2 The `render.conf.sh' translation model ............................................... Translation pre-rendering configuration scripts take precedence before @@ -5774,7 +5234,7 @@ default translation rendering action. Translation pre-rendering actions are useful when default translation rendering action do not fit itself to translation entry rendering requirements. -3.54.2.3 The `render.conf.sh' rendering actions +3.56.2.3 The `render.conf.sh' rendering actions ............................................... Inside both image-based and text-based identity pre-rendering @@ -5834,9 +5294,9 @@ file in the list of files to process has been rendered. The `LAST' action is optional. Possible values for `LAST' actions may be `groupByFormat', `renderGdmTgz', etc. - *Note* *Note trunk Scripts Bash Functions Render::, to know more - about possible values for `BASE', `POST' and `LAST' action - definitions. + *Note* -- *Removed*(xref:trunk Scripts Bash Functions Render) --, + to know more about possible values for `BASE', `POST' and `LAST' + action definitions. To specify the `LAST' action, you need to set the `LAST:' string followed by the function name of the action you want to perform. For @@ -5848,7 +5308,7 @@ ACTIONS[0]='BASE:renderImage' ACTIONS[1]='POST:renderFormats: xpm jpg tif' ACTIONS[2]='LAST:groupByformat: png xpm jpg tif' -3.54.3 Usage +3.56.3 Usage ------------ Use the following commands to administer both identity and translation @@ -5875,19 +5335,19 @@ pre-rendering configuration scripts: directory path under `trunk/Identity' or `trunk/Translations' structures only. -3.54.4 See also +3.56.4 See also --------------- -3.55 trunk/Scripts/Bash/Functions/Shell -======================================= +3.57 trunk/Scripts/Bash/centos-art/Functions/Shell +================================================== -3.55.1 Goals +3.57.1 Goals ------------ This section exists to organize files related to `shell' functionality of `centos-art.sh' script. -3.55.2 Description +3.57.2 Description ------------------ The `shell' functionality of `centos-art.sh' script helps you to @@ -6017,7 +5477,7 @@ for changes to take effect over the files you specify. be used, please share your reasons at CentOS Developers mailing list