Hachikaduki Handbook

murakumo

Version 0.9.2


1. Introduction
1.1. What is Hachikaduki?
1.2. System Requirements
2. Installation
2.1. Binary Installation
2.2. Build from source code
3. Usage
3.1. Starting Hachikaduki
3.2. Creating a new Knowledge
3.3. Finding Knowledge
3.3.1. Find Knowledge by title
3.3.2. Find Knowledge by content
3.4. Updating Knowledge
3.5. Deleting Knowledge
3.6. Quitting Hachikaduki
4. Configuration
4.1. Configuration Options
5. FAQ

Chapter 1. Introduction

1.1. What is Hachikaduki?

Hachikaduki is a simple knowledge management tool for knowledge workers.

Hachikaduki enables you to manage text-based Knowledge consists of title and text. Hachikaduki has a powerful full-text search function [1]. You can find Knowledge quickly and easily.

1.2. System Requirements

Hachikaduki has been tested under the following environments.

  • Operating System

    • Windows XP SP 3

    • SliTaz GNU/Linux 2.0

    • Puppy Linux 4.20p1-JP

  • Java Runtime Environment

    • JDK 6 Update 20



[1] Powered by Apache Lucene.

Chapter 2. Installation

You can download the source code and the pre-compiled binary from the Hachikaduki project page.

The recommended way to install Hachikaduki is to download a ready-to-run Unix or Windows executable.

2.1. Binary Installation

Download binary release from download page.

Simply unpacking the archive in a desired location installs the Hachikaduki.

2.2. Build from source code

Chapter 3. Usage

3.1. Starting Hachikaduki

At the command prompt, enter java -jar /path/to/hachikaduki/hachikaduki.jar. You can also start Hachikaduki by double clicking hachikaduki.jar on a file explorer.

3.2. Creating a new Knowledge

Procedure 3.1. Creating a new Knowledge

  1. Press the New button.

  2. Enter title and text.

    Creating a new Knowledge

    Creating a new Knowledge

  3. Press the Save button.

3.3. Finding Knowledge

3.3.1. Find Knowledge by title

  1. Select Title tab.

  2. Enter the keywords you want to search for.

    Find Knowledge by title

    Find Knowledge by title

  3. Search results appear in the list.

3.3.2. Find Knowledge by content

  1. Select Content tab.

  2. Enter the keywords you want to search for.

    Find Knowledge by content

    Find Knowledge by content

  3. Search results appear in the list.

Tip

You can use Apache Lucene's query language to find your Knowledge.

Example 3.1. Find Knowledge which contains "Hachikaduki" and "management" in its title.

If you want to find Knowledge which contains "Hachikaduki" and "management" in its title, select tab named Title and enter Hachikaduki AND management.

Query language

Query language

See the Apache Lucene - Query Parser Syntax for more information.


3.4. Updating Knowledge

  1. Left click on the row that you want to update.

  2. Edit Knowledge.

    Updating Knowledge

    Updating Knowledge

  3. Press the Save button.

3.5. Deleting Knowledge

  1. Right click on the row that you want to delete.

  2. Choose Delete.

    Deleting Knowledge

    Deleting Knowledge

  3. Press the OK button in the confirmation dialog.

    Confirmation dialog

    Confirmation dialog

3.6. Quitting Hachikaduki

Choose Exit from the File menu.

Quitting Hachikaduki

Quitting Hachikaduki

Chapter 4. Configuration

4.1. Configuration Options

Chapter 5. FAQ

5.1. Does Hachikaduki write registry?
5.2. How can I backup Knowledge?

5.1.

Does Hachikaduki write registry?

No. Instead of writing registry, Hachikaduki stores values in the following location.

  • GUI session state

    Directory %APPDATA%\net.sourceforge.hachikaduki in Windows environment. Directory ${HOME}/.net.sourceforge.hachikaduki.ui.Hachikaduki in UNIX environment.

  • Configuration file

    File hachikaduki.xml in the installation directory.

  • Lock file to prevent multiple instances of Hachikaduki

    File .lock in the installation directory.

  • Database files

    Directory db in the installation directory.

5.2.

How can I backup Knowledge?

Hachikaduki creates directory names db in its installation directory and stores Knowledge. To backup Knowledge, copy this directory to a desired location.

Caution

Completely exit the application before backing up database.

Colophon