root/livinglogic.python.xist/INSTALL.xml @ 2590:7b6bba35f3a0

Revision 2590:7b6bba35f3a0, 3.5 KB (checked in by Walter Doerwald <walter@…>, 13 years ago)

htmlspecials.pixel() now no longer uses colored pixels, instead color is
done via CSS. The URL for the one remaining transparent pixel can now be
specified via src (either as an XML attribute or via the converter context).

Rename attrs methods with() and without() to withnames() and withoutnames()
(for Python 2.5 compatibility).

Use elinks instead of w3m for asText() and move/rename this method to a
function ll.xist.ns.html.astext().

Try to make XIST independent from PyXML (however PyXML is still required
for parsing via expat and for dtd2xsc.py (because this requires xmlproc)).

Remove the long dperecated method withSep().

Use Py_ssize_t in the C source where appropriate.

Line 
1<?xml version='1.0' encoding='iso-8859-1'?>
2<section><title>Requirements</title>
3<par>To use &xist; you need the following software packages:</par>
4<olist>
5<item><link href="http://www.python.org/">Python 2.4</link>,</item>
6<item><link href="http://pyxml.sf.net/">The Python &xml; package</link> (at least version 0.8.4),</item>
7<item><link href="root:core/index.html">ll-core</link> (1.3 or newer),</item>
8<item>if you want to use automatic image size calculation: the
9<link href="http://www.pythonware.com/products/pil/">Python Imaging Library</link>,</item>
10<item>if you want to parse broken &html;: <link href="http://www.xmlsoft.org/">libxml2</link>
11(including its Python wrapper),</item>
12<item>if you want want to use the function <function>ll.xist.ns.html.astext</function>
13to convert &html; to plain text: <link href="http://elinks.or.cz/">elinks</link>,</item>
14<item>if you want to install this package as an egg:
15<link href="http://peak.telecommunity.com/DevCenter/setuptools">setuptools</link>.</item>
16<item>if you want to run the test suite: <link href="http://codespeak.net/py/current/doc/test.html">py.test</link>,</item>
17<item>and a C compiler supported by <app>distutils</app>, if you want
18to install the source distribution.</item>
19</olist>
20</section>
21
22
23<section><title>Installation</title>
24<par><app moreinfo="http://peak.telecommunity.com/DevCenter/setuptools">setuptools</app>
25is used for installation so you can install this module with the following command:</par>
26
27<prog>
28easy_install ll-xist
29</prog>
30
31<par>If you want to install from source, you can download one of the
32<link href="root:xist/Download.html">distribution archives</link>, unpack it,
33enter the directory and execute the following command:</par>
34<prog>
35python setup.py install
36</prog>
37
38<par>This will copy <filename>*.py</filename> files, compile <filename>*.c</filename>
39files and install everything in the <dirname>site-packages</dirname>
40directory as the <module>ll.xist</module> package.</par>
41
42<par>For Windows a binary distribution is provided. To install it,
43double click it, and follow the instructions.</par>
44
45<par>If you have difficulties installing this software, send a problem report
46to Walter Dörwald (<email>walter@livinglogic.de</email>).</par>
47</section>
48
49
50<section><title>Character encoding</title>
51<par>When you pass an 8bit string in the constructor
52of an &xist; element, these strings have to
53be converted to Unicode. &xist; assumes that these 8bit strings
54are in the system default encoding, which normally is &ascii;.</par>
55
56<par>If your strings contain non-&ascii; characters you <em>must</em>
57pass them as unicode strings to the &xist; constructors and you <em>must</em>
58specify the encoding you're using in your source code in the first or second
59line of your script (see
60<link href="http://www.python.org/peps/pep-0263.html">PEP 263</link> for
61a detailed description).</par>
62</section>
63
64
65<section><title>IPython display hooks</title>
66<par>If you're using &xist; in an
67<link href="http://ipython.scipy.org/">IPython shell</link>, &xist; allows you
68to browse through your trees using any of the browsers provided by IPython's
69<link href="http://projects.scipy.org/ipython/ipython/wiki/UsingIPipe">ipipe module</link>.</par>
70
71<par>You can specify which format gets used by changing the value of the
72<lit>defaultpresenter</lit> variable in the module <module>ll.xist.presenters</module>:</par>
73
74<prog>
75from ll.xist import presenters
76presenters.defaultpresenter = presenters.TreePresenter
77</prog>
78
79<par>Setting this value to <lit>None</lit> turns off the display hook.</par>
80
81</section>
Note: See TracBrowser for help on using the browser.