~ubuntu-branches/ubuntu/lucid/tomboy/lucid-proposed

« back to all changes in this revision

Viewing changes to help/en_GB/tomboy.xml

Tags: upstream-0.6.1
Import upstream version 0.6.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="utf-8"?>
 
2
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 
3
<!ENTITY date "February 2007">
 
4
<!ENTITY app "<application>Tomboy Notes</application>">
 
5
<!ENTITY appname "Tomboy">
 
6
<!ENTITY extappname "Tomboy Notes">
 
7
<!ENTITY manversion "2.0">
 
8
<!ENTITY version "0.6.0">
 
9
]>
 
10
<!-- 
 
11
  (Do not remove this comment block.)
 
12
  Maintained by the GNOME Documentation Project
 
13
  http://live.gnome.org/DocumentationProject
 
14
  Template version: 3.0 beta
 
15
  Template last modified August 7th, 2006
 
16
-->
 
17
<!-- =============Document Header ============================= -->
 
18
<!-- please do not change the id; for translations, change lang to -->
 
19
<!-- appropriate code -->
 
20
<article id="index" lang="en_GB">
 
21
  <articleinfo>
 
22
    <title>Tomboy Notes Manual</title>
 
23
 
 
24
    <abstract role="description">
 
25
      <para>Tomboy is a simple desktop note-taking application, with some powerful built-in features to help you organise your ideas.</para>
 
26
    </abstract>
 
27
 
 
28
    <copyright>
 
29
      <year>2007</year>
 
30
 
 
31
      <holder>Alex Graveley</holder>
 
32
    </copyright>
 
33
 
 
34
    <copyright>
 
35
      <year>2006</year>
 
36
 
 
37
      <holder>Brent Smith</holder>
 
38
    </copyright>
 
39
 
 
40
    <copyright>
 
41
      <year>2006</year>
 
42
 
 
43
      <holder>Free Software Foundation</holder>
 
44
    </copyright>
 
45
    
 
46
    <copyright>
 
47
      <year>2007</year>
 
48
      
 
49
      <holder>Boyd Timothy</holder>
 
50
    </copyright><copyright><year>2007</year><holder>David Lodge (dave@cirt.net)</holder></copyright>
 
51
 
 
52
    <!-- translators: uncomment this:
 
53
    <copyright>
 
54
      <year>2002</year>
 
55
      <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
 
56
    </copyright>
 
57
-->
 
58
 
 
59
    <publisher>
 
60
      <publishername>GNOME Documentation Project</publishername>
 
61
    </publisher>
 
62
 
 
63
    <include xmlns="http://www.w3.org/2001/XInclude" href="legal.xml"/>
 
64
 
 
65
    <!-- This file  contains link to license for the documentation (GNU FDL), and 
 
66
         other legal stuff such as "NO WARRANTY" statement. Please do not change 
 
67
         any of this. -->
 
68
 
 
69
    <authorgroup>
 
70
      <author role="maintainer">
 
71
        <firstname>Alex</firstname>
 
72
 
 
73
        <surname>Graveley</surname>
 
74
 
 
75
        <affiliation>
 
76
          <orgname>GNOME Documentation Project</orgname>
 
77
 
 
78
          <address><email>alex@beatniksoftware.com</email></address>
 
79
        </affiliation>
 
80
      </author>
 
81
 
 
82
      <author>
 
83
        <firstname>Brent</firstname>
 
84
 
 
85
        <surname>Smith</surname>
 
86
 
 
87
        <affiliation>
 
88
          <orgname>GNOME Documentation Project</orgname>
 
89
 
 
90
          <address><email>gnome@nextreality.net</email></address>
 
91
        </affiliation>
 
92
      </author>
 
93
      
 
94
      <author role="maintainer">
 
95
        <firstname>Boyd</firstname>
 
96
        
 
97
        <surname>Timothy</surname>
 
98
        
 
99
        <affiliation>
 
100
          <orgname>GNOME Documentation Project</orgname>
 
101
 
 
102
          <address><email>btimothy@gmail.com</email></address>
 
103
        </affiliation>
 
104
      </author>
 
105
 
 
106
      <!-- This is appropriate place for other contributors: translators,
 
107
     maintainers,  etc. Commented out by default.
 
108
      <othercredit role="translator">
 
109
        <firstname>Latin</firstname> 
 
110
        <surname>Translator 1</surname> 
 
111
        <affiliation> 
 
112
          <orgname>Latin Translation Team</orgname> 
 
113
          <address> <email>translator@gnome.org</email> </address> 
 
114
        </affiliation>
 
115
        <contrib>Latin translation</contrib>
 
116
     </othercredit>-->
 
117
    </authorgroup>
 
118
 
 
119
    <!-- According to GNU FDL, revision history is mandatory if you are -->
 
120
 
 
121
    <!-- modifying/reusing someone else's document.  If not, you can omit it. -->
 
122
 
 
123
    <revhistory>
 
124
      <!-- Remember to remove the &manrevision; entity from the revision entries other
 
125
   than the current revision. -->
 
126
 
 
127
      <revision>
 
128
        <revnumber>Tomboy Manual 2.0</revnumber>
 
129
 
 
130
        <date>2007-02-28</date>
 
131
 
 
132
        <revdescription>
 
