# The &basket; Handbook

Gleb
Baryshev
gleb.baryshev@gmail.com
2016-11-07
2.11

Taking care of your ideas.

KDE
BasKet

## NOTICE: handbook not written yet

&basket; still does not have a handbook, so contributors are welcome! Check the KDE documentation for the hints on the DocBook format.

Meanwhile, you can look for help on the Internet. In particular, look through the old website or check Linux magazines if you have access to them, for example:

- Tutorial: Basket: Capture your thoughts. Linux Format 120 (Andy Channelle)

- A Virtual Basket. Storing, sorting, and filing with KDE's Basket Linux Magazine 54 (Stefanie Teufel)

## Introduction

&basket; is mainly an all-purpose notes taker, but a particular one:

## Installation

### How to obtain &basket;

### Requirements

### Compilation and Installation

Compiling BasKet is very easy. The following should do it:

              % ./configure
              % make
              % make install

That should do it! Should you run into any problems, please report them to the author

## Using BasKet

### Version Sync

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):

- check out old revisions and revert the changes

- synchronize baskets on several computers (merge the changes)

- push baskets backup to remote repository

To enable it, select Settings Configure BasKet Note Pads → Version Sync and Enable distributed version control. It will initialize git repository in `~/.kde/share/apps/basket/baskets` (or `$(kde4-config --path data)/basket/baskets`), upon which standard git tools can be used.

#### Clearing version history

Clearing the history can be useful in these cases:

- you have locked a basket and want to remove any previous unencrypted versions (which are still stored in the system)

- you want to free some disk space (can be topical if you insert a lot of images or other files into Basket)

Note that you will have to redo any manual setup you did on the git repository.

## Questions, Answers, and Tips

### Frequently asked questions

Question 1

The answer