pim/kjots/Mainpage.dox

0001 /** @mainpage kjots
0002
0003 KJots is a simple note taking application.
0004
0005 The main interface to KJots is a QTreeWidget subclass on one side and a
0006 QTextEdit subclass on the other. Entries in the tree view represent notebooks
0007 which can contain pages or other notebooks. If a book is selected, the content
0008 of its pages is displayed in the tree view read-only. If a page is selected, its
0009 content is presented for editing in the textedit.
0010
0011 <h2>Saving and exporting data</h2>
0012
0013 Each of the top level books in the application are represented by an xml file in
0014 users data directory (.kde/share/apps/kjots). The xml file contains elements to
0015 represent the pages and books contained in it. When a book is dragged from
0016 within another book to the top-level, a new xml file is created for it.
0017
0018 The saved file format is suitable for exporting and importing. Additionally, it
0019 is possible to export files in simple text or an html file and to import data
0020 files created by the KnowIt application. The export is done in the KJotsEntry
0021 class by adding the data of selected books and pages to a QTextDocument using
0022 the QTextCursor interface.
0023
0024 */
0025
0026 // DOXYGEN_REFERENCES = kdecore
0027 // DOXYGEN_SET_PROJECT_NAME = kjots