Zwiki

======================
This is the first release of Zwiki 2, formerly the ZWiki-unstable branch.
To recap, on 2009/01/30 I renamed the old Zwiki stable and unstable repos,
and we now have:

* http://zwiki.org/repos/ZWiki1 - the classic Zwiki 0.x branch, aka
Zwiki 1. This version stores text as utf-8 and supports Zope versions
up to 2.11. Barring some unusual need, this will receive no further
development. At the time of writing the last release in this line is
Zwiki 0.61.0, 2008/10/24.

* http://zwiki.org/repos/ZWiki - the new main line of Zwiki
development, aka Zwiki 2. This version stores text as unicode,
reorganizes skins, drops some non-essential features and adds support
for Zope 2.12 and python 2.6. Older zopes are still supported, at least
in the 2.0 release.

The biggest change in Zwiki 2 is that we now work internally with unicode
rather than utf8-encoded text. Encoding-related errors in non-ascii wikis
are hard to prevent; this change will help us stamp them out. Also this
will permit accurate searching of non-ascii content. Thanks to
Wirtschaftsuniversität Wien (Vienna University of Economics and Business)
and Willi Langenberger for funding part of this work. There has also been
a lot of skins and code cleanup.

**Upgrade notes**

With an existing wiki containing non-ascii wiki content, you will probably
notice new encoding-related errors. (Eg try searching for some non-ascii
text.) In this case you need to convert all wiki content from utf-8 to
unicode. To do this, visit SOMEPAGE/upgradeAll as manager.

As usual, if you have a lot of content this can take several minutes; set
your logging level to BLATHER (in zope.conf) and watch the event.log to
see progress and be sure it completes successfully.

Afterward, most encoding-related errors should be gone (try the search
again). If not: first try upgradeAll a second time, then please report
(eg to sm on zwiki) for investigation.

Also, if you have custom skin templates they will likely need updating
(see eg the note below about lastEditor). It's probably best to move them
out of the way and deal with that later, or re-apply your customisations
to the latest templates.

**Browsing**

* show a "created" timestamp at top right, like Michael Haubenwallner's
on the zope3 wiki

* 1414 - indentation was not displayed in literal code blocks (betabug)

* minor css fixes (betabug)

* Fixed the display of non-ascii search expressions on the search form (betabug)

**Editing**

* 517 - more robust and careful updating of backlinks during page renames.
(Sascha Welter)

* 1171 - more than one double parenthesis link in the same paragraph
works now. (betabug)

* interwiki links now require at least one word character after the :

**Mail**

* mail-in no longer requires configuring an external method.
Have /etc/aliases post incoming mail to SOMEPAGEURL/mailin.

* when there are multiple mailhosts, choose the one with alphabetically
first id This lets you use a zope 2.11 "MailHost" when you have a
"MaildropHost" still kicking around, may be useful for someone else
testing mailhosts.

* drop mailin's unused spam-reporting feature

**General**

* Unicodegeddon! A big set of changes switching to unicode for internal
text handling. Many were committed as a single mega-patch from the the
early unicode branch. Noteworthy details:

* for proper operation, wiki content should be converted from utf-8
to unicode, a one-way upgrade step. See upgrade notes above.

* skin templates should use (lastEditor(), lastEditTime() etc.)
methods, not properties. If you have customised editform, history,
or RecentChanges, they may need to be updated accordingly.
Also catalog page brains now contain lastEditor, not last_editor.

* we use unicode-aware ZCTextIndexes in the wiki catalog by
default. SOMEPAGE/upgradeAll (or /setupCatalog) upgrades old
TextIndex-based indexes if present. (betabug)

* we use a simple unicode-aware splitter, based on code by Stefan
Holek. The following code is mostly taken from the
UnicodeLexicon product by Stefan H. Holek (ZPL) which can be found
at: http://www.zope.org/Members/shh/UnicodeLexicon . Many thanks to
you Stefan! We are using this here, so people with minimal needs
don't have to install extra products. If you need more than this
install a more specific splitter (e.g. a CJK splitter) create a new
"ZCTextIndex Lexicon" and recreate the "SearchableText" and "Title"
indexes with your new lexicon. (betabug)

* preserve unicode when evaluating DTML (1411)

* Many other unicode-related changes/fixes (simon, betabug)

* Skin cleanups: rearrange templates, provide nav links and access keys
more consistently, skin machinerys, basic support for alternate
filesystem skins. Many of these were committed as a single mega-patch.
Noteworthy details:

* more css ids

* move accesskeys, links and ratingform into pageheader template

* move pagemanagementform into a new pagefooter template

