From 5e5a98de7cc96dc402b7b42390eb5f45af146188 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Jun 20 2011 18:04:51 +0000 Subject: Update repository documentation manual in docbook format. --- diff --git a/Manuals/Repository/Docbook/Introduction.docbook b/Manuals/Repository/Docbook/Introduction.docbook index 929d8ac..32dee77 100644 --- a/Manuals/Repository/Docbook/Introduction.docbook +++ b/Manuals/Repository/Docbook/Introduction.docbook @@ -25,10 +25,7 @@ - &intro-docconvs; - &intro-copying; &intro-history; &intro-repoconvs; - &intro-feedback; diff --git a/Manuals/Repository/Docbook/Introduction/Copying.docbook b/Manuals/Repository/Docbook/Introduction/Copying.docbook deleted file mode 100644 index 2420c5d..0000000 --- a/Manuals/Repository/Docbook/Introduction/Copying.docbook +++ /dev/null @@ -1,16 +0,0 @@ - - - Repository Copying Conditions - - - Copyright © 2009, 2010, 2011 The CentOS Artwork SIG - - - - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - - &intro-copying-preamble; - - diff --git a/Manuals/Repository/Docbook/Introduction/Copying/preamble.docbook b/Manuals/Repository/Docbook/Introduction/Copying/preamble.docbook deleted file mode 100644 index 4a2aed8..0000000 --- a/Manuals/Repository/Docbook/Introduction/Copying/preamble.docbook +++ /dev/null @@ -1,72 +0,0 @@ - - - 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 must be - considered part of centos-art.sh script, a - bash script that automate most of the frequent tasks inside - the repository. - - - - The centos-art.sh script and the - organization of files it needs to work are not in the public - domain; they are copyrighted and there are restrictions on - their distribution, but these restrictions are designed to - permit everything that a good cooperating citizen would want - to do. What is not allowed is to try to prevent others from - further sharing any version of this program that they might - get from you. - - - - Specifically, we want to make sure that you have the right to - give away copies of centos-art.sh script - and the organization of files it needs to work, that you - receive source code or else can get it if you want it, that - you can change this program or use pieces of it in new free - programs, and that you know you can do these things. - - - - To make sure that everyone has such rights, we have to forbid - you to deprive anyone else of these rights. For example, if - you distribute copies of the centos-art.sh - script, you must give the recipients all the rights that you - have. You must make sure that they, too, receive or can get - the source code. And you must tell them their rights. - - - - Also, for our own protection, we must make certain that - everyone finds out that there is no warranty for the - centos-art.sh script. If this program is - modified by someone else and passed on, we want their - recipients to know that what they have is not what we - distributed, so that any problems introduced by others will - not reflect on our reputation. - - - - The centos-art.sh script is released as a - GPL work. Individual packages used by - centos-art.sh script include their own - licenses and the centos-art.sh script - license applies to all packages that it does not clash with. - If there is a clash between the - centos-art.sh script license and individual - package licenses, the individual package license applies - instead. - - - - The precise conditions of the license for the - centos-art.sh script are found in the - . This manual specifically is - covered by the . - - - diff --git a/Manuals/Repository/Docbook/Introduction/Docconvs.docbook b/Manuals/Repository/Docbook/Introduction/Docconvs.docbook deleted file mode 100644 index 9efcdb9..0000000 --- a/Manuals/Repository/Docbook/Introduction/Docconvs.docbook +++ /dev/null @@ -1,259 +0,0 @@ - - - Document Convenctions - - - 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. - - - Example: - - - - - - Use the centos-art render trunk/Manuals/Repository/Docbook - --filter="repository" command to produce - the CentOS Artwork Repository User's Guide. - - - - - - - - - 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. - - - Example: - - - - - - 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. - - - Example: - - - - - To use Tab completion to list - particular files in a directory, type - 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. - - - - - - - keycombination - - - A combination of keystrokes is represented in this - way. - - - 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 using - this style: - - - -render_doTranslation.sh render_getDirTemplate.sh render_doBaseActions.sh -render_getConfigOption.sh render_getOptions.sh render_doThemeActions.sh -render_getDirOutput.sh render.sh - - - - The output returned in response to the command (in - this case, the contents of the directory) is shown in - this style. - - - - - - prompt - - - A prompt, which is a computer's way of signifying that it - is ready for you to input something, is shown in this - style. Examples: - - - - $ - - - - - # - - - - - [centos@projects centos]$ - - - - - projects login: - - - - - - - - - - user input - - - Text that the user types, either on the command line or - into a text box on a GUI screen, is displayed in this - style. In the following example, - text is displayed in this style: To - boot your system into the text based installation program, - you must type in the text command - at the boot: prompt. - - - - - - replaceable - - - Text used in examples that is meant to be replaced with - data provided by the user is displayed in this style. In - the following example, - version-number is displayed in - this style: The directory for the kernel source is - /usr/src/kernels/version-number/, - where version-number is the - version and type of kernel installed on this system. - - - - - - 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 /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/Repository/Docbook/Introduction/Feedback.docbook b/Manuals/Repository/Docbook/Introduction/Feedback.docbook deleted file mode 100644 index 5068e59..0000000 --- a/Manuals/Repository/Docbook/Introduction/Feedback.docbook +++ /dev/null @@ -1,21 +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. - - - diff --git a/Manuals/Repository/Docbook/Preface.ent b/Manuals/Repository/Docbook/Preface.ent new file mode 100644 index 0000000..9ac1a2a --- /dev/null +++ b/Manuals/Repository/Docbook/Preface.ent @@ -0,0 +1,3 @@ + + + diff --git a/Manuals/Repository/Docbook/Preface/Copying.docbook b/Manuals/Repository/Docbook/Preface/Copying.docbook new file mode 100644 index 0000000..31ab1a9 --- /dev/null +++ b/Manuals/Repository/Docbook/Preface/Copying.docbook @@ -0,0 +1,86 @@ + + + Copying Conditions + + + Copyright © 2009, 2010, 2011 The CentOS Artwork SIG + + + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + + + Preamble + + + &TCAR; organizes files in a very specific way to implement + &TCPCVI;. This very specific organization of files must be + considered part of centos-art.sh script, a + bash script that automate most of the frequent tasks inside + the repository. + + + + The centos-art.sh script and the + organization of files it needs to work are not in the public + domain; they are copyrighted and there are restrictions on + their distribution, but these restrictions are designed to + permit everything that a good cooperating citizen would want + to do. What is not allowed is to try to prevent others from + further sharing any version of this program that they might + get from you. + + + + Specifically, we want to make sure that you have the right to + give away copies of centos-art.sh script + and the organization of files it needs to work, that you + receive source code or else can get it if you want it, that + you can change this program or use pieces of it in new free + programs, and that you know you can do these things. + + + + To make sure that everyone has such rights, we have to forbid + you to deprive anyone else of these rights. For example, if + you distribute copies of the centos-art.sh + script, you must give the recipients all the rights that you + have. You must make sure that they, too, receive or can get + the source code. And you must tell them their rights. + + + + Also, for our own protection, we must make certain that + everyone finds out that there is no warranty for the + centos-art.sh script. If this program is + modified by someone else and passed on, we want their + recipients to know that what they have is not what we + distributed, so that any problems introduced by others will + not reflect on our reputation. + + + + The centos-art.sh script is released as a + GPL work. Individual packages used by + centos-art.sh script include their own + licenses and the centos-art.sh script + license applies to all packages that it does not clash with. + If there is a clash between the + centos-art.sh script license and individual + package licenses, the individual package license applies + instead. + + + + The precise conditions of the license for the + centos-art.sh script are found in the . This manual specifically is covered + by the . + + + + + diff --git a/Manuals/Repository/Docbook/Preface/Copying/preamble.docbook b/Manuals/Repository/Docbook/Preface/Copying/preamble.docbook new file mode 100644 index 0000000..4a2aed8 --- /dev/null +++ b/Manuals/Repository/Docbook/Preface/Copying/preamble.docbook @@ -0,0 +1,72 @@ + + + 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 must be + considered part of centos-art.sh script, a + bash script that automate most of the frequent tasks inside + the repository. + + + + The centos-art.sh script and the + organization of files it needs to work are not in the public + domain; they are copyrighted and there are restrictions on + their distribution, but these restrictions are designed to + permit everything that a good cooperating citizen would want + to do. What is not allowed is to try to prevent others from + further sharing any version of this program that they might + get from you. + + + + Specifically, we want to make sure that you have the right to + give away copies of centos-art.sh script + and the organization of files it needs to work, that you + receive source code or else can get it if you want it, that + you can change this program or use pieces of it in new free + programs, and that you know you can do these things. + + + + To make sure that everyone has such rights, we have to forbid + you to deprive anyone else of these rights. For example, if + you distribute copies of the centos-art.sh + script, you must give the recipients all the rights that you + have. You must make sure that they, too, receive or can get + the source code. And you must tell them their rights. + + + + Also, for our own protection, we must make certain that + everyone finds out that there is no warranty for the + centos-art.sh script. If this program is + modified by someone else and passed on, we want their + recipients to know that what they have is not what we + distributed, so that any problems introduced by others will + not reflect on our reputation. + + + + The centos-art.sh script is released as a + GPL work. Individual packages used by + centos-art.sh script include their own + licenses and the centos-art.sh script + license applies to all packages that it does not clash with. + If there is a clash between the + centos-art.sh script license and individual + package licenses, the individual package license applies + instead. + + + + The precise conditions of the license for the + centos-art.sh script are found in the + . This manual specifically is + covered by the . + + + diff --git a/Manuals/Repository/Docbook/Preface/Docconvs.docbook b/Manuals/Repository/Docbook/Preface/Docconvs.docbook new file mode 100644 index 0000000..d112c5e --- /dev/null +++ b/Manuals/Repository/Docbook/Preface/Docconvs.docbook @@ -0,0 +1,259 @@ + + + Document Convenctions + + + 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. + + + Example: + + + + + + Use the centos-art render trunk/Manuals/Repository/Docbook + --filter="repository" command to produce + the CentOS Artwork Repository User's Guide. + + + + + + + + + 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. + + + Example: + + + + + + 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. + + + Example: + + + + + To use Tab completion to list + particular files in a directory, type + 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. + + + + + + + keycombination + + + A combination of keystrokes is represented in this + way. + + + 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 using + this style: + + + +render_doTranslation.sh render_getDirTemplate.sh render_doBaseActions.sh +render_getConfigOption.sh render_getOptions.sh render_doThemeActions.sh +render_getDirOutput.sh render.sh + + + + The output returned in response to the command (in + this case, the contents of the directory) is shown in + this style. + + + + + + prompt + + + A prompt, which is a computer's way of signifying that it + is ready for you to input something, is shown in this + style. Examples: + + + + $ + + + + + # + + + + + [centos@projects centos]$ + + + + + projects login: + + + + + + + + + + user input + + + Text that the user types, either on the command line or + into a text box on a GUI screen, is displayed in this + style. In the following example, + text is displayed in this style: To + boot your system into the text based installation program, + you must type in the text command + at the boot: prompt. + + + + + + replaceable + + + Text used in examples that is meant to be replaced with + data provided by the user is displayed in this style. In + the following example, + version-number is displayed in + this style: The directory for the kernel source is + /usr/src/kernels/version-number/, + where version-number is the + version and type of kernel installed on this system. + + + + + + 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 /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/Repository/Docbook/Preface/Feedback.docbook b/Manuals/Repository/Docbook/Preface/Feedback.docbook new file mode 100644 index 0000000..5fd2d66 --- /dev/null +++ b/Manuals/Repository/Docbook/Preface/Feedback.docbook @@ -0,0 +1,21 @@ + + + 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/Repository/Docbook/repository.docbook b/Manuals/Repository/Docbook/repository.docbook index 82b518f..e4ed3d6 100644 --- a/Manuals/Repository/Docbook/repository.docbook +++ b/Manuals/Repository/Docbook/repository.docbook @@ -4,6 +4,7 @@ [ + @@ -12,6 +13,7 @@ %Commons.ent; +%Preface.ent; %Introduction.ent; %Identity.ent; %Locales.ent; @@ -69,6 +71,11 @@ + + &preface-copying; + &preface-docconvs; + &preface-feedback; + &intro; &identity;