Difference between revisions of "WikiDB/Index"
m (→Public constants: tweak) |
(Added a bunch of links to existing or anticipated content.) |
||
| Line 1: | Line 1: | ||
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. | 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 == | + | == [[WikiDB/Configuration settings|Configuration settings]] == |
Used to configure how WikiDB works. | Used to configure how WikiDB works. | ||
| − | * $wgWikiDBNamespaces | + | * [[WikiDB/Configuration settings#$wgWikiDBNamespaces|$wgWikiDBNamespaces]] |
| − | * $wgWikiDBMaxRefreshRate | + | * [[WikiDB/Configuration settings#$wgWikiDBMaxRefreshRate|$wgWikiDBMaxRefreshRate]] |
| − | == Maintenance scripts == | + | == [[WikiDB/Maintenance scripts|Maintenance scripts]] == |
Command-line scripts for creating, upgrading or maintaining the WikiDB database. | Command-line scripts for creating, upgrading or maintaining the WikiDB database. | ||
| Line 23: | Line 23: | ||
* 'data' tab | * 'data' tab | ||
| − | == New wiki syntax == | + | == [[WikiDB/Syntax|New wiki syntax]] == |
New wiki markup that WikiDB provides. | New wiki markup that WikiDB provides. | ||
| − | * <data> tag | + | * [[WikiDB/Syntax#Data tag|<data> tag]] |
| − | * <repeat> tag | + | * [[WikiDB/Syntax#Repeat tag|<repeat> tag]] |
* <guesstypes> tag | * <guesstypes> tag | ||
| − | * Table definition syntax | + | * [[WikiDB/Syntax#Table definitions|Table definition syntax]] |
| − | == Built-in data types == | + | == [[WikiDB/Data types|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. | Data types provided by WikiDB for use when defining tables. It is also possible for you to create custom data types, if necessary. | ||
| − | * wikistring | + | * [[WikiDB/Data types#wikistring|wikistring]] |
| − | * string | + | * [[WikiDB/Data types#string|string]] |
| − | * integer / int | + | * [[WikiDB/Data types#integer|integer / int]] |
| − | * number | + | * [[WikiDB/Data types#number|number]] |
| − | * | + | * [[WikiDB/Data types#link|link]] |
| − | * | + | * [[WikiDB/Data types#image|image]] |
== Meta-data fields == | == Meta-data fields == | ||
| 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. | ||
| − | === For $wgWikiDBMaxRefreshRate === | + | === For setting [[WikiDB/Configuration settings#$wgWikiDBMaxRefreshRate|$wgWikiDBMaxRefreshRate]] === |
| − | + | ||
* WIKIDB_DisableAutoRefresh | * WIKIDB_DisableAutoRefresh | ||
Revision as of 23:45, 25 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.
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.
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 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