133
          <para role="author">Boyd Timothy</para>
 
134
 
 
135
          <para role="publisher">GNOME Documentation Project</para>
 
136
        </revdescription>
 
137
      </revision>
 
138
    </revhistory>
 
139
 
 
140
    <releaseinfo>This manual describes version 0.6.0 of Tomboy</releaseinfo>
 
141
 
 
142
    <legalnotice>
 
143
      <title>Feedback</title>
 
144
 
 
145
      <para>To report a bug or make a suggestion regarding the Application Name application or this manual, follow the directions in the <ulink type="help" url="ghelp:gnome-feedback">GNOME Feedback Page</ulink>.</para>
 
146
 
 
147
      <!-- Translators may also add here feedback address for translations -->
 
148
    </legalnotice>
 
149
  </articleinfo>
 
150
 
 
151
  <indexterm zone="index">
 
152
    <primary>Tomboy Notes</primary>
 
153
  </indexterm>
 
154
 
 
155
  <indexterm zone="index">
 
156
    <primary>Tomboy</primary>
 
157
  </indexterm>
 
158
 
 
159
  <indexterm zone="index">
 
160
    <primary>notes</primary>
 
161
  </indexterm>
 
162
 
 
163
  <!-- ============= Introduction ============================== -->
 
164
 
 
165
  <sect1 id="tomboy-intro">
 
166
    <title>Introduction</title>
 
167
 
 
168
    <figure id="tomboy-panel">
 
169
      <title>Notes Application</title>
 
170
 
 
171
      <mediaobject>
 
172
        <imageobject>
 
173
          <imagedata fileref="figures/tomboy-panel.png"/>
 
174
        </imageobject>
 
175
      </mediaobject>
 
176
    </figure>
 
177
 
 
178
    <para>Tomboy is a desktop note-taking application for GNOME. It is simple and easy to use, and allows you to organise the ideas and information you deal with every day. Tomboy has some very useful editing features to help you customize your notes, including:</para>
 
179
 
 
180
    <itemizedlist>
 
181
      <listitem>
 
182
        <para>Highlighting Search Text</para>
 
183
      </listitem>
 
184
 
 
185
      <listitem>
 
186
        <para>Inline Spell Checking</para>
 
187
      </listitem>
 
188
 
 
189
      <listitem>
 
190
        <para>Auto-linking Web &amp; Email Addresses</para>
 
191
      </listitem>
 
192
 
 
193
      <listitem>
 
194
        <para>Undo/Redo Support</para>
 
195
      </listitem>
 
196
 
 
197
      <listitem>
 
198
        <para>Font Styling &amp; Sizing</para>
 
199
      </listitem>
 
200
 
 
201
      <listitem>
 
202
        <para>Bulleted Lists</para>
 
203
      </listitem>
 
204
    </itemizedlist>
 
205
 
 
206
    <para>Tomboy is accessed through the GNOME panel. To startup Tomboy automatically when you log into GNOME, see the section <xref linkend="add-to-panel"/>.</para>
 
207
  </sect1>
 
208
 
 
209
  <!--=========== Getting Started ============================== -->
 
210
 
 
211
  <sect1 id="getting-started">
 
212
    <title>Getting Started</title>
 
213
 
 
214
    <sect2 id="add-to-panel">
 
215
      <title>Adding Tomboy to the Panel</title>
 
216
 
 
217
      <para>To add Tomboy to a panel, right-click on the panel, then choose <menuchoice><guimenuitem>Add to Panel</guimenuitem></menuchoice>. Select Tomboy Notes in the Add to the panel dialogue, then click <menuchoice><guibutton>Add</guibutton></menuchoice>. You should see a yellow note icon appear in the panel, representing Tomboy. The panel icon is illustrated in <xref linkend="tomboy-panel"/>.</para>
 
218
    </sect2>
 
219
 
 
220
    <sect2 id="creating-notes">
 
221
      <title>Creating Notes</title>
 
222
 
 
223
      <para>Once you have successfully added Tomboy to the Panel, you can create new notes using one of the following methods.</para>
 
224
 
 
225
      <para>To create a new note using the mouse:</para>
 
226
 
 
227
      <orderedlist>
 
228
        <listitem>
 
229
          <para>Click on the Tomboy note icon present in the GNOME Panel. A menu will appear.</para>
 
230
        </listitem>
 
231
 
 
232
        <listitem>
 
233
          <para>Select the <menuchoice><guimenuitem>Create New Note</guimenuitem></menuchoice> option in the menu.</para>
 
234
        </listitem>
 
235
      </orderedlist>
 
236
 
 
237
      <para>To create a new note using the keyboard:</para>
 
238
 
 
239
      <orderedlist>
 
240
        <listitem>
 
241
          <para>Open the Tomboy menu using the key combination <keycombo><keycap>Alt</keycap><keycap>F12</keycap></keycombo>.</para>
 
242
        </listitem>
 
243
 
 
244
        <listitem>
 
245
          <para>Use the <keycap>N</keycap> key to select the menu option <menuchoice><guimenuitem>Create New Note</guimenuitem></menuchoice>.</para>
 
246
        </listitem>
 
247
      </orderedlist>
 
248
    </sect2>
 
249
 
 
250
    <sect2 id="editing-notes">
 
251
      <title>Editing Notes</title>
 
