# The &kjots; Handbook

Matt
Johnston

    matt.kde@caifex.org

Christoph
Neerfield

    Christoph.Neerfield@home.ivm.de

Developer
Lauri
Watts

    lauri@kde.org

Reviewer
2000
Matt Johnston
&FDLNotice;
2000-12-14
0.05.00

This handbook describes how to use &kjots; 0.5, a small program which is handy for keeping miscellaneous notes.

KDE
KJots
kdeutils
notes
organiser

## Introduction

&kjots; is a small program that helps you to write down some short notes and organizes them for you.

## Using &kjots;

&kjots; has two basic items used to organise your notes - Books and Pages.

You can create a number of books in &kjots;, and each book can contain a number of pages, where you actually type your notes. Each book should be given a name (so you can find what you are looking for), as should each page. Although you aren't forced to give a page a name, it is sensible to do so.

### Using Books

To create a new book, use &Ctrl; N or the menu entry File New Book, and you will be prompted to enter a name for the new book.

The name of the new book should now appear in the bottom left hand corner of the window. If you want the book to be on your Hotlist, choose Hotlist Add Current Book to Hotlist and a button with the book's name will appear near the bottom of the screen. You can have up to 8 books on the hotlist, and can remove the current book using Hotlist Remove current book from hotlist.

A book can be saved using &Ctrl; S or the menu entry File Save Current Book. When you change books, or exit &kjots;, the currently open book will be saved.

You can also export an entire book as a text file, using File Save Book to ASCII File. You will be then prompted to enter a location for the file to be saved. The format of an example saved book is shown below:

    ############
    # First page
    ############
    Remember to go to the shops!

    #############
    # Useful code
    #############
    10 PRINT "HELLO WORLD"
    20 GOTO 10

    ################
    # The third page
    ################
    This is the third page and is an example for KJots.

### Using Pages

Pages are where you actually write whatever you are going to write. Once you have created a book, you can type text in the main text box.

To create additional pages, you can use Edit New Page , which will create a new page. Similarly, the current page can be removed using Edit Delete Page .

So that you can get to the page you want to see, pages can (and should) be given a Subject. This can be chosen by typing the subject in the textbox at the bottom of the window. To view a list of subjects for the current book, use &Ctrl; L or the menu entry Hotlist Subject List .

To quickly switch between pages, use &Ctrl; K to go to the next page, and &Ctrl; J to go to the previous page. You can also use the scrollbar below the main text window, to change pages.

If you select a &URL;, such as http://www.kde.org, or ftp://ftp.kde.org, and then right click on the selected text, you can choose to open the &URL; in &konqueror;, or any program you choose in Options Configure KJots.

## Command Reference

### The File Menu

&Ctrl;N File New Book...

  Creates a new Book

&Ctrl;S File Save current Book

  Saves the currently open Book. Books are saved in `$HOME/.kde/share/apps/kjots/` Each book is saved as a single file, they are readable in any text editor.

File Save Book to ASCII File

  Saves the current book to a text file. See Using Books.

File Save Page to ASCII File

  Saves the current page to a text file.

File Delete Current Book

  Deletes the currently open Book.

&Ctrl;Q File Quit

  Quits &kjots;

### The Edit Menu

&Ctrl;X Edit Cut

  Cuts the currently selected text in the main textbox and places it on the clipboard.

&Ctrl;C Edit Copy

  Copies the currently selected text in the main textbox and places it on the clipboard.

&Ctrl;V Edit Paste

  Pastes text from the clipboard to the main textbox.

&Ctrl;F Edit Find...

  Searches for text in the main textbox. Note that this only searches the current page.

F3 Edit Find Next

  Searches for the next occurance of the search text (specified with Find).

&Ctrl;R Edit Replace...

  Replaces one bit of text with another, only on the current page.

&Ctrl;W Edit New Page

  Creates a new blank page in the current book.

&Ctrl;D Edit Delete Page

  Deletes the current page.

&Ctrl;J Edit Previous

  Changes the view to the previous page in the current book, if it exists.

&Ctrl;K Edit Next

  Changes the view to the next page in the current book, if it exists.

### The Hotlist Menu

Hotlist Add Current Book to Hotlist

  Adds the current book to the hotlist. See Using Books

Hotlist Remove Current Book from Hotlist

  Removes the current book to the hotlist. See Using Books

&Ctrl;L Hotlist Subject List

  Shows the subject list for the current book, allowing you to select which page to view.

### The Options Menu

Settings Configure Shortcuts...

  Choose shortcut keys for various menu items.

Settings Configure KJots...

  Configure options for &kjots;, including the external program to open URLs and the font to use.

### The Help Menu

&help.menu.documentation;

## Credits and License

&kjots;

Program copyright 1997 Christoph Neerfeld Christoph.Neerfeld@home.ivm.de

Based on the `jots` program included in the tkgoodstuff package. The tkgoodstuff package is copyright 1995-96 Mark Crimmins markcrim@umich.edu

Documentation copyright 2000 Matt Johnston matt.kde@caifex.org

Some parts taken from documentation copyright 1998 Christoph Neerfeld Christoph.Neerfeld@home.ivm.de

&underFDL;

&underGPL;

## Installation

### How to obtain &kjots;

&install.intro.documentation;

### Requirements

In order to successfully use &kjots;, you need &kde; 2.x. There are no other requirements.

### Compilation and Installation

&install.compile.documentation;

### Configuration

&kjots; is a nice small program, and you don't have do do anything before running it.

&documentation.index;