changeset 3736:1a7574a7952c

preparing a condensed CHANGES for 1.7.0 release
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Sat, 21 Jun 2008 18:54:18 +0200
parents 76265568e8d3
children 691271d8c211
files docs/CHANGES
diffstat 1 files changed, 189 insertions(+), 243 deletions(-) [+]
line wrap: on
line diff
--- a/docs/CHANGES	Sat Jun 21 16:33:56 2008 +0200
+++ b/docs/CHANGES	Sat Jun 21 18:54:18 2008 +0200
@@ -32,94 +32,192 @@
 
 
 Version 1.7.0current:
-
-  Bug Fixes:
-    * PageEditor: fixed msg displaying the notified people - use a breakable
-      list.
-    * Fixed RenamePage comment handling, let RecentChanges generate (and
-      translate) the comment.
-    * Fixed OpenID RP bug when invalid usernames were entered.
-    * Fix MyPages action (gave traceback and used wrong link markup).
-
-  New Features:
+  Note: This is a reduced CHANGES, ommitting details from rc/beta test and
+        also less interesting minor changes and fixes. It shows changes
+        relative to 1.6.3 release.
+        If you want to see full detail, read it there:
+        http://hg.moinmo.in/moin/1.7/file/76265568e8d3/docs/CHANGES
+
+  New Features: ==============================================================
+    * HINT: we added generic UPDATE instructions as docs/UPDATE.html.
+
+    * HINT: Standalone server usage changed:
+      * Standalone server can now be started via the "moin" script command,
+        optionally backgrounding itself.
+        See: moin server standalone --help
+      * In the toplevel dir, we have renamed moin.py to wikiserver.py (it was
+        often confused with the moin scripting command).
+        Now you have:
+        * wikiserver.py - to start the standalone server
+        * wikiserverconfig.py - to configure the standalone server
+        * wikiserverlogging.conf - to configure logging for it (default config
+          is ok for all day use, but can easily be modified for debugging)
+        * wikiconfig.py - to configure the wiki engine
+      * Removed old moin daemonizing script (replaced by moin server standalone
+        --start/stop)
+      * We now provide the "moin" script command also for people not using
+        setup.py, see wiki/server/moin.
+
+    * Logging
+      * New powerful and flexible logging, please see wiki/config/logging/ -
+        HINT: you have to upgrade your server adaptor script (e.g. moin.cgi)
+        and load a logging configuration that fits your needs from there, or
+        alternatively you can also set MOINLOGGINGCONF environment variable
+        to point at your logging config file.
+        If you use some of our sample logging configs, make sure you have a
+        look INTO them to fix e.g. the path of the logfile it will use.
+      * Moin now logs the path from where it loaded its configuration(s).
+
+    * Authentication / Sessions:
+      * HINT: New authentication plugin system, see HelpOnAuthentication. If
+        you do not use the builtin default for 'auth' list, you likely have to
+        change your configuration. See wiki/config/snippets/ for some samples.
+      * HINT: New session handling system (no moin_session any more, now done
+        internally and automatically), see HelpOnSessions for details.
+      * Added OpenID client and server support.
+        See: HelpOnAuthentication and HelpOnOpenIDProvider.
+      * cfg.trusted_auth_methods is a list of auth methods that put an
+        authenticated user into the "Trusted" ACL group.
+
+    * User preferences / password recovery / notification:
+      * New recoverpass action for password recovery:
+        If you forgot your password, recoverpass sends you an email with a
+        password recovery token (NOT the encrypted password) that is valid
+        for 12 hours.
+      * New moin account resetpw script for resetting a user's password by
+        the wiki admin.
+      * New preferences plugin system, see MoinMoin/userprefs/__init__.py.
+      * New notification system with an optional jabber notification bot, see
+        HelpOnNotification. HINT: wiki users have to check their notification
+        settings, esp. if they want to receive trivial update notifications.
+
+    * The diff action now has navigation buttons for prev/next change.
     * ThemeBase: support Universal Edit Button, see there for details:
       http://universaleditbutton.org/