252
 
 
253
      <para>After creating a new note, a new window will appear with the title <literal>New Note <replaceable>N</replaceable></literal>. At the top of the note is a toolbar with several buttons and text. Directly below this toolbar is the content area of the note. This is illustrated in <xref linkend="new-note"/>.</para>
 
254
 
 
255
      <para>The note can be edited by clicking in the content area and using the keyboard to add and remove content. The first line is considered the title of the note. By default this is populated with the text <quote><literal>New Note <replaceable>N</replaceable></literal></quote>. The title is changed by clicking in the content area on the first line and using the keyboard to change the title. By default, focus is given to the content area upon creation of a new note, so you can immediately start editing the note without the need to click on the content area with the mouse.</para>
 
256
 
 
257
      <para>Using the toolbar available on each note is discussed in the section <xref linkend="working-with-notes"/>.</para>
 
258
 
 
259
      <figure id="new-note">
 
260
        <title>The default window for a New Note</title>
 
261
 
 
262
        <mediaobject>
 
263
          <imageobject>
 
264
            <imagedata fileref="figures/tomboy-new-note.png"/>
 
265
          </imageobject>
 
266
        </mediaobject>
 
267
      </figure>
 
268
    </sect2>
 
269
 
 
270
    <sect2 id="search-all-notes">
 
271
      <title>Table of Contents</title>
 
272
 
 
273
      <para>To get an overview of all the notes managed by Tomboy, select the <menuchoice><guimenuitem>Search All Notes</guimenuitem></menuchoice> menu item from the panel menu. By default, the <interface>Search All Notes</interface> dialogue will display the notes in the order that they were last modified. Click the <guilabel>Note</guilabel> or <guilabel>Last Changed</guilabel> column headings to change the sort order. Click the column heading a second time to toggle between ascending and descending order.</para>
 
274
      
 
275
      <para>You can find specific notes by entering text into the search field in the <interface>Search All Notes</interface> dialogue. The list of notes will automatically update to list only the notes which have matching text.</para>
 
276
      
 
277
      <para>To open a note in the <interface>Search All Notes</interface> dialogue, do one of the following:</para>
 
278
 
 
279
      <orderedlist>
 
280
        <listitem>
 
281
          <para>Double-click on a note.</para>
 
282
        </listitem>
 
283
        
 
284
        <listitem>
 
285
          <para>Highlight a note by selecting it and then select <menuchoice><guimenuitem>Open</guimenuitem></menuchoice> from the <guimenuitem>File</guimenuitem> menu.</para>
 
286
        </listitem>
 
287
        
 
288
        <listitem>
 
289
          <para>Right-click on a note and select <menuchoice><guimenuitem>Open</guimenuitem></menuchoice> from the context menu that appears.</para>
 
290
        </listitem>
 
291
        
 
292
        <listitem>
 
293
          <para>Highlight a note by selecting it and then press the key combination <keycombo><keycap>Ctrl</keycap><keycap>O</keycap></keycombo>.</para>
 
294
        </listitem>
 
295
      </orderedlist>
 
296
    </sect2>
 
297
  </sect1>
 
298
 
 
299
  <!--=========== Working With Notes ============================== -->
 
300
 
 
301
  <sect1 id="working-with-notes">
 
302
    <title>Working With Notes</title>
 
303
 
 
304
    <para>Notes are modified and edited through the main window for each note. The toolbar at the top of each note allows you to apply a style to the note and perform other note-related functions. We discuss the functions of each item on the toolbar in the following sections.</para>
 
305
 
 
306
    <sect2 id="search">
 
307
      <title>Search</title>
 
308
 
 
309
      <para>Clicking the <guibutton>Search</guibutton> button will open the <interface>Search All Notes</interface> dialogue described earlier (<xref linkend="search-all-notes"/>.)</para>
 
310
    </sect2>
 
311
 
 
312
    <sect2 id="link">
 
313
      <title>Link</title>
 
314
 
 
315
      <para>The <guibutton>Link</guibutton> button allows you to create a link to a new note from within the current note. For example, if your note contains the phrase <quote>FinalExam</quote>, you can select this text with the mouse and click the <guibutton>Link</guibutton> button to create a new note with the title <quote>FinalExam</quote>. A link will also be created in the current note that can be clicked to open the new <quote>FinalExam</quote> note.</para>
 
316
 
 
317
      <note>
 
318
        <para>Changing the title of a note will update links present in other notes. This prevents broken links from occurring when a note is renamed.</para>
 
319
      </note>
 
320
    </sect2>
 
321
 
 
322
    <sect2 id="text">
 
323
      <title>Text</title>
 
324
 
 
325
      <para>Formatting text within your notes can be done using the <guibutton>Text</guibutton> button. The <guibutton>Text</guibutton> button will display a drop down menu with several options from which you can choose. Each menu item is explained next.</para>
 
326
 
 
327
      <variablelist>
 
328
        <varlistentry>
 
329
          <term>Undo</term>
 
330
 
 
331
          <listitem>
 
332
            <para>Support for <quote>Undo</quote> is available in Tomboy through this menu item. The Undo function allows you to revert previous changes made to your note during the current session. To undo your last change using the keyboard, use the standard keybinding, <keycombo><keycap>Ctrl</keycap><keycap>Z</keycap></keycombo>.</para>
 
