Difference between revisions of "WikiDB/Index"
m (→Built-in data types: Another helpful link to the tutorial.) |
(→New wiki syntax: Added details about attributes, etc.) |
||
| Line 28: | Line 28: | ||
* [[WikiDB/Syntax#Data tag|<data> tag]] | * [[WikiDB/Syntax#Data tag|<data> tag]] | ||
| + | ** Attributes: <code>table</code>, <code>expand_when</code>, <code>fields</code>, <code>separator</code>, <code>template</code>, <code>thead</code>, <code>tfoot</code> | ||
* [[WikiDB/Syntax#Repeat tag|<repeat> tag]] | * [[WikiDB/Syntax#Repeat tag|<repeat> tag]] | ||
| + | ** Attributes: <code>table</code>, <code>sort</code>, <code>criteria</code> | ||
| + | ** Sub-tags: <code><header></code>, <code><footer></code> | ||
* [[WikiDB/Tutorial: Creating your own data type#Testing the type-sniffing|<guesstypes> tag]] | * [[WikiDB/Tutorial: Creating your own data type#Testing the type-sniffing|<guesstypes> tag]] | ||
| + | ** Attributes: ''none'' | ||
* [[WikiDB/Syntax#Table definitions|Table definition syntax]] | * [[WikiDB/Syntax#Table definitions|Table definition syntax]] | ||
Revision as of 11:05, 13 April 2019
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.
Special pages
Additional pages provided by WikiDB.
New wiki syntax
New wiki markup that WikiDB provides.
- <data> tag
- Attributes:
table,expand_when,fields,separator,template,thead,tfoot
- Attributes:
- <repeat> tag
- Attributes:
table,sort,criteria - Sub-tags:
<header>,<footer>
- Attributes:
- <guesstypes> tag
- Attributes: none
- 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 in any place where filter criteria may be specified. Note that when used in the criteria attribute of the <repeat> tag, you currently need to write > as > (due to the inherent restrictions on attribute values), so you may wish to use the alternative text-representation instead. Note that text-representations are case-insensitive.
- Equal
-
=or==orEQ - Not equal
-
<>or!=orNEQ - Greater than
-
>orGT - Less than
-
<orLT - Greater than or equal to
-
>=orGTE - Less than or equal to
-
<=orLTE - Conjunctions
-
ANDor&&or, -
ORor|| -
XOR - Grouping
-
()
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
