1
1
<?xml version="1.0" encoding="utf-8"?>
2
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 "August 2006">
3
<!ENTITY date "February 2007">
4
4
<!ENTITY app "<application>Tomboy Notes</application>">
5
5
<!ENTITY appname "Tomboy">
6
6
<!ENTITY extappname "Tomboy Notes">
7
<!ENTITY manversion "1.0">
8
<!ENTITY version "0.3.10">
7
<!ENTITY manversion "2.0">
8
<!ENTITY version "0.6.0">
11
11
(Do not remove this comment block.)
84
90
<address><email>gnome@nextreality.net</email></address>
94
<author role="maintainer">
95
<firstname>Boyd</firstname>
97
<surname>Timothy</surname>
100
<orgname>Proyecto de documentación de GNOME</orgname>
102
<address><email>btimothy@gmail.com</email></address>
88
106
<!-- This is appropriate place for other contributors: translators,
89
107
maintainers, etc. Commented out by default.
107
125
than the current revision. -->
110
<revnumber>Tomboy Manual 1.0</revnumber>
128
<revnumber>Tomboy Manual 2.0</revnumber>
112
<date>2006-08-07</date>
130
<date>2007-02-28</date>
115
<para role="author">Brent Smith</para>
133
<para role="author">Boyd Timothy</para>
117
135
<para role="publisher">Proyecto de documentación de GNOME</para>
118
136
</revdescription>
122
<releaseinfo>This manual describes version 0.3.10 of Tomboy</releaseinfo>
140
<releaseinfo>This manual describes version 0.6.0 of Tomboy</releaseinfo>
125
143
<title>Comentarios</title>
231
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>
233
<para>The note can be editted 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>
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>
235
257
<para>Using the toolbar available on each note is discussed in the section <xref linkend="working-with-notes"/>.</para>
270
<sect2 id="search-all-notes">
249
271
<title>Table of Contents</title>
251
<para>To get an overview of all the notes managed by Tomboy, select the <menuchoice><guimenuitem>Table of Contents</guimenuitem></menuchoice> menu item from the panel menu. By default, the <interface>Table of Contents</interface> dialog 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>
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> dialog 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>
275
<para>You can find specific notes by entering text into the search field in the <interface>Search All Notes</interface> dialog. The list of notes will automatically update to list only the notes which have matching text.</para>
277
<para>To open a note in the <interface>Search All Notes</interface> dialog, do one of the following:</para>
281
<para>Double-click on a note.</para>
285
<para>Highlight a note by selecting it and then select <menuchoice><guimenuitem>Open</guimenuitem></menuchoice> from the <guimenuitem>File</guimenuitem> menu.</para>
289
<para>Right-click on a note and select <menuchoice><guimenuitem>Open</guimenuitem></menuchoice> from the context menu that appears.</para>
293
<para>Highlight a note by selecting it and then press the key combination <keycombo><keycap>Ctrl</keycap><keycap>O</keycap></keycombo>.</para>
257
301
<sect1 id="working-with-notes">
258
302
<title>Working With Notes</title>
260
<para>Notes are modified and editted through the main window for each note. The toolbar at the top of each note allows you to stylize the note and perform other note-related functions. We discuss the functions of each item on the toolbar in the following sections.</para>
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 stylize the note and perform other note-related functions. We discuss the functions of each item on the toolbar in the following sections.</para>
262
306
<sect2 id="search">
263
307
<title>Search</title>
265
<para>Clicking the <guibutton>Search</guibutton> button will open a new dialog titled <guilabel>Search Note</guilabel>. Enter the text to search for, within the current note. Occurrences of this text will be highlighted in the note to allow quick identification.</para>
267
<para>Use the <guibutton>Find Next</guibutton> button to move focus to the next occurrence of the text within the current note. Similarly, you can use the <guibutton>Previous</guibutton> button to move focus to the previous occurrence of the text within the current note.</para>
269
<para>There are also different options you can set when performing a search. Both options are explained next.</para>
272
<title>Search Note Options</title>
275
<term>Case Sensitive</term>
278
<para>Select this checkbox to make the search distinguish between uppercase and lowercase characters.</para>
283
<term>Search All Notes</term>
286
<para>This option expands the <guilabel>Search Note</guilabel> dialog, and will display a list of notes which contain the search text. The number of occurrences of the text is also displayed next to the note.</para>
309
<para>Clicking the <guibutton>Search</guibutton> button will open the <interface>Search All Notes</interface> dialog described earlier (<xref linkend="search-all-notes"/>.)</para>
292
312
<sect2 id="link">
377
<term>Fixed Width</term>
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>
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>
357
387
<term>Font size</term>
360
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>
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>
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>
402
<para>For more information on bullets, see <xref linkend="bullets"/>.</para>
407
<term>Find in This Note</term>
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>
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>
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>
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>
473
<!--=========== Panel Menu ====================================== -->
475
<sect1 id="panel-menu">
476
<title>Panel Menu</title>
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>
480
<sect2 id="note-pinning">
481
<title>Note Pinning</title>
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>
486
<title>Tomboy Panel Menu</title>
490
<imagedata fileref="figures/tomboy-main-menu.png"/>
497
<!--=========== Bulleted Lists ================================== -->
500
<title>Bulleted Lists</title>
502
<sect2 id="bullet-start">
503
<title>Begin a bulleted list</title>
505
<para>You may begin a bulleted list by using one of the following methods:</para>
509
<para>Select <menuchoice><guimenuitem>Bullets</guimenuitem></menuchoice> from the <guibutton>Text</guibutton> dropdown menu.</para>
513
<para>Begin a line with a single dash character (-), type some text immediately following the dash, and press <keycap>Enter</keycap>.</para>
518
<sect2 id="bullet-end">
519
<title>End a bulleted list</title>
521
<para>End a bulleted list by doing one of the following:</para>
525
<para>Select <menuchoice><guimenuitem>Bullets</guimenuitem></menuchoice> from the <guibutton>Text</guibutton> dropdown menu.</para>
529
<para>Press <keycap>Enter</keycap> on a blank bulleted line.</para>
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>
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>
542
<sect2 id="bullet-increase-indent">
543
<title>Increase Indentation</title>
545
<para>To increase the line indentation in a bulleted list with the mouse:</para>
549
<para>Select <menuchoice><guimenuitem>Increase Indent</guimenuitem></menuchoice> from the <guibutton>Text</guibutton> dropdown menu.</para>
553
<para>To increase the line indentation in a bulleted list with the keyboard:</para>
557
<para>Press the <keycap>Tab</keycap> key.</para>
562
<sect2 id="bullet-decrease-indent">
563
<title>Decrease Indentation</title>
565
<para>To decrease the line indentation in a bulleted list with the mouse:</para>
569
<para>Select <menuchoice><guimenuitem>Decrease Indent</guimenuitem></menuchoice> from the <guibutton>Text</guibutton> dropdown menu.</para>
573
<para>To decrease the line indentation in a bulleted list with the keyboard:</para>
577
<para>Press the key combination <keycombo><keycap>Shift</keycap><keycap>Tab</keycap></keycombo>.</para>
410
584
<title>Preferences</title>
684
<sect2 id="prefs-plugins">
685
<title>Plugins</title>
687
<para>The plugins section allows you to enable and configure Tomboy Plugins.</para>
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>
691
<para>Please see the <xref linkend="plugins"/> section for more information about the plugins that are installed with Tomboy.</para>
694
<title>Tomboy Plugin Preferences</title>
698
<imagedata fileref="figures/tomboy-preferences-plugins.png"/>
511
705
<sect1 id="plugins">
512
706
<title>Plugins</title>
514
<para>By default, Tomboy comes with several pre-installed plugins: <simplelist type="inline"><member>Evolution Mail Drop</member><member>Export to HTML</member><member>Print Notes</member><member>and Sticky Notes Import.</member></simplelist> Since these are preinstalled, they are ready to use and are automatically loaded into the Tomboy interface.</para>
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 preinstalled, they are ready to use and are automatically loaded into the Tomboy interface.</para>
517
711
<para>Some plugins exist that are not installed by default.</para>
716
<term>Backlinks (What links here?)</term>
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>
724
<term>Bugzilla URL Drop</term>
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>
729
<para>Customize the icons that are used by editing the plugin's settings in the <link linkend="prefs-plugins">Preferences Dialog</link>. After highlighting the Bugzilla Plugin, click <guibutton>Settings</guibutton> to open the <interface>Bugzilla PluginSettings</interface> dialog. 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>
522
734
<term>Evolution Mail Drop</term>
754
<term>Fixed Width</term>
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>
762
<term>Note of the Day</term>
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>
767
<para>If you leave a "Today" note unmodified, the Note of the Day Plugin will automatically delete the note.</para>
769
<para>To customize 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>
542
774
<term>Print Notes</term>