Zwiki

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

Bugfixes.

**Upgrade notes**

Reminder: the plone skin disables DTML-based pages (like
RecentChanges) by default now. If you wish to enable those you'll
need to remove the ZWiki/skins/zwiki_plone/no_dtml.dtml file after
an upgrade.

In the ZMI add menu, "ZWiki Web" is now just "ZWiki".

**General**

* change ZMI add menu's 'Wiki' to 'ZWiki', to locate it back
beside 'ZWiki Page'

* hide the WWML page type option by default in cmf/plone, by
installing an allowed_page_types property on the portal folder
during install (for limi)

* make new hierarchy methods more robust when a page has bogus
parents; also, check new parents more carefully. reparent() now
also accepts fuzzy page names & ids, removes duplicates, and
leaves parents sorted. The backlinks form's parent text field
now interprets the string as a single page name, like the page
management form. (IssueNo0633, IssueNo0634)

* context(with_siblings=1) no longer includes the current page's
children, which I think was a regression. (IssueNo0629)

* fix missing import that confused error messages during upgrades

* log individual page upgrade errors in upgradeAll rather than
aborting the whole process

* log STX rendering errors (eg from tables) rather than breaking
the page

* added/cleaned up tests, all tests pass again, the
CMF/Plone-specific tests now work with (and require) plone 2 and
all it's dependencies.

* dublin core fixes, so wiki pages should show correct
modification time, ownership etc. in CMF/Plone

**Skins and content**

* allow access to diff screens (but not full history button)
without 'View history' permission

* the access key for backlinks is now L everywhere

* zwiki_plone: tidy up wikinav_portlet a little

**Mail and messages**

* fixed never-encountered bug in subscriber list upgrading
(IssueNo0540)

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

Permission renames, useful page/catalog/tracker setup methods, more
functional default skin with slow but nifty hierarchy navigation
options, default content updates, bugfixes.

**Upgrade notes**

Three permissions have been renamed, and wherever you have
configured these ('Add ZWiki Webs', 'Add ZWiki Pages' & 'Zwiki: Add
comments to pages') you'll have to set them again with the new
names. You may want to review your settings before upgrading.
Sorry; it should be easy to write a script to automate this, I don't
have one.

As usual, but especially if upgrading from a very old version, it
doesn't hurt to visit SOMEPAGE/upgradeAll once as manager (except,
it may be slow in large wikis). This will ensure all your pages have
the latest attributes and have been rendered with the latest
code. Do this if you want to use the subtopics display option below.

Regulations support was not working and has been dropped - I don't
expect this to affect you, but if I'm wrong join the discussion on
http://zwiki.org/RegulatingYourPages .

**General**

* permissions & ZMI menu renames for usability/consistency:

- 'Add ZWiki Web' in the ZMI add menu is now 'Add Wiki'.
('Add ZWiki Page' remains as is to avoid changing the meta type).

- 'Add ZWiki Webs' permission is now 'Zwiki: Add wikis'

- 'Add ZWiki Pages' permission is now 'Zwiki: Add pages'

- 'Zwiki: Add comments to pages' permission is now
'Zwiki: Add comments'

* new wiki setup methods

From any page, visit these urls as manager to quickly set up
standard wiki features:

- setupPages - install default wiki pages (like Add Wiki in the ZMI)

- setupDtmlMethods - install index_html and standard_error_message

- setupCatalog - install or configure a wiki catalog, with
appropriate configuration for optimizing large wikis.
CMF/Plone notes: this one is called automatically by the CMF
install script, to simplify installation. It adds all the
indexes and metadata that Zwiki expects from a catalog (see
setupCatalog or http://zwiki.org/ZwikiAndZCatalog for a
list). NB these will apply for all catalogable plone objects,
not just zwiki pages, but will (hopefully) be empty/harmless
for the non-pages.

- setupTracker - configure the wiki & catalog for issue tracking
and install the IssueTracker and FilterIssues pages

These also work inside CMF/Plone, except for setupDtmlMethods
which may not work there.

* pages() now always returns brains with complete metadata, even
when a partial catalog is present. This allows a number of
things, eg creating/renaming in a cmf/plone site where
setupCatalog has not been called, to keep working, at the cost
of more zodb access (IssueNo0623 and others)

