A mock documentation based on this Documentation Design.

Contents

  1. General Information
  2. Getting It
    1. Generic Install
    2. Linux Repositories
  3. Using Tomboy
    1. Create a Note
      1. Create a Note Within A Notebook
    2. Delete a Note
      1. Method 1
      2. Method 2
    3. Creating a Notebook
    4. Linking Notes
    5. Searching Notes
    6. Formatting Text
    7. Syncing Notes
  4. Customizing It
  5. Getting Support
  6. Contributing

General Information

Tomboy is a desktop note-taking application for Linux, Unix, Windows, and Mac OS X. Simple and easy to use, but with potential to help you organize the ideas and information you deal with every day.

Tomboy features:

  • Highlighting text
  • Inline spell checking

  • Auto-linking web & email addresses

  • Undo/redo

  • Font styling & sizing

  • Bulleted lists

Getting It

Generic Install

Tomboy is available for use on multiple operating systems:

Linux Repositories

  1. Debian Based (Ubuntu, Linux Mint, etc.)
    • sudo apt-get install tomboy
  2. Fedora
    • sudo yum install tomboy

Linux users may check with their specific distribution for software installation instructions.

Using Tomboy

Create a Note

Keyboard Shortcut: Ctrl+N (Linux / Windows)

  1. Click File from the upper menu
  2. Select New

Create a Note Within A Notebook

  1. Right click on the notebook in the Notebooks list

  2. Select New Note

Delete a Note

Keyboard Shortuct: [Delete]

Method 1

  1. Right click on the note in the search area

  2. Select Delete

  3. Confirm your deletion

Method 2

  1. Open the note

  2. Click the Delete Note button

  3. Confirm your deletion

note-delete.png

Creating a Notebook

  1. From the top menu, select File

  2. Under Notebooks, select New Notebook...

  3. Enter a name for your Notebook

  4. Click Create

Linking Notes

Keyboard Shortcut: Ctrl+L (Linux / Windows)

  1. Select the text to create a link to.
  2. Click the Link button

note-link1.png

Clicking Link, creates the new Note for the selected text.

note-link2.png

In this example, the text is now linked back in the original document. Everytime GNOME would be typed, it would now link to the GNOME note.

note-link3.png

Notes in Tomboy can be linked together by highlighting text in the current note and clicking the Link button. Doing so will create a new note and also underline the note's title in the current note.

Changing the title of a note will update links present in other notes. This prevents broken links from occurring when a note is renamed.

Also, if you type the name of another note in your current note, it will automatically be linked for you.

Searching Notes

  1. Open the search box
  2. In the search text box, enter the words to search for

search-small.png

Formatting Text

Text formatting can be set by clicking the Text button inside a note. Text formatting can be preset before typing, or text may be highlighted and then a text formatting style can be applied to the highlighted region.

note-formatting.png

Syncing Notes

Customizing It

Official & Third-party Tomboy add-ins

Getting Support

To get support regarding Tomboy use, please visit the IRC channel:

  • IRC: #tomboy on irc.gnome.org

Contributing

Get Involved

Apps/Tomboy/PlaceForNewIdeas/TomboyDocumentation (last edited 2013-08-09 00:14:59 by WilliamJonMcCann)