-    * Added OpenID server settings dialog to allow removing trusted websites.
-    * Add moin account resetpw script.
-
-  Other Changes:
-    * Allow trusted users to go beyond surge action limits, but log their names
-      if it happens.
-    * Added MyPages and CopyPage to actions_excluded because MyPages doesn't
-      work without special SecurityPolicy anyway and CopyPage has questionable
-      behaviour.
-
-
-Version 1.7.0rc3:
-
-  Bug Fixes:
-    * Fix xmlrpc request.read() call to use content-length, if available,
-      fixes hangs with wsgiref server.
-    * Fix traceback in filesys.py on Mac OS X when import Carbon fails.
-    * Xapian search / indexing:
-      * fix searching for negative terms
-      * improve result list ordering
-      * index filters: redirect stderr to logging system
-      * search results: improve ordering
-    * FootNote macro: revert to old behaviour (using the arg parser made
-      problems with footnotes including commas)
-    * Wiki parser: fix subscript parsing (was broken for cases like 'a,,1,2,,').
-    * Fixed MoinMoinBugs/WikiSyncMissingInterWikiNameOnRemoteSide
-    * Fixed 1.7 mig scripts.
-    * Clear openid cache when saving a user.
-    * Add "Use FirstnameLastname" message to newaccount form.
-    * Make recoverpass/newaccount refuse access unless MoinAuth is enabled.
-    * info action: fix exception happening for invalid query args
-    * AttachFile action:
-      * catch runtime errors raised by zipfile stdlib modules when trying to
-        process a defective zip
-      * when unzipping member files, decode their filenames from utf-8 and
-        replace invalid chars
-
-  Other changes:
+    * ?action=info&max_count=42 - show the last 42 history entries of the page.
+      max_count has a default of default_count and a upper limit of
+      limit_max_count - you can configure both in your wiki config:
+      cfg.history_count = (100, 200) # (default_count, limit_max_count) default
+    * The CSV parser can sniff the delimiter from the first CSV line so other
+      delimeters than ";" can be used.
+    * Admonition support. Added styling for tip, note, important, warning 
+      and caution in the modern theme. For more info see HelpOnAdmonitions.
+    * DocBook-formatter:
+      * supports HTML entities like &rarr; and &#9731;
+      * supports the FootNote macro
+      * supports bulletless lists
+      * support for admonitions
+      * will export the wiki page's edit history as the generated article's
+        revision history. Doesn't add history of included pages.
+      * supports for the MoinMoin comment element, though only inline comments
+        are likely to be valid since the DocBook remark is an inline element.
+
+  Removed Features: ==========================================================
+    * HINT: Removed attachments direct serving (cfg.attachments - this was
+            deprecated since long!). Use AttachFile action to serve attachments.
+    * Duplicated file attachment upload code was removed from Load action (just
+      use AttachFile action to deal with attachments).
+
+  Bug Fixes: =================================================================
+    * Better handling of ImportErrors (farmconfig, macros, wikiserverconfig).
+    * Fix failure of detection of on-disk cache updates.
+    * Fix traceback in filesys.py on Mac OS X when "import Carbon" fails.
+
+    * AttachFile action / file up- and download / zip support:
+      * WSGI: use wsgi.file_wrapper (or a builtin simple wrapper). Fixes memory
+        consumption for sending of large file attachments.
+      * FastCGI: flush often. Fixes memory consumption for sending of large
+        file attachments.
+      * Use the open temporary file for receiving file attachment uploads
+        (fixes big memory consumption for large file uploads).
+      * Catch runtime errors raised by zipfile stdlib modules when trying to
+        process a defective zip.
+      * When unzipping member files, decode their filenames from utf-8 and
+        replace invalid chars.
+      * AttachFile/Load: remove misleading/outdated text, fix UI cosmetics.
+      * Make error msg less confusing when trying to overwrite a file attachment
+        without having 'delete' rights.
+
+    * Xapian search / indexing / stemming:
+      * Use text/<format> as mimetype for pages.
+      * Index also major and minor for mimetypes, so it will find 'text' or
+        'plain' as well as 'text/plain'
+      * Fix searching for negative terms.
+      * Improve result list ordering.
+      * Index filters: redirect stderr to logging system.
+      * Remove crappy num regex from WikiAnalyzer, improve tokenization.
+      * Fix AttributeError that happened when trying to access an attribute only
+        used with xapian search (but regex search is not done by xapian)
+      * Fix IndexErrors happening when pages are renamed/nuked after the index
+        was built.
+      * Fixed indexing of WikiWords (index "WikiWords", "Wiki" and "Words").
+      * Fix crash if default language is un-stemmable.
+      * xapian_stemming: removed some strange code (fixes search
+        title:lowercaseword with xapian_stemming enabled)
+      * Fixed category indexing (index CategoryFoo correctly as CategoryFoo, not
+        Foo - for all languages, see page_*_regex change below).
+    * Builtin search: support mimetype: search for pages for the builtin search
+      engine (using text/<format>).
+
+    * HINT: page_*_regex processing had to be changed to fix Xapian category
+      search. If you don't use the builtin (english) defaults, you will have
+      to change your configuration:
+        old (default): page_category_regex = u'^Category[A-Z]'
+        new (default): page_category_regex = ur'(?P<all>Category(?P<key>\S+))'
+      As you see, the old regex did work for detecting whether a pagename is
+      a category, but it could not be used to search for a category tag in the
+      page text. The new regex can be used for both and identifies the complete
+      category tag (match in group 'all', e.g. "CategoryFoo") as well as the
+      category key (match in group 'key', e.g. "Foo") by using named regex
+      groups. \S+ means the category key can be anything non-blank.
+      If you like to simultaneously support multiple languages, use something
+      like this: ur'(?P<all>(Kategorie|Category)(?P<key>\S+))'
+
+    * Parser fixes:
+      * Wiki: fix subscript parsing (was broken for cases like 'a,,1,2,,').
+      * Docbook: fixed detection of WikiWords.
+      * All: Add ssh protocol to url_schemas for ssh:... URLs.
+
+    * XMLRPC:
+      * Fix xmlrpc request.read() call to use content-length, if available,
+        fixes hangs with wsgiref server.
+      * Wiki xmlrpc getPageInfoVersion() fixed:
+        * works correctly now for old page versions (was unsupported)
+        * works correctly now for current page version (reported wrong
+          data when a page had attachment uploads after the last page
+          edit)
+        * returns a Fault if it did not find a edit-log entry
+
+  Other Changes: =============================================================
+    * Using better ACLs and comments on system/help pages now, just taking
+      away 'write' permission, but using default ACLs for everything else.
     * HINT: If you want to use xapian based indexed search, you need to have
