About

ZWikiFolder is a container for ZWiki Page content. It provides a nice Plone/AT interface that changes the properties the ZWiki Pages expect from their container.

Copyright and license

Copyright (c) 2007 Ingeniweb SAS

This software is subject to the provisions of the GNU General Public License, Version 2.0 (GPL). A copy of the GPL should accompany this distribution. THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE

See the ./LICENSE file that comes with this product.

Requirements

• Plone 2.1.* and Plone 2.5.*
• ZWiki 0.58 +

Note that ZWikiFolder has been developed and tested with ZWiki 0.58 but might run with some other ZWiki versions.

Installation

As usual with the Plone quick installer, but install ZWiki before installing ZWikiFolder.

Configuring

Depending on your ZWiki/Plone/publishing charset, you might change some data in customconfig.py. Please read the instructions in that file.

Sorry, there is no configlet since some data must be known at Zope startup time, and we can't use a configlet in such case.

How it works

ZWikiFolder wraps most properties expected from a ZWiki container with AT fields and widgets.

See http://zwiki.org/QuickReference for comments about these properties.

Note that we do not support :

• Of course, properties that do not make sense in a Plone site.
• "Mail in" mode properties.
• Tracker mode dedicated properties. There are better trackers than ZWiki in the Plone world.

Testing

Please read ./tests/README.txt (unit tests) and ./ftest/README.txt (functional tests).

Downloads

You may find newer stable versions of AttachmentField and pointers to related informations (tracker, doc, ...) from http://plone.org/products/zwikifolder

SVN repository

Stay in tune with the freshest (maybe unstable) versions or participate to the ZWikiFolder maintenance:

https://svn.plone.org/svn/collective/ZWikiFolder

Support and feedback

Please read all the documentation that comes with this product before asking for support, unless you might get a RTFM reply ;)

Please do not ask for support or report bugs on ZWiki pages unless code from ZWikiFolder appears in the traceback.

Please do not ask for support or report bugs when mixing ZWikiFolder with a ZWiki version older than 0.58 unless you provide a patch and a unit test.

Mail to Ingeniweb support in English or French to ask for specific support.

Donations are welcome for new features requests

Credits

• Main developer: Gilles Lenfant

Further documentation

See the additional documents in ./doc/*

We do not provide documentation on ZWiki itself. You'll find all ZWiki related documentation from the ZWiki site.

What about LinguaPlone?

ZWikiFolder is not LinguaPlone aware, because translating a ZWikiFolder has no sense at all, and ZWiki Page contents are neither LinguaPlone friendly. If you ignore this warning and get trouble after translating a ZWikiFolder to some language, please don't ask for support.

If you really want to get rid of the LinguaPlone widget, you can send me the patch.

What versions of ZWiki are supported?

Hmmm, not easy to answer... We developped and tested ZWikiFolder with ZWiki 0.58.0 and did'nt test with other versions. It may or may not work with other ZWiki versions. Please report to the authors ZWiki versions you tested succesfully with ZWikiFolder.

I don't understand everything in ZWikiFolder

Of course we do not , and will not explain in details all that's pertainig to the ZWiki product. You must first understand what's a Wiki before using ZWikiFolder. Please read the documentation from http://zwiki.org first if you're a pure Wiki newbie.

Why ZWikiFolder doesn't support the ZWiki tracker features?

Just because Plone has better tracking tools, like POI (http://plone.org/products/poi) and others. I do not use the ZWiki tracker any more. If you want support for the ZWiki tracker, either:

• Send us the patch (see README.txt) and the unit tests that checks your patch.
• Your donation is welcome if you want this feature (or another one). Programming activity requires beer and coffee, both aren't free. http://sourceforge.net/project/project_donations.php?group_id=74634

I need ZWikiFolder in my language

Sorry but we speak only English or French. But it's easy to do it yourself:

• Copy i18n/zwikifolder.pot to ì18n/zwikifolder-xx.po (xx is your language IANA id).
• Copy i18n/zwikifolder-plone.pot to i18n/zwikifolder-plone-xx.po.
• Change the headers according to your language.
• Provide your translated texts in the msgstr fields.
• Test your translations.
• Send me both files, those will be included in the repository and shipped with the next release. And your name will be added to the credits in the README.txt.
• Stay in tune with the SVN repository (see README.txt) and stay in synch with the changes of the above mentioned .pot files.

You will find doc on Plone products localisation from http://plone.org

I can't run the functional tests in 'ftests'

Sorry, if you're stuck with running functional tests, I can't help. All the documentation and examples are in the funittest product. You may anyway ask for support if you can run the functional tests and these tests raise errors in ZWikiFolder.

1.0.0 (2007/2/26)

No changes since 1.0.0RC1, but no bug report issued for this version. So, we can consider this version as stable.

1.0.0RC1 (2007/2/1)

• Shows the actual acquired roles in the security tab
• Included functional tests (requires funittests)

1.0.0alpha1 (2006/12/28)

First public release