<?xml version="1.0" ?> <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ <!-- nothing below must be removed --> <!ENTITY kappname "&kjots;"> <!ENTITY package "kdepim"> <!ENTITY % addindex "IGNORE"> <!ENTITY % English "INCLUDE"> ]> <book lang="&language;"> <bookinfo> <title>The &kjots; Handbook</title> <authorgroup> <author> <firstname>Matt</firstname> <surname>Johnston</surname> <affiliation> <address><email>matt.kde@caifex.org</email></address> </affiliation> </author> <othercredit role="developer"> <firstname>Christoph</firstname> <surname>Neerfield</surname> <affiliation> <address>&Christoph.Neerfield.mail;</address> </affiliation> <contrib>Developer</contrib> </othercredit> <othercredit role="reviewer"> <firstname>Lauri</firstname> <surname>Watts</surname> <affiliation> <address>&Lauri.Watts.mail;</address> </affiliation> <contrib>Reviewer</contrib> </othercredit> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> <copyright> <year>2000</year> <holder>&Matt.Johnston;</holder> </copyright> <legalnotice>&FDLNotice;</legalnotice> <date>2004-10-17</date> <releaseinfo>0.05.00</releaseinfo> <abstract><para>This handbook describes how to use &kjots; 0.5, a small program which is handy for keeping miscellaneous notes.</para></abstract> <keywordset> <keyword>KDE</keyword> <keyword>KJots</keyword> <keyword>kdepim</keyword> <keyword>notes</keyword> <keyword>organizer</keyword> </keywordset> </bookinfo> <chapter id="introduction"> <title>Introduction</title> <para>&kjots; is a small program that helps you to write down some short notes and organizes them for you.</para> </chapter> <chapter id="using-kjots"> <title>Using &kjots;</title> <para>&kjots; has two basic items used to organize your notes - <quote>Books</quote> and <quote>Pages</quote>.</para> <para>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.</para> <sect1 id="kjots-books"> <title>Using Books</title> <para>To create a new book, use <keycombo action="simul">&Ctrl;&Shift; <keycap>N</keycap></keycombo> or the menu entry <menuchoice><guimenu>File</guimenu><guimenuitem>New Book</guimenuitem></menuchoice>, and you will be prompted to enter a name for the new book.</para> <para>The name of the new book should now appear in the left part of the window. If you want the book to be in your <quote>Bookmarks</quote>, use <keycombo action="simul">&Ctrl; <keycap>B</keycap></keycombo> or the menu entry <menuchoice> <guimenu>Bookmarks</guimenu><guimenuitem>Add Bookmark</guimenuitem> </menuchoice>. You can even organize your bookmarks in separate folders just as you probably do in &konqueror;.</para> <tip><para>If you want to have your books in a different order, you can simply drag and drop the book to the place where you want it to be. </para></tip> <para>Maybe you have noticed that there is no <quote>Save</quote> anywhere. This is not an error, &kjots; saves your books and pages automatically, so you will never lose that small note you write when you are on the phone and need to write down something in a hurry.</para> <para>You can also export an entire book as a text file or as a html file, using <menuchoice><guimenu>File</guimenu> <guimenuitem>Export book... </guimenuitem></menuchoice>. 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:</para> <screen>############ # 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.</screen> <para>Remember that the dialog where you are prompted for a filename is a standard &kde; dialog. That means it is just as easy to store the file on your local hard disk as it is to save it on a web server, ftp server or USB memory stick. So you can export as html and save it on a webserver, this way you always have your notes available to you.</para> </sect1> <sect1 id="kjots-pages"> <title>Using Pages</title> <para>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.</para> <para>To create additional pages, you can use <keycombo action="simul">&Ctrl; <keycap>N</keycap></keycombo> or the menu entry <menuchoice><guimenu>File</guimenu><guimenuitem>New Page</guimenuitem> </menuchoice>, which will create a new page. Similarly, the current page can be removed using <menuchoice><guimenu>File</guimenu> <guimenuitem>Delete Page</guimenuitem></menuchoice>.</para> <tip><para>If you need to insert the current date and time while you are writing a note, you can use <keycombo action="simul">&Ctrl;&Shift;<keycap>I </keycap></keycombo>.</para></tip> <para>So that you can get to the page you want to see, pages can (and should) be given a name. This can be done in the way you are used to: double click the page you want to rename. You are then able to rename the page. Of course there is also a keyboard shortcut, you can use that at any time while writing a note. The shortcut is: <keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo>.</para> <para>An other way of renaming the page is by selecting a part of your note and then press <keycombo action="simul">&Ctrl;<keycap>T</keycap></keycombo>, the selected text will instantly become the title of the page.</para> <tip><para>If you want fast access to a particular page, you can assign a keyboard shortcut to that page. Go to <menuchoice> <guimenu>Settings</guimenu><guimenuitem>Configure Shortcuts... </guimenuitem></menuchoice>.</para></tip> </sect1> </chapter> <chapter id="commands"> <title>Command Reference</title> <sect1 id="menu-file"> <title>The <guimenu>File</guimenu> Menu</title> <variablelist> <varlistentry> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> </shortcut> <guimenu>File</guimenu> <guimenuitem>New Page...</guimenuitem> </menuchoice></term> <listitem><para><action>Creates</action> a new Page.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;&Shift;<keycap>N</keycap></keycombo> </shortcut> <guimenu>File</guimenu> <guimenuitem>New Book...</guimenuitem> </menuchoice></term> <listitem><para><action>Creates</action> a new Book.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <guimenu>File</guimenu> <guimenuitem>Export Page</guimenuitem> </menuchoice></term> <listitem><para><action>Saves</action> the current page to a text file or a html file.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <guimenu>File</guimenu> <guimenuitem>Export Book</guimenuitem> </menuchoice></term> <listitem><para><action>Saves</action> the current book to a text file or a html file.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <guimenu>File</guimenu> <guimenuitem>Delete Page</guimenuitem> </menuchoice></term> <listitem><para><action>Deletes</action> the current page.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <guimenu>File</guimenu> <guimenuitem>Delete Book</guimenuitem> </menuchoice></term> <listitem><para><action>Deletes</action> the current book.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo> </shortcut> <guimenu>File</guimenu> <guimenuitem>Print</guimenuitem> </menuchoice></term> <listitem><para><action>Prints</action> the current book or page.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo> </shortcut> <guimenu>File</guimenu> <guimenuitem>Quit</guimenuitem> </menuchoice></term> <listitem><para><action>Quits</action> &kjots;.</para></listitem> </varlistentry> </variablelist> </sect1> <sect1 id="menu-edit"> <title>The <guimenu>Edit</guimenu> Menu</title> <variablelist> <varlistentry> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>X</keycap></keycombo> </shortcut> <guimenu>Edit</guimenu> <guimenuitem>Cut</guimenuitem> </menuchoice></term> <listitem><para><action>Cuts</action> the currently selected text in the main text box and places it on the clipboard.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo> </shortcut> <guimenu>Edit</guimenu> <guimenuitem>Copy</guimenuitem> </menuchoice></term> <listitem><para><action>Copies</action> the currently selected text in the main text box and places it on the clipboard.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo> </shortcut> <guimenu>Edit</guimenu> <guimenuitem>Paste</guimenuitem> </menuchoice></term> <listitem><para><action>Pastes</action> text from the clipboard to the main text box.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>T</keycap></keycombo> </shortcut> <guimenu>Edit</guimenu> <guimenuitem>Paste as Page Title</guimenuitem> </menuchoice></term> <listitem><para><action>Renames</action> the page to the text on the clipboard.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo> </shortcut> <guimenu>Edit</guimenu> <guimenuitem>Find...</guimenuitem> </menuchoice></term> <listitem><para><action>Searches</action> for text in the main text box. Note that this only searches the current page. </para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <shortcut> <keycombo><keycap>F3</keycap></keycombo> </shortcut> <guimenu>Edit</guimenu> <guimenuitem>Find Next</guimenuitem> </menuchoice></term> <listitem><para><action>Searches</action> for the next occurrence of the search text (specified with Find).</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo> </shortcut> <guimenu>Edit</guimenu> <guimenuitem>Replace...</guimenuitem> </menuchoice></term> <listitem><para><action>Replaces</action> one bit of text with another, only on the current page. </para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo> </shortcut> <guimenu>Edit</guimenu> <guimenuitem>Rename...</guimenuitem> </menuchoice></term> <listitem><para>Gives the possibility to <action>rename</action> the current page.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo> </shortcut> <guimenu>Edit</guimenu> <guimenuitem>Insert Date</guimenuitem> </menuchoice></term> <listitem><para><action>Inserts</action> the date and time in the current page.</para></listitem> </varlistentry> </variablelist> </sect1> <sect1 id="menu-bookmarks"> <title>The <guimenu>Bookmarks</guimenu> Menu</title> <variablelist> <varlistentry> <term><menuchoice> <shortcut> <keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo> </shortcut> <guimenu>Bookmarks</guimenu> <guimenuitem>Add bookmark</guimenuitem> </menuchoice></term> <listitem><para><action>Adds</action> the current page to the list of bookmarks. See <link linkend="kjots-books">Using Books</link>. </para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <guimenu>Bookmarks</guimenu> <guimenuitem>Edit bookmarks</guimenuitem> </menuchoice></term> <listitem><para><action>Edits</action> the bookmarks. Here you can search bookmarks, make comments, organize them in different folders and much more. </para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <guimenu>Bookmarks</guimenu> <guimenuitem>New Bookmark Folder</guimenuitem> </menuchoice></term> <listitem><para><action>Makes</action> a new folder where you can store your bookmarks.</para></listitem> </varlistentry> </variablelist> </sect1> <sect1 id="menu-settings"> <title>The <guimenu>Settings</guimenu> Menu</title> <variablelist> <varlistentry> <term><menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Hide/Show Toolbar</guimenuitem> </menuchoice></term> <listitem><para><action>Toggles</action> display of the toolbar below the menu bar.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure Shortcuts...</guimenuitem> </menuchoice></term> <listitem><para><action>Choose</action> shortcut keys for various menu items.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure Toolbars...</guimenuitem> </menuchoice></term> <listitem><para><action>Choose</action> which items are present in the toolbar.</para></listitem> </varlistentry> <varlistentry> <term><menuchoice> <guimenu>Settings</guimenu> <guimenuitem>Configure KJots...</guimenuitem> </menuchoice></term> <listitem><para><action>Configure</action> options for &kjots;, including the font to use and the settings for autosaving. </para></listitem> </varlistentry> </variablelist> </sect1> <sect1 id="menu-help"> <title>The <guimenu>Help</guimenu> Menu</title> &help.menu.documentation; </sect1> </chapter> <chapter id="credits"> <title>Credits and License</title> <para> &kjots; </para> <para> Program copyright 1997 Christoph Neerfeld <email>Christoph.Neerfeld@home.ivm.de</email> </para> <para> Based on the <command>jots</command> program included in the <application>tkgoodstuff</application> package. The <application>tkgoodstuff</application> package is copyright 1995-96 Mark Crimmins <email>markcrim@umich.edu</email> </para> <para> Documentation copyright 2000 &Matt.Johnston; <email>matt.kde@caifex.org</email> </para> <para> Some parts taken from documentation copyright 1998 Christoph Neerfeld <email>Christoph.Neerfeld@home.ivm.de</email> </para> <!-- TRANS:CREDIT_FOR_TRANSLATORS --> &underFDL; <!-- FDL: do not remove --> &underGPL; <!-- GPL License --> </chapter> <appendix id="installation"> <title>Installation</title> <sect1 id="getting-kjots"> <title>How to obtain &kjots;</title> &install.intro.documentation; </sect1> <sect1 id="requirements"> <title>Requirements</title> <para>In order to successfully use &kjots;, you need &kde; 2.x. There are no other requirements.</para> </sect1> <sect1 id="compilation"> <title>Compilation and Installation</title> &install.compile.documentation; </sect1> <sect1 id="configuration"> <title>Configuration</title> <para>&kjots; is a nice small program, and you don't have to do anything before running it.</para> </sect1> </appendix> &documentation.index; </book> <!-- Local Variables: mode: sgml sgml-minimize-attributes:nil sgml-general-insert-case:lower sgml-indent-step:0 sgml-indent-data:nil End: // vim:ts=2:sw=2:tw=78:noet -->