Difference between revisions of "WikiDB"
(→News: r1143 released) |
(→v4 (r1143) released.: + note about documentation.) |
||
Line 19: | Line 19: | ||
Please report any issues in the [[WikiDB/Bugs|usual place]]. | Please report any issues in the [[WikiDB/Bugs|usual place]]. | ||
+ | |||
+ | Also, I am in the process of expanding/improving the wiki documentation, to bring it up-to-date with current functionality and to give a fuller overview of what is possible with WikiDB. Please bear with me whilst this is in progress. | ||
--[[User:HappyDog|HappyDog]] 23:02, 17 July 2015 (UTC) | --[[User:HappyDog|HappyDog]] 23:02, 17 July 2015 (UTC) |
Revision as of 23:03, 17 July 2015
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
v4 (r1143) released.
This is a major rewrite of the internals of WikiDB, which adds a much more flexible querying system. Query criteria can now be a lot more flexible, plus it is now possible to quickly run queries from the data tab for any table. There are a large number of fixes and improvements in this release, so please consult the CHANGELOG for full details.
Please report any issues in the usual place.
Also, I am in the process of expanding/improving the wiki documentation, to bring it up-to-date with current functionality and to give a fuller overview of what is possible with WikiDB. Please bear with me whilst this is in progress.
--HappyDog 23:02, 17 July 2015 (UTC)
Documentation
- 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:
- Reference:
- 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:
- 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.