Table of Contents
=================

  1 Description of the model
  2 Edit and render your document
      2.1 Render a pdf document
  3 Rendering the modified parts of the document and cleaning up
  4 How to get other dokkit models
  5 WHAT'S NEXT?


1 Description of the model
==========================

This is a simple document model for dokkit. You can use this model
as a base to create simple documents like tutorials, howtos, technical
reports, etc.


2 Edit and render your document
===============================

To edit the content of the document simply edit doc/pages/simpledocument.dpl
(this file) or create a new file with dpl extension in doc/pages directory.

To get further information about the wiki syntax to use please check
deplate[1] homepage.

To render this document in html, open a terminal and type:

    $ dokkit

from the top-level directory or from any subdirectory contained in
it.

To render this document in latex format, type:

    $ dokkit render_tex

To render this document in plain text format, type:

    $ dokkit render_text

In any case, you should get the output

  * in the html directory for the html generated output
  * in the tex directory for the tex generated output
  * in the text directory for the plain text generated output


2.1 Render a pdf document
~~~~~~~~~~~~~~~~~~~~~~~~~

If a latex distribution is present on your system then the command:

    $ dokkit render_pdf

will try to generate a pdf file for your document.

If you are an ubuntu/debian user then you can obtain a complete latex
distribution running the command:

    $ sudo apt-get install texlive


3 Rendering the modified parts of the document and cleaning up
==============================================================

Once you have rendered the document, running the dokkit command again
will appear to do nothing, because only changed resources are re-rendered.
To clean the output and start over run:

    $ dokkit clobber

Note that if you modify any part of the document then you must re-run
dokkit command in order to apply changes and to re-generate the desidered
output.

So, once you have modified your document, run:

    $ dokkit render_<xxx>

Only the modified resources will be transformed.


4 How to get other dokkit models
================================

To search for other document models open a terminal and type:

    $ gem list dokkit-model

To get a particular model named <model_name> run:

    $ gem install dokkit-model-<model_name>

or check http://rubyforge.org/projects/dokkit/.[2]


5 WHAT'S NEXT?
==============

  * See what else you can do by typing:

    $ dokkit --tasks
    EOB
    
     - Modify the configuration of the document by editing
       ''doc/config/simpledocument.yaml''.
    
     - Override the default layout creating in ''doc/layouts'' a custom
       layout with the same name of your document.
    
    For further information about ''dokkit'' see http://dokkit.rubyforge.org/.
    

[1] http://deplate.sf.net/deplate.html
[2] http://rubyforge.org/projects/dokkit/.