-            Xapian >= 1.0.0.
-    * Removed dependency on PyStemmer (we just use the stemmer built into
-      Xapian (it uses utf-8 since 1.0.0, so we can use it)).
-    * Use better ACLs and comments on system/help pages,
-      remove MoinPagesEditorGroup (not needed any more).
-    * If a user is authenticated by a trusted authentication (see also
-      cfg.auth_methods_trusted) then he won't trigger surge protection.
-      But moin will log a INFO level log msg with the user's name so you can
-      find the culprit in case he/she is overusing ressources.
-    * docs: added UPDATE instructions
-
-
-Version 1.7.0rc2:
-
-  Bug Fixes:
-    * Security Fix: fixed MoinMoinBugs/DummyPasswordInAutoCreatedLdapUserProfiles
-      (bug was present since some auth refactoring in 1.7.0alpha).
-    * Fix editor preview not working for new pages.
-    * Add ssh protocol to url_schemas.
-    * Fix PageList macro with search errors.
-    * Center the message icons and fix their spacing. Add a class to the
-      "Clear message" link, make the link text smaller and lower.
-    * Better handling of ImportErrors (farmconfig, macros, wikiserverconfig).
-    * Builtin search: support mimetype: search for builtin engine, too
-    * Xapian search/indexing:
-      * use text/<format> as mimetype for pages
-      * index also major and minor for mimetypes, so it will find 'text' or
-        'plain' as well as 'text/plain'
-      * remove crappy num regex from WikiAnalyzer, improve tokenization
-    * Fix the second hmac use for python 2.4
-    * csv parser:
-      * fix delimiter sniffing troubles, fix tests
-      * remove empty lines above the csv table
-    * Event notifications: send notifies in the language of the message
-      recipient (not of the current wiki user), other fixes.
-
-  Other changes:
+      Xapian >= 1.0.0 (and you can remove PyStemmer in case you have installed
+      it just for moin - we now use the stemmer built into Xapian as it
+      supports utf-8 since 1.0.0).
+    * Surge Protection: If a user is authenticated by a trusted authentication
+      (see also cfg.auth_methods_trusted) then he/she won't trigger surge
+      protection, but moin will just log a INFO level log msg with the user's
+      name so you can find the culprit in case he/she is overusing ressources.
+    * HINT: Added MyPages and CopyPage to actions_excluded because MyPages
+      doesn't work without special SecurityPolicy anyway and CopyPage has
+      questionable behaviour.
+    * Load action now just creates a new revision of the target page, the
+      target pagename defaults to the current page name and can be edited.
+      If the target pagename is empty, moin tries to derive the target pagename
+      from the uploaded file's name.
+      Load tries to decode the file contents first using utf-8 coding and, if
+      that fails, it forces decoding using iso-8859-1 coding (and replacing
+      invalid characters).
+    * HINT: cfg.show_login is gone, see code in theme/__init__.py, this may
+      affect many themes!
+    * HINT: a new userprefs/ plugin directory will be created by the usual
+      "moin migration data" command.
+    * DocBook-formatter:
+      * generates a valid DOCTYPE
+      * table support has been improved
+      * handling of definitions and glossaries is more robust
+      * supports program language and line numbering in code areas
     * HINT: ldap_login behaves a bit different now:
       In previous moin versions, ldap_login tended to either successfully
       authenticate a user or to completely cancel the whole login process in