333
          </listitem>
 
334
        </varlistentry>
 
335
 
 
336
        <varlistentry>
 
337
          <term>Redo</term>
 
338
 
 
339
          <listitem>
 
340
            <para>The <quote>Redo</quote> function is used to put back changes that were removed using the <quote>Undo</quote> feature. To redo your last change using the keyboard, use the standard keybinding, <keycombo><keycap>Shift</keycap><keycap>Ctrl</keycap><keycap>Z</keycap></keycombo>.</para>
 
341
          </listitem>
 
342
        </varlistentry>
 
343
 
 
344
        <varlistentry>
 
345
          <term>Bold</term>
 
346
 
 
347
          <listitem>
 
348
            <para>To make text within your note bold, first select the text you want to modify. Then select the <menuchoice><guimenuitem>Bold</guimenuitem></menuchoice> option from the <guibutton>Text</guibutton> dropdown menu. You may also use the keybinding <keycombo><keycap>Ctrl</keycap><keycap>B</keycap></keycombo> after selecting the text.</para>
 
349
          </listitem>
 
350
        </varlistentry>
 
351
 
 
352
        <varlistentry>
 
353
          <term>Italic</term>
 
354
 
 
355
          <listitem>
 
356
            <para>To make text within your note italic, first select the text you want to modify. Then select the <menuchoice><guimenuitem>Italic</guimenuitem></menuchoice> option from the <guibutton>Text</guibutton> dropdown menu. You may also use the keybinding <keycombo><keycap>Ctrl</keycap><keycap>I</keycap></keycombo> after selecting the text.</para>
 
357
          </listitem>
 
358
        </varlistentry>
 
359
 
 
360
        <varlistentry>
 
361
          <term>Strikeout</term>
 
362
 
 
363
          <listitem>
 
364
            <para>The strikeout style will put a line through the selected text. To add a strikeout, select the text and then select the <menuchoice><guimenuitem>Strikeout</guimenuitem></menuchoice> option from the <guibutton>Text</guibutton> dropdown menu. You may also use the keybinding <keycombo><keycap>Ctrl</keycap><keycap>S</keycap></keycombo> after selecting the text.</para>
 
365
          </listitem>
 
366
        </varlistentry>
 
367
 
 
368
        <varlistentry>
 
369
          <term>Highlight</term>
 
370
 
 
371
          <listitem>
 
372
            <para>The highlight style will put a yellow background around the selected text. To add a highlight, select the text and then select the <menuchoice><guimenuitem>Highlight</guimenuitem></menuchoice> option from the <guibutton>Text</guibutton> dropdown menu. You may also use the keybinding <keycombo><keycap>Ctrl</keycap><keycap>H</keycap></keycombo> after selecting the text.</para>
 
373
          </listitem>
 
374
        </varlistentry>
 
375
 
 
376
        <varlistentry>
 
377
          <term>Fixed Width</term>
 
378
 
 
379
          <listitem>
 
380
            <para>The fixed width style allows text to use a fixed width font. To change existing text, first select the text you want to modify. Then select the <menuchoice><guimenuitem>Fixed Width</guimenuitem></menuchoice> option from the <guibutton>Text</guibutton> dropdown menu. You can also select the <menuchoice><guimenuitem>Fixed Width</guimenuitem></menuchoice> option from the <guibutton>Text</guibutton> before you start typing to have the text you type be in a fixed width style.</para>
 
381
            
 
382
            <para>The <menuchoice><guimenuitem>Fixed Width</guimenuitem></menuchoice> option is a feature provided by the Fixed Width Plugin. For more information on plugins, see <xref linkend="plugins"/>.</para>
 
383
          </listitem>
 
384
        </varlistentry>
 
385
 
 
386
        <varlistentry>
 
387
          <term>Font size</term>
 
388
 
 
389
          <listitem>
 
390
            <para>There are actually four options in this part of the menu: <simplelist type="inline"><member><guilabel>Small</guilabel></member><member><guilabel>Normal</guilabel></member><member><guilabel>Large</guilabel></member><member><guilabel>Huge</guilabel></member></simplelist>. Each one of these options represents a font size to use for the selected text in the note. To modify the font size, select the text and then select one of <simplelist type="inline"><member><guilabel>Small</guilabel></member><member><guilabel>Normal</guilabel></member><member><guilabel>Large</guilabel></member><member><guilabel>Huge</guilabel></member></simplelist> options from the <guibutton>Text</guibutton> dropdown menu.</para>
 
391
          </listitem>
 
392
        </varlistentry>
 
393
 
 
394
        <varlistentry>
 
395
          <term>Bullets</term>
 
396
 
 
397
          <listitem>
 
398
            <para>Select the <menuchoice><guimenuitem>Bullets</guimenuitem></menuchoice> option from the <guibutton>Text</guibutton> dropdown menu to begin or end a bulleted list. If the cursor is inside a bulleted list, the <simplelist type="inline"><member><guilabel>Increase Indent</guilabel></member><member><guilabel>Decrease Indent</guilabel></member></simplelist> options will be enabled.</para>
 
399
             
 
400
            <para>With the cursor on a bulleted list line, select the <menuchoice><guimenuitem>Increase Indent</guimenuitem></menuchoice> option to shift the current line to the right or the <menuchoice><guimenuitem>Decrease Indent</guimenuitem></menuchoice> option to shift the current line to the left.</para>
 
