summaryrefslogtreecommitdiffstats
path: root/doc/en/index.docbook
diff options
context:
space:
mode:
authortpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2010-02-17 02:48:30 +0000
committertpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2010-02-17 02:48:30 +0000
commite1481e0a7c066357dfb67136f331b5f069d94f3c (patch)
tree19599adc9a54e8295402ceb25d6f2ea42edea439 /doc/en/index.docbook
downloadknowit-e1481e0a7c066357dfb67136f331b5f069d94f3c.tar.gz
knowit-e1481e0a7c066357dfb67136f331b5f069d94f3c.zip
Added abandoned KDE3 version of knowit
git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/applications/knowit@1091582 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'doc/en/index.docbook')
-rw-r--r--doc/en/index.docbook261
1 files changed, 261 insertions, 0 deletions
diff --git a/doc/en/index.docbook b/doc/en/index.docbook
new file mode 100644
index 0000000..fd1edb1
--- /dev/null
+++ b/doc/en/index.docbook
@@ -0,0 +1,261 @@
+<?xml version="1.0" ?>
+<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1-Based Variant V1.0//EN" "dtd/kdex.dtd" [
+ <!ENTITY knowit '<application>KnowIt</application>'>
+ <!ENTITY kapp "&knowit;"><!-- replace knowit here -->
+ <!ENTITY % addindex "IGNORE">
+ <!ENTITY % English "INCLUDE"><!-- change language only here -->
+
+
+ <!-- Do not define any other entities; instead, use the entities
+ from kde-genent.entities and $LANG/user.entities. -->
+]>
+
+
+<book lang="&language;">
+
+<bookinfo>
+<title>The KnowIt Handbook</title>
+
+<authorgroup>
+<author>
+<firstname>Michal</firstname>
+<othername></othername>
+<surname>Rudolf</surname>
+<affiliation>
+<address><email>[email protected]</email></address>
+</affiliation>
+</author>
+</authorgroup>
+
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+
+<copyright>
+<year>2002</year>
+<year>2003</year>
+<year>2004</year>
+<holder>Michal Rudolf</holder>
+</copyright>
+<!-- Translators: put here the copyright notice of the translation -->
+<legalnotice>&FDLNotice;</legalnotice>
+
+<date>31/03/2003</date>
+<releaseinfo>0.10</releaseinfo>
+
+<abstract>
+<para>
+&knowit; is an application to help you keep, edit and maintain notes.
+</para>
+</abstract>
+
+<keywordset>
+<keyword>KDE</keyword>
+<keyword>KnowIt</keyword>
+<keyword>notes</keyword>
+<keyword>manage</keyword>
+<keyword>edit</keyword>
+<keyword>tree</keyword>
+<keyword>hierarchy</keyword>
+<keyword>HTML</keyword>
+</keywordset>
+
+</bookinfo>
+
+<chapter id="introduction">
+<title>Introduction</title>
+
+<para>
+&kapp; is a simple tool for managing notes. It is similar to
+<ulink url="http://tuxcards.sourceforge.net">TuxCards</ulink>,
+but designed for KDE 3.x. Notes are organized in tree-like hierarchy,
+texts are stored in RichText format, so bold, italic and underline fonts
+are supported, as well as various text colors and unordered lists.
+</para>
+
+<para>
+&kapp; development depends on user's feedback! If you have
+suggestions or want to help developing &kapp;, have a look at the
+<ulink url="http://knowit.sourceforge.net">&kapp; page</ulink>
+to see what is still to do.
+</para>
+
+</chapter>
+
+<chapter id="using-kapp">
+<title>Using &knowit;</title>
+
+<sect1 id="Interface">
+<title>Interface</title>
+<para>
+
+The main screen of &knowit; is divided into two parts: on the left you can see the notes
+hierarchy (tree-like), on the right you can find the text of the current note.
+You can browse and manage notes in the tree view and edit them in the
+edit view.
+
+<screenshot>
+<screeninfo>Here's a screenshot of &kapp;</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="screenshot.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Screenshot</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+</para>
+
+<sect2 id="editing">
+<title>Editing notes</title>
+<para>
+You can use standard KDE shortcuts for editing text. Unordered lists are
+supported: just start the line with <keycap>*</keycap>. You can also use
+<guimenu>List</guimenu> submenu of <guimenu>Edit</guimenu> menu to get all
+available list formats.
+</para>
+
+<para>
+<keycap>Enter</keycap> inserts a new paragraph (as in HTML there
+is an empty line between two paragraphs) - if you
+just want a line break, use <keycap>Ctrl+Enter</keycap> instead.
+</para>
+</sect2>
+
+<sect2 id="managing">
+<title>Managing notes</title>
+<para>
+You can use shortcuts for adding notes. If the notes tree is active,
+just press <keycap>Ctrl+Enter</keycap> to add a same-level note following
+the current one, <keycap>Insert</keycap> to add a child-note and
+<keycap>Delete</keycap> to delete the current note.
+</para>
+
+<para>
+<guimenu>Notes</guimenu> menu or popup menu (accessed by right-clicking
+on the list) contains many commands for managing notes. Most of them
+have shortcuts assigned, for others you could assign them yourself.
+</para>
+</sect2>
+
+<sect2 id="links">
+<title>Links</title>
+<para>
+You can create links in notes. Links will be displayed below the note
+text. There are two kinds of links: <emphasis>external</emphasis> (to
+any file or URL) - click on it, and it will be opened in appropriate
+application, and <emphasis>internal</emphasis> (to another note) - click
+on it, and note with appropriate title will be displayed.
+</para>
+</sect2>
+</sect1>
+</chapter>
+
+<chapter id="about">
+<title>About &knowit;</title>
+
+<sect1 id="credits">
+<title>Credits and License</title>
+
+<para>
+Program and documentation:
+</para>
+<para>copyright 2002, 2003, 2004 Michal Rudolf <email>[email protected]</email>
+</para>
+&underFDL; <!-- FDL: do not remove. Commercial development should -->
+&underGPL; <!-- GPL License -->
+</sect1>
+
+<sect1 id="new">
+<title>New in this version</title>
+
+<para>
+<itemizedlist>
+<listitem><simpara>list editing commands</simpara></listitem>
+<listitem><simpara>improved handling of read-only files</simpara></listitem>
+<listitem><simpara>many improvements to export</simpara></listitem>
+<listitem><simpara>link copy command</simpara></listitem>
+<listitem><simpara>some shortcuts for links added</simpara></listitem>
+<listitem><simpara>fixed backup bugs</simpara></listitem>
+<listitem><simpara>warning when resource file is missing</simpara></listitem>
+</itemizedlist>
+
+&knowit; 0.10 was released at 31st of March 2003. File <filename>ChangeLog</filename> in
+source package contains information about changes in previous versions.
+</para>
+</sect1>
+</chapter>
+
+
+<appendix id="installation">
+<title>Installation</title>
+
+<sect1 id="getting-knowit">
+<title>How to obtain &knowit;</title>
+
+<para>
+Newest version of &knowit; can be found at
+<ulink url="href://knowit.sourceforge.net">knowit.sourceforge.net</ulink>.
+Updates will probably be announced on <ulink
+url="http://freshmeat.net">Freshmeat</ulink> and
+<ulink url="href://apps.kde.com">apps.kde.com</ulink>.
+</para>
+</sect1>
+
+
+<sect1 id="requirements">
+<title>Requirements</title>
+<para>
+I use KDE 3.1 for both developing and testing &knowit;. As
+far as I know, it should work in both KDE 3.2 and KDE 3.0 without any problems.
+</para>
+
+<para>
+I doubt that it would compile in KDE 2.x - but I have no access
+to older KDE versions to check it. Anyway, any information
+about &knowit; in KDE 2.x would be welcomed.
+</para>
+</sect1>
+
+<sect1 id="compilation">
+<title>Compilation and installation</title>
+<para>
+In order to compile and install &knowit; on your system, type the following
+in the base directory of the &knowit; distribution:
+<screen width="40">
+<prompt>%</prompt> <userinput>./configure</userinput>
+<prompt>%</prompt> <userinput>make</userinput>
+<prompt>%</prompt> <userinput>make install</userinput>
+</screen>
+</para>
+
+<para>Since &knowit; uses autoconf and automake, you should have no
+trouble compiling it. Should you run into problems please report
+them to the autor.</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:
+-->
+
+
+
+
+
+
+
+
+
+
+
+
+