* Hierarchy navigation links and subtopics links

If your wiki folder has a true 'show_navlinks' boolean property,
the default skin in full mode will show a navigation links panel.
These are GNU Info-style next/previous/up links, with N/P/U quick
access keys respectively. See zwiki.org for an example.

If your wiki folder has a true 'show_subtopics' boolean property,
and the user is currently in full mode (their zwiki_displaymode
cookie is "full"): pages with children will have a "subtopics"
panel displayed, after the document part and before any
messages. (This will appear after the next edit, or after running
upgradeAll.)

Subtopics display can also be turned permanently on or off for a
specific page, and all pages below it in the hierarchy, by setting
an option in the default skin's editform (requires 'Zwiki:
Reparent pages' permission). We may find a way to simplify this
later, ideas welcome.

Both of these options (navlinks and subtopics) are expensive in a
large wiki, even if you set up a catalog to optimize it (and you
should). When active they will slow page rendering down a lot
(ballpark figure: zwiki.org FrontPage goes from 0.1 to ~1 second).

* regulations support dropped - this has been broken for some
time, and noone used it anyway because it makes life too
complicated. I'll be removing and mothballing the code next
month, assuming no-one steps forward to make it worth
keeping. We might revive it in a simpler form later.

* there is a new PREFER_USERNAME_COOKIE global option in
Defaults.py; set this true to allow username cookie to override
authenticated name. Useful for a simple community wiki protected
by a single shared login.

* STX footnote links were broken by 0.22's refactoring (IssueNo0605)

* disable iframe tags by default, like javascript (IssueNo0588)

* wiki link regexp tweak: remove unnecessary restriction on the
end character of bare urls, and allow single-character remote
parts in interwiki links

* fix a bug in rename where children's parents field was not
updated, leading to an error when you tried to view that child

* make renaming's update backlinks pass more robust and more
verbose (IssueNo0594, James Collier)

* make post-delete redirect work when the parent is freeform-named

