From 1e543dd979abab14cbb75d9b80d20770e94d2c88 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Jun 26 2013 18:46:12 +0000 Subject: Update Tcar-ug documentation manual. - Add Repository/Convenctions/directories.docbook to describe directories inside the repository. - Add &TCWE; entity. It expands to The CentOS Web Environment. - Update content related to repository conventions. --- diff --git a/Documentation/Models/Docbook/Default/Book/Book.ent b/Documentation/Models/Docbook/Default/Book/Book.ent index 3bab162..af62731 100644 --- a/Documentation/Models/Docbook/Default/Book/Book.ent +++ b/Documentation/Models/Docbook/Default/Book/Book.ent @@ -43,6 +43,7 @@ centos-devel@centos.org mailing list"> centos-info@centos.org mailing list"> + &TC; Wiki"> &TC; Mailing Lists"> diff --git a/Documentation/Models/Docbook/Tcar-ug/Repository.ent b/Documentation/Models/Docbook/Tcar-ug/Repository.ent index f9060ee..f0a40a4 100644 --- a/Documentation/Models/Docbook/Tcar-ug/Repository.ent +++ b/Documentation/Models/Docbook/Tcar-ug/Repository.ent @@ -3,6 +3,7 @@ + diff --git a/Documentation/Models/Docbook/Tcar-ug/Repository/Conventions.docbook b/Documentation/Models/Docbook/Tcar-ug/Repository/Conventions.docbook index a4c0b5e..792bcd5 100644 --- a/Documentation/Models/Docbook/Tcar-ug/Repository/Conventions.docbook +++ b/Documentation/Models/Docbook/Tcar-ug/Repository/Conventions.docbook @@ -5,6 +5,7 @@ &repo-convs-mission; &repo-convs-infra; &repo-convs-worklines; + &repo-convs-directories; &repo-convs-filenames; &repo-convs-relbdirs; &repo-convs-syncpaths; diff --git a/Documentation/Models/Docbook/Tcar-ug/Repository/Conventions/directories.docbook b/Documentation/Models/Docbook/Tcar-ug/Repository/Conventions/directories.docbook new file mode 100755 index 0000000..4de2550 --- /dev/null +++ b/Documentation/Models/Docbook/Tcar-ug/Repository/Conventions/directories.docbook @@ -0,0 +1,774 @@ +
+ + Repository Directory Structure + + + This section describes the directory structure of &TCAR;. You + can use this section as reference to know where the files you + are looking at are stored in and where you can store new + files, as well. This section organizes directories' + description using the same hierarchy the repository has. This + section begins describing the first level of directories in + the repository and continues with each relevant sub-directory + in the hierarchy, one by one. + + + + The directory structure this section describes is based on the + document &TCAR; Directory + Structure, available at: + Documentation/Models/Svg/Repository/directory-structure.svgz + + +
+ The <filename class="directory">Artworks</filename> Directory + + This directory contains the files used to produce the + corporate visual identity of &TCP;. The information in this + directory is organized in Brushes, Gradients, Fonts, Images, + Models, Palettes, Patterns and Webenv directories. + + + + + Artworks/Brushes/ + + + This directory contains GIMP brushes. Brushes stored in this + directory will be available inside GIMP's brushes dialog. + + + + + + Artworks/Patterns/ + + + This directory contains GIMP patterns. Patterns stored in this + directory will be available inside GIMP's patterns dialog. + + + + + + Artworks/Gradients/ + + + This directory contains GIMP gradients. Gradients stored in + this directory will be available inside GIMP's gradients + dialog. + + + + + + Artworks/Fonts/ + + + This directory contains font files. Font files stored in this + directory will be available to be used from applications like + GIMP and Inkscape. + + + + + + Artworks/Images/ + + + This directory contains final images. The directory structure + used to organize files here is rather similar to that used in + Artworks/Models/ + directory structure. + + + + + + Artworks/Images/Themes/ + + + This directory contains image files rendered from design + models that use theme background images. In this location you + can also find design models used to create the background + images, too. + + + + Design models used to build themes' background images must not + be moved to Artworks/Models/Themes/ directory + structure. Design models used to build themes' background + images are theme-specific, so they must be inside Artworks/Images/Themes/ directory + structure. + + + + + + + Artworks/Images/Themes/${THEME_NAME}/ + + + This directory contains theme directory structure + organized in version number. Here, ${THEME_NAME} is a + string of letters representing the name of the theme. In + this string, all letters are written in lowercase except + the first one which must be written in uppercase. + + + + + + Artworks/Images/Themes/${THEME_NAME}/${THEME_VERSION}/ + + + This directory contains the theme directory structure + organized in theme components. Here, ${THEME_VERSION} is a + string with the form M.N, where M and N are integer + numbers from 0 to 9. M is required and .N is optional. + + + + + + Artworks/Images/Themes/${THEME_NAME}/${THEME_VERSION}/Backgrounds/ + + + This directory contains theme-specific background images + and design models used to build them. This directory is a + key component of theme concept. It provides background + images to different sizes which are use on different theme + components, as defined by theme design models stored at + Artworks/Models/Themes + directory. + + + + Theme-specific background files + + + + Images/ + Models/ + Description + + + + + 160x600-final.png, 160x600-final.jpg + 160x600-final.svgz, + 160x600-final.xcf + Graphic design at 160x600 pixels, used to + produce the left-side bar of Firstboot + theme component. + + + 200x150-final.png, 200x150-final.jpg + 200x150-final.svgz, 200x150-final.xcf + Graphic design at 200x150 pixels, used to produce + the screenshot of both + Gdm and Kdm theme + components. + + + + 400x300-final.png, 400x300-final.jpg + 400x300-final.svgz, 400x300-final.xcf + Graphic design at 400x300 pixels, used to + produce the splash component of both + Gnome and Kde theme + components. + + + 490x200-final.png, 490x200-final.jpg + 490x200-final.svgz, 490x200-final.xcf + Graphic design at 490x200 pixels, used to + produce the splash image of Anaconda + theme component. + + + 510x300-final.png, 510x300-final.jpg + 510x300-final.svgz, 510x300-final.xcf + Graphic design at 510x300 pixels, used to + produce the slide images of Anaconda theme component. + + + 640x300-final.png, 640x300-final.jpg + 640x300-final.svgz, 640x300-final.xcf + Graphic design at 640x300 pixels, used to + produce the splash image of Syslinux + theme component. + + + 640x480-final.png, 640x480-final.jpg + 640x480-final.svgz, 640x480-final.xcf + Graphic design at 640x480 pixels, used to + produce the splash image of Grub theme + component. + + + 744x1052-final.png, 744x1052-final.jpg + 744x1052-final.svgz, 744x1052-final.xcf + Graphic design at 744x1052 pixels, used to + produce the Posters theme components. + + + 800x600-final.png, 800x600-final.jpg + 800x600-final.svgz, 800x600-final.xcf + Graphic design at 800x600 pixels, used to + produce the Concept theme component. + + + 800x88-final.png, 800x88-final.jpg + 800x88-final.svgz, 800x88-final.xcf + Graphic design at 800x88 pixels, used to + produce the heading image of Anaconda + theme component. + + + +
+ + + Besides background files described in , you'll also find + background files for specific screen resolutions. The + number of files you find here may vary depending the + screen resolutions demanded by &TCD; at /usr/share/backgrounds/. + Resolution-specific background files follow the same name + convention described in the table above but change the + resolution numbers to show the screen resolution they + represent (e.g., 1360x768-final.png + for 1360x768 screen resolutions.). + + + The word -final is used on background files + to mark them as ready for applying. When you design + background images, you might need to create intermediate + images so as to reach desired effects by combining them + into a final one. Such intermediate images do not use the + word -final. Only the result of all your + combinations and tests must have the word + -final on its name. + + + + + + Artworks/Images/Themes/${THEME_NAME}/${THEME_VERSION}/Backgrounds/Images/ + + + This directory contains theme-specific background images, + mostly in PNG and JPG formats. The files in this + directory are used by centos-art.sh + script to produce theme components. The relation between + image files and theme component is described in . + + + + + + Artworks/Images/Themes/${THEME_NAME}/${THEME_VERSION}/Backgrounds/Models/ + + + This directory contains theme-specific background design + models, mostly in SVGZ and XCF formats. The files in this + directory are used to produce theme-specific background + images, only. + + + Design models in this directory must not be confused with + design models stored in Artworks/Models/Theme/ + directory. Design models stored in this directory are + theme-specific while design models stored in Artworks/Models/Theme/ are + common to all themes. + + + + + + Artworks/Images/Themes/${THEME_NAME}/${THEME_VERSION}/Concept/ + + + This directory contains theme-specific conceptual ideas. + The images in this directory can be used to present the + theme's artistic motif in the community. These images + include can include theme name, theme version, theme + author, theme license, theme copyright and similar + information. + + + + + + Artworks/Images/Themes/${THEME_NAME}/${THEME_VERSION}/Distro/ + + + This directory contains theme-specific images for each + component of &TCD;. In this location, images are organized + in distribution major release, distribution component and + language, if the current locale is different from English + language. + + + + + + Artworks/Images/Themes/${THEME_NAME}/${THEME_VERSION}/Gradients/ + + + This directory contains theme-specific GIMP gradients. + + + + + + Artworks/Images/Themes/${THEME_NAME}/${THEME_VERSION}/Palettes/ + + + This directory contains theme-specific GIMP palettes. + The centos-art.sh script uses theme-specific palettes to produce indexed + images with reduced number of colors used by specific + theme components, like Syslinux and + Grub. These components have specific color + requirements which we must comply with. + + + + , describes + the palettes files used inside themes and the number of + colors they require. + + + + Theme-specific palette files + + + + File + Description + + + + + syslinux.gpl + + This palette is used to produce Syslinux final image. + This palette must be created to hold 16 colors using GIMP's + palette format. Inside the palette file, the color + information is organized in an index that begins at 0 + and ends at 15. In this index, the color information + set at position 0 must be the background color used in + the image (e.g., the darkest color in the list) and + the color information set at position 7 must be the + foreground color used in the image (e.g., the lightest + color in the list). + + + + grub.gpl + This palette is used to produce Grub final image. + This palette must be created to hold 14 colors using + GIMP's palette format. Inside the palette file, color + information can be set in any order. + + + +
+ + + + To produce optimum palettes of colors, open with GIMP the + full-colored PNG image you need to reduce colors to and + reduce colors using GIMP's indexing tool at + Mode → + Indexed... from + Image menu. Later, you import the set + of colors into a new palette using the GIMP palettes + editor and save it here. This way, you can grantee + centos-art.sh script will use the + correct color information when it produces images with + reduced colors for theme-specific components. + + + + + + When you create theme-specific palettes, it is necessary + that you fill the comment field of palette file using the + related color information in hexadecimal format. + Otherwise, centos-art.sh script won't be able to realize + image conversion from PNG to LSS format. + + + + + + + + Artworks/Images/Themes/${THEME_NAME}/${THEME_VERSION}/Patterns/ + + + This directory contains theme-specific GIMP patterns. + + + + + + Artworks/Images/Themes/${THEME_NAME}/${THEME_VERSION}/Screenshots/ + + + This directory contains theme-specific screenshots. It is + a series of images illustrating the theme already in + place. Here you'll find one screenshot for each relevant + component inside &TCD;. + + + + + + Artworks/Models/ + + + This directory contains design models (e.g., scalable vector + graphics using the .svgz extension) and image + configuration files (e.g., plain text using the .conf extension) used by + centos-art.sh script to produce images + inside Artworks/Images/. Relevant + components inside this directory include Brands, Icons, Themes + and Webenv. + + + + + + Artworks/Models/Brands/ + + + This directory organizes branding information for &TCP;. + Relevant components inside this directory include Logos/, + Symbols/, and Types/ directories. If you need to tune up &TCP; + branding information, this is the directory you need to go to. + To know more about &TCB;, see . + + + + + + Artworks/Models/Icons/ + + + This directory organizes icon design models for &TCP;. By + default, &TCD; uses the same icons set packaged inside the + SRPMs the upstream provider makes available. Only icons related + to branding information are changed in order to identify + &TCP; and comply with upstream redistribution guidelines. This + directory is not very used by now, it presently contains + design models for Tango's icons set. + + + + + + Artworks/Models/Themes/ + + + This directory contains design models organized by categories. + When you are producing theme-specific images, you can use the + option to instruct the + centos-art.sh script what of these + categories you want to use as reference to produce + theme-specific images. + + + + + + Artworks/Models/Themes/Default/ + + + This directory contains default design models used to produce + theme-specific images, when the + is not provided to + centos-art.sh script at theme-specific + images rendition time. This directory is also used as + reference by centos-art.sh script to build + the theme-specific directory structures inside Artworks/Images/Themes/${THEME_NAME}/${THEME_VERSION}/ + directory, when the + functionality is executed. So, if you find that some + directories in this location are empty, don't remove them. + They should be present in order for + centos-art.sh script to prepare + theme-specific directory structures correctly. + + + + + + Artworks/Models/Themes/Default/Concept/ + + + This directory contains design models used to produce the + conceptual presentation of each theme. This is a 800x600px + image that illustrate the background artistic motif along the + license and copyright information. All images produced from + this design model use the CC-SA license and &TCP; as copyright + holder. + + + + + + Artworks/Models/Themes/Default/Distro/ + + + This directory contains design models used to produce the + visual style of each component inside &TCD; for all its major + releases. The first sub-directory level under this directory + will contain the major release which components will be + produced for. Inside the release-specific directory you will + find one directory for each related distribution component, + including Grub, + Anaconda, + Gdm, + Syslinux, + Firstboot and others. + + + + The components you find inside &TCD; may vary from one major + release to another. They might be added or removed as required + in each new major release. Thus, it is very important to keep + the relation between components and major releases accurate + inside this directory. + + + + + + + Artworks/Models/Themes/Default/Media/ + + + This directory contains design models used to produce visual + style for installation media, including CDs, DVDs, LiveCDs and + LiveDVDs. We don't use release-specific directories in this + location because it is determined automatically from the + /etc/redhat-release file or the + option through the command-line + of centos-art.sh script. + + + + + + Artworks/Models/Themes/Default/Palettes/ + + + This directory contains the palettes of colors used by + centos-art.sh script when no one is found + inside Artworks/Images/Themes/${THEME_NAME}/${THEME_VERSION}/Palettes/ + directory. + + + + + + Artworks/Models/Themes/Default/Gradients/ + + + This directory is empty. It is used to build theme-specific + directory structures. Don't remove it. + + + + + + Artworks/Models/Themes/Default/Patterns/ + + + This directory is empty. It is used to build theme-specific + directory structures. Don't remove it. + + + + + + Artworks/Models/Themes/Default/Posters/ + + + This directory contains design models used by + centos-art.sh script to produce posters. + Posters are promotional stuff, generally printed in different + media and sizes to be shown on events. + + + + + + Artworks/Models/Webenv/ + + + This directory contains common design models used by &TCWE;. + These images include, admonition icons, heading backgrounds, + html backgrounds, admonition backgrounds and whatever + graphical information &TCWE; could need. + + + + + + Artworks/Palettes/ + + + This directory contains GIMP palettes that you always want to + have available in GIMP sessions. + + + + + + Artworks/Patterns/ + + + This directory contains GIMP patterns that you always want to + have available in GIMP sessions. + + + + + + Artworks/Webenv/ + + + This directory contains customizations for specific web + applications. The kind of files you find here vary from one + web application to another. Generally, you find .css and .html files here. Relevant + components inside this directory include Docbook, Httpd, + Mantis, Moin, PhpBB, Punbb, Puntal, Style-guide, Texi2html and + Trac. + + + + + +
+ +
+ The <filename class="directory">Documentation</filename> Directory + + This directory contains documentation related to &TCAR; + written in different formats. This directory is organized in + Models and Manuals. Models contain the documentation source + files and Manuals the final documentation ready to be read + through different media (e.g., online and paper). Here, the + language used to write documentation manuals is English. + + + + + Documentation/Models/ + + + This directory contains documentation source formats used + inside &TCAR;. + + + + + + Documentation/Models/${MANUAL_FORMAT}/ + + + This directory contains documentation manuals' name for + specific documentation formats. + + + + + + Documentation/Models/${MANUAL_FORMAT}/${MANUAL_NAME}/ + + + This directory contains the documentation manual directory + structure. Here is where source files are stored in. If you + want to modify content from a documentation manual, this is + the directory level you need to go to. + + + + + + Documentation/Manuals/ + + + This directory organizes documentation final files, organized + by documentation format, documentation manual name and + documentation language, if documentation files were produced + to a language different from English. + + + + + + + + Several documentation formats have been used to write &TCAR; + documentation manuals through time, including + Texinfo, + LaTeX and finally + DocBook. From these documentation + formats, DocBook is addressed to be the one adopted in the + near future as default documentation format inside &TCAR;. + Support for other documentation formats will remain inside + centos-art.sh script without further + improvements. This in order to dedicate more attention to + DocBook documentation format. + + + + The directory structure used by each documentation format is + not described in this section. To know more about + documentation formats and the directory structure used by + documentation manuals, read . + + +
+ +
+ The <filename class="directory">Localization</filename> Directory + + ... + +
+ +
+ The <filename class="directory">Automation</filename> Directory + + ... + +
+ +
+ The <filename class="directory">Packages</filename> Directory + + ... + +
+ +
diff --git a/Documentation/Models/Docbook/Tcar-ug/Repository/Conventions/extending.docbook b/Documentation/Models/Docbook/Tcar-ug/Repository/Conventions/extending.docbook old mode 100644 new mode 100755 diff --git a/Documentation/Models/Docbook/Tcar-ug/Repository/Conventions/filenames.docbook b/Documentation/Models/Docbook/Tcar-ug/Repository/Conventions/filenames.docbook old mode 100644 new mode 100755 diff --git a/Documentation/Models/Docbook/Tcar-ug/Repository/Conventions/infra.docbook b/Documentation/Models/Docbook/Tcar-ug/Repository/Conventions/infra.docbook old mode 100644 new mode 100755 diff --git a/Documentation/Models/Docbook/Tcar-ug/Repository/Conventions/relbdirs.docbook b/Documentation/Models/Docbook/Tcar-ug/Repository/Conventions/relbdirs.docbook old mode 100644 new mode 100755 diff --git a/Documentation/Models/Docbook/Tcar-ug/Repository/Conventions/syncpaths.docbook b/Documentation/Models/Docbook/Tcar-ug/Repository/Conventions/syncpaths.docbook old mode 100644 new mode 100755 diff --git a/Documentation/Models/Docbook/Tcar-ug/Repository/Conventions/worklines.docbook b/Documentation/Models/Docbook/Tcar-ug/Repository/Conventions/worklines.docbook old mode 100644 new mode 100755 index 094f1bd..f31dd87 --- a/Documentation/Models/Docbook/Tcar-ug/Repository/Conventions/worklines.docbook +++ b/Documentation/Models/Docbook/Tcar-ug/Repository/Conventions/worklines.docbook @@ -9,50 +9,45 @@ produced individually by each work line is combined one another later to achieve higher purposes (e.g., corporate identity for &TCP;). The repository work lines, as conceived - here, provide a relaible environment for people to work - syncronized and descentralized. + here, provide a reliable environment for people to work + synchronized and decentralized. - The action of combining work lines inside &TCAR; is known as - the corporate identity production cycle. The rest of this - section describes the work lines available in the repository - and how they fit inside the corporate identity production - cycle. + The action of combining work lines inside &TCAR; is also known + as the Production Cycle of CentOS corporate + visual identity. The rest of this section describes the work + lines available in the repository and how they integrate one + another. -
+
- Visual Identity + Artworks - The visual identity is the first component we work out in - order to produce a new corporate identity. Through this work - line, graphic designers create models and - motifs for all the visual manifestation &TCP; - is made of. Once design models and artistic motifs are set in - place, graphic designers use the render - functionality described in to combine both design models and artistic motifs into - final images. + Artworks is the first component we work + out in order to produce new corporate visual identities. + Through this work line, graphic designers create + models and motifs for all the + visual manifestation &TCP; is made of. Once design models and + artistic motifs are set in place, graphic designers use the + functionality to + combine them into final images. - The main purposes of this work line is define all the visual - manifestations the &TCP; is made of and provide design models - and artistic motifs for them in order to render the set of - images required to transmit the visual style that identifies - &TCP; as unique organization. To know more about &TCPCVI;, - read . + The mission of Artworks work line is + define all the visual manifestations the &TCP; is made of and + provide design models and artistic motifs for them in order to + produce the image files required to transmit the visual style + that identifies &TCP; as unique organization. - The visual identity work line takes palce in the Identity directory. + To know more about &TCPCVI;, read . -
@@ -60,34 +55,42 @@ Localization - The content localization is the second component that must be - worked out in the corporate identity production cycle. - Through this work line translators localize source files - (e.g., SVG, DocBook, Shell scripts) which are later use to - produce localized images, localized documentation and - localized automation scripts. To localize source files, - translators use - the locale functionality described in - which takes care of - retriving translatable strings from source files and provide a - consistent localization interface based on GNU + Localization is the second component that + must be worked out in the production cycle of CentOS corporate + visual identity. Through this work line translators localize + source files (e.g., SVG, DocBook, Shell scripts) which are + later used to produce localized images, localized + documentation and localized automation scripts. To localize + source files, translators use the functionality which takes + care of retrieving translatable strings from source files and + provide a consistent localization interface based on GNU gettext multi-lingual message production tool set and xml2po command. - The main purpose of this work line is extend the visual - identity (produced in English language) to as many native - languages as possible in order for people which doesn't - understand English languague to feel more confortable with - &TCP; and its messages. To know more about the specific - localization process read . + The localization process takes place inside the + Localization/ directory + in the first level of each repository directory structure. + This directory mirrors the renderable directory structures + outside it and stores .po and .pot files mainly. - The localization work line takes palce in the Locales directory. + The mission of Localization work line is + extend the visual identity (produced in English language) to + as many native languages as possible, in order for people + which doesn't understand English language to feel more + comfortable with &TCP; in their own native languages. + + + + To know more about the specific localization process read + .
@@ -123,11 +126,11 @@
-
- Packaging +
+ Packages - The packaging work line is the fourth component that must be + The packages work line is the fourth component that must be worked out in the corporate identity production cycle. Through this work line packager gather final images, final translations and final documentation related to art works and @@ -145,7 +148,7 @@ - The packaging work line takes palce in the Packages directory.