# The &kjots; Handbook

Matt
Johnston

    matt.kde@caifex.org

Christoph
Neerfield

    Christoph.Neerfield@home.ivm.de

Developer
Lauri
Watts

    vampyr@atconnex.net

Reviewer
2000
Matt Johnston
&FDLNotice;
14/12/2000
0.5.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.

### &kjots; Revision History

(Carsten Pfeiffer pfeiffer@kde.org)

  - use `KEdit` instead of `QMultiLineEdit` directly, adding Search & replace + undo

  - allocate `KTMainWindow` on the heap to avoid double deletion on quit

New in version 0.4 (Mario Weilguni mweilguni@kde.org)

  - works now with Qt 2.0

  - fixed broken layout of main window

  - layout improvements in `AskFileName()`

  - layout improvements in `SubjList()`

  - compiles without warnings

  - Apply button is only activated when changes were made

  - improved layout of configuration dialog

  - fixed a bug in the font selection

  - now compiles with EGCS ( Robert Williams )

New in version 0.3.0

  - added lots of keyboard shortcuts

  - added `klocale->translate()`

New in version 0.2.6

  - icons should be visible in the toolbar

New in version 0.2.5

  - you may save books and pages to an ascii file

  - more kde conforming due to the use of `KTopLevelWidget`

New in version 0.2.4

  - uses `KFontDialog` to set the font of the editor widget

  - you may select an URL in your text and press the &RMB; to execute a program with this URL. The program to execute is configurable for &HTTP; and &FTP; URLs.

  - some code cleanup

New in version 0.2.3

  - compiles with libkde-970510 (no longer relevant)

  - shouldn't segfault, if you delete pages

  - double clicking on an entry in the subjectlist closes the subjectlist window

  - fixed fonds -> fonts ;)

New in version 0.2.2

  - compiles with libkde-0.7.2 (no longer relevant)

  - several bug fixes

New in version 0.2.1

  - should compile cleanly with libqt1.2 and libkde-0.7.1 and later (no longer relevant)

New in version 0.2.0

  - changed the layout to be more KDE conforming (toolbar, statusbar,...)

  - folders are now called books and entries are pages

  - added subject to each page

  - you may popup a window with a list of all subjects and use it to find pages more easily

  - further reduced the minimum size of the window

New in version 0.1.1

  - does not delete empty lines anymore

  - you may insert TABs into your text

  - the minimum size of the window is smaller now

  - the size of the window is saved and read the next time &kjots; is started

Version 0.1 (presumed)

  - Original release

## 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

CtrlN File New Book...

  Creates a new Book

CtrlS 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.

CtrlQ File Quit

  Quits &kjots;

### The Edit Menu

CtrlX Edit Cut

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

CtrlC Edit Copy

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

CtrlV Edit Paste

  Pastes text from the clipboard to the main textbox.

CtrlF 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).

CtrlR Edit Replace...

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

CtrlW Edit New Page

  Creates a new blank page in the current book.

CtrlD Edit Delete Page

  Deletes the current page.

CtrlJ Edit Previous

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

CtrlK 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

CtrlL Hotlist Subject List

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

### The Options Menu

Options Configure Key Bindings...

  Choose shortcut keys for various menu items.

Options Configure KJots...

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

### The Help Menu

F1 Help Contents

  Displays this help file.

ShiftF1 Help What's This

  Changes the cursor and should show help when you click on various items on the screen. Not currently working.

Help Report Bug...

  Allows you to report a bug in &kjots;.

Help About KJots

  Shows information about &kjots;.

Help About KDE

  Shows information about KDE.

## 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;

&kjots; is part of the KDE project http://www.kde.org. &kjots; can be found in the kdeutils package on ftp://ftp.kde.org/pub/kde/, the main ftp site of the KDE project.

### Requirements

In order to successfully use &kjots;, you need KDE 2.0. There are no other requirements.

### Compilation and installation

In order to compile and install &kjots; on your system, type the following in the base directory of the &kjots; distribution:

    % ./configure
    % make
    % make install

Since &kjots; uses autoconf and automake you should have not trouble compiling it. Should you run into problems please report them to the KDE mailing lists.

### Configuration

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

&kdedocindex;