@@ -144,160 +242,12 @@
           ldap_auth2 = LDAPAuth(server_uri='ldap://backupserver', ...)
           auth = [ldap_auth1, ldap_auth2, ]
 
-
-Version 1.7.0rc1:
-
-  Bug Fixes:
-    * Fix hmac for Python 2.4.
-    * AttachFile: fix uploading of < 1K files
-    * fix action=info on page that never existed
-    * deny access on invalid input (happens only with spammers anyway)
-    * fix failure of detection of on-disk cache updates
-
-
-Version 1.7.0beta2:
-
-  Bug Fixes:
-    * HINT: page_*_regex processing had to be changed to fix Xapian category
-      search. If you don't use the english defaults, you will have to change
-      your configuration:
-        old (default): page_category_regex = u'^Category[A-Z]'
-        new (default): page_category_regex = ur'(?P<all>Category(?P<key>\S+))'
-      As you see, the old regex did work for detecting whether a pagename is
-      a category, but it could not be used to search for a category tag in the
-      page text. The new regex can be used for both and identifies the complete
-      category tag (match in group 'all', e.g. "CategoryFoo") as well as the
-      category key (match in group 'key', e.g. "Foo") by using named regex
-      groups. \S+ means the category key can be anything non-blank.
-      If you like to simultaneously support multiple languages, use something
-      like this: ur'(?P<all>(Kategorie|Category)(?P<key>\S+))'
-    * Xapian indexing / search / stemming:
-      * fix AttributeError that happened when trying to access an attribute only
-        used with xapian search (but regex search is not done by xapian)
-      * fix IndexErrors happening when pages are renamed/nuked after the index
-        was built
-      * fix crash if default language is un-stemmable
-      * Fixed indexing of WikiWords (index "WikiWords", "Wiki" and "Words")
-      * Fixed category indexing (index CategoryFoo correctly as CategoryFoo, not
-        Foo - for all languages, see page_*_regex change above)
-      * xapian_stemming: removed some strange code (fixes search
-        title:lowercaseword with xapian_stemming enabled)
-    * AttachFile / file upload / download:
-      * WSGI: use wsgi.file_wrapper (or a builtin simple wrapper). Fixes memory
-        consumption for sending of large file attachments.
-      * FastCGI: flush often. Fixes memory consumption for sending of large
-        file attachments
-      * use the open temporary file for file uploads (fixes big memory
-        consumption for large file uploads).
-        !!! Twisted and mod_python is completely untested !!!
-      * AttachFile/Load: remove misleading/outdated text, fix UI cosmetics
-      * Fixed traceback for attachment notifications.
-      * make error msg less confusing when trying to overwrite a file attachment
-        without having acl delete rights
-    * Wiki xmlrpc getPageInfoVersion() fixed:
-      * works correctly now for old page versions (was unsupported)
-      * works correctly now for current page version (reported wrong
-        data when a page had attachment uploads after the last page
-        edit)
-      * returns a Fault if it did not find a edit-log entry
-    * SystemAdmin user browser: handle empty email/jabber addresses correctly
-    * events.wikidictsrescan: handle TrivialPageChangedEvent too (bug fix for
-      MoinMoinBugs/17devWikiDictsDontUpdate)
-    * Fixed detection of WikiWords for the docbook parser.
-
-  New features:
-    * Password recovery (recoverpass action):
-      If you forgot your password, this action sends you an email with a password
-      recovery token (NOT the encrypted password). Token is valid for 12 hours.
-    * Logging: you can use MOINLOGGINGCONF environment variable now to override
-      from where your logging config is read.
-
-  Other changes:
-    * HINT: in the toplevel dir, we have renamed moin.py to wikiserver.py (it
-      was often confused with the moin scripting command).
-      Now you have:
-      * wikiserver.py - to start the standalone server
-      * wikiserverconfig.py - to configure the standalone server
-      * wikiserverlogging.conf - to configure logging for it (default config
-        should be ok for all day use, but can easily be modified for debugging)
-      * wikiconfig.py - to configure the wiki engine
-    * removed old moin daemonizing script (replaced by moin server standalone
-      --start/stop)
-    * provide moin script command for people not using setup.py, see wiki/server/moin
-    * Duplicated file attachment upload code was removed from Load action (just
-      use AttachFile action to deal with attachments).
-    * Load action now just creates a new revision of the target page, the
-      target pagename defaults to the current page name and can be edited. If
-      the target pagename is empty, moin tries to derive the target pagename
-      from the uploaded file's name.
-      Load tries to decode the file contents first using utf-8 coding and, if
-      that fails, it forces decoding using iso-8859-1 coding (and replacing
-      invalid characters).
-
-  Developer notes (these should be moved to the end in the release):
+  Developer notes: ===========================================================
     * Page.last_edit() is DEPRECATED, please use Page.edit_info().
     * Page._last_edited() is GONE (was broken anyway), please use
       Page.editlog_entry().
