~ubuntu-branches/ubuntu/hardy/xubuntu-docs/hardy-updates

« back to all changes in this revision

Viewing changes to common/sl/preface.xml

  • Committer: Bazaar Package Importer
  • Author(s): Jani Monoses
  • Date: 2007-03-27 17:22:31 UTC
  • Revision ID: james.westby@ubuntu.com-20070327172231-0uy581znv3cxkzbo
Tags: 7.03.1
First upload to Feisty 

Show diffs side-by-side

added added

removed removed

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