401
            
 
402
            <para>For more information on bullets, see <xref linkend="bullets"/>.</para>
 
403
          </listitem>
 
404
        </varlistentry>
 
405
 
 
406
        <varlistentry>
 
407
          <term>Find in This Note</term>
 
408
 
 
409
          <listitem>
 
410
                <para>Use this to search for text within the current note. A small find bar will open up at the bottom of the note. To open the find bar using the keyboard, use the standard keybinding, <keycombo><keycap>Ctrl</keycap><keycap>F</keycap></keycombo>.</para>
 
411
            
 
412
            <para>Enter text to find. After entering text, the matches will be highlighted. Click <guibutton>Find Next</guibutton> to highlight the next match and place the cursor there. Click <guibutton>Previous</guibutton> to move to the previous match.</para>
 
413
                
 
414
                <para>Use the <guibutton>Case sensitive</guibutton> checkbox to limit the matches to ones that match the case of the search string exactly.</para>
 
415
                
 
416
                <para>To close the find bar, click <guibutton>X</guibutton> (Close Button) on the far left or press the <keycap>Escape</keycap> key.</para>
 
417
          </listitem>
 
418
        </varlistentry>
 
419
      </variablelist>
 
420
    </sect2>
 
421
 
 
422
    <sect2 id="tools">
 
423
      <title>Tools (gear icon)</title>
 
424
 
 
425
      <para>The <guibutton>Tools</guibutton> button is represented by the <inlinegraphic fileref="figures/tomboy-tools.png"/> icon. When you click the <guiicon>Tools</guiicon> icon on the toolbar present on your note, a dropdown menu will appear with the following items:</para>
 
426
 
 
427
      <variablelist>
 
428
        <varlistentry>
 
429
          <term>Open Plugins Folder</term>
 
430
 
 
431
          <listitem>
 
432
            <para>This option will open the plugins folder for Tomboy in the File Browser application. For more information on plugins, see <xref linkend="plugins"/>.</para>
 
433
          </listitem>
 
434
        </varlistentry>
 
435
 
 
436
        <varlistentry>
 
437
          <term>What links here?</term>
 
438
 
 
439
          <listitem>
 
440
            <para>This option allows you to quickly see what other notes link to the current note. This feature is provided by the Backlinks Plugin. For more information on plugins, see <xref linkend="plugins"/>.</para>
 
441
          </listitem>
 
442
        </varlistentry>
 
443
 
 
444
        <varlistentry>
 
445
          <term>Export to HTML</term>
 
446
 
 
447
          <listitem>
 
448
            <para>You can create an <acronym>HTML</acronym> (Hypertext Markup Language) document from one or more notes by selecting this option. For more information, please see <xref linkend="plugins"/>.</para>
 
449
          </listitem>
 
450
        </varlistentry>
 
451
 
 
452
        <varlistentry>
 
453
          <term>Print</term>
 
454
 
 
455
          <listitem>
 
456
            <para>Select this option to print the current note. You will be presented with the standard GNOME print dialogue.</para>
 
457
          </listitem>
 
458
        </varlistentry>
 
459
      </variablelist>
 
460
 
 
461
      <note>
 
462
        <para>Depending on the plugins that you have installed for Tomboy, you may have more or less items available in the <guimenu>Tools</guimenu> menu.</para>
 
463
      </note>
 
464
    </sect2>
 
465
 
 
466
    <sect2 id="delete">
 
467
      <title>Delete</title>
 
468
 
 
469
      <para>The <guibutton>Delete</guibutton> button will pop up a dialogue box asking if you want to permanently delete the note and its contents. Click the <guibutton>Delete</guibutton> button to discard the note permanently, or <guibutton>Cancel</guibutton> to abort the process. Links to this note from other notes will still exist, but will re-create the note upon activation.</para>
 
470
    </sect2>
 
471
  </sect1>
 
472
 
 
473
  <!--=========== Panel Menu ====================================== -->
 
474
 
 
475
  <sect1 id="panel-menu">
 
476
    <title>Panel Menu</title>
 
477
 
 
478
    <para>Tomboy keeps the most recently used notes quickly available to you in a menu that appears when you click on the Tomboy Icon in the GNOME Panel.</para>
 
479
 
 
480
    <sect2 id="note-pinning">
 
481
      <title>Note Pinning</title>
 
482
 
 
483
      <para>To force a note to always be in the panel menu regardless of when you last accessed it, click the thumbtack icon to "pin" it to the menu. Notes that are pinned to the panel menu will have a thumbtack icons that look like this: <inlinegraphic fileref="figures/tomboy-pindown.png"/>. Notes that are not pinned to the panel menu will have thumbtack icons that look like this: <inlinegraphic fileref="figures/tomboy-pinup.png"/>.</para>
 
484
 
 
485
      <figure>
 
486
        <title>Tomboy Panel Menu</title>
 
487
 
 
488
        <mediaobject>
 
489
          <imageobject>
 
490
            <imagedata fileref="figures/tomboy-main-menu.png"/>
 
491
          </imageobject>
 
492
        </mediaobject>
 
493
      </figure>
 
494
    </sect2>
 
495
  </sect1>
 
