Difference between revisions of "WikiDB/Index"
(+ public constants) |
m (→Public constants: tweak) |
||
Line 60: | Line 60: | ||
The following constants have been provided for use in configuring/customisting WikiDB. | The following constants have been provided for use in configuring/customisting WikiDB. | ||
− | === $wgWikiDBMaxRefreshRate === | + | === For $wgWikiDBMaxRefreshRate === |
As well as setting a numeric refresh rate, the following constants can be used when setting this variable. | As well as setting a numeric refresh rate, the following constants can be used when setting this variable. | ||
Line 66: | Line 66: | ||
* WIKIDB_RefreshAll | * 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. | The following constants have been provided for use when creating a custom type handler, in order to understand what operation is being requested. | ||
Revision as of 23:42, 23 February 2011
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.
Contents
Configuration settings
Used to configure how WikiDB works.
- $wgWikiDBNamespaces
- $wgWikiDBMaxRefreshRate
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
- image
- link
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 > 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 $wgWikiDBMaxRefreshRate
As well as setting a numeric refresh rate, the following constants can be used when setting this variable.
- 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