From 411b46112429fdabb5ec701bdeacf24ef57de24f Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Jun 24 2011 20:48:09 +0000 Subject: Update repository documentation manual in docbook format. --- diff --git a/Manuals/Repository/Docbook/Introduction.docbook b/Manuals/Repository/Docbook/Introduction.docbook new file mode 100644 index 0000000..e6e0f1c --- /dev/null +++ b/Manuals/Repository/Docbook/Introduction.docbook @@ -0,0 +1,26 @@ + + + Introduction + + + Welcome to &TCARUG;. + + + + &TCARUG; describes how &TCPCVI; is organized and produced + inside &TCAR;. If you are looking for a comprehensive, + task-oriented guide for understanding how &TCPCI; is produced, + this is the manual for you. + + + + This manual assumes you have a basic understanding of &TCD;. + If you need help with it, refer to the help page on The CentOS Wiki for + a list of different places you can find help. + + + &intro-docconvs; + &intro-feedback; + + diff --git a/Manuals/Repository/Docbook/Introduction.ent b/Manuals/Repository/Docbook/Introduction.ent new file mode 100644 index 0000000..86feba0 --- /dev/null +++ b/Manuals/Repository/Docbook/Introduction.ent @@ -0,0 +1,3 @@ + + + diff --git a/Manuals/Repository/Docbook/Introduction/Docconvs.docbook b/Manuals/Repository/Docbook/Introduction/Docconvs.docbook new file mode 100644 index 0000000..8ee2ff3 --- /dev/null +++ b/Manuals/Repository/Docbook/Introduction/Docconvs.docbook @@ -0,0 +1,250 @@ +
+ + 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. For 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. 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 + 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. 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 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 new file mode 100644 index 0000000..f690b2a --- /dev/null +++ b/Manuals/Repository/Docbook/Introduction/Feedback.docbook @@ -0,0 +1,18 @@ +
+ + Send in Your Feedback + + + If you find an error in the &TCAR;, or if you have thought of + a way to make this manual better, we would like to hear from + you! Share your suggestions in &TCAML;. + + + + 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.docbook b/Manuals/Repository/Docbook/Preface.docbook deleted file mode 100644 index e6e0f1c..0000000 --- a/Manuals/Repository/Docbook/Preface.docbook +++ /dev/null @@ -1,26 +0,0 @@ - - - Introduction - - - Welcome to &TCARUG;. - - - - &TCARUG; describes how &TCPCVI; is organized and produced - inside &TCAR;. If you are looking for a comprehensive, - task-oriented guide for understanding how &TCPCI; is produced, - this is the manual for you. - - - - This manual assumes you have a basic understanding of &TCD;. - If you need help with it, refer to the help page on The CentOS Wiki for - a list of different places you can find help. - - - &intro-docconvs; - &intro-feedback; - - diff --git a/Manuals/Repository/Docbook/Preface.ent b/Manuals/Repository/Docbook/Preface.ent deleted file mode 100644 index 0f4f354..0000000 --- a/Manuals/Repository/Docbook/Preface.ent +++ /dev/null @@ -1,3 +0,0 @@ - - - diff --git a/Manuals/Repository/Docbook/Preface/Docconvs.docbook b/Manuals/Repository/Docbook/Preface/Docconvs.docbook deleted file mode 100644 index 8ee2ff3..0000000 --- a/Manuals/Repository/Docbook/Preface/Docconvs.docbook +++ /dev/null @@ -1,250 +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. For 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. 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 - 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. 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 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 deleted file mode 100644 index f690b2a..0000000 --- a/Manuals/Repository/Docbook/Preface/Feedback.docbook +++ /dev/null @@ -1,18 +0,0 @@ -
- - Send in Your Feedback - - - If you find an error in the &TCAR;, or if you have thought of - a way to make this manual better, we would like to hear from - you! Share your suggestions in &TCAML;. - - - - 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 d98698c..32a4ba3 100644 --- a/Manuals/Repository/Docbook/repository.docbook +++ b/Manuals/Repository/Docbook/repository.docbook @@ -4,7 +4,7 @@ [ - + @@ -13,7 +13,7 @@ %Commons.ent; -%Preface.ent; +%Introduction.ent; %Repository.ent; %Identity.ent; %Locales.ent;