diff --git a/Manuals/TCAR-UG/Docbook/Introduction.docbook b/Manuals/TCAR-UG/Docbook/Introduction.docbook index d95bcfa..9efe8c2 100644 --- a/Manuals/TCAR-UG/Docbook/Introduction.docbook +++ b/Manuals/TCAR-UG/Docbook/Introduction.docbook @@ -14,59 +14,26 @@ </para> <para> - - This manual is divided into the following main parts: - - <itemizedlist> - <listitem> - <para> - <xref linkend="repo" /> — This part describes what - &TCAR; is, how it is organized, the things you can achieve - inside it and how you can do such things. - </para> - </listitem> - - <listitem> - <para> - <xref linkend="identity" /> — This part describes &TCP; - as organization. Here we dig in the ground and climb up to the - sky, looking for the roots, flowers and thorns &TCP; is made - of. - </para> - </listitem> - - <listitem> - <para> - <xref linkend="l10n" /> — This part describes how to - produce localized content inside the repository. + This manual discusses the following topics: </para> - </listitem> + <itemizedlist> <listitem> <para> - <xref linkend="doc" /> — This part describes how to - produce and maintain documentation inside the repository. + &TCAR;, what it is, how it is organized, the things you can + achieve inside it and how you can do such things. </para> </listitem> <listitem> <para> - <xref linkend="scripts" /> — This part describes how - automation scripts are implemented and used inside the - repository. + &TCP; as organization. Here we dig in the ground and climb up + to the sky, looking for the roots, flowers and thorns &TCP; is + made of. </para> </listitem> - - <listitem> - <para> - <xref linkend="licenses" /> — This part contains the - licenses refered in this manual. </para> - </listitem> - </itemizedlist> - </para> - <para> This manual assumes you have a basic understanding of &TCD;. If you need help with it, refer to the help page on <ulink diff --git a/Manuals/TCAR-UG/Docbook/Introduction/Docconvs.docbook b/Manuals/TCAR-UG/Docbook/Introduction/Docconvs.docbook index 8ee2ff3..0f522c7 100644 --- a/Manuals/TCAR-UG/Docbook/Introduction/Docconvs.docbook +++ b/Manuals/TCAR-UG/Docbook/Introduction/Docconvs.docbook @@ -13,174 +13,149 @@ <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. For 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> + <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 <keycap>Enter</keycap> 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: + </para> + + <para> + Use the <command>centos-art render + trunk/Identity/Images/Themes/TreeFlower/4/Distro/5/Anaconda + --filter="01-welcome"</command> command to produce the first + slide image used by Anaconda in the branch 5 of &TCD; + using the version 4 of TreeFlower artistic motif. + </para> + </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. Examples: - </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> + <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. Examples: + </para> + + <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> + + <para> + The <command>centos-art</command> command uses the + <filename>ImageMagick</filename> RPM package to convert + images from PNG format to other formats. + </para> + </listitem> </varlistentry> <varlistentry> - <term><keycap>key</keycap></term> - <listitem> - <para> - A key on the keyboard is shown in this style. - For 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> + <term><keycap>key</keycap></term> + <listitem> + <para> + A key on the keyboard is shown in this style. For + example: + </para> + + <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> </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. For 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> - + <term><keycombo action="simul"><keycap>key</keycap><keycap>combination</keycap></keycombo></term> + <listitem> + <para> + A combination of keystrokes is represented in this way. + For example: + </para> + + <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> </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> + <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> + +<screen> render_doTranslation.sh render_getDirTemplate.sh render_doBaseActions.sh render_getConfigOption.sh render_getOptions.sh render_doThemeActions.sh render_getDirOutput.sh render.sh -</programlisting> +</screen> - <para> - The output returned in response to the command (in - this case, the contents of the directory) is shown in - this style. - </para> + <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> - <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> + <itemizedlist> + <listitem> + <para> + <prompt>$</prompt> + </para> + </listitem> + <listitem> + <para> + <prompt>#</prompt> </para> </listitem> - </varlistentry> + <listitem> + <para> + <prompt>[centos@projects centos]$</prompt> + </para> + </listitem> + <listitem> + <para> + <prompt>projects login:</prompt> + </para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> - <varlistentry> + <varlistentry> <term><userinput>user input</userinput></term> <listitem> <para> @@ -193,9 +168,9 @@ render_getDirOutput.sh render.sh at the <prompt>boot:</prompt> prompt. </para> </listitem> - </varlistentry> + </varlistentry> - <varlistentry> + <varlistentry> <term><replaceable>replaceable</replaceable></term> <listitem> <para> @@ -210,7 +185,7 @@ render_getDirOutput.sh render.sh version and type of kernel installed on this system. </para> </listitem> - </varlistentry> + </varlistentry> </variablelist> <para>Additionally, we use several different strategies to draw