A mock documentation based on this Documentation Design.
Contents
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
1. Generic Install
Tomboy is available for use on multiple operating systems:
2. Linux Repositories
- Debian Based (Ubuntu, Linux Mint, etc.)
- sudo apt-get install tomboy
- Fedora
- sudo yum install tomboy
Linux users may check with their specific distribution for software installation instructions.
Using Tomboy
1. Create a Note
Keyboard Shortcut: Ctrl+N (Linux / Windows)
- Click File from the upper menu
- Select New
1.1. Create a Note Within A Notebook
Right click on the notebook in the Notebooks list
Select New Note
2. Delete a Note
Keyboard Shortuct: [Delete]
2.1. Method 1
- Right click on the note in the search area
Select Delete
- Confirm your deletion
2.2. Method 2
- Open the note
Click the Delete Note button
- Confirm your deletion
3. Creating a Notebook
From the top menu, select File
Under Notebooks, select New Notebook...
- Enter a name for your Notebook
Click Create
4. Linking Notes
Keyboard Shortcut: Ctrl+L (Linux / Windows)
- Select the text to create a link to.
- Click the Link button
Clicking Link, creates the new Note for the selected text.
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.
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.
5. Searching Notes
- Open the search box
- In the search text box, enter the words to search for
6. 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.
7. 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