Difference between revisions of "WikiDB/Index"
(→Special pages: Make into links to local versions of these pages, by way of example.) |
m (→New wiki syntax: Better ordering) |
||
(6 intermediate revisions by the same user not shown) | |||
Line 28: | Line 28: | ||
* [[WikiDB/Syntax#Data tag|<data> tag]] | * [[WikiDB/Syntax#Data tag|<data> 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|<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]] | ||
== [[WikiDB/Data types|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 [[WikiDB/Tutorial: Creating your own data type|create custom data types]], if necessary. |
* [[WikiDB/Data types#wikistring|wikistring]] | * [[WikiDB/Data types#wikistring|wikistring]] | ||
Line 49: | Line 53: | ||
== Criteria operators == | == Criteria operators == | ||
− | The following operators are available for use | + | The following operators are available for use in any place where filter criteria may be specified. Note that when used in the <code>criteria</code> attribute of the <code><repeat></code> tag, you currently need to write <code>></code> as <code>&gt;</code> (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 | |
− | + | : <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 == | == Public constants == | ||
Line 67: | Line 83: | ||
=== For custom type handlers === | === 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 [[WikiDB/Tutorial: Creating your own data type|creating a custom type handler]], in order to understand what operation is being requested. |
* WIKIDB_Validate | * WIKIDB_Validate |
Latest revision as of 10:06, 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[edit]
Used to configure how WikiDB works.
Maintenance scripts[edit]
Command-line scripts for creating, upgrading or maintaining the WikiDB database.
Special pages[edit]
Additional pages provided by WikiDB.
New wiki syntax[edit]
New wiki markup that WikiDB provides.
- <data> tag
- Attributes:
table
,fields
,separator
,template
,thead
,tfoot
,expand_when
- Attributes:
- <repeat> tag
- Attributes:
table
,sort
,criteria
- Sub-tags:
<header>
,<footer>
- Attributes:
- <guesstypes> tag
- Attributes: none
- Table definition syntax
Built-in data types[edit]
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[edit]
Extra fields that are included in each row of data, that may be referenced within the <repeat> tag.
- _SourceArticle
- _Row
Criteria operators[edit]
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
-
AND
or&&
or,
-
OR
or||
-
XOR
- Grouping
-
(
)
Public constants[edit]
The following constants have been provided for use in configuring/customisting WikiDB.
For setting $wgWikiDBMaxRefreshRate[edit]
- WIKIDB_DisableAutoRefresh
- WIKIDB_RefreshAll
For custom type handlers[edit]
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