496
 
 
497
  <!--=========== Bulleted Lists ================================== -->
 
498
 
 
499
  <sect1 id="bullets">
 
500
    <title>Bulleted Lists</title>
 
501
 
 
502
    <sect2 id="bullet-start">
 
503
      <title>Begin a bulleted list</title>
 
504
        
 
505
      <para>You may begin a bulleted list by using one of the following methods:</para>
 
506
 
 
507
      <orderedlist>
 
508
        <listitem>
 
509
          <para>Select <menuchoice><guimenuitem>Bullets</guimenuitem></menuchoice> from the <guibutton>Text</guibutton> dropdown menu.</para>
 
510
        </listitem>
 
511
 
 
512
        <listitem>
 
513
          <para>Begin a line with a single dash character (-), type some text immediately following the dash, and press <keycap>Enter</keycap>.</para>
 
514
        </listitem>
 
515
      </orderedlist>
 
516
    </sect2>
 
517
      
 
518
    <sect2 id="bullet-end">
 
519
      <title>End a bulleted list</title>
 
520
 
 
521
      <para>End a bulleted list by doing one of the following:</para>
 
522
      
 
523
      <orderedlist>
 
524
        <listitem>
 
525
          <para>Select <menuchoice><guimenuitem>Bullets</guimenuitem></menuchoice> from the <guibutton>Text</guibutton> dropdown menu.</para>
 
526
        </listitem>
 
527
 
 
528
        <listitem>
 
529
          <para>Press <keycap>Enter</keycap> on a blank bulleted line.</para>
 
530
        </listitem>
 
531
 
 
532
        <listitem>
 
533
          <para>Select <menuchoice><guimenuitem>Decrease Indent</guimenuitem></menuchoice> from the <guibutton>Text</guibutton> dropdown menu in succession until the current line is no longer part of the bulleted list.</para>
 
534
        </listitem>
 
535
 
 
536
        <listitem>
 
537
          <para>Using the key combination <keycombo><keycap>Shift</keycap><keycap>Tab</keycap></keycombo> in succession until the current line is no longer part of the bulleted list.</para>
 
538
        </listitem>
 
539
      </orderedlist>
 
540
    </sect2>
 
541
      
 
542
    <sect2 id="bullet-increase-indent">
 
543
      <title>Increase Indentation</title>
 
544
      
 
545
      <para>To increase the line indentation in a bulleted list with the mouse:</para>
 
546
      
 
547
      <itemizedlist>
 
548
        <listitem>
 
549
          <para>Select <menuchoice><guimenuitem>Increase Indent</guimenuitem></menuchoice> from the <guibutton>Text</guibutton> dropdown menu.</para>
 
550
        </listitem>
 
551
      </itemizedlist>
 
552
 
 
553
      <para>To increase the line indentation in a bulleted list with the keyboard:</para>
 
554
      
 
555
      <itemizedlist>
 
556
        <listitem>
 
557
          <para>Press the <keycap>Tab</keycap> key.</para>
 
558
        </listitem>
 
559
      </itemizedlist>
 
560
    </sect2>
 
561
      
 
562
    <sect2 id="bullet-decrease-indent">
 
563
      <title>Decrease Indentation</title>
 
564
        
 
565
      <para>To decrease the line indentation in a bulleted list with the mouse:</para>
 
566
      
 
567
      <itemizedlist>
 
568
        <listitem>
 
569
          <para>Select <menuchoice><guimenuitem>Decrease Indent</guimenuitem></menuchoice> from the <guibutton>Text</guibutton> dropdown menu.</para>
 
570
        </listitem>
 
571
      </itemizedlist>
 
572
 
 
573
      <para>To decrease the line indentation in a bulleted list with the keyboard:</para>
 
574
      
 
575
      <itemizedlist>
 
576
        <listitem>
 
577
          <para>Press the key combination <keycombo><keycap>Shift</keycap><keycap>Tab</keycap></keycombo>.</para>
 
578
        </listitem>
 
579
      </itemizedlist>
 
580
    </sect2>
 
581
  </sect1>
 
582
 
 
583
  <sect1>
 
584
    <title>Preferences</title>
 
585
 
 
586
    <para>To set preferences for Tomboy, right-click on the icon in the panel, and select <menuchoice><guimenuitem>Preferences</guimenuitem></menuchoice> from the menu. You will see a dialogue similar to the one displayed in <xref linkend="pref-editing"/>. There are two categories of preferences, <guilabel>Editing</guilabel> and <guilabel>Hotkeys</guilabel>. Preferences for each section will be described below.</para>
 
587
 
 
588
    <sect2>
 
589
      <title>Editing</title>
 
590
 
 
591
      <para>The editing section will allow you to set preferences related to editing notes. There are three checkboxes on this tab, which can either be turned on or off.</para>
 
592
 
 
593
      <variablelist>
 
594
        <varlistentry>
 
595
          <term>Spellcheck While Typing</term>
 
596
 
 
597
          <listitem>
 
598
            <para>Enable this checkbox to underline misspellings in red, and provide suggestions in the right click context menu. Enable or disable the checkbox using the mouse or the key combination <keycombo><keycap>Alt</keycap><keycap>S</keycap></keycombo>.</para>
 
599
 
 
600
            <note>
 
