From 9ae76f7d75330ec7258efbeab4424d88870ee296 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: May 18 2011 03:28:21 +0000 Subject: Update output files related to repository documentation manual. --- diff --git a/Manual/repository.info.bz2 b/Manual/repository.info.bz2 index 52ffefe..bb7f917 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 4790123..d736099 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 fe7dde1..7c1ce3d 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 5cd7620..c17362b 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 c356195..02435ac 100644 --- a/Manual/repository.xml +++ b/Manual/repository.xml @@ -227,10 +227,7 @@ Introduction
Copying Conditions - Copying conditions - + Copying conditionsCopyright ©right; 2009, 2010, 2011 The CentOS Project. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The CentOS Artwork Repository organizes files in a very specific way to implement The CentOS Project corporate visual identity. This very specific organization of files is part of centos-art.sh script, a bash script that automate most of the frequent tasks inside the repository. @@ -397,7 +394,7 @@ help_deleteCrossReferences.sh help_searchIndex.sh Documentation Documentation work line The documentation work line exists to describe what each directory inside the CentOS Artwork Repository is for, the conceptual ideas behind them and, if possible, how automation scripts make use of them. The CentOS Artwork Repository documentation is supported by Texinfo, a documentation system that uses a single source file to produce both online information and printed output. - The repository documentation is organized under trunk/Manual directory structure and uses the repository directories as reference. Each directory structure in the repository has a documentation entry associated in the documentation manual. Documentation entries are stored under trunk/Manual/Directories directory structure and the action itself is controlled by the help functionality of centos-art.sh script. + The repository documentation is organized under trunk/Manual directory and uses the repository directory structre as reference. Each directory in the repository has a documentation entry associated in the documentation manual. Documentation entries are stored under trunk/Manual/Directories directory and the action itself is controlled by the help functionality of centos-art.sh script. The help functionality let you create, edit and delete documentation entries in a way that you don't need to take care of updating menus, nodes and cross reference information inside the manual structure; the functionality takes care of it for you. However, if you need to write repository documentation that have nothing to do with repository directories (e.g., Preface, Introduction and similar) you need to do it manually, there is no functionality to automate such process yet. See Directories trunk Manual, for more information on documentation. @@ -730,6 +727,21 @@ centos-art help --read turnk/Identity/Images/Themes/TreeFlower/3 + Directories trunk Manual Directories + Directories trunk Manual Directories + + + + Directories trunk Manual Introduction + Directories trunk Manual Introduction + + + + Directories trunk Manual Licenses + Directories trunk Manual Licenses + + + Directories trunk Scripts Directories trunk Scripts @@ -1064,6 +1076,12 @@ trunk/Identity/Images/Themes/THEMENAME/THEMEVERSION/Brushes file:///usr/share/gimp/2.0/help/en/index.htmlThe Gimp Manual, specifically the section related to file:///usr/share/gimp/2.0/help/en/gimp-concepts-brushes.htmlBrushes. + + Directories trunk Identity + + + Directories trunk +
@@ -1137,7 +1155,10 @@ trunk/Identity/Images/Themes/THEMENAME/THEMEVERSION/Brushes • - ... + Directories trunk Identity + + + Directories trunk @@ -1484,9 +1505,25 @@ trunk/Identity/Images/Themes/THEMENAME/THEMEVERSION/Brushes Note The information about trademarks and corporate identity is my personal interpretation of http://en.wikipedia.org/Corporate_identity and http://en.wikipedia.org/Trademark description. If you have practical experiences with these affairs, please serve yourself to improve this section with your reasons. Usage + + • + + ... + + See also - - + + • + + Directories trunk Identity Models + + + Directories trunk Identity + + + Directories trunk + + @@ -2176,8 +2213,15 @@ trunk/Identity/Images/Themes/THEMENAME/THEMEVERSION/Brushes See also - - + + • + + Directories trunk Identity + + + Directories trunk + + @@ -2425,25 +2469,85 @@ priority=10 • - ... + See Directories trunk Scripts Functions Locale. See also - •Directories trunk Scripts Functions Locale + • + + Directories trunk + Directories trunk Manual - Directories trunk Scripts + Directories trunk Manual Directories Directories trunk Locales Directories
The <file>trunk/Manual</file> Directory Directories trunk Manual Goals - This trunk/Manual directory structure provides the documentation work line. The main goal of documentation work line is describe what each directory inside the CentOS Artwork Repository is for, the conceptual ideas behind them and, if possible, how automation scripts make use of them. + The trunk/Manual directory is the place where files related to documentation work line are stored in. The main goal of documentation work line is to describe what each directory inside the CentOS Artwork Repository is for, the conceptual ideas behind them and, if possible, how automation scripts make use of them. + Description + Files + + + repository.css + repository-index.texi + repository.info.bz2 + repository-init.pl + repository-menu.texi + repository-node.texi + repository.pdf + repository.sed + repository.texi + repository.txt.bz2 + repository.xhtml.bz2 + repository.xml + +
+ Directories + + • + + See Directories trunk Manual Directories. + + + See Directories trunk Manual Introduction. + + + See Directories trunk Manual Licenses. + + + Usage + + • + + See Directories trunk Scripts Functions Help. + + + See also + + • + + Directories trunk + + +
+ + + Directories trunk Manual Directories + Directories trunk Manual Introduction + Directories trunk Manual + Directories +
+ The <file>trunk/Manual/Directories</file> Directory + Directories trunk Manual Directories + Goals + The trunk/Manual/Directories directory stores source documentation files related to repository directories. The directory structure in this location mirrors the directory structure being documented in the repository from top level directories (e.g., trunk, branches and tags) to inner levels, including the trunk/Manual location itself where documentation source files are stored in. Description • @@ -2459,14 +2563,94 @@ priority=10 See also - - + + • + + ... + + +
+ + + Directories trunk Manual Introduction + Directories trunk Manual Licenses + Directories trunk Manual Directories + Directories +
+ The <file>trunk/Manual/Introduction</file> Directory + Directories trunk Manual Introduction + Goals + + • + + ... + + + Description + + • + + ... + + + Usage + + • + + ... + + + See also + + • + + ... + + +
+ + + Directories trunk Manual Licenses + Directories trunk Scripts + Directories trunk Manual Introduction + Directories +
+ The <file>trunk/Manual/Licenses</file> Directory + Directories trunk Manual Licenses + Goals + + • + + ... + + + Description + + • + + ... + + + Usage + + • + + ... + + + See also + + • + + ... + +
Directories trunk Scripts Directories trunk Scripts Functions - Directories trunk Manual + Directories trunk Manual Licenses Directories
The <file>trunk/Scripts</file> Directory @@ -2840,19 +3024,29 @@ centos-art locale --edit trunk/Scripts When documentation entries are removed (e.g., through or options), the centos-art.sh script takes care of updating nodes, menus and cross references related to documentation entries in order to keep the manual structure in a correct state. Description - - • - - ... - - + The CentOS Project corporate identity is organized through directories in The CentOS Artwork Repository. Each directory inside the repository responds to conceptual ideas and uses files to get the implementation of those ideas. The help functionality of centos-art.sh script uses this directory layout as reference to document the conceptual ideas it is based on. Each directory inside the repository can be documented, in order to provide the explanation of what it is for and how automation scripts use it. + + Caution When the repository directory layout changes, the documentation layout related must be changed as well in order for both locations to be consistent in their paths. Otherwise, you may end up having documentation entries that point to unexistent directories in the repository. + + Files inside the repository are not documented. The only exception to this rule are files under trunk/Manual directory, the place where documentation source files are stored in. Inside this location you can refer .texi files for direct actions using the help functionality of centos-art.sh script. File actions, in this location, are also used to manage specific parts of the manual which have no association outside trunk/Manual directory (e.g., Preface, Introduction, etc.). + The manual structure (see Directories trunk Manual) is supported by GNU Texinfo, a documentation system that can produce both online information and a printed manual from a single source. The help functionality is an interface you can use to control the source files in the manual structure. + The manual output files is produced from Texinfo files and stored in trunk/Manual on different formats including Info, Pdf, XHTML, XML and TXT. + Whatever your prefered language be, you'll always edit documentation entries in English language and so will be the output produced from them, when you use the help functionality of centos-art.sh script. However, you can achieve the manual localization to your prefered language by applying the locale functionality of centos-art.sh script (see Directories trunk Scripts Functions Locale) to any of the XML-based English outputs supported by centos-art.sh script (e.g., XHTML and Docbook) to produce portable objects for your prefered language and the render functionality of centos-art.sh script (see Directories trunk Scripts Functions Render) to produce the translated version of the output XHTML files taken in first place. The translated version is produced in the same format of the file taken as reference to build the portable objects. XHTML format in this case. Examples - - • - - ... - - + + + centos-art help --edit trunk/Identity + + This command edits the documentation entry related to trunk/Identity directory. + + + + centos-art help --read trunk/Identity + + This command reads the doumentation entry related to trunk/Identity directory in info format. + + +
Author Written by Alain Reguera Delgado. Reporting bugs @@ -2947,9 +3141,9 @@ locale -a | less Design models localization Design models are used as input to produce most images and some other contents as well. Design models are always XML-based files (e.g., SVG, XHTML, Docbook), so the locale functionality uses the xml2po program to create protable objects from them under trunk/Locales/Models directory. Portable objects contain the relation between message id and message translation, as translator, need to take care of. Thanks to xml2po, it is possible for the locale functionality to separate designing tasks from the translating tasks. It is possible for graphic designers to concentrate their efforts on designing models in English language while translators take care of their localization using the and options as much as it be needed. - Once design models have been localized, rendering them in different language is a matter using the render functionality of centos-art.sh script. See Directories trunk Scripts Functions Render, for more information about it. + Once design models have been localized, rendering them in different language is a matter using the render functionality of centos-art.sh script. See Directories trunk Scripts Functions Render, for more information about it. Shell script localization - Additionally to design models localization, the locale functionality is also used to localize the centos-art.sh script itself. The centos-art.sh script is a shell script written in Bash, so the locale functionality uses the gettext tools to retrive translatable strings, create portable objects and machine objects. + The locale functionality is used to localize the centos-art.sh script itself. The centos-art.sh script is a shell script written in Bash, so the locale functionality uses the gettext tools to retrive translatable strings, create portable objects and machine objects. Thanks to gettext, it is possible for the locale functionality to separate programming tasks from the translating tasks. It is possible for programmer to concentrate their efforts in programming output messages in English language while translators take care of their localization using the and options as much as it be needed. Once centos-art.sh script has been localized, the translated messages should be immediatly visible to you, the next time you execute the centos-art.sh script @@ -2965,10 +3159,10 @@ locale -a | less - centos-art locale --edit trunk/Identity/Models/Default/Distro/5/Anaconda --dont-create-mo + centos-art locale --edit trunk/Identity/Models/Default/Distro/5/Anaconda This command let translators to edit portable objects related to Anaconda default design models of The CentOS Distribution major release 5. The edit action is where the translator localize translatable strings in English language to another language. - When portable objects for XML-base files are produced, there is no need to retain the machine object format, so we used the . + When portable objects for XML-base files are produced, there is no need to retain the machine object format, so we the is automatically assumed. @@ -2981,7 +3175,23 @@ locale -a | less centos-art locale --edit trunk/Scripts - This command let translators to edit portable objects related to centos-art.sh script. The edit action is where the translator localize translatable strings in English language to another language. + This command edits portable objects related to centos-art.sh script in your prefered language. + + + + centos-art locale --update trunk/Manual/repository.xhtml + + This command updates portable objects for the XHTML output of the repository documentation manual. The portable objects are created in your prefered language and can be used to produced localized versions of the manual in XHTML format. + The update action consists on adding new translatable strings to or removing old translatable strings from the portable objects in order to keep both the portable object and the manual XHTML output consistent one another. + People execute this command after committing changes to the repository documentation manual. + + + + centos-art locale --edit trunk/Manual/repository.xhtml + + This command takes all the repository documentation manual XHTML output files, which have not been translated yet inside the trunk/Manual/repository.xhtml directory, as input to produce portable objects from them so as for you to localize translatable strings to your prefered language (e.g., as specified by the LANG environment variable). + Once the portable objects have been created they are used to produce the translated version of the manual in XHTML format under the trunk/Manual/repository.xml/LANG directory, where LANG refers your prefered language. The translated version of the XHTML files is produced using the render functionality of centos-art.sh script (see Directories trunk Scripts Functions Render). + When your prefered language is other but English, the centos-art.sh script takes care of updating both the portable objects and the translated version of files after you've edited a manual documentation entry, using the help functionality of centos-art.sh script (see Directories trunk Scripts Functions Help). In other situations, you need to do these actions by yourself.