diff --git a/Manuals/Docbook/Entities/Introduction.docbook b/Manuals/Docbook/Entities/Introduction.docbook new file mode 100644 index 0000000..673a9c1 --- /dev/null +++ b/Manuals/Docbook/Entities/Introduction.docbook @@ -0,0 +1,34 @@ + + + + Introduction + + Welcome to The CentOS Artwork Repository + Manual. + + The CentOS Artwork Repository Manual describes how The + CentOS Project Corporate Visual Identity is organized and produced + inside the CentOS Artwork Repository (). If you are + looking for a comprehensive, task-oriented guide for understanding + how The CentOS Project Corporate Visual Identity is produced, this + is the manual for you. + + This manual discusses the following intermedite + topics: + + + The CentOS Brand + The CentOS Corporate Visual Structure + The CentOS Corporate Visual Style + + + This guide assumes you have a basic understanding of your + CentOS system. If you need help with CentOS, refer to the help + page on the CentOS Wiki () for a list of different places you can find help. + + &intro-document-convenctions; + &intro-send-in-your-feedback; + + diff --git a/Manuals/Docbook/Entities/Introduction/document-convenctions.docbook b/Manuals/Docbook/Entities/Introduction/document-convenctions.docbook new file mode 100644 index 0000000..c58c66f --- /dev/null +++ b/Manuals/Docbook/Entities/Introduction/document-convenctions.docbook @@ -0,0 +1,148 @@ + +
+ + Document convenctions + + In this manual the personal pronoun we + is used to repesent The CentOS Artwork SIG, + the group of persons that build The CentOS Project corporate + visual identity through the CentOS Artwork Repository. + + In this manual, certain words are represented in different + fonts, typefaces, sizes, and weights. This highlighting is + systematic; different words are represented in the same style to + indicate their inclusion in a specific category. The types of + words that are represented this way include the following: + + + + command + + Linux commands (and other operating system + commands, when used) are represented this way. This + style should indicate to you that you can type the + word or phrase on the command line and press Enter to + invoke a command. Sometimes a command contains words + that would be displayed in a different style on their + own (such as file names). In these cases, they are + considered to be part of the command, so the entire + phrase is displayed as a command. For example: + + Use the centos-art identity + --render='path/to/dir' command to produce + contents inside the trunk/Identity directory + structure. + + + + + + file name + + File names, directory names, paths, and RPM + package names are represented this way. This style + indicates that a particular file or directory exists + with that name on your system. Examples: + + The init.sh file in + trunk/Scripts/Bash/Cli/ + directory is the initialization script, written in + Bash, used to automate most of tasks in the + repository. + + The centos-art command uses + the ImageMagick RPM package to + convert images from PNG format to other + formats. + + + + + + key + + A key on the keyboard is shown in this style. + For example: + + To use TAB completion to list + particular files in a directory, type @command{ls}, + then a character, and finally the Tab key. Your + terminal displays the list of files in the working + directory that begin with that character. + + + + + key-combination + + A combination of keystrokes is represented in + this way. For example: + + The CtrlAltBackspace + key combination exits your graphical session and + returns you to the graphical login screen or the + console. + + + + + + + computer output + + Text in this style indicates text displayed to a + shell prompt such as error messages and responses to + commands. For example: + + The ls command displays the + contents of a directory. For example: + + +Config help_renameEntry.sh +help_copyEntry.sh help_restoreCrossReferences.sh +help_deleteCrossReferences.sh help_searchIndex.sh + + + The output returned in response to the command (in this + case, the contents of the directory) is shown in this + style. + + + + + Additionally, we use several different strategies to draw + your attention to certain pieces of information. In order of + urgency, these items are marked as a note, tip, important, + caution, or warning. For example: + + + Remember that Linux is case sensitive. In other words, a + rose is not a ROSE is not a rOsE. + + + + The directory @file{/usr/share/doc/} contains additional + documentation for packages installed on your system. + + + + If you modify the DHCP configuration file, the changes + do not take effect until you restart the DHCP daemon. + + + + Do not perform routine tasks as root — use a + regular user account unless you need to use the root account + for system administration tasks. + + + + Be careful to remove only the necessary partitions. + Removing other partitions could result in data loss or a + corrupted system environment. + + +
diff --git a/Manuals/Docbook/Entities/Introduction/send-in-your-feedback.docbook b/Manuals/Docbook/Entities/Introduction/send-in-your-feedback.docbook new file mode 100644 index 0000000..b3dc889 --- /dev/null +++ b/Manuals/Docbook/Entities/Introduction/send-in-your-feedback.docbook @@ -0,0 +1,18 @@ + +
+ + Send in your feedback + + If you find an error in the CentOS Artwork + Repository, or if you have thought of a way to make + this manual better, we would like to hear from you! Share your + suggestions in the appropriate mailing list + (http://lists.centos.org/) and/or bug tracker + (http://bugs.centos.org/). + + When you make suggestion, try to be as specific as possible. + For example, if you have found an error in the manual, include the + section number and some of the surrounding text so we can find it + easily. + +
diff --git a/Manuals/Docbook/Entities/Preface.docbook b/Manuals/Docbook/Entities/Preface.docbook index 3090ff8..e3a0417 100644 --- a/Manuals/Docbook/Entities/Preface.docbook +++ b/Manuals/Docbook/Entities/Preface.docbook @@ -1,34 +1,149 @@ - Introduction + Preface - Welcome to The CentOS Artwork Repository - Manual. + The CentOS Artwork Repository started around 2008, at CentOS Developers mailing + list during a discussion about how to automate the slide + images of Anaconda. In such discussion, Ralph Angenendt rose up + his hand to ask: Do you have something to show? + + To answer the question, Alain Reguera Delgado suggested a + bash script which combined SVG and SED files in order to produce + PNG images in different languages —together with the + proposition of creating a Subversion repository where translations + and image production could be distributed inside The CentOS + Community—. + + Karanbirn Sighn considered the idea intresting and provided + the infrastructure necessary to support the effort. This way the + CentOS + Artwork SIG and the CentOS Artwork + Repository were officially created. + + Once the CentOS Artwork Repository was available, Alain + Reguera Delagdo uploaded the bash script for rendering Anaconda + slides; Ralph Angenendt documented it very well; and people + started to download working copies of CentOS Artwork Repository to + produce slide images in their own languages. - The CentOS Artwork Repository Manual describes how The - CentOS Project Corporate Visual Identity is organized and produced - inside the CentOS Artwork Repository (). If you are - looking for a comprehensive, task-oriented guide for understanding - how The CentOS Project Corporate Visual Identity is produced, this - is the manual for you. + Around 2009, The rendition script was at a very rustic state + where only slide images could be produced, so it was redesigned to + extend the image production to other areas, not just slide images. + In this configuration, one SVG file was used as input to produce a + translated instance of it which, in turn, was used to produce one + translated PNG image as output. The SVG translated instance was + created through SED replacement commands. The translated PNG image + was created from the SVG translated instance using Inkscape + command-line interface. + + The rendition script was named + render.sh. + + The repository directory structure was prepared to receive + the rendition script using design templates and translation files + in the same location. There was one directory structure for each + artwork that needed to be produced. In this configuration, if you + would want to produce the same artwork with a different visual + style or structure, it was needed to create a new directory + structure for it because both the image structure and the image + visual style were together in the design template. + + The rendition script was moved to a common place and linked + from different directory structures. There was no need to have the + same code in different directory structures if it could be in just + one place and then be linked from different locations. + + The concepts about corporate identity began to be + considered. As referece, it was used the book Corporate + Identity by Wally Olins (1989) and Wikipedia (). This way, + the rendition script main's goal becomes to: automate production + of a monolithic corporate visual identity structure, based on the + mission and the release schema of The CentOS Project. + + The directory structures started to be documented inside the + repository using text files without markup. Later, documentation + in flat text files was moved to LaTeX format and this way + The CentOS Artwork Repository Manual started to + take form. - This manual discusses the following intermedite - topics: + Around 2010, the rendition script changed its name from + render.sh to centos-art.sh + and became a collection of functionalities where rendition was + just one among others (e.g., documenting and localizing). + + The centos-art.sh was created to organize + automation of most frequent tasks inside the repository. There + was no need to have links all around the repository if a + command-line interface could be created (through symbolic links, + in the ~/bin directory) and + be called anywhere inside the repository as it would be a regular + command. + + Inside centos-art.sh, functionalities + started to get identified and separated one another. For example, + when images were rendered, there was no need to load + functionalities related to documentation manual. This layout moved + us onto common functionalities and specific functionalities inside + centos-art.sh script. Common functionalities + are loaded when centos-art.sh script is + initiated and are available to specific functionalities. + + The centos-art.sh script was redesigned + to handle command-line options trough getopt + option parser. + + The repository directory structure was updated to improve + the implementation of concepts related to corporate visual + identity. Specially in the area related to themes which were + divided into design models and + artistic motifs to eliminate the content + duplication produced by having both image structure and image + visual style in the same file. Now, themes are produced as result + of arbitrary combinations of both design models (structures) and + artistic motifs (visual styles). + + In the documentation area, the documentation files in LaTeX + format were migrated to Texinfo format. In this configuration, + each directory structure in the repository has a documentation + entry associated in a Texinfo structure which can be read, edited + and administered (e.g., renamed, deleted, copied) interactively + throuch centos-art.sh. Additionally, the + texi2html program was used to produced XHTML + output customized by CSS from The CentOS Webenv. - - The CentOS Brand - The CentOS Corporate Visual Structure - The CentOS Corporate Visual Style - + Around 2011, the centos-art.sh script was + redesigned to start translating SVG and other XML-based files + (e.g., XHTML and Docbook files) through the + xml2po program and shell scripts files (e.g., + Bash scripts) through GNU gettext tools. This + configuration provided a stronger interface for graphic designers, + translators and programmers to produce localized content. The SED + files are no longer used to handle translations. + + Improve option parsing through + getopt. - This guide assumes you have a basic understanding of your - CentOS system. If you need help with CentOS, refer to the help - page on the CentOS Wiki () for a list of different places you can find help. - - &preface-document-convenctions; - &preface-send-in-your-feedback; + Consolidate the render, help and + locale functionalities as the most frequent tasks + performed inside the repository. Additionally, the + prepare and tuneup functionalities are + maintained as useful tasks. + + The centos-art.sh script is updated to + organize functionalities in two groups: the administrative + functionalities and the productive + functionalities. The administrative functionalities cover + actions like: copying, deleting and renaming directory structures + inside the repository. Also, preparing your workstation for using + centos-art.sh script, making backups of the + distribution theme currently installed, installing themes created + inside repository and restoring themes from backup. On the other + hand, the productive functionalities cover actions like: content + rendition, content localization, content documentation and content + maintainance. diff --git a/Manuals/Docbook/Entities/Preface/document-convenctions.docbook b/Manuals/Docbook/Entities/Preface/document-convenctions.docbook deleted file mode 100644 index c58c66f..0000000 --- a/Manuals/Docbook/Entities/Preface/document-convenctions.docbook +++ /dev/null @@ -1,148 +0,0 @@ - -
- - Document convenctions - - In this manual the personal pronoun we - is used to repesent The CentOS Artwork SIG, - the group of persons that build The CentOS Project corporate - visual identity through the CentOS Artwork Repository. - - In this manual, certain words are represented in different - fonts, typefaces, sizes, and weights. This highlighting is - systematic; different words are represented in the same style to - indicate their inclusion in a specific category. The types of - words that are represented this way include the following: - - - - command - - Linux commands (and other operating system - commands, when used) are represented this way. This - style should indicate to you that you can type the - word or phrase on the command line and press Enter to - invoke a command. Sometimes a command contains words - that would be displayed in a different style on their - own (such as file names). In these cases, they are - considered to be part of the command, so the entire - phrase is displayed as a command. For example: - - Use the centos-art identity - --render='path/to/dir' command to produce - contents inside the trunk/Identity directory - structure. - - - - - - file name - - File names, directory names, paths, and RPM - package names are represented this way. This style - indicates that a particular file or directory exists - with that name on your system. Examples: - - The init.sh file in - trunk/Scripts/Bash/Cli/ - directory is the initialization script, written in - Bash, used to automate most of tasks in the - repository. - - The centos-art command uses - the ImageMagick RPM package to - convert images from PNG format to other - formats. - - - - - - key - - A key on the keyboard is shown in this style. - For example: - - To use TAB completion to list - particular files in a directory, type @command{ls}, - then a character, and finally the Tab key. Your - terminal displays the list of files in the working - directory that begin with that character. - - - - - key-combination - - A combination of keystrokes is represented in - this way. For example: - - The CtrlAltBackspace - key combination exits your graphical session and - returns you to the graphical login screen or the - console. - - - - - - - computer output - - Text in this style indicates text displayed to a - shell prompt such as error messages and responses to - commands. For example: - - The ls command displays the - contents of a directory. For example: - - -Config help_renameEntry.sh -help_copyEntry.sh help_restoreCrossReferences.sh -help_deleteCrossReferences.sh help_searchIndex.sh - - - The output returned in response to the command (in this - case, the contents of the directory) is shown in this - style. - - - - - Additionally, we use several different strategies to draw - your attention to certain pieces of information. In order of - urgency, these items are marked as a note, tip, important, - caution, or warning. For example: - - - Remember that Linux is case sensitive. In other words, a - rose is not a ROSE is not a rOsE. - - - - The directory @file{/usr/share/doc/} contains additional - documentation for packages installed on your system. - - - - If you modify the DHCP configuration file, the changes - do not take effect until you restart the DHCP daemon. - - - - Do not perform routine tasks as root — use a - regular user account unless you need to use the root account - for system administration tasks. - - - - Be careful to remove only the necessary partitions. - Removing other partitions could result in data loss or a - corrupted system environment. - - -
diff --git a/Manuals/Docbook/Entities/Preface/send-in-your-feedback.docbook b/Manuals/Docbook/Entities/Preface/send-in-your-feedback.docbook deleted file mode 100644 index b3dc889..0000000 --- a/Manuals/Docbook/Entities/Preface/send-in-your-feedback.docbook +++ /dev/null @@ -1,18 +0,0 @@ - -
- - Send in your feedback - - If you find an error in the CentOS Artwork - Repository, or if you have thought of a way to make - this manual better, we would like to hear from you! Share your - suggestions in the appropriate mailing list - (http://lists.centos.org/) and/or bug tracker - (http://bugs.centos.org/). - - When you make suggestion, try to be as specific as possible. - For example, if you have found an error in the manual, include the - section number and some of the surrounding text so we can find it - easily. - -