601
              <para>The spellcheck option is only available if you have the <application>GtkSpell</application> package for your distribution installed.</para>
 
602
            </note>
 
603
          </listitem>
 
604
        </varlistentry>
 
605
 
 
606
        <varlistentry>
 
607
          <term>Highlight WikiWords</term>
 
608
 
 
609
          <listitem>
 
610
            <para>Enable this checkbox to create links for phrases <literal>ThatLookLikeThis</literal>. Clicking on the link will create a new note with the title corresponding to the link text. Enable or disable this checkbox using the mouse or the key combination <keycombo><keycap>Alt</keycap><keycap>W</keycap></keycombo>.</para>
 
611
          </listitem>
 
612
        </varlistentry>
 
613
 
 
614
        <varlistentry>
 
615
          <term>Use Custom Font</term>
 
616
 
 
617
          <listitem>
 
618
            <para>Enable this checkbox to set a custom font to be used in your notes. If this option is disabled, the default system font will be used. Enable or disable this checkbox using the mouse or the key combination <keycombo><keycap>Alt</keycap><keycap>F</keycap></keycombo>.</para>
 
619
          </listitem>
 
620
        </varlistentry>
 
621
      </variablelist>
 
622
 
 
623
      <figure id="pref-editing">
 
624
        <title>Tomboy Editing Preferences</title>
 
625
 
 
626
        <mediaobject>
 
627
          <imageobject>
 
628
            <imagedata fileref="figures/tomboy-preferences-editing.png"/>
 
629
          </imageobject>
 
630
        </mediaobject>
 
631
      </figure>
 
632
    </sect2>
 
633
 
 
634
    <sect2>
 
635
      <title>Hotkeys</title>
 
636
 
 
637
      <para>The hotkeys section allows you to set global key combinations to perform different functions in Tomboy. In order to set key combinations, you must have the <guibutton>Listen for Hotkeys</guibutton> checkbox enabled. Use <keycombo><keycap>Alt</keycap><keycap>H</keycap></keycombo> to toggle this option.</para>
 
638
 
 
639
      <variablelist>
 
640
        <varlistentry>
 
641
          <term>Show notes menu</term>
 
642
 
 
643
          <listitem>
 
644
            <para>Enter the key combination to open the notes menu.</para>
 
645
          </listitem>
 
646
        </varlistentry>
 
647
 
 
648
        <varlistentry>
 
649
          <term>Open "Start Here"</term>
 
650
 
 
651
          <listitem>
 
652
            <para>Enter the key combination to open the <quote>Start Here</quote> note, which is preinstalled with Tomboy.</para>
 
653
          </listitem>
 
654
        </varlistentry>
 
655
 
 
656
        <varlistentry>
 
657
          <term>Create new note</term>
 
658
 
 
659
          <listitem>
 
660
            <para>Enter the key combination to create a new note.</para>
 
661
          </listitem>
 
662
        </varlistentry>
 
663
 
 
664
        <varlistentry>
 
665
          <term>Search notes</term>
 
666
 
 
667
          <listitem>
 
668
            <para>Enter the key combination to open the <interface>Search All Notes</interface> dialogue.</para>
 
669
          </listitem>
 
670
        </varlistentry>
 
671
      </variablelist>
 
672
 
 
673
      <figure>
 
674
        <title>Tomboy Hotkey Preferences</title>
 
675
 
 
676
        <mediaobject>
 
677
          <imageobject>
 
678
            <imagedata fileref="figures/tomboy-preferences-hotkeys.png"/>
 
679
          </imageobject>
 
680
        </mediaobject>
 
681
      </figure>
 
682
    </sect2>
 
683
 
 
684
    <sect2 id="prefs-plugins">
 
685
      <title>Plugins</title>
 
686
 
 
687
      <para>The plugins section allows you to enable and configure Tomboy Plugins.</para>
 
688
      
 
689
      <para>The list of installed plugins shows on the left. A plugin is enabled by placing a check in the checkbox. Disable a plugin by unchecking its checkbox.</para>
 
690
      
 
691
      <para>Please see the <xref linkend="plugins"/> section for more information about the plugins that are installed with Tomboy.</para>
 
692
 
 
693
      <figure>
 
694
        <title>Tomboy Plugin Preferences</title>
 
695
 
 
696
        <mediaobject>
 
697
          <imageobject>
 
698
            <imagedata fileref="figures/tomboy-preferences-plugins.png"/>
 
699
          </imageobject>
 
700
        </mediaobject>
 
701
      </figure>
 
702
    </sect2>
 
703
  </sect1>
 
704
 
 
705
  <sect1 id="plugins">
 
706
    <title>Plugins</title>
 
707
 
 
708
    <para>By default, Tomboy comes with several pre-installed plugins: <simplelist type="inline"><member>Backlinks</member><member>Bugzilla URL Drop</member><member>Evolution Mail Drop</member><member>Export to HTML</member><member>Fixed Width</member><member>Note of the Day</member><member>Print Notes</member><member>and Sticky Notes Import.</member></simplelist> Since these are pre-installed, they are ready to use and are automatically loaded into the Tomboy interface.</para>
 
709
 
 
710
    <note>
 
711
      <para>Some plugins exist that are not installed by default.</para>
 
712
    </note>
 
713
 
 
714
    <variablelist>
 