* saving a page via ftp or webdav after removing the blank line
between headers and text was giving an error. (Dan McMullen)
This should fix the error (but may not do what's wanted..)

* misc. code cleanups: move admin-related methods to Admin.py;
begin long-awaited Parents.py cleanup; move the WikiNesting code
into ParentsSupport and simplify; various new methods.

* convert more unit tests to ZopeTestCase; make MockZWikiPage a
bit more useful; first unit tests for cmf/plone and page
hierarchy functionality

**Skins and content**

* default: the default skin has been rearranged somewhat, as at
zwiki.org; cf recent GeneralDiscussion. Less gray, widgets
grouped into panels, site links moved to top, annoying quote and
user bookmarks dropped, navigation links support. Note the
various site links appear only if you have a corresponding page,
following the names used at zwiki.org.

* default wikipage: freeform names now work when reparenting via
the page management form. Only a single parent can be set there
now.

* zwiki_plone wikipage_view: fix freeform links in the ancestor
list (IssueNo0603)

* default, zwiki_plone editform: when creating a new page, default
to the wiki's default page type, not the parent page's type

* default editform: fix an editform breakage with zope 2.5,
apparently due to a TAL difference

* default, zwiki_plone backlinks: make the reparent form action
url more robust, to fix reparenting in CMF/Plone (IssueNo0610)

* default backlinks: always explicitly list a page's parents, as
well as it's backlinks; don't show reparent controls if user
does not have permission

* a wikipage() UI method has been added, which you can use (in
portal_types -> Wiki Page -> actions -> view) to allow a non-CMF
skin like CommonPlace to be used inside a CMF/Plone
site. Possibly just a temporary hack.

* quick access keys in the default skin have been rearranged - see
QuickReference

* RecentChanges: latest zwiki.org code,
catalog-optimization-compatible, comment out old brute-force
code which should no longer be needed, fix last edit times when
there is no timezone cookie

* UserOptions: make it function inside a CMF/Plone site too
(useful with alternate skins); remove no longer used quote &
bookmarks options; include valid Pacific timezones (except for a
couple which DateTime doesn't support)
(IssueNo0595, James Collier)

* SearchPage: catalog search improvements: make help text always
visible, search only within current wiki, also show page title
hits (but the default code assumes Title index is a TextIndexNG2
with left globbing and case folding enabled, otherwise may not
work so well)

* zwiki_plone: the experimental skin-based versions of DTML pages
are now generated automatically and the tracker has been added
(untested). These are: recentchanges, searchwiki, useroptions,
issuetracker, filterissues.

**Mail and messages**

* mailout signatures now include the precise message url

* a whitespace + horizontal rule separator is inserted before the
messages section. You'll see this after next page edit or
upgradeAll.

* update catalog after subscribing/unsubscribing (fixes non-updating
"other page subscriptions" when a catalog is present)

* new 'fewer_threads' option, disabled by default, tries to gather
comments under a single thread per page per month

**Tracker**

* creating issue pages without first setting issue_* folder
properties didn't work.. it should work now. The necessary
folder properties will be installed as needed.

* IssueTracker: remove "how to report a bug" link;
latest-catalog-compatible code (so we don't always return all
pages)

* FilterIssues: move search form to the top; use pages() method to
ensure we search only this wiki; latest-catalog-compatible code

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

Memory efficiency/performance/scalability improvements; simpler page
types and DTML control; zwiki_plone and default skin updates;
wikimail tweaks; STX images; bugs, fixes, features.

**Upgrade notes**

Control of page types and DTML has been simplified. NB in this
release wikis tend to allow embedded DTML by default. To disallow
it, add a 'no_dtml' property as described below.

The backlinksFor() and pages() methods have changed; Title() is now
preferred instead of title_or_id(); and RESPONSE is no longer
provided in the default namespace for skin templates (see below).
If you have DTML pages or customized skin templates using these
things, they may need to be updated.

If using a catalog, you should add the Title field to your metadata
if not already present. Use of title_or_id is being phased out but
you may want to leave it in your catalog until Zwiki 0.23 to be
safe.

**General**

* page type cleanups and DTML changes: deprecated page types have
been removed, as have the non-DTML-supporting STX and HTML types.
DTML is now controlled as follows: a 'no_dtml' property (value
doesn't matter) on page or folder will disable Zwiki's DTML
functionality below that point. You can set this on the root
folder to disable it server-wide.

NB: non-CMF wikis, and CMF/Plone wikis which don't use the
zwiki_plone skin, are DTML-enabled by default for the moment. The
zwiki_plone skin includes an empty 'no_dtml' method which disables
DTML. To enable it in all your CMF/Plone wikis, you need to remove
ZWiki/skins/zwiki_plone/no_dtml.dtml and restart zope, (or switch
to a similar skin without that file).

* the 'allowed_page_types' lines property is supported again. It
does not prevent setting any type, but is used to restrict the
types offered in the default edit form. All supported types are
offered by default. The type of new pages, if unspecified, now
defaults to the first of the wiki's allowed page types. The
'standard_page_type' property is no longer supported.

* zodb caching improvements for large wikis: many operations which
used to load all or many pages into cache will no longer do so if
a suitably configured catalog is available. This can greatly
reduce cache activity and peak per-transaction memory usage for
large wikis, improving performance and server uptime. Renaming and
deleting are still relatively memory-expensive; more optimizations
to come. To fully benefit, you should have a wiki catalog with
meta_type, id, Title, path, canonicalLinks, isIssue indexes and
id, Title, issueColour, parents, links metadata (IIRC). NB most
wikis don't need to worry about this. See
http://zwiki.org/MemoryUsage for some more details.

* the pages() method now returns catalog brains if possible,
otherwise brain-like objects (if there is no catalog), rather than
(expensive) page objects. It will also pass keyword arguments to
the catalog, if there is one, so is convenient for searching among
the pages of the current wiki (only). pageObjects() provides the
old behaviour.

* likewise, backlinksFor() now returns either catalog results or
similar brain-like objects. Old custom backlinks templates should
still work without upgrading, except in this (unlikely) case: when
there is a catalog with meta_type, path, and canonicalLinks
indexes but without page_url and linkTitle metadata.
(with help from Magog)

* the rendering code uses a simpler, more memory-efficient
pre-rendering and pre-linking scheme. The relative_urls property
is no longer supported.

* DTML-enabled pages now invoke DTML only when there is code in
the page, to avoid unnecessary parsing and reduce our memory
footprint.

* wiki link titles (last edited info in tooltips) have been
disabled for the moment.

* three new boolean properties are supported, on page or folder:
use_wikiname_links, use_bracket_links, use_doublebracket_links,
for configuring your linking syntax of choice (lightly tested).
You'll need to run /clearCache or /upgradeAll after changing these.

* be smarter about choosing where to store uploaded files - when
checking for the "uploads" subfolder, make sure it is a subobject
of the wiki folder, and make sure it is folderish.

* we support the STX :img: syntax, finally (IssueNo0601, etc.)

* bare urls containing ; (semicolon) are now recognized
(DeanGoodmanson)

* renaming fixes: add or remove brackets when appropriate; when
updating links, tolerate edit failures (eg due to regexp
recursion); also replace changed ids

* pages are now reindexed after being reparented, when a catalog
is present

* catalog lookup behaviour has changed:
"By default, Zwiki looks for an object named 'Catalog' in this wiki
folder (will not acquire) or a 'portal_catalog' (can acquire).
If a SITE_CATALOG property exists (can acquire), Zwiki will look
for an object by that name (can acquire); if no such object
exists, or SITE_CATALOG is blank, no catalog will be used."

* new catalogId() method returns id of the catalog in use, or
NONE. Requires 'Manage properties' permission.

* hasCatalog() is now public

* getPath() is now supported

* Title() is now always provided and is equivalent to pageName().
Use of title_or_id is now deprecated; DTML pages and skin
templates should use Title instead, to take best advantage of
future catalog optimizations etc.

* other misc. new methods: pageName(), summary(), size(),
cachedSize(), cachedDtmlSize()

* ChangeLog is no longer provided in releases for the moment, to
simplify maintenance

**Skins and content**

* RESPONSE is no longer provided in the namespace for DTML Method
skin templates; they must use REQUEST.RESPONSE (code simplification)

* new methods recentchanges(), searchwiki(), useroptions() provide
experimental skin-based implementations of these wiki pages, which
can be used when DTML pages are not allowed. The included
implementations are preliminary and unskinned (but customizable);
they are DTML methods so as to reuse code from the evolving
page-based implementations, but you can also use page templates.

* if a SiteMap page exists, the "site contents" link in full mode
will point there instead. Also contents() now accepts a 'here'
page name argument to allow this page to control the "you are
here". See http://zwiki.org/SiteMap for an example.

* default skin: reduce subject field width again to "fix" too-wide
comment form

* default editform: show the page rename field as in the plone skin
(but display only if the user has rename permission)

* default search field & SearchPage: use GET when searching, for
more useful URLs

* default, zwiki_plone editform: show the STX and HTML page types
with "(+ DTML)" when DTML is allowed

* default, zwiki_plone editform: clear the "sticky" last log note when
creating a page

* default, zwiki_plone subscribeform: fix other subscribed page links

* zwiki_plone: initial cut of a wiki navigation portlet for Plone.
(AlexanderLimi)

* zwiki_plone: Added File Uploads Overview template (AlexanderLimi)

* zwiki_plone: made the wiki editform explanation more clear.
(AlexanderLimi)

* zwiki_plone editform: make the convenient alt-s (save) key work
again

* zwiki_plone: fix links in ancestor list

* content/basic/RecentChanges.stxdtml, SearchPage.stxdtml,
UserOptions.stxdtml, and content/tracker/IssueTracker.stxdtml,
FilterIssues.stxdtml: latest catalog-optimized versions from
zwiki.org

* content/basic/SearchPage.stxdtml: remove other search tools for
now

**Mail and messages**

* fix message id inconsistencies preventing proper threading in
mail clients (IssueNo0587)

* mailout policy change: don't mail out page rename and deletions
with default 'comments' policy. Also don't mail out when
placeholder pages are created during rename.

* don't put brackets around mail sender's name in message
headings.. too clever

* the 'auto_subscribe' option now automatically subscribes a
page's creator, as well as commenters. Also it's possible to use
this property on a page now.

* the subscribe/unsubscribe methods now support a redirectURL
REQUEST parameter, which makes them more flexible

* fix unicode/UnixMailbox problem. Comments made on the
place-holder page left after a rename would not appear, since the
text was unicode. Removed the i18n for the moment so this works.

* try a fix for non-formatted comment headers in certain timezones
(IssueNo0552)

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

Bugfix release.

* support old Wiki Folders (IssueNo0571)

* drop confusing allowed_page_types option

* fix scroll to bottom after comment

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

A number of important bugfixes & usability tweaks for wiki mail and
the Plone/CMF skin, and preliminary optional Purple Numbers support
(fine-grained linking).

**Upgrade notes**

Should be routine. Upgrading to this release is recommended.

**General**

* CMF/Plone: Wiki Folder is no more! use ordinary folders instead.
NB this means you can't create a pre-populated wiki for the
moment; copy RecentChanges, UserOptions, SearchPage, HelpPage,
ZWiki etc. from zwiki.org if you need them.

* experimental Purple Numbers support for zwiki. A true
'use_purple_numbers' boolean property on the folder or page will
cause persistent id numbers (node ids) to be embedded within
source text and rendered as purple links (after your next page
edit). These are usable (with quirks) on (non-DTML) STX pages,
not yet on RST or WWML or the non-wiki page types. Performance
impact when rendering large pages is unknown. Cf
http://zwiki.org/PurpleNumbers .
(Mike Mell, Simon Michael, thanks to Eugene Kim & PurpleWiki)

* fixed a pageWithFuzzyName error in BTreeFolders (IssueNo0535)

* stxprelinkfitissue and wwmlprelinkfitissue page types weren't
being auto-upgraded (IssueNo0546)

* use absolute urls in STX footnotes and comment headings so these
links work in CMF/Plone (IssueNo0550)

* use latest page types in new wikis, avoiding excessive
"non-allowed page type" warnings in edit form (IssueNo0564)

**Skins and content**

* the zwiki product icon was not checked in to CVS as a binary
file, which may have been causing problems for (even crashing!)
certain web browsers in the ZMI (Alexander Limi)

* zwiki_plone: close anchor tags in comment headings to prevent
bogus hyperlinks in Plone

* zwiki_plone: initial cut at breadcrumbs-style display of page
parents (Alexander Limi)

* zwiki_plone wikipage_footer: don't show the add comment box if
user doesn't have add comment permission

* default, zwiki_plone: make the editform's non-allowed page type
warning show the developer name again, not the end-user name

* default, zwiki_plone: if a user edits a page again within 24
hours, re-use their last log note by default (idea: Dean
Goodmanson)

* default, zwiki_plone skins: editform code cleanups. The options
used by the editform template are now 'page', 'text' and 'action'
as described in the comments. 'id' and 'oldid' options are no
longer used (but are still provided by Zwiki, for backwards
compatibility with old templates).

* zwiki_plone editform rename support: you can now rename a page
via the edit form. A placeholder page will be left behind and
links on other pages will be updated if possible (this may need to
be made more robust). This ensures Zwiki-compliant page ids,
makes wiki page renaming possible in plone and makes wiki page
creation via the CMF/Plone content management interface work
better. Also, as a special case, if you are editing the sole page
in the wiki the page name field will default to "FrontPage", which
latest Plone will display by default. To support this, edit() and
create() now also do a rename if a new name is passed in the
"title" argument (so named for backwards compatibility).
(idea: Alexander Limi)

* zwiki_plone editform: clean up attributes/fix i18n for page type
radio buttons (fix for IssueNo0549 ?)

* zwiki_plone editform: in the heading, show whether you're
editing or creating (Alexander Limi)

* zwiki_plone editform: fix a 0.19 bug which showed the
originating page's text instead of an empty field when creating a
page (IssueNo0557)

* zwiki_plone editform: make editform work with CMF again
(IssueNo0560)

* zwiki plone editform: move least-used widgets to the bottom

**Mail and messages**

* comment heading display tweaks - message number no longer
displayed, date now links to more permanent url based on message
id, email sender's name is now enclosed in [] to link to personal
pages

* citations no longer cause HTML markup to be added to the page
text

* citations no longer have an extra blank line displayed before
them

* smarter paragraph filling in mail-outs: preserve citation
prefixes and leave indented paragraphs alone

* like TestPage, a page named 'SandBox' no longer sends mail to
whole-wiki subscribers

* display no messages, rather than an error, if unicode gets into
the page (and document some of the ways this can happen)

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

Simpler page types, smarter message handling, auto subscription
option; mail, skin and miscellaneous bugfixes; python 2.1 or greater
now required.

**Upgrade notes**

Page types have been simplified and renamed (both the end-user and
developer names) as mentioned below. If you have standard_page_type
or allowed_page_types properties on your wiki folders, you should
update them to the latest types (in the left column below):

I have dropped python 1.5.2 compatibility as of this release; this
allows us to use more up-to-date python 2.1 features and means zwiki
0.20 and later won't run on very old zope installations.

The comment method's arguments have changed.

**General**

* more page type simplifications:
As shipped, Zwiki now supports four main wiki page types and
three non-wiki page types::

wiki page types
'msgstxprelinkfitissuehtml' :'Structured Text',
'msgstxprelinkdtmlfitissuehtml':'Structured Text + DTML',
'msgrstprelinkfitissue' :'reStructured Text',
'msgwwmlprelinkfitissue' :'WikiWikiWeb markup',
non-wiki page types
'html' :'HTML',
'dtmlhtml' :'HTML + DTML',
'plaintext' :'Plain text',

The wiki page types have similar features (message formatting,
text formatting, wiki linking, pre-rendering, fit tests & issue
properties) except for the choice of text formatting rules (and
only the STX types allow HTML).

A wiki will offer a restricted subset of these in the editform:
Structured Text, reStructured Text, WikiWikiWeb markup, and HTML
by default. To offer other types, set a custom
allowed_page_types lines property on your wiki folder (or change
ALLOWED_PAGE_TYPES in Defaults.py).

* new message storage format:
Comments are now stored as rfc2822-style messages in mbox format
(think of a wiki page with an mbox stuck on the end). This looks
more verbose in the page source, but allows rich message data to
be stored in a standard way. Messages must begin with "strict"
mbox-style 'From ' separators. (If you ever need to add these,
upgradeMessages may help.) Messages stored in this way are
formatted for display with numbers and named anchors
(msgN, msgidXXX, messages). Message bodies are formatted with
the usual text formatting rules. Message-id and in-reply-to
headers are stored and threads are preserved when posting via
web. This behaviour has been added to all the main page types, but
some features require STX mode at present.

* fix memory leak when printing tracebacks
(IssueNo0536, Shane Hathaway)

* clean up '\r\n' line terminators if added by browser, in
comment().

**Mail**

* fill paragraphs in mailouts, finally. Also wrap at column 70,
not 78. (IssueNo0340)

* try to preserve indentation in mailouts somewhat. Each paragraph
will be re-indented as per it's first line. This means indentation
within a paragraph will be lost, and a paragraph with only it's
first line indented will become wholly indented. Hopefully this
will be better than the old policy of throwing away all
indentation. (IssueNo0538)

* prevent duplicates when integrated with a mailing list, by
excluding the address in the X-BeenThere header from mailout.
(comment's do_mailout argument replaced with exclude_address)
(IssueNo0519)

* a true auto_subscribe folder property will cause any commenters
to a page to be subscribed there (authenticated/usernamed
commenters, at least)

* exclude a page named "TestPage" from whole-wiki subscription.
Page subscribers will still receive mail from it.

**Tracker**

* supply default categories, severities, statuses lists for the
issue properties form if they have not been defined. This should
allow "IssueNoXXXX ..." pages to work in any wiki without
additional setup.

* tolerate whitespace in the issue_colours list

**Skins and content**

* zwiki_plone: added the last basic elements of the Plone styling,
cosmetic change to footer, external edit link moved to header.
(Alexander Limi)

* skins/zwiki_plone/subscribeform.pt: was a conflict ... I
manually resolved it... please test (Alan Runyan)

* zwiki_plone: minor fixes: fix change email address button label,
remove whitespace from comment form, remove stray code breaking
editform

* default: name error when changing email address in
subscribeform, fixed (IssueNo0537, Laura Trippi)

* default, zwiki_plone: make editform tolerate an out-of-date
allowed_page_types property (if allowed_page_types contains type
that no longer exists, we just list it with the others and rely on
auto-upgrade to fix the page); also tolerate whitespace there

* minor xhtml-compliance fixes

* make skin template error messages more to the point