Template:Guide table
Jump to navigation
Jump to search
This template performs a Cargo query for guides and returns the results as a formatted table. Guide pages must use {{Guide}} in order to be queryable.
Parameters
Query parameters
These parameters are used to construct the Cargo query. For more information about how these parameters should be used, see Extension:Cargo/Querying data.
| Parameter | Value | Description | Required |
|---|---|---|---|
| where | str | The conditions that must be met for guides to appear in the table. This is the main portion of the WHERE clause in the query. | |
| tables | list[str] | A comma-separated list of any additional Cargo tables to select from. This corresponds to the FROM clause in the query. | |
| join | list[str] | Specifies how the rows are combined from any additional Cargo tables given by |tables=. This corresponds to JOIN clauses in the query.
|
|
| orderBy | list[str] | Fields to sort the results by, and in which order. This corresponds to the ORDER BY clause in the query. Defaults to guides._pageName ASC to sort the guides by their page name in alphabetical order.
|
|
| limit | int | The maximum number of rows to return. This corresponds to the LIMIT clause in the query. | |
| groupBy | list[str] | Additional fields to group rows by, secondary to guides._pageID. This corresponds to the GROUP BY clause in the query.
|
|
| having | list[str] | The conditions that must be met when grouping rows. This corresponds to the HAVING clause in the query. |
Usage
Without specifying any query parameters, this template will display a list of all guides.
{{Guide table}}
The above documentation is transcluded from Template:Guide table/doc.
Editors can experiment in this template's sandbox and testcases pages.
Please add categories to the /doc subpage. Subpages of this template.
Editors can experiment in this template's sandbox and testcases pages.
Please add categories to the /doc subpage. Subpages of this template.