KnowIt – tool for managing notes
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

index.docbook 6.8KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261
  1. <?xml version="1.0" ?>
  2. <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  3. <!ENTITY knowit '<application>KnowIt</application>'>
  4. <!ENTITY kapp "&knowit;"><!-- replace knowit here -->
  5. <!ENTITY % addindex "IGNORE">
  6. <!ENTITY % English "INCLUDE"><!-- change language only here -->
  7. <!-- Do not define any other entities; instead, use the entities
  8. from kde-genent.entities and $LANG/user.entities. -->
  9. ]>
  10. <book lang="&language;">
  11. <bookinfo>
  12. <title>The KnowIt Handbook</title>
  13. <authorgroup>
  14. <author>
  15. <firstname>Michal</firstname>
  16. <othername></othername>
  17. <surname>Rudolf</surname>
  18. <affiliation>
  19. <address><email>mrudolf@kdewebdev.org</email></address>
  20. </affiliation>
  21. </author>
  22. </authorgroup>
  23. <!-- TRANS:ROLES_OF_TRANSLATORS -->
  24. <copyright>
  25. <year>2002</year>
  26. <year>2003</year>
  27. <year>2004</year>
  28. <holder>Michal Rudolf</holder>
  29. </copyright>
  30. <!-- Translators: put here the copyright notice of the translation -->
  31. <legalnotice>&FDLNotice;</legalnotice>
  32. <date>31/03/2003</date>
  33. <releaseinfo>0.10</releaseinfo>
  34. <abstract>
  35. <para>
  36. &knowit; is an application to help you keep, edit and maintain notes.
  37. </para>
  38. </abstract>
  39. <keywordset>
  40. <keyword>KDE</keyword>
  41. <keyword>KnowIt</keyword>
  42. <keyword>notes</keyword>
  43. <keyword>manage</keyword>
  44. <keyword>edit</keyword>
  45. <keyword>tree</keyword>
  46. <keyword>hierarchy</keyword>
  47. <keyword>HTML</keyword>
  48. </keywordset>
  49. </bookinfo>
  50. <chapter id="introduction">
  51. <title>Introduction</title>
  52. <para>
  53. &kapp; is a simple tool for managing notes. It is similar to
  54. <ulink url="http://tuxcards.sourceforge.net">TuxCards</ulink>,
  55. but designed for KDE 3.x. Notes are organized in tree-like hierarchy,
  56. texts are stored in RichText format, so bold, italic and underline fonts
  57. are supported, as well as various text colors and unordered lists.
  58. </para>
  59. <para>
  60. &kapp; development depends on user's feedback! If you have
  61. suggestions or want to help developing &kapp;, have a look at the
  62. <ulink url="http://knowit.sourceforge.net">&kapp; page</ulink>
  63. to see what is still to do.
  64. </para>
  65. </chapter>
  66. <chapter id="using-kapp">
  67. <title>Using &knowit;</title>
  68. <sect1 id="Interface">
  69. <title>Interface</title>
  70. <para>
  71. The main screen of &knowit; is divided into two parts: on the left you can see the notes
  72. hierarchy (tree-like), on the right you can find the text of the current note.
  73. You can browse and manage notes in the tree view and edit them in the
  74. edit view.
  75. <screenshot>
  76. <screeninfo>Here's a screenshot of &kapp;</screeninfo>
  77. <mediaobject>
  78. <imageobject>
  79. <imagedata fileref="screenshot.png" format="PNG"/>
  80. </imageobject>
  81. <textobject>
  82. <phrase>Screenshot</phrase>
  83. </textobject>
  84. </mediaobject>
  85. </screenshot>
  86. </para>
  87. <sect2 id="editing">
  88. <title>Editing notes</title>
  89. <para>
  90. You can use standard KDE shortcuts for editing text. Unordered lists are
  91. supported: just start the line with <keycap>*</keycap>. You can also use
  92. <guimenu>List</guimenu> submenu of <guimenu>Edit</guimenu> menu to get all
  93. available list formats.
  94. </para>
  95. <para>
  96. <keycap>Enter</keycap> inserts a new paragraph (as in HTML there
  97. is an empty line between two paragraphs) - if you
  98. just want a line break, use <keycap>Ctrl+Enter</keycap> instead.
  99. </para>
  100. </sect2>
  101. <sect2 id="managing">
  102. <title>Managing notes</title>
  103. <para>
  104. You can use shortcuts for adding notes. If the notes tree is active,
  105. just press <keycap>Ctrl+Enter</keycap> to add a same-level note following
  106. the current one, <keycap>Insert</keycap> to add a child-note and
  107. <keycap>Delete</keycap> to delete the current note.
  108. </para>
  109. <para>
  110. <guimenu>Notes</guimenu> menu or popup menu (accessed by right-clicking
  111. on the list) contains many commands for managing notes. Most of them
  112. have shortcuts assigned, for others you could assign them yourself.
  113. </para>
  114. </sect2>
  115. <sect2 id="links">
  116. <title>Links</title>
  117. <para>
  118. You can create links in notes. Links will be displayed below the note
  119. text. There are two kinds of links: <emphasis>external</emphasis> (to
  120. any file or URL) - click on it, and it will be opened in appropriate
  121. application, and <emphasis>internal</emphasis> (to another note) - click
  122. on it, and note with appropriate title will be displayed.
  123. </para>
  124. </sect2>
  125. </sect1>
  126. </chapter>
  127. <chapter id="about">
  128. <title>About &knowit;</title>
  129. <sect1 id="credits">
  130. <title>Credits and License</title>
  131. <para>
  132. Program and documentation:
  133. </para>
  134. <para>copyright 2002, 2003, 2004 Michal Rudolf <email>mrudolf@kdewebdev.org</email>
  135. </para>
  136. &underFDL; <!-- FDL: do not remove. Commercial development should -->
  137. &underGPL; <!-- GPL License -->
  138. </sect1>
  139. <sect1 id="new">
  140. <title>New in this version</title>
  141. <para>
  142. <itemizedlist>
  143. <listitem><simpara>list editing commands</simpara></listitem>
  144. <listitem><simpara>improved handling of read-only files</simpara></listitem>
  145. <listitem><simpara>many improvements to export</simpara></listitem>
  146. <listitem><simpara>link copy command</simpara></listitem>
  147. <listitem><simpara>some shortcuts for links added</simpara></listitem>
  148. <listitem><simpara>fixed backup bugs</simpara></listitem>
  149. <listitem><simpara>warning when resource file is missing</simpara></listitem>
  150. </itemizedlist>
  151. &knowit; 0.10 was released at 31st of March 2003. File <filename>ChangeLog</filename> in
  152. source package contains information about changes in previous versions.
  153. </para>
  154. </sect1>
  155. </chapter>
  156. <appendix id="installation">
  157. <title>Installation</title>
  158. <sect1 id="getting-knowit">
  159. <title>How to obtain &knowit;</title>
  160. <para>
  161. Newest version of &knowit; can be found at
  162. <ulink url="href://knowit.sourceforge.net">knowit.sourceforge.net</ulink>.
  163. Updates will probably be announced on <ulink
  164. url="http://freshmeat.net">Freshmeat</ulink> and
  165. <ulink url="href://apps.kde.com">apps.kde.com</ulink>.
  166. </para>
  167. </sect1>
  168. <sect1 id="requirements">
  169. <title>Requirements</title>
  170. <para>
  171. I use KDE 3.1 for both developing and testing &knowit;. As
  172. far as I know, it should work in both KDE 3.2 and KDE 3.0 without any problems.
  173. </para>
  174. <para>
  175. I doubt that it would compile in KDE 2.x - but I have no access
  176. to older KDE versions to check it. Anyway, any information
  177. about &knowit; in KDE 2.x would be welcomed.
  178. </para>
  179. </sect1>
  180. <sect1 id="compilation">
  181. <title>Compilation and installation</title>
  182. <para>
  183. In order to compile and install &knowit; on your system, type the following
  184. in the base directory of the &knowit; distribution:
  185. <screen width="40">
  186. <prompt>%</prompt> <userinput>./configure</userinput>
  187. <prompt>%</prompt> <userinput>make</userinput>
  188. <prompt>%</prompt> <userinput>make install</userinput>
  189. </screen>
  190. </para>
  191. <para>Since &knowit; uses autoconf and automake, you should have no
  192. trouble compiling it. Should you run into problems please report
  193. them to the autor.</para>
  194. </sect1>
  195. </appendix>
  196. &documentation.index;
  197. </book>
  198. <!--
  199. Local Variables:
  200. mode: sgml
  201. sgml-minimize-attributes:nil
  202. sgml-general-insert-case:lower
  203. sgml-indent-step:0
  204. sgml-indent-data:nil
  205. End:
  206. -->