Read Me

--------------
Titivullus. A Language Tool module for Gedit.
--------------

@author: Giovanni Ornaghi
@date: January 2013
@language: Python
@license: GPL v.3


--------------
Introduction
--------------

Titivullus is a simple Gedit plugin to integrate Language Tool's proofreading abilities. It will take every line in the document, pass it to Language Tool and show the errors in the bottom panel.
Language Tool server needs to run on a separate process (i.e. the plugin doesn't start it for you) and listen on port 8081, language is set to autodetect. A config dialog might appear in future versions, for now, if you wish to change the parameters, you can easily do so by looking into the Titivullus.py source code.

--------------
Prerequisites and installation
--------------

Prerequisites:
- Gedit
- Language Tool (its configuration is up to you)

Move the folder to:

> /home/$USER/.local/share/gedit/plugins

Open Gedit and enable the plugin going into:

> Edit-Preferences-Plugin

Show the bottom panel (if not already present) pressing 

> Ctrl+F9

or by

> View-Bottom Panel

Start the Language Tool server firing into terminal:

> languagetool --tray

You can proofread your document by going into Gedit:

> Tools-Proofread

(it takes a while)