Warning, /utilities/basket/doc/index.docbook is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" encoding="UTF-8" ?>
0002 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003 <!ENTITY basket "<application>BasKet</application>">
0004   <!ENTITY % addindex "IGNORE">
0005   <!ENTITY % English "INCLUDE" > <!-- change language only here -->
0006 ]>
0007 
0008 <book id='basket' lang="&language;">
0009 
0010         <bookinfo>
0011                 <title>The &basket; Handbook</title>
0012                 <authorgroup>
0013                         <author>
0014                                 <personname>
0015                                         <firstname>Gleb</firstname>
0016                                         <surname>Baryshev</surname>
0017                                 </personname>
0018                                 <email>gleb.baryshev@gmail.com</email>
0019                         </author>
0020                 </authorgroup>
0021                 <date>2016-11-07</date>
0022                 <releaseinfo>2.11</releaseinfo>
0023 
0024                 <abstract>
0025                         <para>Taking care of your ideas.</para>
0026                 </abstract>
0027                 <keywordset>
0028                         <keyword>KDE</keyword>
0029                         <keyword>BasKet</keyword>
0030                                 <!--keyword>note pad</keyword-->
0031                 </keywordset>
0032         </bookinfo>
0033 
0034         <chapter id="notice">
0035                 <title>NOTICE: handbook not written yet</title>
0036                 <para>&basket; still does not have a handbook, so contributors are welcome!
0037                         Check the <ulink url='https://l10n.kde.org/docs/doc-primer/index.html'>
0038                                         KDE documentation</ulink> for the hints on the DocBook format.</para>
0039                         <para>Meanwhile, you can look for help on the Internet. In particular,
0040                                 look through the <ulink url='https://basket-notepads.github.io'>old website</ulink> or
0041                                         check Linux magazines if you have access to them, for example:
0042                                 <itemizedlist>
0043                                         <listitem><para>
0044                                                         <quote>Tutorial: Basket: Capture your thoughts.</quote> Linux Format 120
0045                                                                 (Andy Channelle)
0046                                         </para></listitem>
0047                                         <listitem><para>
0048                                                         <quote>A Virtual Basket. Storing, sorting, and filing with KDE&apos;s
0049                                                                 Basket</quote> Linux Magazine 54 (Stefanie Teufel)
0050                                                 </para></listitem>
0051                                         </itemizedlist>
0052                                 </para>
0053                         </chapter>
0054 
0055                         <chapter id="introduction">
0056                                 <title>Introduction</title>
0057                                 <para>&basket; is mainly an all-purpose notes taker, but a particular one:</para>
0058                         </chapter>
0059 
0060                         <chapter id="using-BasKet">
0061                                 <title>Using BasKet</title>
0062                                 <para></para>
0063                                 <sect1>
0064                                         <title>Version Sync</title>
0065                                         <para>When enabled, Version Sync puts your baskets and notes under version control. Currently this is an experimental feature and only very basic functions are implemented, so it may require additional software and some manual setup. These are some of the things that can be done using external tools (but not Basket interface yet):</para>
0066                                         <itemizedlist>
0067                                                 <listitem>
0068                                                         <para>check out old revisions and revert the changes</para>
0069                                                 </listitem>
0070                                                 <listitem>
0071                                                         <para>synchronize baskets on several computers (merge the changes)</para>
0072                                                 </listitem>
0073                                                 <listitem>
0074                                                         <para>push baskets backup to remote repository</para>
0075                                                 </listitem>
0076                                         </itemizedlist>
0077                                         <para>To enable it, select
0078                                         <menuchoice>
0079                                                 <guimenu>Settings</guimenu> <guimenuitem>Configure BasKet Note Pads</guimenuitem>
0080                                         </menuchoice>
0081                                                 → <guibutton>Version Sync</guibutton>
0082                                                         and <guibutton>Enable distributed version control</guibutton>. It will initialize git repository in <filename>~/.kde/share/apps/basket/baskets</filename>, upon which standard git tools can be used.</para>
0083                                                 <sect2>
0084                                                         <title>Clearing version history</title>
0085                                                         <para>Clearing the history can be useful in these cases:</para>
0086                                                         <itemizedlist>
0087                                                                 <listitem>
0088                                                                         <para>you have locked a basket and want to remove any previous unencrypted versions (which are still stored in the system)</para>
0089                                                                 </listitem>
0090                                                                 <listitem>
0091                                                                         <para>you want to free some disk space (can be topical if you insert a lot of images or other files into Basket)</para>
0092                                                                 </listitem>
0093                                                         </itemizedlist>
0094                                                         <para>Note that you will have to redo any manual setup you did on the git repository.</para>
0095                                                 </sect2>
0096                                         </sect1>
0097                                 </chapter>
0098 
0099                                 <chapter id="basket-file-structure">
0100                                         <title>BasKet file structure</title>
0101 
0102                                         <sect1 id="basket-file-structure-intro">
0103                                                 <title>Introduction</title>
0104                                                 <para></para>   
0105                                         </sect1>
0106 
0107                                         <sect1 id="basket-archive-file-format">
0108                                                 <title>BasKet Archive file format</title>
0109                                                 <para>The BasKet file format (.baskets) is a structure which wraps a compressed tar and a preview image. The latest archive format version is 0.6.1.</para>
0110 
0111                                                 <sect2 id="basket-archive-file-structure">
0112                                                         <title>File Structure</title>
0113                                                         <para>The archive file is devided into the structures: file header, preview image header, a preview image (.png), archive header, and a gunzipped tar archive (.tar.gz) containing a baskets file tree as illustrated in the following sketch</para>
0114                                                         <mediaobject  id="basket-archive-file-structure-graph">
0115                                                                 <imageobject> 
0116                                                                         <imagedata  format="PNG"  fileref="basket-archive-file-structure.png"/> </imageobject>
0117                                                         </mediaobject>
0118                                                 </sect2>
0119 
0120                                                 <sect2 id="archive-file-header">
0121                                                         <title>Archive file header</title>
0122                                                         <para>The file header is a short structure, consisting of lines of strings, the file declarator, and the format version</para>
0123 
0124                                                         <para>The first 17 bytes contain the literal string <code>BasKetNP:archive</code> followed by a new line feed symbol (0x0A) in ISO-8859-1 encoding.</para>
0125                                                         <para>The second string is a literal string <code>version:0.6.1</code> followed by a line feed symbol (0x0A) in ISO-8859-1 encoding.</para>
0126                                                         <para>An example:</para>
0127                                                         <programlisting>
0128                                                                 <![CDATA[
0129 BasKetNP:archive
0130 version:0.6.1
0131                                                                         ]]>
0132                                                         </programlisting>
0133                                                 </sect2>
0134 
0135                                                 <sect2 id="archive-file-preview-header">
0136                                                         <title>Preview image header</title>
0137                                                         <para>Currently, the basket archive file contains a preview file which is derived from the first basket's content.</para>
0138                                                         <para>Directly following the file header, a literal string <code>preview*:&lt;size&gt;</code> in ISO-8859-1 encoding, again followed by a line feed symbol. The parameter <code>&lt;size&gt;</code> is a string of decimal numbers. It declares the size in bytes of the preview image.  <code>&lt;size&gt;</code> is of type unsigned long.</para>
0139                                                         <para>An example:</para>
0140                                                         <programlisting>
0141                                                                 <![CDATA[
0142 preview*:12000
0143                                                                         ]]>
0144                                                         </programlisting>
0145                                                 </sect2>
0146 
0147                                                 <sect2 id="archive-file-preview">
0148                                                         <title>Preview image file</title>
0149                                                         <para>The preview image is of type .png. Its size is specified by the preview image header. The preview image file is inserted as file stream, and directly follows the preview image header.</para>
0150                                                 </sect2>
0151 
0152                                                 <sect2 id="content-archive-file-header">
0153                                                         <title>BasKet content archive header</title>
0154                                                         <para>Just like for the previe image file, the content archive is preceded by a string specifying its size. That string directly follows the file stream of the preview image.</para>
0155                                                         <para>That string must be <code>archive*:&lt;size&gt;</code> followed by a line feed symbol, in ISO-8869-1 encoding. The parameter <code>&lt;size&gt;</code> is a unsigned long integer in string format.</para>
0156                                                         <para>An example:</para>
0157                                                         <programlisting>
0158                                                                 <![CDATA[
0159 archive*:1245000
0160                                                                         ]]>
0161                                                         </programlisting>
0162                                                 </sect2>
0163 
0164                                                 <sect2 id="content-archive-file">
0165                                                         <title>BasKet content archive</title>
0166                                                         <para> The content archive contains the BasKet file tree compressed in to a gzipped tar archive (.tar.gz). Its size is size is specified by the content header.</para>
0167                                                 </sect2>
0168 
0169                                                 <sect2 id="basket-archive-file-content-example">
0170                                                         <title>Example byte stream</title>
0171                                                         <para>The following table shows key parts of the basket archive file content. The left column specifies the offset in the file stream. The center column gives the byte stream at the current offset in hexadecimal format. The right column shows printable characters within the file stream at the current offset.</para>
0172                                                         <mediaobject  id="file-content-example">
0173                                                                 <imageobject> 
0174                                                                         <imagedata  format="PNG"  fileref="basket-archive-file-content-example.png"/> </imageobject>
0175                                                         </mediaobject>
0176                                                 </sect2>
0177                                                         
0178                                         </sect1><!--archive file format-->
0179 
0180                                 </chapter><!--basket file structure-->
0181 
0182                                 <chapter id="questions-answers-and-tips">
0183                                         <title>Questions, Answers, and Tips</title>
0184 
0185                                         <qandaset id="faq">
0186                                                 <title>Frequently asked questions</title>
0187                                                 <qandaentry>
0188                                                         <question>
0189                                                                 <para>Question 1</para>
0190                                                         </question>
0191                                                         <answer>
0192                                                                 <para>The answer</para>
0193                                                         </answer>
0194                                                 </qandaentry>
0195                                         </qandaset>
0196 
0197                                 </chapter>
0198                         </book>
0199                         <!--
0200                                 Local Variables:
0201                                 mode: sgml
0202                                 sgml-omittag: nil
0203                                 sgml-shorttag: t
0204                                 sgml-general-insert-case: lower
0205                                 End:
0206                         -->