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 @@ </partintro> - &intro-docconvs; - &intro-copying; &intro-history; &intro-repoconvs; - &intro-feedback; </part> 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 @@ -<chapter id="intro-copying" xreflabel="Copying conditions"> - - <title>Repository Copying Conditions</title> - - <para> - Copyright © 2009, 2010, 2011 The CentOS Artwork SIG - </para> - - <para> - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - </para> - - &intro-copying-preamble; - -</chapter> 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 @@ -<simplesect id="intro-copying-preamble" xreflabel="Preamble"> - - <title>Preamble</title> - - <para> - 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 <command>centos-art.sh</command> script, a - bash script that automate most of the frequent tasks inside - the repository. - </para> - - <para> - The <command>centos-art.sh</command> 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. - </para> - - <para> - Specifically, we want to make sure that you have the right to - give away copies of <command>centos-art.sh</command> 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. - </para> - - <para> - 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 <command>centos-art.sh</command> - 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. - </para> - - <para> - Also, for our own protection, we must make certain that - everyone finds out that there is no warranty for the - <command>centos-art.sh</command> 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. - </para> - - <para> - The <command>centos-art.sh</command> script is released as a - GPL work. Individual packages used by - <command>centos-art.sh</command> script include their own - licenses and the <command>centos-art.sh</command> script - license applies to all packages that it does not clash with. - If there is a clash between the - <command>centos-art.sh</command> script license and individual - package licenses, the individual package license applies - instead. - </para> - - <para> - The precise conditions of the license for the - <command>centos-art.sh</command> script are found in the - <xref linkend="licenses-gpl" />. This manual specifically is - covered by the <xref linkend="licenses-gfdl" />. - </para> - -</simplesect> 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 @@ -<chapter id="intro-docconvs" xreflabel="Document convenctions"> - - <title>Document Convenctions</title> - - <para> - 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: - </para> - - <variablelist> - <varlistentry> - <term><command>command</command></term> - <listitem> - <para> - 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. - </para> - <para> - Example: - </para> - - <itemizedlist> - <listitem> - <para> - Use the <command>centos-art render <filename - class="directory">trunk/Manuals/Repository/Docbook</filename> - --filter="repository"</command> command to produce - the CentOS Artwork Repository User's Guide. - </para> - </listitem> - </itemizedlist> - - </listitem> - </varlistentry> - - <varlistentry> - <term><filename>file name</filename></term> - <listitem> - <para> - 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. - </para> - <para> - Example: - </para> - - <itemizedlist> - <listitem> - <para> - The <filename>init.sh</filename> file in <filename - class="directory">trunk/Scripts/Bash/Cli/</filename> - directory is the initialization script, written in - Bash, used to automate most of tasks in the - repository. - </para> - </listitem> - <listitem> - <para> - The <command>centos-art</command> command uses the - <package>ImageMagick</package> RPM package to - convert images from PNG format to other - formats. - </para> - </listitem> - </itemizedlist> - - </listitem> - </varlistentry> - - <varlistentry> - <term><keycap>key</keycap></term> - <listitem> - <para> - A key on the keyboard is shown in this style. - </para> - <para> - Example: - </para> - - <itemizedlist> - <listitem> - <para>To use <keycap>Tab</keycap> completion to list - particular files in a directory, type - <command>ls</command>, then a character, and finally - the <keycap>Tab</keycap> key. Your terminal displays - the list of files in the working directory that begin - with that character.</para> - </listitem> - </itemizedlist> - </listitem> - </varlistentry> - - <varlistentry> - <term><keycombo action="simul"><keycap>key</keycap><keycap>combination</keycap></keycombo></term> - <listitem> - <para> - A combination of keystrokes is represented in this - way. - </para> - <para> - Example: - </para> - <itemizedlist> - <listitem> - <para> - The <keycombo - action="simul"><keycap>Ctrl</keycap><keycap>Alt</keycap><keycap>Backspace</keycap></keycombo> - key combination exits your graphical session and - returns you to the graphical login screen or the - console. - </para> - </listitem> - </itemizedlist> - - </listitem> - - </varlistentry> - - <varlistentry> - <term><computeroutput>computer output</computeroutput></term> - <listitem> - <para> - Text in this style indicates text displayed to a shell - prompt such as error messages and responses to - commands. For example, the <command>ls</command> - command displays the contents of a directory using - this style: - </para> - -<programlisting> -render_doTranslation.sh render_getDirTemplate.sh render_doBaseActions.sh -render_getConfigOption.sh render_getOptions.sh render_doThemeActions.sh -render_getDirOutput.sh render.sh -</programlisting> - - <para> - The output returned in response to the command (in - this case, the contents of the directory) is shown in - this style. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term><prompt>prompt</prompt></term> - <listitem> - <para> - 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: - <itemizedlist> - <listitem> - <para> - <prompt>$</prompt> - </para> - </listitem> - <listitem> - <para> - <prompt>#</prompt> - </para> - </listitem> - <listitem> - <para> - <prompt>[centos@projects centos]$</prompt> - </para> - </listitem> - <listitem> - <para> - <prompt>projects login:</prompt> - </para> - </listitem> - </itemizedlist> - - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term><userinput>user input</userinput></term> - <listitem> - <para> - 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, - <userinput>text</userinput> is displayed in this style: To - boot your system into the text based installation program, - you must type in the <userinput>text</userinput> command - at the <prompt>boot:</prompt> prompt. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term><replaceable>replaceable</replaceable></term> - <listitem> - <para> - 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, - <replaceable>version-number</replaceable> is displayed in - this style: The directory for the kernel source is - <filename - class="directory">/usr/src/kernels/<replaceable>version-number</replaceable>/</filename>, - where <replaceable>version-number</replaceable> is the - version and type of kernel installed on this system. - </para> - </listitem> - </varlistentry> - </variablelist> - - <para>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:</para> - - <note> - <para>Remember that Linux is case sensitive. In other words, a - rose is not a ROSE is not a rOsE.</para> - </note> - - <tip> - <para>The directory <filename - class="directory">/usr/share/doc/</filename> contains - additional documentation for packages installed on your - system.</para> - </tip> - - <important> - <para>If you modify the DHCP configuration file, the changes - do not take effect until you restart the DHCP daemon.</para> - </important> - - <caution> - <para>Do not perform routine tasks as root — use a - regular user account unless you need to use the root account - for system administration tasks.</para> - </caution> - - <warning> - <para>Be careful to remove only the necessary partitions. - Removing other partitions could result in data loss or a - corrupted system environment.</para> - </warning> - -</chapter> 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 @@ -<chapter id="intro-feedback" xreflabel="Send in your feedback"> - - <title>Send in Your Feedback</title> - - <para> - If you find an error in the <emphasis>CentOS Artwork - Repository</emphasis>, 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/). - </para> - - <para> - 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. - </para> - -</chapter> 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 @@ +<!ENTITY preface-docconvs SYSTEM "Preface/Docconvs.docbook"> +<!ENTITY preface-feedback SYSTEM "Preface/Feedback.docbook"> +<!ENTITY preface-copying SYSTEM "Preface/Copying.docbook"> 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 @@ +<preface id="copying"> + + <title>Copying Conditions</title> + + <para> + Copyright © 2009, 2010, 2011 The CentOS Artwork SIG + </para> + + <para> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + </para> + + <simplesect id="copying-preamble"> + + <title>Preamble</title> + + <para> + &TCAR; organizes files in a very specific way to implement + &TCPCVI;. This very specific organization of files must be + considered part of <command>centos-art.sh</command> script, a + bash script that automate most of the frequent tasks inside + the repository. + </para> + + <para> + The <command>centos-art.sh</command> 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. + </para> + + <para> + Specifically, we want to make sure that you have the right to + give away copies of <command>centos-art.sh</command> 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. + </para> + + <para> + 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 <command>centos-art.sh</command> + 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. + </para> + + <para> + Also, for our own protection, we must make certain that + everyone finds out that there is no warranty for the + <command>centos-art.sh</command> 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. + </para> + + <para> + The <command>centos-art.sh</command> script is released as a + GPL work. Individual packages used by + <command>centos-art.sh</command> script include their own + licenses and the <command>centos-art.sh</command> script + license applies to all packages that it does not clash with. + If there is a clash between the + <command>centos-art.sh</command> script license and individual + package licenses, the individual package license applies + instead. + </para> + + <para> + The precise conditions of the license for the + <command>centos-art.sh</command> script are found in the <xref + linkend="licenses-gpl" />. This manual specifically is covered + by the <xref linkend="licenses-gfdl" />. + </para> + + </simplesect> + +</preface> 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 @@ +<simplesect id="intro-copying-preamble" xreflabel="Preamble"> + + <title>Preamble</title> + + <para> + 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 <command>centos-art.sh</command> script, a + bash script that automate most of the frequent tasks inside + the repository. + </para> + + <para> + The <command>centos-art.sh</command> 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. + </para> + + <para> + Specifically, we want to make sure that you have the right to + give away copies of <command>centos-art.sh</command> 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. + </para> + + <para> + 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 <command>centos-art.sh</command> + 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. + </para> + + <para> + Also, for our own protection, we must make certain that + everyone finds out that there is no warranty for the + <command>centos-art.sh</command> 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. + </para> + + <para> + The <command>centos-art.sh</command> script is released as a + GPL work. Individual packages used by + <command>centos-art.sh</command> script include their own + licenses and the <command>centos-art.sh</command> script + license applies to all packages that it does not clash with. + If there is a clash between the + <command>centos-art.sh</command> script license and individual + package licenses, the individual package license applies + instead. + </para> + + <para> + The precise conditions of the license for the + <command>centos-art.sh</command> script are found in the + <xref linkend="licenses-gpl" />. This manual specifically is + covered by the <xref linkend="licenses-gfdl" />. + </para> + +</simplesect> 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 @@ +<preface id="docconvs"> + + <title>Document Convenctions</title> + + <para> + 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: + </para> + + <variablelist> + <varlistentry> + <term><command>command</command></term> + <listitem> + <para> + 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. + </para> + <para> + Example: + </para> + + <itemizedlist> + <listitem> + <para> + Use the <command>centos-art render <filename + class="directory">trunk/Manuals/Repository/Docbook</filename> + --filter="repository"</command> command to produce + the CentOS Artwork Repository User's Guide. + </para> + </listitem> + </itemizedlist> + + </listitem> + </varlistentry> + + <varlistentry> + <term><filename>file name</filename></term> + <listitem> + <para> + 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. + </para> + <para> + Example: + </para> + + <itemizedlist> + <listitem> + <para> + The <filename>init.sh</filename> file in <filename + class="directory">trunk/Scripts/Bash/Cli/</filename> + directory is the initialization script, written in + Bash, used to automate most of tasks in the + repository. + </para> + </listitem> + <listitem> + <para> + The <command>centos-art</command> command uses the + <package>ImageMagick</package> RPM package to + convert images from PNG format to other + formats. + </para> + </listitem> + </itemizedlist> + + </listitem> + </varlistentry> + + <varlistentry> + <term><keycap>key</keycap></term> + <listitem> + <para> + A key on the keyboard is shown in this style. + </para> + <para> + Example: + </para> + + <itemizedlist> + <listitem> + <para>To use <keycap>Tab</keycap> completion to list + particular files in a directory, type + <command>ls</command>, then a character, and finally + the <keycap>Tab</keycap> key. Your terminal displays + the list of files in the working directory that begin + with that character.</para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + + <varlistentry> + <term><keycombo action="simul"><keycap>key</keycap><keycap>combination</keycap></keycombo></term> + <listitem> + <para> + A combination of keystrokes is represented in this + way. + </para> + <para> + Example: + </para> + <itemizedlist> + <listitem> + <para> + The <keycombo + action="simul"><keycap>Ctrl</keycap><keycap>Alt</keycap><keycap>Backspace</keycap></keycombo> + key combination exits your graphical session and + returns you to the graphical login screen or the + console. + </para> + </listitem> + </itemizedlist> + + </listitem> + + </varlistentry> + + <varlistentry> + <term><computeroutput>computer output</computeroutput></term> + <listitem> + <para> + Text in this style indicates text displayed to a shell + prompt such as error messages and responses to + commands. For example, the <command>ls</command> + command displays the contents of a directory using + this style: + </para> + +<programlisting> +render_doTranslation.sh render_getDirTemplate.sh render_doBaseActions.sh +render_getConfigOption.sh render_getOptions.sh render_doThemeActions.sh +render_getDirOutput.sh render.sh +</programlisting> + + <para> + The output returned in response to the command (in + this case, the contents of the directory) is shown in + this style. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><prompt>prompt</prompt></term> + <listitem> + <para> + 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: + <itemizedlist> + <listitem> + <para> + <prompt>$</prompt> + </para> + </listitem> + <listitem> + <para> + <prompt>#</prompt> + </para> + </listitem> + <listitem> + <para> + <prompt>[centos@projects centos]$</prompt> + </para> + </listitem> + <listitem> + <para> + <prompt>projects login:</prompt> + </para> + </listitem> + </itemizedlist> + + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>user input</userinput></term> + <listitem> + <para> + 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, + <userinput>text</userinput> is displayed in this style: To + boot your system into the text based installation program, + you must type in the <userinput>text</userinput> command + at the <prompt>boot:</prompt> prompt. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable>replaceable</replaceable></term> + <listitem> + <para> + 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, + <replaceable>version-number</replaceable> is displayed in + this style: The directory for the kernel source is + <filename + class="directory">/usr/src/kernels/<replaceable>version-number</replaceable>/</filename>, + where <replaceable>version-number</replaceable> is the + version and type of kernel installed on this system. + </para> + </listitem> + </varlistentry> + </variablelist> + + <para>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:</para> + + <note> + <para>Remember that Linux is case sensitive. In other words, a + rose is not a ROSE is not a rOsE.</para> + </note> + + <tip> + <para>The directory <filename + class="directory">/usr/share/doc/</filename> contains + additional documentation for packages installed on your + system.</para> + </tip> + + <important> + <para>If you modify the DHCP configuration file, the changes + do not take effect until you restart the DHCP daemon.</para> + </important> + + <caution> + <para>Do not perform routine tasks as root — use a + regular user account unless you need to use the root account + for system administration tasks.</para> + </caution> + + <warning> + <para>Be careful to remove only the necessary partitions. + Removing other partitions could result in data loss or a + corrupted system environment.</para> + </warning> + +</preface> 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 @@ +<preface id="feedback"> + + <title>Send in Your Feedback</title> + + <para> + If you find an error in the <emphasis>CentOS Artwork + Repository</emphasis>, 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/). + </para> + + <para> + 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. + </para> + +</preface> 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 @@ [ <!ENTITY % Commons.ent SYSTEM "Commons.ent"> +<!ENTITY % Preface.ent SYSTEM "Preface.ent"> <!ENTITY % Introduction.ent SYSTEM "Introduction.ent"> <!ENTITY % Identity.ent SYSTEM "Identity.ent"> <!ENTITY % Locales.ent SYSTEM "Locales.ent"> @@ -12,6 +13,7 @@ <!ENTITY % Licenses.ent SYSTEM "Licenses.ent"> %Commons.ent; +%Preface.ent; %Introduction.ent; %Identity.ent; %Locales.ent; @@ -69,6 +71,11 @@ </bookinfo> + <!-- Front matter --> + &preface-copying; + &preface-docconvs; + &preface-feedback; + <!-- Main matter --> &intro; &identity;