Annotation of kupuMPIWG/doc/ZOPE2.txt, revision 1.1.1.1
1.1 dwinter 1: ========================
2: Installing Kupu on Zope2
3: ========================
4:
5: Requirements
6: -------------
7:
8: o Zope 2.5 or higher, Zope 2.7 recommended.
9:
10: o FileSystemSite product, version 1.3 or higher, available at
11: http://zope.org/Members/philikon/FileSystemSite.
12:
13: o An XSLT processor with XInclude support, such as xsltproc from Gnome's
14: libxml/libxslt (only required for SVN checkouts, not for plain release
15: tarballs).
16:
17: Installation
18: ------------
19:
20: Drop the 'kupu' directory into your instance home's Products directory.
21:
22: Kupu provides a sample integration in the 'zope2' directory based on ZPT
23: macros. In order to use it, you need to generate the ZPT template called
24: 'kupumacros.html' by typing:
25:
26: $ make zope2macros
27:
28: Note: this is only required if you use a Subversion checkout of Kupu, the
29: template will be available pre-built in the release tarballs.
30:
31: Now restart your Zope instance
32:
33: Overview
34: --------
35:
36: Kupu mainly consists of several directories representing integration
37: implementations. It is most convenient, to simply use the 'default'
38: implementation as a filesystem-based layer in Zope. The editor application
39: itself is a combination of ECMAScripts and markup necessary for certain
40: features.
41:
42: In order to use Kupu in your custom Zope2 application, you will have to make
43: these filesystem-based ZPT macros available to your ZODB-based Page Templates.
44: The easiest way is to use the zope2 integration package using the
45: FileSystemSite product. It can be downloaded at
46: http://zope.org/Members/philikon/FileSystemSite.
47:
48: Once you have installed FileSystemSite and Kupu in your Products directory, you
49: will see a new addable meta type called 'kupu editor'. Add this one to the
50: top-most folder of your Zope2 application. A common id would be 'kupu'. If you
51: look inside the object you just created, you will see that it provides all
52: filesystem-based page templates and ECMAScript files to the ZODB.
53:
54: You can now create a page template and use the macro defined in
55: 'kupumacros.html'.
56:
57: Using the kupu editor macro
58: ---------------------------
59:
60: To use Kupu on your own Zope objects, create a page template and make use of
61: the macros and slots provided by kupumacros.html. Depending on whether you have
62: further customized the provided implementation or not, these are:
63:
64: - macro 'head' provides the necessary markup for the HTML header, such as
65: links to CSS and JavaScript includes.
66:
67: - macro 'fulleditor' provides Kupu's full editor, including toolbar and
68: toolboxes. The slot 'editorframe' can be filled with the iframe element in
69: case its 'src' attribute needs to change.
70:
71: Differences to Epoz
72: -------------------
73:
74: Kupu has a totally different approach than Epoz. While Epoz provides a global
75: python function called 'Epoz' that was callable from Python Script, DTML and
76: ZPT, we have done away with the triple-code generation in Kupu.
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>