Difference between revisions of "WikiDB"

Revision as of 16:47, 12 September 2013

WikiDB is a MediaWiki extension which can be used to add database functionality to your wiki. Its core principal is to do this whilst still following a wiki-like workflow for creating and managing data. Data is therefore defined in-page via the standard editing process and, just as you can create links to pages that don't exist, you can put data into a table that doesn't exist, and you are able to display and query that data without requiring any formal structure to be defined.

By creating a table definition, however, you get to force fields to a certain data-type, define fields as aliases of each other (e.g. if different articles use a different name to refer to the same field) and easily flag up unexpected fields that may have been added in error. Changing the field definition instantly updates all data output on the wiki, however the original data is left unmodified. This means that schema changes will never result in data being lost or corrupted.

Because WikiDB allows you to define data on any page, the data can be located directly within the article it relates to. It is therefore easy to find, and there is no problem ensuring it stays up-to-date as the article changes. By default, WikiDB hides the raw data at the point that it is defined, on the assumption that you will output it in aggregated form elsewhere. However you also have the option of outputting it in a standard tabular form or to pass the fields as parameters to a template for in-line display (so if your wiki makes extensive use of infoboxes, it will be easy to update it so this data goes into a table as well).

For more information, see the documentation, below.

News

Download WikiDB Here!
Installation instructions • CHANGELOG • Older versions

MW 1.6 no longer supported

As of WikiDB v3, r844, MediaWiki 1.6.x and below are no longer supported (note that this is 1.6 - yup, that old - it still works fine on 1.16). This also means that PHP4 is no longer supported, as MediaWiki 1.7 requires PHP5.

If there are any users who require support for older versions of MediaWiki and who really are unable to upgrade (hopefully there are not many of you!), you can continue to use the previous version of WikiDB (v3, r816), which is available for download here.

I will no longer be testing on versions of MediaWiki prior to v1.17 and there is no guarantee that future releases will run on versions prior to this, but for the moment anything from 1.7 onwards should be fine. I don't plan to remove existing code that enables support for earlier versions and will continue to accept patches and bug reports against any MediaWiki version, so long as it's running on PHP5 - I just won't be pro-actively testing on those earlier versions.

-- HappyDog 12:25, 24 August 2013 (UTC)

Documentation

This extension is also documented at Extension:WikiDB on MediaWiki.org. If the pages are not in sync. then this version on my test wiki is always the most up-to-date.

• Getting Started:
  • Tutorial - Read this first!
  • Features - A list of the extension's current and planned functionality.
  • Installation - Everything you need to know to get the extension working.
  • Versioning - What the version numbers mean.
  • License - CC-BY-SA 2.0
• Using WikiDB:
  • Syntax - Current syntax for all elements of the extension.
  • Data types - A list of currently supported data types.
  • Tutorial: Creating your own data type
• Administering WikiDB:
  • Configuration settings
  • Maintenance scripts
  • Upgrading
• Support:
  • Bugs - Please report any bugs here.
  • Feature requests - Add any suggestions for new features to this page.
  • ToDo List - My list of planned features, and general (non-bug) issues that need fixing.
• Index

Technical Info

• Tables - Details about the new tables that are required by the extension.
• Files - Listings of all the files required by the extension.