← Back to branch summary

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

« back to all changes in this revision

Viewing changes to libs/en/conventions.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/en/conventions.xml
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!--<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
        "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 
4
<!ENTITY % xinclude SYSTEM "../../libs/xinclude.mod">
 
5
%xinclude;
 
6
<!ENTITY % globalent SYSTEM "../../libs/global.ent">
 
7
%globalent;
 
8
]>-->
 
9
<sect1 id="conventions" status="complete">
 
10
    <title>Conventions</title>
 
11
    <para>
 
12
        <emphasis role="bold">The following admonitions will be found throughout the book:</emphasis>
 
13
    </para>
 
14
    <note>
 
15
        <para>A note presents interesting, sometimes technical, pieces of information related to the
 
16
            surrounding discussion.</para>
 
17
    </note>
 
18
    <tip>
 
19
        <para>A tip offers advice or an easier way of doing something.</para>
 
20
    </tip>
 
21
    <caution>
 
22
        <para>A caution alerts the reader to potential problems and helps avoid them.</para><!-- Direct referencing in a non-instructional context is bad. -->
 
23
    </caution>
 
24
    <warning>
 
25
        <para>A warning advises the reader of a hazard condition that may arise in a given scenario.</para>
 
26
    </warning>
 
27
    <para>
 
28
        <emphasis role="bold">Cross-reference conventions for print will be displayed as follows:</emphasis>
 
29
    </para>
 
30
    <itemizedlist>
 
31
        <listitem>
 
32
            <para>Internal references will look like this: <xref linkend="sect-acknowledge"/>. The
 
33
                numeral contained within square braces is the [page number].</para>
 
34
        </listitem>
 
35
        <listitem>
 
36
            <para>External references, such as those pointing to a Web site, will look like <ulink url="http://www.ubuntulinux.org">this</ulink>.</para>
 
37
        </listitem>
 
38
    </itemizedlist>
 
39
    <note>
 
40
        <para>PDF, HTML, and XHTML versions of this document will use hyperlinks to handle cross-referencing.</para>
 
41
    </note>
 
42
    <para>
 
43
        <emphasis role="bold">Type conventions will be displayed as follows:</emphasis>
 
44
    </para>
 
45
    <itemizedlist>
 
46
        <listitem>
 
47
            <para>File names or paths to directories will be shown in <filename>monospace</filename> type.</para>
 
48
        </listitem>
 
49
        <listitem>
 
50
            <para>Commands that you type at a prompt will be displayed in <command>bold</command> type.</para>
 
51
        </listitem>
 
52
        <listitem>
 
53
            <para>Options that you click, select, or choose in a user interface will be shown in
 
54
                <filename>monospace</filename> type.</para>
 
55
        </listitem>
 
56
        <listitem>
 
57
            <para>When variables, parameters, SGML tags, etc. are contained within a paragraph of
 
58
                text, they will be shown in <filename>monospace</filename> type. Otherwise, they will
 
59
                use the normal type.</para>
 
60
        </listitem>
 
61
    </itemizedlist>
 
62
    <para>
 
63
        <emphasis role="bold">Menu selections, mouse actions, and keyboard short-cuts:</emphasis>
 
64
    </para>
 
65
    <itemizedlist>
 
66
        <listitem>
 
67
            <para>A sequence of menu selections will be displayed as follows: <menuchoice>
 
68
                    <guimenu>
 
69
                        <accel>F</accel>ile</guimenu>
 
70
                    <guimenuitem>
 
71
                        <accel>O</accel>pen</guimenuitem>
 
72
                </menuchoice>
 
73
            </para>
 
74
        </listitem>
 
75
        <listitem>
 
76
            <para>Mouse actions shall assume a right-handed mouse configuration. The terms
 
77
                <quote><mousebutton>click</mousebutton></quote> and
 
78
                <quote><mousebutton>double-click</mousebutton></quote> refer to using the
 
79
                left mouse button. The term
 
80
                <quote><mousebutton>right-click</mousebutton></quote> refers to using the
 
81
                right mouse button. The term
 
82
                <quote><mousebutton>middle-click</mousebutton></quote> refers to using the
 
83
                middle mouse button, pressing down on the scroll wheel, or pressing both
 
84
                the left and right buttons simultaneously, based on the design of your mouse.</para>
 
85
        </listitem>
 
86
        <listitem>
 
87
            <para>Keyboard short-cut combinations will be displayed as follows: <keycombo>
 
88
                    <keycap>Ctrl</keycap><keycap>N</keycap></keycombo>. Where the conventions for <quote>Control</quote>,
 
89
                <quote>Shift,</quote> and <quote>Alternate</quote> keys will be
 
90
                <keycap>Ctrl</keycap>, <keycap>Shift</keycap>, and <keycap>Alt</keycap>, respectively,
 
91
                and shall mean the first key is to be held down while pressing the second key.</para>
 
92
        </listitem>
 
93
    </itemizedlist>
 
94
    <para>
 
95
        <emphasis role="bold">Code conventions:</emphasis>
 
96
    </para>
 
97
    <itemizedlist>
 
98
        <listitem>
 
99
            <para>Code and mark-up samples will be formatted in a grey block.</para>
 
100
        </listitem>
 
101
        <listitem>
 
102
            <para>Sometimes, lines of code or mark-up examples will be longer than the page width. To
 
103
                avoid having them run off the page, the slash character &quot;\&quot; is used
 
104
                to denote a soft line break. This means that the line of code is meant to
 
105
                be on one line, but for print formatting, it has been broken across two or more lines.</para>
 
106
        </listitem>
 
107
    </itemizedlist>
 
108
</sect1>