Current development on JAMWiki is primarily focused on maintenance rather than new features due to a lack of developer availability. If you are interested in working on JAMWiki please join the jamwiki-devel mailing list.

JAMWiki 0.5.0

Release Notes[edit]

JAMWiki 0.5.0 is now available for download. This release includes new features and numerous bug fixes. Major changes made during this release include:

  • A new caching infrastructure that utilizes ehcache to improve performance.
  • The Acegi Security System is now used to handle user authentication.
  • Experimental support has been added for LDAP integration, RSS, WYSIWYG editing and XML import of Mediawiki files.

See the README.txt and CHANGELOG.txt files included in the JAMWiki distribution for additional details about this release. Users are also encouraged to visit http://jamwiki.org/ for more detailed documentation, and to report any problems.

IMPORTANT: JAMWiki is undergoing rapid development, and while the code is reasonably stable bug reports, feedback and contributions are encouraged and can be reported at http://jamwiki.org/.

Installation Instructions[edit]

New Installs[edit]

See Installation for the complete installation instructions; see the UPGRADE.txt for the complete upgrade instructions - DO NOT attempt to upgrade JAMWiki using the new installation process!

The basic steps for performing a new JAMWiki install are:

  1. Download the latest JAMWiki release from http://sourceforge.net/projects/jamwiki/.
  2. Deploy the JAMWiki WAR file. See your web application server's documentation for specific deployment instructions.
  3. (Optional) If using an external database create a new database instance that can be used by JAMWiki, or verify that a database user is available with permission to create tables and sequences. If support is needed for double-byte character sets be sure that the database uses UTF-8 encoding.
  4. (Optional) If using an external database verify that your JDBC driver is in the web application server's classpath.
  5. Update the org.jamwiki.pattern value in the logging.properties file with the location where log files should be written. The logging.properties file can be found in the /WEB-INF/classes/ directory of your installation. Note that the web application server must have permission to write to the specified log location.
  6. Once the JAMWiki WAR file has been deployed and the web application server started, view the http://<server>/<context>/ page, where <server> is the application server URL, and <context> is the application server context. The JAMWiki configuration process will begin automatically.

The configuration process begins automatically with the first JAMWiki pageview after setup. Configuration will request the following information:

  1. A directory (accessible to the application server) into which JAMWiki files can be written.
  2. A directory (accessible to the web/application server) into which images and other files can be uploaded.
  3. The relative path (with respect to the web/application server doc root) to the image upload directory.
  4. The login and password of an administrative user.
  5. (Optional) If using an external database for persistency then the database settings must be provided.
  6. (Optional) Once setup is complete, JAMWiki can be customized by using the Special:Admin page, accessible to admins by clicking on the "Admin" link on the top right portion of all JAMWiki pages.

Once the configuration settings have been verified JAMWiki will create the admin user account, database tables (if using an external database), base properties, and default topics. Once configuration is complete JAMWiki redirects to the starting page, ready for use. If any problems occur during installation please review the detailed installation instructions on Installation. If your problem persists please report it on Bug Reports and include any relevant information from your log files with the problem report.

Upgrades[edit]

In most cases upgrades can be handled using a mostly-automated wizard process. To upgrade using this automated process follow these steps:

  1. Download the latest JAMWiki release from http://sourceforge.net/projects/jamwiki/.
  2. Back up all database and/or file data prior to upgrading.
  3. Back up the jamwiki.properties file and the logging.properties from the the /WEB-INF/classes/ directory. These files will need to be restored after the new JAMWiki WAR file has been deployed.
  4. If you have made any changes to any other files under the /WEB-INF/ directory be sure that they are backed up as well as they will need to be restored after the new JAMWiki WAR file has been deployed.
  5. Remove the old JAMWiki installation by deleting your existing JAMWiki web application. For some web application servers you may also want to clear the application server's cache.
  6. Install the new JAMWiki WAR file. See your web application server's documentation for instructions.
  7. Restore the files that were backed up in steps three and four to their previous locations under the /WEB-INF/ and /WEB-INF/classes/ directories, overwriting any new files.
  8. (Optional) If using an external database, make sure that your JDBC driver is available in the web application server's classpath.
  9. Verify that the web application server process has read and write access to all files in the new JAMWiki installation.
  10. Restart the web application server and view any page on the Wiki. You will be redirected to the upgrade page and any required upgrade steps will be automatically performed.

If the upgrade fails see the UPGRADE.txt for instructions to manually upgrade. If the problem persists please report it on Bug Reports and include any relevant information from your log files with the problem report. Note that some users have reported failures after upgrading, but the problem was caused by old JAMWiki files being cached by the application server. This problem is particularly common with Tomcat, and can be resolved by clearing the application server's cache.

Changelog[edit]

New Features[edit]

  • Add ehcache library for caching of parsed topics and images.
  • Integrate the Acegi security framework (swift).
  • Add experimental support for LDAP.
  • Add experimental RSS support (swift).
  • Allow users to select a default locale (swift).
  • Consolidate configuration values into jamwiki-configuration.xml.
  • Add option to use WYSIWYG edit buttons (axelclk).
  • Add Special:Imagelist page to display a list of all images.
  • Add Special:Filelist page to display a list of all non-image files.
  • Experimental Special:Import XML import (gutsul).
  • Add support for the __FORCETOC__ tag.
  • Handle category names case-insensitive, thus "Category:Test" and "Category:test" are treated as the same category.
  • Display current date & time on Special:RecentChanges page.
  • Upgrade to Spring Framework 2.0.1.
  • Remove (now unused) convert-to-file option from Special:Convert.
  • Include the Bliki parser as an alternative to the default parser (axelclk).
  • Add access keys for edit page fields (axelclk).
  • Add option to open "printable page" links in a new window.
  • Add a check to verify a supported JDK version during setup.
  • Add pmd static code analysis target to the ANT build.xml file.

Bugfixes[edit]

  • Fixes for MS SQL issues (scroco).
  • "Login already exists" error when trying to update user account fixed.
  • Fix upload error with IE that could cause file upload to incorrectly set the file name.
  • The __TOC__ should force a table of contents to appear, even with fewer than four headings.
  • Do not allow users without proper permissions to move read-only or admin-only topics.
  • Properly log messages from Utilities and with configured log levels.
  • Resolve problems with unreliability in deletion/undeletion.
  • Fix failure when changing default topic for virtual wiki from Special:Admin.

Translation Updates[edit]

  • Added Dutch translations (Angel).
  • Added Ukranian translations (gutsul).
  • Updated Chinese translations (hfl).
  • Updated Polish translations (dlpa).
  • Updated German translations (axelclk).
  • Updated Hungarian translations (bDaneE).
  • Updated French translations (hgomez).