MyWord

Copyright 2004, Christof Ecker. 
MyWord is distributed under the terms of the GNU General Public
License. See the attached file LICENSE for further information.
 
INTRODUCTION
~~~~~~~~~~~~

MyWord is a library for interactive typesetting and also a plugin for
Sketch. It is is fast and allows complex things as the typesetting of
formulae.

The current version is unstable and also unfinished. 

USAGE OF THE PLUGIN
~~~~~~~~~~~~~~~~~~~

Most will be familiar if you used a computer before. Things you have
to know are the following:

- 'Alt-i' creates an inputbox. 

- You an create objects by typing the name in the inputbox. For
  example write 'Integral' and hit space -> an integral will appear.
  Try 'alpha', 'one' and 'product'.

- 'Alt--' inserts a hyphen position.

- 'Shift-Enter' inserts a forced break.
 
- From the context menu (right click) you can open the 'parameter
  window'. It allows to customize most text elements. Ok, this is a bit
  provisional ...

- The scripting window will only pop up if you installed my python
  shell. If you don't have, get it. Its buggy but very useful. 

- If it is too slow (which should not be the case), set the flag
  _debug in MyWord/__init__.py to 0.

INSTALLATION AS PLUGIN FOR SKETCH
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. Unpackage the file tar -zxvf MyWord-0.0.tar.gz (I you obviously
   already did that when you are reading this) and cd to the package 
   directory:

   Type 'tar -zxvf MyWord-0.0.tar.gz'
   Type 'cd MyWord-0.0'

2. Build the module

   Type 'python setup.py install --home=.'

   This will create a directory lib wich contains the module MyWord:
   lib/python/MyWord

For a system wide installation check the sketch manual. Here I will
only describe how to make a local installation.

For a local installation, you need to have a plugin directory and you
need to tell Sketch to look in that directory for plugins.
   
I suggest you to use ~.sketch/Plugins to store the plugins. 
3. Create '.sketch/Plugins' if it does not already exist:

   Type 'cd ~'
   Type 'mkdir .sketch'
   Type 'cd .sketch'
   Type 'mkdir Plugins'

4. Sketch can be configured using a file 'userhooks.py'. If it does
   not already exist, create it. It should contain the following lines:

import os, sys
config.plugin_path.append(os.path.expanduser('~/.sketch/Plugins'))
sys.path.append(os.path.expanduser('~/.sketch/Plugins'))


5. Next you have to copy the library to the plugin directory. Cd back
   to 'MyWord-0.0' and ...

   Type 'cp -r lib/python/MyWord ~/.sketch/Plugins/'

6. Copy the plugin to the plugin directory

   Type 'cp lib/python/MyWord/Sketch ~/.sketch/Plugins/'


If everything worked the plugin should appear in sketch's edit menu as
    
    Edit->Create->Text