* add wikifooter and wikiheader - visible header/footer for wiki-contextual views

* include either pageheader or wikiheader in every view, for
appropriate links, access keys, etc. Show all nav links
everywhere.

* avoid duplicate access key definitions so you don't have to press
enter in firefox 3

* drop the s for search form access key, so s for save edit works without enter

* some skin machinery cleanup and basic support for alternate
filesystem skins, selectable by "skin" property or request var

* 939 - suppress "e" access key when already in edit form. (betabug)

* 1361 - check permission for the edit form more carefully; the edit
form should be viewable also in the case that the user has "Add"
rights on the wiki. E.g. going through the "add" form on a
restricted page, then clicking on the "Preview" button raised
Unauthorized before this fix. (betabug)

* add /index as an alias for the /index_object page method, drop /updateCatalog

* catalog search results now contain lastEditor, not last_editor

* more tests (simon, betabug)

* code cleanups, documentation (simon)

=======================
This and previous releases were made from the Zwiki 1 branch, formerly
known as Zwiki-stable.

A catch-up release with various bugfixes, code cleanups, and newer
translations from launchpad. You'll want this if you use Plone 3.x, to
work around a layout glitch with document action icons.

**Upgrade notes**

**Configuring**

* /setupDtmlMethods now installs a sitemap.xml, which might reduce
load from google and possibly other search bots (Simon Michael, Sascha Welter)

* remove the anti-spam 24 hour indexing delay introduced in 0.41, for
quicker indexing of actively-edited pages (1387)

* recognise a site_footer attribute, like site_header, useful for eg
stats tracking

* Change content-type of the SomePage/text (or /src) methods to UTF-8,
making the /text view of wiki pages much more useful for non-ascii
languages. (Sascha Welter)

**Browsing**

* "fix" the plone 3 document actions layout glitch, by hiding them. This
release Zwiki should work as well with Plone 3.x as previous versions
did with Plone 2.x.

* add the wiki navigation links (home, contents, changes..) to all forms

* merge access key help with the help page

* drop the "discussion" nav link activated by GeneralDiscussion, it is a
special case and confusable with per-page discussion

**Mail**

* fix a bug preventing mail-out in some Plone versions (1400)

* strip (some) annoying bottom-quoting from mailins ("----Original message:---- ...")

* support for mailing darcs patches through a zwiki: keep any
text/x-darcs-patch part, as well as the first text/plain part

* the unused "forward to spam address to update banned_links &
banned_ips" feature has been dropped.

**Translations**

* import latest translations from launchpad

* switch to launchpad-only translations process, see http://zwiki.org/I18n

* switch to i18ndude for generating pot files

**General**

* More functional tests: recentchanges and options (Sascha Welter)

* exception handling cleanups (Sascha Welter)

* 1272 - create PageBrain only for Zwiki Pages. Since we are now
ensuring that there is always a catalog in a Zwiki, the method
metadataFor() shouldn't be needed any more. But I'm still adding this
patch (credits and thanks to koegler), in case some code hits on it in
the time between an upgrade and running the /upgradeAll
method. (Sascha Welter)

* Rewrote the rating module to use a BTree to store votes, instead of a
dictionary. Saves some kB writing to Data.fs and avoids
conflicts. (Sascha Welter)

* code review and cleanup. All significant methods in Editing have now
been reviewed (by Simon) and tightened up

* make lastLog more robust to prevent possible page view breakage

* pages now returns nothing without a fully-configured catalog (to avoid
blowing up zodb cache when viewing old revisions)

* new methods expungeLastEditor, expungeLastEditorEverywhere, feedUrl,
setCreatorLike, setLastEditorLike

* replaced subscriberCount, wikiSubscriberCount methods with
subscriberCount, pageSubscriberCount, wikiSubscriberCount

* renamed changes_rss method to edits_rss

* make bare page rendering at the debug prompt work again, cleanup

* include Makefile in tarball so that folks can see how to run tests

* start a developer style guide, some developer docs cleanup

=======================

Fix TAL unicode errors with zope 2.10, Plone 3/CMF 2.1 compatibility,
quicker page rendering, permanent edit history, labelled bracket links,
better support for custom wiki templates, a tool for importing MoinMoin
wikis, many other improvements and code cleanups.

**Upgrade notes**

* Zope >=2.10 users should upgrade to this release to avoid TAL unicode
errors. Also, skin customizers should update their custom templates
to avoid the same errors. See 1330 below.

* Plone 3/CMF 2.1 users should upgrade to this release

* Plone 2.x users will not be able to install this release in sites, see 1322 below

* skin customizers should note the wiki navigation links are now in the wikipage template

