← Back to branch summary

~ubuntu-branches/ubuntu/maverick/kubuntu-docs/maverick

« back to all changes in this revision

Viewing changes to libs/preface.xml

  • Committer: Bazaar Package Importer
  • Author(s): Richard A. Johnson
  • Date: 2008-08-18 10:49:14 UTC
  • Revision ID: james.westby@ubuntu.com-20080818104914-83r2er2hsmdp2o0l
Tags: 8.10-2
* Restructured kubuntu documentation package
  - Refer to the NEWS text located in the root directory of the package
* Removed the Firefox start page files
* debian/rules: updated to remove firefox files
* debian/control: removed perl deps due to removal of firefox files, bumped
  version to 3.8.0, updated kdelibs-data dep to kdelibs5-data

Show diffs side-by-side

added added

removed removed

Lines of Context:
libs/preface.xml
 
1
<preface id="preface" status="complete">
 
2
                <title>About This Guide</title>
 
3
                <sect1 id="conventions" status="complete">
 
4
                        <title>Conventions</title>
 
5
                        <para>
 
6
                                <emphasis role="bold">The following notes will be used
 
7
                                        throughout the book:
 
8
                                </emphasis>
 
9
                        </para>
 
10
                        <note>
 
11
                                <para>A note presents interesting, sometimes technical, pieces
 
12
                                        of information related to the surrounding discussion.
 
13
                                </para>
 
14
                        </note>
 
15
                        <tip>
 
16
                                <para>A tip offers advice or an easier way of doing
 
17
                                        something.
 
18
                                </para>
 
19
                        </tip>
 
20
                        <caution>
 
21
                                <para>A caution alerts the reader to potential problems and
 
22
                                        helps avoid them.
 
23
                                </para>
 
24
                                <!-- Direct referencing in a non-instructional context is bad. -->
 
25
                        </caution>
 
26
                        <warning>
 
27
                                <para>A warning advises the reader of a hazard that
 
28
                                        may arise in a given scenario.
 
29
                                </para>
 
30
                        </warning>
 
31
                        <para>
 
32
                                <emphasis role="bold">Cross-reference conventions for print will
 
33
                                        be displayed as follows:
 
34
                                </emphasis>
 
35
                        </para>
 
36
                        <itemizedlist>
 
37
                                <listitem>
 
38
                                        <para>Links to other documents or websites will look like <ulink url="http://www.ubuntu.com">this</ulink>.
 
39
                                        </para>
 
40
                                </listitem>
 
41
                        </itemizedlist>
 
42
                        <note>
 
43
                                <para>PDF, HTML, and XHTML versions of this document will use
 
44
                                        hyperlinks to handle cross-referencing.
 
45
                                </para>
 
46
                        </note>
 
47
                        <para>
 
48
                                <emphasis role="bold">Type conventions will be displayed as
 
49
                                        follows:
 
50
                                </emphasis>
 
51
                        </para>
 
52
                        <itemizedlist>
 
53
                                <listitem>
 
54
                                        <para>File names or paths to directories will be shown in
 
55
                                                <filename>monospace</filename>.
 
56
                                        </para>
 
57
                                </listitem>
 
58
                                <listitem>
 
59
                                        <para>
 
60
                                                Commands that you type at a <application>Terminal</application>
 
61
                                                command prompt will
 
62
                                                be shown as:
 
63
                                        </para>
 
64
                                        <para>
 
65
                                                <!-- NOTE: the spaces before </screen> are significant, and will be in the html output. -->
 
66
                                                <screen>command to type                                 </screen>
 
67
                                        </para>
 
68
                                </listitem>
 
69
                                <listitem>
 
70
                                        <para>Options that you click, select, or choose in a user
 
71
                                                interface will be shown in
 
72
                                                <filename>monospace</filename> type.
 
73
                                        </para>
 
74
                                </listitem>
 
75
                        </itemizedlist>
 
76
                        <para>
 
77
                                <emphasis role="bold">Menu selections, mouse actions, and
 
78
                                        keyboard short-cuts:
 
79
                                </emphasis>
 
80
                        </para>
 
81
                        <itemizedlist>
 
82
                                <listitem>
 
83
                                        <para>A sequence of menu selections will be displayed as
 
84
                                                follows: <menuchoice>
 
85
                                                        <guimenu>
 
86
                                                                <accel>F</accel>ile
 
87
                                                        </guimenu>
 
88
                                                        <guimenuitem>
 
89
                                                                <accel>O</accel>pen
 
90
                                                        </guimenuitem>
 
91
                                                </menuchoice>
 
92
                                        </para>
 
93
                                </listitem>
 
94
                                <listitem>
 
95
                                        <para>Mouse actions shall assume a right-handed mouse
 
96
                                                configuration. The terms <quote>
 
97
                                                        <mousebutton>click</mousebutton>
 
98
                                                </quote>
 
99
                                                and <quote>
 
100
                                                        <mousebutton>double-click</mousebutton>
 
101
                                                </quote>
 
102
                                                refer to using the left mouse button. The term <quote>
 
103
                                                        <mousebutton>right-click</mousebutton>
 
104
                                                </quote>
 
105
                                                refers to using the right mouse button. The
 
106
                                                term <quote>
 
107
                                                        <mousebutton>middle-click</mousebutton>
 
108
                                                </quote>
 
109
                                                refers to using the middle mouse button,
 
110
                                                pressing down on the scroll wheel, or pressing both the
 
111
                                                left and right buttons simultaneously, based on the
 
112
                                                design of your mouse.
 
113
                                        </para>
 
114
                                </listitem>
 
115
                                <listitem>
 
116
                                        <para>Keyboard short-cut combinations will be displayed as
 
117
                                                follows: <keycombo>
 
118
                                                        <keycap>Ctrl</keycap>
 
119
                                                        <keycap>N</keycap>
 
120
                                                </keycombo>
 
121
                                                .Where the conventions for
 
122
                                                <quote>Control</quote>, <quote>Shift,</quote> and
 
123
                                                <quote>Alternate</quote> keys will be
 
124
                                                <keycap>Ctrl</keycap>, <keycap>Shift</keycap>, and
 
125
                                                <keycap>Alt</keycap>, respectively, and shall mean
 
126
                                                the first key is to be held down while pressing the
 
127
                                                second key.
 
128
                                        </para>
 
129
                                </listitem>
 
130
                        </itemizedlist>
 
131
                </sect1>
 
132
                <sect1 id="sect-contributing" status="complete">
 
133
                        <title>Contributing and Feedback</title>
 
134
                        <para>This book is developed by the <ulink url="&ubuntu-doc-team;">Ubuntu Documentation Team</ulink>. <emphasis>You</emphasis> can contribute to this document by sending ideas or comments to the Ubuntu Documentation Team mailing list. Information about the team, its mailing lists, projects, etc. can be found on the <ulink url="&ubuntu-doc-team;">Ubuntu Documentation Team Website</ulink>.
 
135
                        </para>
 
136
                       <para>If you see a problem with this document, or would like to make a suggestion, you can simply file a bug report at the <ulink url="&ubuntu-doc-bugs;">Ubuntu Bugtracker</ulink>. Your help is vital to the success of our documentation!</para>
 
137
                       <para>Many thanks,</para>
 
138
                       <para>-Your Ubuntu Documentation Team</para>
 
139
                </sect1>
 
140
 
 
141
</preface>