-    * new request.send_file() call, making it possible to use server-specific
-      optimizations
-
-Version 1.7.0beta1:
-
-  New Features:
-    * New powerful and flexible logging, please see wiki/config/logging/ -
-      HINT: you have to upgrade your server adaptor script (e.g. moin.cgi)
-      and load a logging configuration that fits your needs from there, or
-      alternatively you can also set MOINLOGGINGCONF environment variable
-      to point at your logging config file.
-      If you use some of our sample logging configs, make sure you have a
-      look INTO them to fix e.g. the path of the logfile it will use.
-    * Moin now logs the path from where it loaded its configuration(s)
-    * cfg.trusted_auth_methods is a list of auth methods that put an
-      authenticated user into the "Trusted" ACL group.
-    * New authentication plugin system, see HelpOnAuthentication.
-    * New session handling system (no moin_session any more, now done
-      internally and automatically), see HelpOnSessions for details.
-    * New preferences plugin system, see MoinMoin/userprefs/__init__.py
-    * New notification system with an optional jabber notification bot.
-    * Jabber notification support; for more information see HelpOnNotification.
-    * Standalone server can now be started via the "moin" script command,
-      optionally backgrounding itself. See: moin server standalone --help
-    * The diff action now has navigation buttons for prev/next change.
-    * Admonition support. Added styling for tip, note, important, warning 
-      and caution in the modern theme. For more info see HelpOnAdmonitions.
-    * DocBook-formatter:
-      * supports HTML entities like &rarr; and &#9731;
-      * supports the FootNote macro
-      * supports bulletless lists
-      * support for admonitions
-      * will export the wiki page's edit history as the generated article's
-        revision history. Doesn't add history of included pages.
-      * supports for the MoinMoin comment element, though only inline comments
-        are likely to be valid since the DocBook remark is an inline element.
-    * ?action=info&max_count=42 - show the last 42 history entries of the page.
-      max_count has a default of default_count and a upper limit of
-      limit_max_count - you can configure both in your wiki config:
-      cfg.history_count = (100, 200) # (default_count, limit_max_count) default
-    * The CSV parser can get the delimiter from the first line so other
-      delimeters than ";" can be used.
-
-  Other changes:
-    * cfg.show_login is gone, see code in theme/__init__.py, this affects
-      many themes!
-    * HINT: a new userprefs/ plugin directory will be created by the usual
-      "moin migration data" command.
-    * Removed attachments direct serving (cfg.attachments - this was deprecated
-      since long!).
-    * The rst-parser's admonition class names are no longer prepended with
-      "admonition_". Instead the class names are now for example "note"
-      and not "admonition_note".
-    * DocBook-formatter:
-      * generates a valid DOCTYPE
-      * table support has been improved
-      * handling of definitions and glossaries is more robust
-      * supports program language and line numbering in code areas
-
-  Developer notes (these should be moved to the end in the release):
+    * New request.send_file() call, making it possible to use server-specific
+      optimizations.
     * getText's (aka _()) 'formatted' keyword param (default: True in 1.6 and
       early 1.7) was renamed/changed: it is now called 'wiki' and defaults to
       False. Example calls:
@@ -309,13 +259,9 @@
       was changed to default False).
     * The themedict no longer contains 'page_user_prefs' and 'user_prefs',
       this may affect custom themes.
-
-
-Version 1.6.current:
-  Fixes:
-    * The iconbar "up" icon (known from 1.5) is back. Although it is not too
-      useful if you use themes that have the navigation in the page title,
-      it is useful for themes not using that kind of navigation.
+    * The rst-parser's admonition class names are no longer prepended with
+      "admonition_". Instead the class names are now for example "note"
+      and not "admonition_note".
 
 
 Version 1.6.3: