v3.0.0+
| Status: | effective |
| Progress: | 95% |
| Version: | 3.0.0+ |
Help:Templatefile format
From Linux Web Expert
| Templatefile format | |
|---|---|
| Outputs results in arbitrary file formats defined via templates. | |
| Further Information | |
| Provided by: | Semantic MediaWiki |
| Added: | 3.0.0 |
| Removed: | still supported |
| Requirements: | none |
| Format name: | templatefile |
| Enabled? Indicates whether the result format is enabled by default upon installation of the respective extension. | yes |
| Authors: | James Hong Kong |
| Categories: | export · plaintext |
| Keywords | |
| Table of Contents | |
The result format templatefile is used to produce links to file outputs in all sorts of formats defined in a template. It was introduced with Semantic MediaWiki 3.0.0Released on an unknown date unknown versions of MediaWiki.1
Parameters
- General
| ⧼validator-describe-header-parameter⧽ | ⧼validator-describe-header-type⧽ | ⧼validator-describe-header-default⧽ | ⧼validator-describe-header-description⧽ |
|---|---|---|---|
| source | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | Alternative query source |
| limit | ⧼validator-type-integer⧽ | 50 | The maximum number of results to return |
| offset | ⧼validator-type-integer⧽ | 0 | The offset of the first result |
| link | ⧼validator-type-string⧽ | all | Show values as links |
| sort | ⧼validator-type-string-list⧽ | ⧼validator-describe-empty⧽ | Property to sort the query by |
| order | ⧼validator-type-string-list⧽ | ⧼validator-describe-empty⧽ | Order of the query sort |
| headers | ⧼validator-type-string⧽ | show | Display the headers/property names |
| mainlabel | ⧼validator-type-string⧽ | no | The label to give to the main page name |
| intro | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | The text to display before the query results, if there are any |
| outro | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | The text to display after the query results, if there are any |
| searchlabel | ⧼validator-type-string⧽ | templateFile | Text for continuing the search |
| default | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | The text to display if there are no query results |
Export formats like templatefile in general will not produce an
intro or outro text since they only produce a link when embedded.2
- Format specific
| ⧼validator-describe-header-parameter⧽ | ⧼validator-describe-header-aliases⧽ | ⧼validator-describe-header-type⧽ | ⧼validator-describe-header-default⧽ | ⧼validator-describe-header-description⧽ |
|---|---|---|---|---|
| valuesep | - | ⧼validator-type-string⧽ | , | The separator between results |
| template | - | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | The name of a template with which to display the printouts |
| named args | namedargs | ⧼validator-type-boolean⧽ | no | Name the arguments passed to the template |
| userparam | - | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | A value passed into each template call, if a template is used |
| introtemplate | - | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | The name of a template to display before the query results, if there are any |
| outrotemplate | - | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | The name of a template to display after the query results, if there are any |
| filename | - | ⧼validator-type-string⧽ | file.txt | The name for the output file |
| mimetype | - | ⧼validator-type-string⧽ | text/plain | The media type (MIME type) for the output file |
Most parameters can be combined to create the desired display of the output to a query. Not all parameters are documented here. See also the documentation on the result format "plainlist"Outputs results in a comma separated list, with additional outputs shown in parentheses. The output does not provide class attributes to HTML elements (default for queries without printout statements).
Example
- Creating a BEACON file with GND identifiers for export
GND is an international authority file for the organisation of personal names, subject headings and corporate bodies from catalogues. It is used mainly for documentation in libraries and increasingly also by archives and museums. The GND is managed by the German National Library (German: Deutsche Nationalbibliothek; DNB) in cooperation with various regional library networks.
BEACON is a data interchange format for large numbers of uniform links. The format was developed to exchange mappings between authority files and resources in cultural institutions.
See how to do it:
In Semantic MediaWiki 2.5.8Released on an unknown date unknown versions of MediaWiki and earlier this can be achieved as explained on the BEACON help page.
See also
- Result format "CSV"Outputs results in Windows-style Comma Separated Value format. – Allowing to create an export in the csv-format
