Editing WikiDB/Index

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.

== [[WikiDB/Configuration settings|Configuration settings]] ==
Used to configure how WikiDB works.

* [[WikiDB/Configuration settings#$wgWikiDBNamespaces|$wgWikiDBNamespaces]]
* [[WikiDB/Configuration settings#$wgWikiDBMaxRefreshRate|$wgWikiDBMaxRefreshRate]]
* [[WikiDB/Configuration settings#$wgWikiDBDefaultClasses|$wgWikiDBDefaultClasses]]

== [[WikiDB/Maintenance scripts|Maintenance scripts]] ==
Command-line scripts for creating, upgrading or maintaining the WikiDB database.

* [[WikiDB/Maintenance scripts#RebuildWikiDB.php|RebuildWikiDB.php]]
* [[WikiDB/Maintenance scripts#RefreshStaleData.php|RefreshStaleData.php]]
* [[WikiDB/Maintenance scripts#SetupTables.php|SetupTables.php]]
* [[WikiDB/Maintenance scripts#UpdateTableNS.php|UpdateTableNS.php]]

== Special pages ==
Additional pages provided by WikiDB.

* [[Special:AllTables]]
* [[Special:EmptyTables]]
* [[Special:UndefinedTables]]
* 'data' tab

== [[WikiDB/Syntax|New wiki syntax]] ==
New wiki markup that WikiDB provides.

* [[WikiDB/Syntax#Data tag|&lt;data&gt; tag]]
** Attributes: <code>table</code>, <code>fields</code>, <code>separator</code>, <code>template</code>, <code>thead</code>, <code>tfoot</code>, <code>expand_when</code>
* [[WikiDB/Syntax#Repeat tag|&lt;repeat&gt; tag]]
** Attributes: <code>table</code>, <code>sort</code>, <code>criteria</code>
** Sub-tags: <code>&lt;header&gt;</code>, <code>&lt;footer&gt;</code>
* [[WikiDB/Tutorial: Creating your own data type#Testing the type-sniffing|&lt;guesstypes&gt; tag]]
** Attributes: ''none''
* [[WikiDB/Syntax#Table definitions|Table definition syntax]]

== [[WikiDB/Data types|Built-in data types]] ==
Data types provided by WikiDB for use when defining tables.  It is also possible for you to [[WikiDB/Tutorial: Creating your own data type|create custom data types]], if necessary.

* [[WikiDB/Data types#wikistring|wikistring]]
* [[WikiDB/Data types#string|string]]
* [[WikiDB/Data types#integer|integer / int]]
* [[WikiDB/Data types#number|number]]
* [[WikiDB/Data types#link|link]]
* [[WikiDB/Data types#image|image]]

== Meta-data fields ==
Extra fields that are included in each row of data, that may be referenced within the &lt;repeat&gt; tag.

* _SourceArticle
* _Row

== Criteria operators ==
The following operators are available for use within the <code>criteria</code> attribute of the <code>&lt;repeat&gt;</code> tag.  Note that, due to the inherent restrictions on attribute values, you currently need to write <code>></code> as <code>&amp;gt;</code>, so you may wish to use the alternative text-representation instead.  Note that text-representations are case-insensitive.

; Equal
: <code>=</code> or <code>==</code> or <code>EQ</code>
; Not equal
: <code><></code> or <code>!=</code> or <code>NEQ</code>
; Greater than
: <code>></code> or <code>GT</code>
; Less than
: <code><</code> or <code>LT</code>
; Greater than or equal to
: <code>>=</code> or <code>GTE</code>
; Less than or equal to
: <code><=</code> or <code>LTE</code>
; Conjunctions
: <code>AND</code> or <code>&&</code> or <code>,</code>
: <code>OR</code> or <code>||</code> 
: <code>XOR</code>
; Grouping
: <code>(</code> <code>)</code>

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

=== For setting [[WikiDB/Configuration settings#$wgWikiDBMaxRefreshRate|$wgWikiDBMaxRefreshRate]] ===

* WIKIDB_DisableAutoRefresh
* WIKIDB_RefreshAll

=== For custom type handlers ===
The following constants have been provided for use when [[WikiDB/Tutorial: Creating your own data type|creating a custom type handler]], in order to understand what operation is being requested.

* WIKIDB_Validate
* WIKIDB_FormatForDisplay
* WIKIDB_FormatForSorting
* WIKIDB_GetSimilarity