Usage
=====

Here is a some usage information for EB4J library.

Library API
-----------

See javadoc https://eb4j.github.io/eb4j/javadoc/index.html

Library: extensions against standard
------------------------------------

appendix
--------

The ``appendix`` is an amendment data for CD-ROM book, which is specific for eb library.
EB4J can understand ``appendix`` that eb library utility generated.
It provide following items.

- Seperator character code.
- Alternative string for external fonts(EUC-JP and/or Unicode escape sequence)

It provides alternative strings for external fonts defined in EPWING data.
It also provides hint information for seperator of article, that is ordinally detect automatically
but not implicitly defined in EPWING data. Otherwise, the hint provides hint what character is a seperator.
Following is same description in Japanese.

appendix (付録) とは CD-ROM 書籍の補助データの ことです。
appendix は CD-ROM 書籍の出版社から提供されているものではなく、 EB および EB4J ライブラリに固有のものです。
EB4Jは、このデータを解釈利用することができます。

- 本文の区切りコード
- 外字の代替文字列(EUC-JPおよび Unicode escape sequence)

appendix のレイアウトは CD-ROM 書籍のものとよく似ています。
トップディレクトリには catalog もしくは catalogs ファイルが存在し、各副本のデータは対応する サブディレクトリに配置されています。

EB4J can handle the appendix contents and provide an API
to get alternative string for external font griff codepoint.

* `JavadDoc for Appendix class`_

.. _`JavadDoc for Appendix class`: https://eb4j.github.io/eb4j/javadoc/io/github/eb4j/Appendix.html


It accept Unicode escape sequences, such as '\u00E1', and  '\U001F401' form.
The appendix can be produced by eb4j-tools appendix subcommand.

オリジナルのEBライブラリは、EUC-JPで代替文字列を生成します。EB4J-toolsのappendixコマンドは、
ASCII文字およびUnicode escape sequenceを生成します。

Unicode map file
----------------

Unicode map file is an amendment data for CD-ROM book, which is produced by EBStudio2 authoring tool.
EBStudio2 generates external fonts codepoints for unicode characters, and also generate ``.map`` file
which describe mapping between external fonts codepoints to unicode characters.

The ``.map`` file should be a TSV: tab-separated value text file, and WBWin4 EBook reader bundles ``.map`` files with applicaiton.

EB4J use ``.map`` file and provides API to get Unicode charecter code from external font codepoint.
User can put ``.map`` file on a same directory with dictionary CATALOG file.

Following is same description in Japanese.

Unicode mapファイルは、CDROM電子書籍のデータに追加するデータです。
EPWING形式の書籍をオーサリングするツールである、EBStudio2は、EPWINGでストレートに表現できないUnicodeの 文字を、
自動的に外字定義として変換する機能を有しています。そのとき同時に、外字とUnicode文字コードポイントの対応関係を
``.map`` という拡張子のファイルに生成します。

``.map`` ファイルは、TSV: タブ区切り値テキスト ファイルである必要があります。
通常、EBStudio2の作者が配布している 電子書籍リーダーであるEBWin4に同梱されており、インストールされた
アプリケーションのフォルダーにいくつかの著名な辞書のためのファイルが格納されています。

ユーザが、電子辞書のCATALOGファイルとおなじフォルダに、対応する``.map``ファイルを格納することで、
EB4Jは、自動的にそのファイルをよみこんで、処理します。
EB4Jには、この値を取得するための拡張されたAPIがあります。

* `JavaDoc for UnicodeMap`_ class

.. _`JavaDoc for UnicodeMap`: https://eb4j.github.io/eb4j/javadoc/io/github/eb4j/ext/UnicodeMap.html


Utility commands
================

EBDUMP
------

.. line-block::

    *EBDump* - dump dictionary data
    *SYNOPSIS*  java -jar EBDump.jar [OPTION] [BOOK directory]
    *DESCRIPTION*
    Extract book data to console.
    If a BOOK directory is not specified, EBDump use current directory as
    a book directory(A CATALOG file exist.)
    -s --subbook  subbook index number
    -p --page  page number(HEX)
    -o --offset offset number(HEX)
    -p --position position(HEX)
    -d --dump  dump size(HEX)
    -h --help  display help message
    -v --version display version

EBINFO
------

.. line-block::

    *EBInfo* - display book information
    *SYNOPSIS* java -jar EBInfo.jar [OPTION] [BOOK directory]
    Display book information to console.
    If a BOOK directory is omitted, EBInfo use current directory as a book.
    -m --multi-search  display multi-search information
    -h --help display help message
    -v --version display version

EBZIP
-----

.. line-block::

    *EBZip* - Compress dictionary
    *SYNOPSIS* java -jar EBZip.jar [OPTION] [BOOK directory]
    Compress/decompress dictionary file with EBZip (.ebz)
    -f --force-overwerite force overwrite output file
    -n --no-overwrite  prohibit overwrite of output file
    -i --information  list information of compressed file
    -k --keep  keep (don't delete) original file
    -l --level  compression level
    -o --output-directory  output file to a specified directory
    -q --quiet   suppress all warnings
    -s --skip-content  [font [, sound [, [grahpic [, movie]]]   skip specified content
    -S --subbook  target subbook
    -z --compress  compress files
    -u --uncompress  uncompress files
    -t --test   only check input files
    -h --help  display help message
    -v --version  display version