* a wiki catalog is no longer optional, and will be added if missing

**Installing**

* 1322: Plone 3 & CMF 2.1 compatibility. Warning, this version of Zwiki
uses GenericSetup and is not compatible with older versions of
Plone/CMF. This could be tackled in a future release if there is
demand. See the issue page for discussion and possible workarounds.

* tools/prepmoin.py, imports MoinMoin wiki data to a zwiki (M. Pedersen)

* 1217: fix setupDtmlPages error (Sascha Welter)

**Configuring**

* fixPageEncoding renamed to fixEncoding and fixed

* move wiki navigation links to wikipage template for easier customizing

* 1041, 1145: ensure a catalog and an outline cache are always present.

**Browsing**

* make the home link, wiki logo and index_html use the default page url
consistently

* hide the prefix in mailto: email hyperlinks

* change long-standing links order: contents before changes, help after
options

* 1348 - redirect to original page after useroptions We are always
calling FrontPage/useroptions to limit bot traffic. Now we are
carrying the redirectURL through the REQUEST, so we know where to
redirect in the end. (Sascha Welter)

* 1333: make literal/code style more precise to avoid styling difform
headings

* help page cleanup

* 1145: avoid the broken dtml-in sort option in SearchPage, also, to
avoid occasional search errors

* most access keys are always available, but disable the s subscribeform
key if mailout is not enabled, as an extra cue

* speed up pages by doing less work

* slight discussionUrl speedup, don't look for UserDiscussion page

* speed up hasIssues, which was taking half the 2.5s skin render time on
zwiki.org

**Editing**

* 1157: replace revertEdits[Everywhere]By with history-wiping expunge,
expungeEditsBy, expungeEditsEverywhereBy methods

* more robust history:

- allow partial history, revisions can safely be deleted
- use a btree folder for revisions if possible
- more zodb cache friendly
- richer history api

* new history and diff views. History should now be at least as
functional as before, and permanent

* simple permanent revisions model, use revisions folder instead of
recycle_bin

* stop discarding content outside of html body tags - they may be part
of the content

* 1370: allow arbitrary urls in bracket links

* optional link labels after | in bracket links

* 965: avoid infinite recursion error when a page is reparented to itself
(Sascha Welter)

* 570 - Ensure valid id with file uploads. But meanwhile try to mess
with uploaded file's names as little as possible. We check first if
the name is acceptable to Zope, and only if it isn't we change
it. (Sascha Welter)

* 1085 - Comments are now properly formatted in HTML pagetype. Now
it's possible to use comments in HTML pagetype pages and have the
comments still properly formatted after page edits. Similar to 1079
and therefore again credits and thanks to Martijn Pieters. We are in
the same manner using preRenderMessages to add the comments. (Sascha
Welter)

* 1079 - Plaintext comments work now. Commenting on plaintext pages
would work until you edited the page itself, then the prerendering
method lost the comment rendering. Credits go to Martijn Peters for
this patch, a bit adapted to code that had moved on. I had to tweak
the output test, as the exact placement of blank lines at end of the
page content has changed minimally. (Sascha Welter)

* refuse any incoming text that's not ascii or utf-8, to avoid problems
later

* createform and create now look only at folder permissions, not the
current page, to be consistent with the page management form. The
'Zwiki: Add pages' permission is meaningful only on folders, and
ignored on pages.

* 512 - fix footnotes with "create page" links in RST (Sascha Welter)

* 1323: revert methods now obey the edits_need_username option

* clean up revertEditsBy, don't break with new pages

**Mail**

* 1256: handle mailins with encodings other than utf8

* don't log body of mail-ins by default

* 141 - Uploading a file causes an "edit" mailout now. (Sascha Welter)

* also allow a 'Secure Maildrop Host' for sending mail (Sascha Welter,
Encolpe Degoute)

**Feeds**

* no updates

**Issue tracking**

* yellow color to make open funded issues stand out

* IssueTracker cleanups

* 1334: make fuzzy urls work better with issue numbers

* use html instead of stx page type when installing issue tracker as
dtml pages, for a 4x speedup of the unit test on my system

**General**

* many code cleanups including imports, safe_hasattr, deprecation warnings, pyflakes warnings, tests

* Replace hasattr() with safe_hasattr() everywhere. Problem with
hasattr() is that it masks exceptions, which is known to be
problematic. "Our" new safe_hasattr() is from
http://www.zope.org/Collectors/Zope/742 - with thanks and credits to
Dieter Maurer. (Sascha Welter)

* 1365 use talsafe() on newname in /editform to avoid
UnicodeDecodeError. This problem appeared in localized browsers only
for some reason, but the fix likely is necessary for 2.10 too. (Sascha
Welter)

