Copyright © 2000 Matt Johnston
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".
This handbook describes how to use KJots 0.5, a small program which is handy for keeping miscellaneous notes.
Table of Contents
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.
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.
Tip
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
- File->New Book... (Ctrl+N)
Creates a new Book
- File->Save current Book (Ctrl+S)
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.
- File->Quit (Ctrl+Q)
Quits KJots
The Edit Menu
- Edit->Cut (Ctrl+X)
Cuts the currently selected text in the main textbox and places it on the clipboard.
- Edit->Copy (Ctrl+C)
Copies the currently selected text in the main textbox and places it on the clipboard.
- Edit->Paste (Ctrl+V)
Pastes text from the clipboard to the main textbox.
- Edit->Find... (Ctrl+F)
Searches for text in the main textbox. Note that this only searches the current page.
- Edit->Find Next (F3)
Searches for the next occurance of the search text (specified with Find).
- Edit->Replace... (Ctrl+R)
Replaces one bit of text with another, only on the current page.
- Edit->New Page (Ctrl+W)
Creates a new blank page in the current book.
- Edit->Delete Page (Ctrl+D)
Deletes the current page.
- Edit->Previous (Ctrl+J)
Changes the view to the previous page in the current book, if it exists.
- Edit->Next (Ctrl+K)
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
- Hotlist->Subject List (Ctrl+L)
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->Contents... (F1)
Invokes the KDE Help system starting at the KJots help pages. (this document).
- Help->What's This? (Shift+F1)
Changes the mouse cursor to a combination arrow and question mark. Clicking on items within KJots will open a help window (if one exists for the particular item) explaining the item's function.
- Help->Report Bug...
Opens the Bug report dialog where you can report a bug or request a ‘wishlist’ feature.
- Help->About KJots
This will display version and author information.
- Help->About KDE
This displays the KDE version and other basic information.
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>
This documentation is licensed under the terms of the GNU Free Documentation License.
This program is licensed under the terms of the GNU General Public License.
Installation
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
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 no trouble compiling it. Should you run into problems please report them to the KDE mailing lists.
Configuration