README for the maemo LaTeX toolchain
------------------------------------
 
 * Toolchain installation:

   - Unpack the toolchain package tarball to some convenient location,

      $ tar -C /path/to/local/repo -xzf maemodoc-toolchain_0.2.6.tar.gz


   - tell apt where to find the packages,
 
     create a file /etc/apt/sources.list.d/maemodoc-toolchain-local.list
     with the contents
    
       deb file:///path/to/local/repo/maemodoc-toolchain /

     and tell apt to update its list of available packages:

      $ sudo apt-get update     


   - install the toolchain,

      $ sudo apt-get install maemodoc-toolchain


   - optionally install the wiki import tool.

      $ sudo apt-get install maemodoc-toolchain-mediawiki
 
     This is only required if you want to be able to import wikified
     documentation into MediaWiki and will pull in MediaWiki, Apache and
     MySQL as dependencies but will /not/ touch their configuration.


 * Toolchain components;

   The executables are installed in /usr/bin.

   `maemodoc-toolchain' consists of the following scripts,

    - maemodoc-menu         a simple frontend for maemodoc-html and 
                            maemodoc-pdf ; can be used to generate HTML and 
                            PDF from and to wikify maemo LaTeX documents,

    - maemodoc-html         a LaTeX-HTML conversion tool,

    - maemodoc-pdf          a LaTeX-PDF conversion tool,

    - maemodoc-scaleimage   a tool for automatically scaling and rotating images
                            to conform to the maemo documentation size 
                            constraints.


  `maemodoc-toolchain-wikify', pulled in as a dependency, contains

    - maemodoc-wikify       a tool for (media)wikifying HTML generated by 
                            maemodoc-html.


  `maemodoc-toolchain-mediawiki' contains just one script,

    - maemodoc-importwiki   a tool for importing maemodoc-wikified documents 
                            into MediWiki. 

  The packages install the normal bits, `copyright' and such, in /usr/share/doc.


 * Usage:

   Simply unpack the LaTeX files somewhere:

    $ unzip maemodoc-baseline_wXX-Y.zip

   and run one of `maemodoc-menu', `maemodoc-html' or `maemodoc-pdf'. Use `-H' 
   or `--help' to get a list of tool parameters.


-- 
LM: 20100218
