Ttk Python wrapper
==================

Testing Code
------------

You will need Python with a _tkinter compiled against Tcl/Tk 8.5[1],
otherwise Tile[2] has to be installed. I have tested it under Linux
with all the Python 2.5.x releases, Python 2.6, Python 3.0, as well
the python-trunk and py3k repos, and, under Windows XP with python 2.5.1
and python 2.6.

Given that your system meet the requirements, you should be able to run
the tests with an appropriated PYTHONPATH (ttk-gsoc/src/2.x or
ttk-gsoc/src/3.x depending on your Python version) or placing the ttk
module somewhere in sys.path. If any test fail, report it as a bug.

If you are not sure if you have Tile installed correctly or if your
tkinter is compiled against Tk 8.5, try running the test suite:

$ PYTHONPATH=ttk-gsoc/src/2.x python ttk-gsoc/src/2.x/test/runtests.py

Be sure to adapt the above line according to your system.


[1] I've shortly used it with Tcl/Tk 8.6a1 too.
[2] I've tested it with Tile 0.8.2 and it works, but I would recommend
    upgrading to Tcl/Tk 8.5 so you get antialiased fonts and other
    nice features. If you are testing this wrapper with Tile, it will
    look for the environment variable TILE_LIBRARY, which you can set
    to your tile library path if you installed it in a custom place.


Reading the Documentation
-------------------------

There are just ttk.rst and tk.rst.diff files at Doc/library and while you
could read the ttk.rst with any editor you will probably want to read it
in a better format.
To generate html from ttk.rst you will need to checkout the python trunk
repository (the one I tested with the docs):

   $ svn co http://svn.python.org/projects/python/trunk python-trunk

And then, optionally, apply tk.rst.diff using patch -p0 < tk.rst.diff. Next
you have to place ttk-gsoc/Doc/library/ttk.rst in python-trunk/Doc/library
and then cd into python-trunk/Doc/library and do:

   $ make html

After it completes, you can use your browser to read the Ttk documentation.
The path to the ttk.html will be something like:
file:///SOMEPATH/python-trunk/Doc/build/html/library/ttk.html


References
----------

What I'm using as a reference to know how complete the project is:

Changes in Tcl/Tk 8.5     http://wiki.tcl.tk/10630
Tk Commands               http://www.tcl.tk/man/tcl8.5/TkCmd/contents.htm
Tk source code            http://tktoolkit.cvs.sourceforge.net/tktoolkit/


Experimental IDLE
=================

Another part of the project is moving the idlelib to use the new ttk
widgets and to add the possibility to use tabs instead of windows to
display multiple shells and files. I'm also changing a bit the layout
of some of the idlelib dialogs.


Testing it
----------

You will find a idlelib directory at src/idlelib, which should be added to
your PYTHONPATH if you want to run IDLE using this experimental branch.
To use both the ttk module and the new idlelib, you could start idle as
this:

$ PYTHONPATH=~/ttk-gsoc/src/2.x:~/ttk-gsoc/src/ python src/idlelib/idle.py