<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!ENTITY basket "<application>BasKet</application>">
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>

<book id='basket' lang="&language;">

  <bookinfo>
    <title>The &basket; Handbook</title>
    <authorgroup>
      <author>
        <personname>
          <firstname>Gleb</firstname>
          <surname>Baryshev</surname>
        </personname>
        <email>gleb.baryshev@gmail.com</email>
      </author>
    </authorgroup>
    <date>2016-11-07</date>
    <releaseinfo>2.11</releaseinfo>
    
    <abstract>
      <para>Taking care of your ideas.</para>
    </abstract>
    <keywordset>
      <keyword>KDE</keyword>
      <keyword>BasKet</keyword>
      <!--keyword>note pad</keyword-->
    </keywordset>
  </bookinfo>

  <chapter id="notice">
    <title>NOTICE: handbook not written yet</title>
    <para>&basket; still does not have a handbook, so contributors are welcome!
      Check the <ulink url='http://l10n.kde.org/docs/doc-primer/index.html'>
      KDE documentation</ulink> for the hints on the DocBook format.</para>
    <para>Meanwhile, you can look for help on the Internet. In particular,
      look through the <ulink url='https://basket-notepads.github.io'>old website</ulink> or
      check Linux magazines if you have access to them, for example:
      <itemizedlist>
	<listitem><para>
	  <quote>Tutorial: Basket: Capture your thoughts.</quote> Linux Format 120
	  (Andy Channelle)
	</para></listitem>
	<listitem><para>
	  <quote>A Virtual Basket. Storing, sorting, and filing with KDE&apos;s
	  Basket</quote> Linux Magazine 54 (Stefanie Teufel)
	</para></listitem>
      </itemizedlist>
      </para>
  </chapter>
  
  <chapter id="introduction">
    <title>Introduction</title>
    <para>&basket; is mainly an all-purpose notes taker, but a particular one:</para>
  </chapter>

  <chapter id="installation">
    <title>Installation</title>

    <sect1 id="how-to-obtain-BasKet">
      <title>How to obtain &basket;</title>
      <para></para>
    </sect1>

    <sect1 id="requirements">
      <title>Requirements</title>
      <para></para>
    </sect1>

    <sect1 id="compilation-and-installation">
      <title>Compilation and Installation</title>

      <para>Compiling BasKet is very easy.  The following should do it:
        <screen>
          <prompt>%</prompt> <userinput><command>./configure</command></userinput>
          <prompt>%</prompt> <userinput><command>make</command></userinput>
          <prompt>%</prompt> <userinput><command>make</command> install</userinput>
        </screen>
      </para>

      <para>That should do it! Should you run into any problems,
        please report them to the <ulink
        url="mailto:slaout@linux62.org">author</ulink></para>
    </sect1>
  </chapter>

  <chapter id="using-BasKet">
    <title>Using BasKet</title>
    <para></para>
      <sect1>
        <title>Version Sync</title>
        <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>
        <itemizedlist>
          <listitem>
            <para>check out old revisions and revert the changes</para>
          </listitem>
          <listitem>
            <para>synchronize baskets on several computers (merge the changes)</para>
          </listitem>
          <listitem>
            <para>push baskets backup to remote repository</para>
          </listitem>
        </itemizedlist>
        <para>To enable it, select
          <menuchoice>
          <guimenu>Settings</guimenu> <guimenuitem>Configure BasKet Note Pads</guimenuitem>
          </menuchoice>
          → <guibutton>Version Sync</guibutton>
          and <guibutton>Enable distributed version control</guibutton>. It will initialize git repository in <filename>~/.kde/share/apps/basket/baskets</filename> (or <filename>$(kde4-config --path data)/basket/baskets</filename>), upon which standard git tools can be used.</para>
        <sect2>
          <title>Clearing version history</title>
          <para>Clearing the history can be useful in these cases:</para>
          <itemizedlist>
          <listitem>
            <para>you have locked a basket and want to remove any previous unencrypted versions (which are still stored in the system)</para>
          </listitem>
          <listitem>
            <para>you want to free some disk space (can be topical if you insert a lot of images or other files into Basket)</para>
          </listitem>
          </itemizedlist>
          <para>Note that you will have to redo any manual setup you did on the git repository.</para>
        </sect2>
      </sect1>
  </chapter>

  <chapter id="questions-answers-and-tips">
    <title>Questions, Answers, and Tips</title>

    <qandaset id="faq">
      <title>Frequently asked questions</title>
      <qandaentry>
        <question>
          <para>Question 1</para>
        </question>
        <answer>
          <para>The answer</para>
        </answer>
      </qandaentry>
    </qandaset>

  </chapter>
</book>
<!--
Local Variables:
mode: sgml
sgml-omittag: nil
sgml-shorttag: t
sgml-general-insert-case: lower
End:
-->