Read Me

Introduction
============

_(obsolote/zastaralé)
Documentation in czech/Dokumentace v češtině:
[documentation/dokumentace][2]._


Installation instructions
-------------------------

For installation instructions see [``INSTALL``][1] file.


User documentation
------------------

Full documentation is embeded into Metadata Editor itself
(choose ``[ help ]`` option from application menu).


Technical documentation
-----------------------

Technical documentation is kept as close to source as possible. That means that
in most subdirectories you should find ``README`` file (formated with 
[Markdown](http://daringfireball.net/projects/markdown/syntax)) with more
detailed information, files/directories/structure description and so on.

For file formats (e.g: ``meta.xml``, ``detail.xml``, ...), directory structure (e.g.:
``data/share/serial``, ...), configuration files or metadata schemas there exists
commented examples.

### Config files

There is actually only one configuration file you should be aware of. It is
``editor/conf/local.rb`` and there exists 2 example files:

1. [``editor/conf/local.rb.example``](editor/conf/local.rb.example)
   - shows how to configure Metadata Editor as is used in DML-CZ project with
     built-in metadata format.
2. [``editor/conf/local.rb.ff-example``](editor/conf/local.rb.ff-example)
   - shows how to configure Metadata Editor to work with user defined metadata
     schemas and authenticate with kerberos as is used at Faculty of Arts (MU).

### Directory strucutre for data

Directory structure for data is described in the file [``data/README``][3].

### File formats

File formats are described in the subdirectory [``data/examples/``][4] where are examples
of complex directory structure for different scenarios. It contains ``README`` files
and commented examples.


Contents of root directory
--------------------------

### Files

* ``README``
  - This file.
* [``INSTALL``][1]
  - Installation instruction.

### Directories

* [``data/``][3]
  - Contains all data and metadata including Authority base.
* [``doc/``](doc/README)
  - There are some presentations.
* [``editor/``](editor/README)
  - Metadata editor itself including some tools.
* [``metadata/``](metadata/README)
  - Mostly perl scripts working with directory structure. Many of them are
    single-purpose only.
* [``olis/``](olis/README)
  - Web image server written in PHP. It can be configured to generate thumbnails
    on the fly.
* [``pdfrecompress/``](pdfrecompress)
  - Tools which recompress PDF files intelegentlly using JBIG2 compression.
* [``pdfsign/``](pdfsign/README)
  - Tools for digital signaturing PDF files
* [``system/``](system/README)
  - Contains scripts for installation, setup, update and deployment.
* [``verify/``](verify/README)
  - Tests which are runing from Metadata editor or by cron and results are
    accessible through Metadata editor web interface.



  [1]: INSTALL
  [2]: http://docs.google.com/Doc?id=dfm3x24f_56gtbjtkwh
  [3]: data/README
  [4]: data/examples/README


<!--
vi: filetype=mkd
-->