Difference between revisions of "WikiDB/Index"

Revision as of 10:12, 24 April 2015

For each category of item, this page contains an exhaustive list of available WikiDB features. Not all of these are documented elsewhere yet. I aim to ensure this page is always up-to-date with the latest features, even if the proper documentation doesn't appear until some time later.

Configuration settings

Used to configure how WikiDB works.

• $wgWikiDBNamespaces
• $wgWikiDBMaxRefreshRate
• $wgWikiDBDefaultClasses

Maintenance scripts

Command-line scripts for creating, upgrading or maintaining the WikiDB database.

• RebuildWikiDB.php
• RefreshStaleData.php
• SetupTables.php
• UpdateTableNS.php

Special pages

Additional pages provided by WikiDB.

• Special:AllTables
• Special:EmptyTables
• Special:UndefinedTables
• 'data' tab

New wiki syntax

New wiki markup that WikiDB provides.

• <data> tag
• <repeat> tag
• <guesstypes> tag
• Table definition syntax

Built-in data types

Data types provided by WikiDB for use when defining tables. It is also possible for you to create custom data types, if necessary.

• wikistring
• string
• integer / int
• number
• link
• image

Meta-data fields

Extra fields that are included in each row of data, that may be referenced within the <repeat> tag.

• _SourceArticle
• _Row

Criteria operators

The following operators are available for use within the criteria attribute of the <repeat> tag. Note that, due to the restrictions on attribute values, you currently need to write > as &gt; but I am working on a solution to this (which will probably result in a different way of defining criteria - see WikiDB/Repeat tag syntax).

• <> or !=
• >
• <
• =
• >=
• <=

Public constants

The following constants have been provided for use in configuring/customisting WikiDB.

For setting $wgWikiDBMaxRefreshRate

• WIKIDB_DisableAutoRefresh
• WIKIDB_RefreshAll

For custom type handlers

The following constants have been provided for use when creating a custom type handler, in order to understand what operation is being requested.

• WIKIDB_Validate
• WIKIDB_FormatForDisplay
• WIKIDB_FormatForSorting
• WIKIDB_GetSimilarity