8d257f Update repository documentation manual in docbook format.

Authored and Committed by areguera 13 years ago
    Update repository documentation manual in docbook format.
    
        
Manuals/TCAR-UG/Docbook/Introduction.docbook CHANGED
@@ -14,59 +14,26 @@
14
14
</para>
15
15
16
16
<para>
17
-
17
+ This manual discusses the following topics:
18
- This manual is divided into the following main parts:
19
-
20
- <itemizedlist>
21
- <listitem>
22
- <para>
23
- <xref linkend="repo" /> &mdash; This part describes what
24
- &TCAR; is, how it is organized, the things you can achieve
25
- inside it and how you can do such things.
26
- </para>
27
- </listitem>
28
-
29
- <listitem>
30
- <para>
31
- <xref linkend="identity" /> &mdash; This part describes &TCP;
32
- as organization. Here we dig in the ground and climb up to the
33
- sky, looking for the roots, flowers and thorns &TCP; is made
34
- of.
35
- </para>
36
- </listitem>
37
-
38
- <listitem>
39
- <para>
40
- <xref linkend="l10n" /> &mdash; This part describes how to
41
- produce localized content inside the repository.
42
18
</para>
43
- </listitem>
44
19
20
+ <itemizedlist>
45
21
<listitem>
46
22
<para>
47
- <xref linkend="doc" /> &mdash; This part describes how to
48
- produce and maintain documentation inside the repository.
23
+ &TCAR;, what it is, how it is organized, the things you can
24
+ achieve inside it and how you can do such things.
49
25
</para>
50
26
</listitem>
51
27
52
28
<listitem>
53
29
<para>
54
- <xref linkend="scripts" /> &mdash; This part describes how
55
- automation scripts are implemented and used inside the
56
- repository.
30
+ &TCP; as organization. Here we dig in the ground and climb up
31
+ to the sky, looking for the roots, flowers and thorns &TCP; is
32
+ made of.
57
33
</para>
58
34
</listitem>
59
-
60
- <listitem>
61
- <para>
62
- <xref linkend="licenses" /> &mdash; This part contains the
63
- licenses refered in this manual. </para>
64
- </listitem>
65
-
66
35
</itemizedlist>
67
36
68
- </para>
69
-
70
37
<para>
71
38
This manual assumes you have a basic understanding of &TCD;.
72
39
If you need help with it, refer to the help page on <ulink
Manuals/TCAR-UG/Docbook/Introduction/Docconvs.docbook CHANGED
@@ -13,174 +13,149 @@
13
13
14
14
<variablelist>
15
15
<varlistentry>
16
- <term><command>command</command></term>
17
- <listitem>
18
- <para>
19
- Linux commands (and other operating system
20
- commands, when used) are represented this way.
21
- This style should indicate to you that you can
22
- type the word or phrase on the command line and
23
- press Enter to invoke a command. Sometimes a
24
- command contains words that would be displayed in
25
- a different style on their own (such as file
26
- names). In these cases, they are considered to be
27
- part of the command, so the entire phrase is
28
- displayed as a command. For example:
29
- </para>
30
-
31
- <itemizedlist>
32
- <listitem>
33
- <para>
34
- Use the <command>centos-art render <filename
35
- class="directory">trunk/Manuals/Repository/Docbook</filename>
36
- --filter="repository"</command> command to produce
37
- the CentOS Artwork Repository User's Guide.
16
+ <term><command>command</command></term>
17
+ <listitem>
18
+ <para>
19
+ Linux commands (and other operating system commands, when
20
+ used) are represented this way. This style should
21
+ indicate to you that you can type the word or phrase on
22
+ the command line and press <keycap>Enter</keycap> to
23
+ invoke a command. Sometimes a command contains words that
24
+ would be displayed in a different style on their own (such
25
+ as file names). In these cases, they are considered to be
26
+ part of the command, so the entire phrase is displayed as
27
+ a command. For example:
28
+ </para>
29
+
30
+ <para>
31
+ Use the <command>centos-art render
32
+ trunk/Identity/Images/Themes/TreeFlower/4/Distro/5/Anaconda
33
+ --filter="01-welcome"</command> command to produce the first
34
+ slide image used by Anaconda in the branch 5 of &TCD;
35
+ using the version 4 of TreeFlower artistic motif.
36
+ </para>
37
+ </listitem>
38
- </para>
39
- </listitem>
40
- </itemizedlist>
41
-
42
- </listitem>
43
38
</varlistentry>
44
39
45
40
<varlistentry>
46
- <term><filename>file name</filename></term>
47
- <listitem>
48
- <para>
49
- File names, directory names, paths, and RPM
50
- package names are represented this way. This style
51
- indicates that a particular file or directory
52
- exists with that name on your system. Examples:
53
- </para>
54
-
55
- <itemizedlist>
56
- <listitem>
57
- <para>
58
- The <filename>init.sh</filename> file in <filename
59
- class="directory">trunk/Scripts/Bash/Cli/</filename>
60
- directory is the initialization script, written in
61
- Bash, used to automate most of tasks in the
62
- repository.
63
- </para>
64
- </listitem>
65
- <listitem>
66
- <para>
67
- The <command>centos-art</command> command uses the
41
+ <term><filename>file name</filename></term>
42
+ <listitem>
43
+ <para>
44
+ File names, directory names, paths, and RPM package names
45
+ are represented this way. This style indicates that a
46
+ particular file or directory exists with that name on your
47
+ system. Examples:
48
+ </para>
49
+
50
+ <para>
51
+ The <filename>init.sh</filename> file in <filename
52
+ class="directory">trunk/Scripts/Bash/Cli/</filename>
53
+ directory is the initialization script, written in Bash,
54
+ used to automate most of tasks in the repository.
55
+ </para>
56
+
57
+ <para>
58
+ The <command>centos-art</command> command uses the
59
+ <filename>ImageMagick</filename> RPM package to convert
60
+ images from PNG format to other formats.
61
+ </para>
62
+ </listitem>
68
- <package>ImageMagick</package> RPM package to
69
- convert images from PNG format to other
70
- formats.
71
- </para>
72
- </listitem>
73
- </itemizedlist>
74
-
75
- </listitem>
76
63
</varlistentry>
77
64
78
65
<varlistentry>
79
- <term><keycap>key</keycap></term>
80
- <listitem>
81
- <para>
82
- A key on the keyboard is shown in this style.
83
- For example:
84
- </para>
85
-
86
- <itemizedlist>
87
- <listitem>
88
- <para>
89
- To use <keycap>Tab</keycap> completion to list
90
- particular files in a directory, type
91
- <command>ls</command>, then a character, and
92
- finally the <keycap>Tab</keycap> key. Your
93
- terminal displays the list of files in the working
66
+ <term><keycap>key</keycap></term>
67
+ <listitem>
68
+ <para>
69
+ A key on the keyboard is shown in this style. For
70
+ example:
71
+ </para>
72
+
73
+ <para>
74
+ To use <keycap>Tab</keycap> completion to list particular
75
+ files in a directory, type <command>ls</command>, then a
76
+ character, and finally the <keycap>Tab</keycap> key. Your
77
+ terminal displays the list of files in the working
78
+ directory that begin with that character.
79
+ </para>
80
+ </listitem>
94
- directory that begin with that character.
95
- </para>
96
- </listitem>
97
- </itemizedlist>
98
- </listitem>
99
81
</varlistentry>
100
82
101
83
<varlistentry>
102
- <term><keycombo action="simul"><keycap>key</keycap><keycap>combination</keycap></keycombo></term>
103
- <listitem>
104
- <para>
105
- A combination of keystrokes is represented in this
106
- way. For example:
107
- </para>
108
- <itemizedlist>
109
- <listitem>
110
- <para>
111
- The <keycombo
112
- action="simul"><keycap>Ctrl</keycap><keycap>Alt</keycap><keycap>Backspace</keycap></keycombo>
113
- key combination exits your graphical session and
114
- returns you to the graphical login screen or the
115
- console.
84
+ <term><keycombo action="simul"><keycap>key</keycap><keycap>combination</keycap></keycombo></term>
85
+ <listitem>
86
+ <para>
87
+ A combination of keystrokes is represented in this way.
88
+ For example:
89
+ </para>
90
+
91
+ <para>
92
+ The <keycombo
93
+ action="simul"><keycap>Ctrl</keycap><keycap>Alt</keycap><keycap>Backspace</keycap></keycombo>
94
+ key combination exits your graphical session and returns
95
+ you to the graphical login screen or the console.
96
+ </para>
97
+ </listitem>
116
- </para>
117
- </listitem>
118
- </itemizedlist>
119
-
120
- </listitem>
121
-
122
98
</varlistentry>
123
99
124
100
<varlistentry>
125
- <term><computeroutput>computer output</computeroutput></term>
126
- <listitem>
127
- <para>
128
- Text in this style indicates text displayed to a shell
129
- prompt such as error messages and responses to
130
- commands. For example, the <command>ls</command>
131
- command displays the contents of a directory using
132
- this style:
133
- </para>
134
-
101
+ <term><computeroutput>computer output</computeroutput></term>
102
+ <listitem>
103
+ <para>
104
+ Text in this style indicates text displayed to a shell
105
+ prompt such as error messages and responses to commands.
106
+ For example, the <command>ls</command> command displays
107
+ the contents of a directory using this style:
108
+ </para>
109
+
110
+ <screen>
135
- <programlisting>
136
111
render_doTranslation.sh render_getDirTemplate.sh render_doBaseActions.sh
137
112
render_getConfigOption.sh render_getOptions.sh render_doThemeActions.sh
138
113
render_getDirOutput.sh render.sh
139
- </programlisting>
114
+ </screen>
140
115
141
- <para>
142
- The output returned in response to the command (in
143
- this case, the contents of the directory) is shown in
144
- this style.
145
- </para>
116
+ <para>
117
+ The output returned in response to the command (in this
118
+ case, the contents of the directory) is shown in this
119
+ style.
120
+ </para>
146
121
</listitem>
147
- </varlistentry>
122
+ </varlistentry>
148
123
149
- <varlistentry>
124
+ <varlistentry>
150
125
<term><prompt>prompt</prompt></term>
151
126
<listitem>
152
127
<para>
153
128
A prompt, which is a computer's way of signifying that it
154
129
is ready for you to input something, is shown in this
155
130
style. Examples:
156
- <itemizedlist>
131
+ </para>
157
- <listitem>
158
- <para>
159
- <prompt>$</prompt>
160
- </para>
161
- </listitem>
162
- <listitem>
163
- <para>
164
- <prompt>#</prompt>
165
- </para>
166
- </listitem>
167
- <listitem>
168
- <para>
169
- <prompt>[centos@projects centos]$</prompt>
170
- </para>
171
- </listitem>
172
- <listitem>
173
- <para>
174
- <prompt>projects login:</prompt>
175
- </para>
176
- </listitem>
177
- </itemizedlist>
178
132
133
+ <itemizedlist>
134
+ <listitem>
135
+ <para>
136
+ <prompt>$</prompt>
137
+ </para>
138
+ </listitem>
139
+ <listitem>
140
+ <para>
141
+ <prompt>#</prompt>
179
142
</para>
180
143
</listitem>
181
- </varlistentry>
144
+ <listitem>
145
+ <para>
146
+ <prompt>[centos@projects centos]$</prompt>
147
+ </para>
148
+ </listitem>
149
+ <listitem>
150
+ <para>
151
+ <prompt>projects login:</prompt>
152
+ </para>
153
+ </listitem>
154
+ </itemizedlist>
155
+ </listitem>
156
+ </varlistentry>
182
157
183
- <varlistentry>
158
+ <varlistentry>
184
159
<term><userinput>user input</userinput></term>
185
160
<listitem>
186
161
<para>
@@ -193,9 +168,9 @@ render_getDirOutput.sh render.sh
193
168
at the <prompt>boot:</prompt> prompt.
194
169
</para>
195
170
</listitem>
196
- </varlistentry>
171
+ </varlistentry>
197
172
198
- <varlistentry>
173
+ <varlistentry>
199
174
<term><replaceable>replaceable</replaceable></term>
200
175
<listitem>
201
176
<para>
@@ -210,7 +185,7 @@ render_getDirOutput.sh render.sh
210
185
version and type of kernel installed on this system.
211
186
</para>
212
187
</listitem>
213
- </varlistentry>
188
+ </varlistentry>
214
189
</variablelist>
215
190
216
191
<para>Additionally, we use several different strategies to draw