* 1339 - fixing text encoding for editform.pt textarea. (Sascha Welter)

* 1330: a better fix for these unicode errors. Zope 2.10 expects TAL
data to be unicode, older zopes do not. This can lead to many obscure
unicode errors depending on your system locale, wiki content, cookies,
phase of the moon etc. This fix aims to make all the standard
templates robust against this. Wikis with old customized templates
will still be vulnerable to this problem after upgrading to zope 2.10,
until those templates are updated.

* partial workaround for 1330 UnicodeDecodeError

* Default wiki type is "basic" + added 'jpeg' fs templating. (Sascha
Welter)

* 1332 - fix for the fix + default wiki_type is "basic". We're now not
trying to grab the REQUEST from self any more -- just doesn't make
sense to me. Also we have now the default wiki_type as
"basic". (Sascha Welter)

* 1332 - make manage_addWiki more programmatic + test. We still
grabbed the REQUEST and thus got a redirect at the 2nd chance. Now
we're doing the same check as on the 1st test and also return the new
id if we don't redirect. Added a test too. (Sascha Welter)

* Recursively add files/folders on addWikiFromFs. This is used for
"nautica" style templates. It's now possible to use templates
e.g. from openwebdesign.org without having to "unroll" images into a
flat structure. Also we now can set document titles and parents from
the filesystem pages. (Sascha Welter)

* 1331, 1186 - last_edit_date / creation_date timestamps now in
ISO6801. We changed the timestamp format for last_edit_date and
creation_date to conform to ISO8601, in order to save time zone
information along with it. Special care is taken to upgrading old
timestamps in Zope's DateTime's ISO() format. (Sascha Welter)

* update stx code, may work better with zope 2.10

* revisionInfoFor -> revisionInfo

* inPlone method

**Translations**

* no updates

=======================

Catchup since the last release in november: a truckload of bugfixes
from Sascha Welter, Frank Laurijssens and many others (YAY!), support
for conditional http get, skins code cleanup, translation updates and
more.

**Upgrade notes**

* The standard issuetracker and filterissues pages now support sorting
on issue name and reverse sorting (14). To enable sorting by name,
visit SOMEPAGE/setupTracker (as manager) to add a required catalog
field.

* If you have customized IssueTracker and/or FilterIssues pages, you
might want to replace them with the latest code. To do this, review
and back up the changes you made. Then delete both pages, reinstall
them with SOMEPAGE/setupTracker?pages=1 (as manager), and re-apply
your customizations.

**Installing**

* show accurate page hierarchy after adding a new wiki

* 1313, updated FrontPage links in basic wiki template (Frank Laurijssens)

**Configuring**

* reparent now obeys the edits_need_username option, so reparenting will
require a username when that property is true

* 1077 implement Conditional HTTP Get handling (aka If-modified-since /
304) for pages, stylesheet and RSS feeds. This feature makes zwiki
pages more browser- and spider-cache friendly, which can potentially
greatly reduce page rendering time and load on your zope server. It
is off by default as it doesn't yet work with Firefox's default
settings (requiring a reload after each edit). See
http://zwiki.org/HowToEnableConditionalHTTPGET (Sascha Welter)

* 974 Property to ignore certain WikiNames Credits to Matt Kunze from
DataSplice. Patch logic is from him, I just simplified it a bit and
tested it. This has yet to be documented somewhere. (Sascha Welter)

* 1227 comment form vulnerability (Sascha Welter)

**Browsing**

* make default site logo work with zope 2.10 (zope bug 2302)

* recent changes default period is now a week, not a day

* 976 cosmetics on "last edited xx ago" link credits to "Andreas", we
check if lastlog contains anything and omit the parentheses if
not. (Sascha Welter)

* format comment header for HTML pages 1085 (Sascha Welter)

* 1304 last-edited-by is not shown when user ID is numerical
(Sascha Welter)

* 1303 Illegal utf-8 handling in Utils.py summary - Credits go to Hideo
at Yokohama! This patch had us worried about performance, since taking
a summary of a long wiki page might be slow. Some preliminary testing
showed that the performance price is rather low, but for sites with
non-ascii content the patch is really worth it. Not only will it stop
producing illegal utf-8, but without the patch the length of the
summary will never be right. (Sascha Welter)

* 1298 non-ascii characters in page names are breaking search functionality
(Sascha Welter)

* don't let a non-wiki page break interwiki link rendering

**Editing**

* 1157 after reverting changes, reset last edit time. (Sascha Welter)

* 1314 use UTC for creation_time too (Sascha Welter)