715
      <varlistentry>
 
716
        <term>Backlinks (What links here?)</term>
 
717
 
 
718
        <listitem>
 
719
          <para>This plugin allows you to know which notes link to the note you're currently editing. It makes it easier to keep track of the relationships between notes. If this plugin is enabled, the <link linkend="tools">Tools</link> menu will have a <guimenuitem>What links here?</guimenuitem> option. When you select this option, it will list all the notes which link to the current note in a submenu. Select a note in the submenu to open it.</para>
 
720
        </listitem>
 
721
      </varlistentry>
 
722
 
 
723
      <varlistentry>
 
724
        <term>Bugzilla URL Drop</term>
 
725
 
 
726
        <listitem>
 
727
          <para>Allows you to drag a Bugzilla URL from your browser directly into a Tomboy note. The bug number is inserted as a link with a small bug icon next to it. Once the Bugzilla link has been inserted into the note, click on it to open the URL in your web browser.</para>
 
728
          
 
729
          <para>Customise the icons that are used by editing the plugin's settings in the <link linkend="prefs-plugins">Preferences Dialogue</link>. After highlighting the Bugzilla Plugin, click <guibutton>Settings</guibutton> to open the <interface>Bugzilla PluginSettings</interface> dialogue. To add a new icon, click <guibutton>Add</guibutton>, select an icon on your computer, provide a Bugzilla host name (e.g., bugzilla.gnome.org), and click <guibutton>Open</guibutton>. Any Bugzilla URL that is dragged and dropped from one of these custom host names will now use the icon you specified.</para>
 
730
        </listitem>
 
731
      </varlistentry>
 
732
 
 
733
      <varlistentry>
 
734
        <term>Evolution Mail Drop</term>
 
735
 
 
736
        <listitem>
 
737
          <para>This plugin allows you to drag and drag an e-mail message from the <application>Evolution</application> mail application to one of your Tomboy notes. Clicking on the mail icon in the note will then open the corresponding e-mail message in Evolution.</para>
 
738
        </listitem>
 
739
      </varlistentry>
 
740
 
 
741
      <varlistentry>
 
742
        <term>Export to HTML</term>
 
743
 
 
744
        <listitem>
 
745
          <para>When this plugin is installed, the <link linkend="tools">Tools</link> menu will have the <guimenuitem>Export to HTML</guimenuitem> option available.</para>
 
746
 
 
747
          <para>After selecting this option, you will be presented with a dialogue that allows you to choose where to save the <acronym>HTML</acronym> file. Enter the destination filename and click <guibutton>OK</guibutton> to save the file, or <guibutton>Cancel</guibutton> to abort the operation.</para>
 
748
 
 
749
          <para>To export any notes for which a link exists in the current note, select the <guibutton>Export linked notes</guibutton> button.</para>
 
750
        </listitem>
 
751
      </varlistentry>
 
752
 
 
753
      <varlistentry>
 
754
        <term>Fixed Width</term>
 
755
 
 
756
        <listitem>
 
757
          <para>Allows you to use a fixed-width font when creating/editing notes. If this plugin is enabled, the <link linkend="text">Text</link> menu will have a <guimenuitem>Fixed Width</guimenuitem> option.</para>
 
758
        </listitem>
 
759
      </varlistentry>
 
760
 
 
761
      <varlistentry>
 
762
        <term>Note of the Day</term>
 
763
 
 
764
        <listitem>
 
765
          <para>This plugin automatically creates a "Today" note for jotting daily thoughts down. The current date is used as a basis for the title of the note. As an example, the title of a "Today" note created on February 28, 2007, would be, "Today: Wednesday, February 28 2007"</para>
 
766
          
 
767
          <para>If you leave a "Today" note unmodified, the Note of the Day Plugin will automatically delete the note.</para>
 
768
          
 
769
          <para>To customise the content of the default "Today" note, create a new note and change the title of the note to be, "Today: Template". Change the content of the template note to whatever you'd like. When new "Today" notes are created, it will then use the content of your "Today: Template" note.</para>
 
770
        </listitem>
 
771
      </varlistentry>
 
772
 
 
773
      <varlistentry>
 
774
        <term>Print Notes</term>
 
775
 
 
776
        <listitem>
 
777
          <para>When this plugin is installed, the <link linkend="tools">Tools</link> menu will have the <guimenuitem>Print</guimenuitem> option available.</para>
 
778
 
 
779
          <para>Select this option to print the current note. You will be presented with the standard GNOME print dialogue.</para>
 
780
        </listitem>
 
781
      </varlistentry>
 
782
 
 
783
      <varlistentry>
 
784
        <term>Sticky Notes Import</term>
 
785
 
 
786
        <listitem>
 
787
          <para>When this plugin is installed, the <link linkend="tools">Tools</link> menu will have the <guimenuitem>Import from Sticky Notes</guimenuitem> option available.</para>
 
788
 
 
789
          <para>Use this option to import notes from the <application>Sticky Notes</application> application that is available in prior releases of GNOME. This option has been included in Tomboy to provide an upgrade path for users who would like to migrate from <application>Sticky Notes</application> to Tomboy for their note taking purposes.</para>
 
790
        </listitem>
 
791
      </varlistentry>
 
792
    </variablelist>
 
793
  </sect1>
 
794
</article>