* 1186 fix for last_edited_date losing time zone information -
converting to UTC. This might be only relevant at hosts that do
not have locale support on their operating system (e.g. BSD, Mac
OS X). Further tests in that direction might be necessary. It
definitely fixes the problem on Mac OS X. (Sascha Welter)

**Mail**

* 1299 - mail out in plone works, could use more error handling though
(Sascha Welter)

**Feeds**

* 1083 escape html in rss feeds (Sascha Welter)

* 1294 - changes to get rss feeds to validate. pages_rss and changes_rss
now validate with feedvalidator.org.

- Date formats in head section had to be adjusted
- feedvalidator.org wanted a guid element (even though specs say it's
optional) (Sascha Welter)

**Issue tracking**

* 14 make the zwikitracker list allow filtering & sorting
(Frank Laurijssens)

* Revert allow_dtml change (1281) (Frank Laurijssens)

* self-document the IssueTracker pages for missing allow_dtml (Sascha Welter)

* 1281 Frank's patch to set up dtml for IssueTracker pages with extra
check (Sascha Welter)

* 1043 Color issue links in "backlinks" (Frank Laurijssens)

* 1008 show issue form on plaintext issues, patch from Bill Page
(Sascha Welter)

**General**

* make skin/template/macro handling more general, add support for
alternate filesystem skins, rewrite skin system developer docs

* clean up stylesheet lookup: look for a template named "stylesheet.css"
or "stylesheet" in that order

* siblingsAsList can include current page + sorting optional. This is
useful mainly for "nautica" style wikipage.pt. In those one often
wants to make a list of pages "on the same level" as the current
page. That list usually includes the current page and is not sorted
alphabetically, but instead left in the order defined in the
/backlinks page. (Sascha Welter)

* many fixes to make Zwiki's exception handling more precise. This may
reveal some new failure scenarios which were previously hidden
(Sascha Welter)

* fix a syntax error in tests

* fix a missing doublequote in standard_error_message

* clarify relicensing clause

* bumped year in copyright statement (Sascha Welter)

* signed (Sascha Welter)

* Signed CONTRIBUTORS (Frank Laurijssens)

**Translations**

* de (Stefan Kose)

* es (Francisco Mañas)

* fr (Nicolas Velin)

* zh_CN, zh_TW (nwind)

* nl (Frank Laurijssens)

=======================

Simpler skin customization, bugfixes, cleanups.

**Upgrade notes**

If you have a very old zwiki relying on standard_wiki_header &
standard_wiki_footer dtml methods, these will now be ignored; you
must use a wikipage page template to customise the skin. I don't
think this will affect anyone (let me know if it did!)

**Installing**

* remove bad import from CMFInit breaking CMF/Plone installation (1291,
1295)
* /upgradeAll now sets up a catalog and tries to fix some common
character encoding problems

**Configuring**

* accept zodb skin templates with .pt or .dtml suffixes too, for easy upload
* when adding a wiki, keep image and file suffixes
* when adding a wiki, set the stylesheet's content type to text/css
* code cleanup, drop standard_wiki_header/standard_wiki_footer support
* add use_issue_links boolean property

**Browsing**

* help page cleanups, link UsersGuide
* clarify username option help
* fix subtopics layout interference from unterminated stx lists &
literal blocks (625)
* improve contents page styling, make it like subtopics (but bigger)
* fix star image in message-board-style subtopics template (1305)

**Editing**

* fix editform helppage link
* clarify page type names, change "type" to "markup"

**Issue tracking**

* set a "medium" severity when mailing in a new issue (kludgy, just
picks the middle list element)

**General**

* use a more stable contents url to reduce bot traffic (762, 699)
(Simon Michael, Daniel Yount, Michael Haubenwallner, Sascha Welter)
* handle unrecognised page types properly
* numericVotes method to get votes without voter identities
* merge Wikis.py into __init__ and Admin

=======================

Style and help cleanups, bugfixes.

**Upgrade notes**

If you use the http://zwiki.org/HowToMakeContentsExpandable , you'll
need to update it to work with the new "expandable" css class.

**Configuring**

* reorganize stylesheet

* add missing mathaction styles

* rename "aqtree3clickable" css class to "expandable"

**Browsing**

* subtopics, page context, wiki contents styling fixes

* make help page a built-in view like recentchanges etc.

* help updates

* make rss feeds and creationTime()/lastEditTime() more robust, eg
when creation_time property is blank

**General**

* fix backwards compatibility for old page objects

* speed up and quieten down tests a little

* developer docs cleanup

* "authorstats" make rule. Welcome, Haskell!