Difference between revisions of "Template:Report"
EricThrift (talk | contribs) m (Don't show the metadata table on the template page itself.) |
EricThrift (talk | contribs) (Added advisor field and reformatted keys to use spaces instead of underscores, which are not technically necessary.) |
||
| Line 1: | Line 1: | ||
<includeonly>; title : {{{title|Report}}} | <includeonly>; title : {{{title|Report}}} | ||
| + | ; date : {{{date|}}} | ||
; author : {{{author|}}} | ; author : {{{author|}}} | ||
; contributor : {{{contributor|}}} | ; contributor : {{{contributor|}}} | ||
| Line 5: | Line 6: | ||
; editor : {{{editor|}}} | ; editor : {{{editor|}}} | ||
; series editor : {{{series editor|}}} | ; series editor : {{{series editor|}}} | ||
| − | ; technical editor : {{{ | + | ; technical editor : {{{technical editor|}}} |
| − | ; | + | ; advisor : {{{advisor|}}} |
; series : {{{series|DFM Working paper}}} | ; series : {{{series|DFM Working paper}}} | ||
| − | ; cover image : {{{ | + | ; cover image : {{{cover image|https://driedfishmatters.org/static/printjs/report-cover.jpg}}} |
; logos : {{{logos|<img src="https://driedfishmatters.org/DFM-logo-square.png">}}} | ; logos : {{{logos|<img src="https://driedfishmatters.org/DFM-logo-square.png">}}} | ||
; license : {{{license|This file is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported license.}}} | ; license : {{{license|This file is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported license.}}} | ||
| Line 42: | Line 43: | ||
"description": "General or managing editor of the report series.", | "description": "General or managing editor of the report series.", | ||
"type": "string" | "type": "string" | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
}, | }, | ||
"date": { | "date": { | ||
| Line 58: | Line 54: | ||
"example": "DFM Working Papers", | "example": "DFM Working Papers", | ||
"default": "DFM Working Papers" | "default": "DFM Working Papers" | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
}, | }, | ||
"logos": { | "logos": { | ||
| Line 82: | Line 73: | ||
"abstract": { | "abstract": { | ||
"description": "Abstract of the report.", | "description": "Abstract of the report.", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "technical editor": { | ||
| + | "description": "Technical editor of the report, responsible for formatting and copy-editing.", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "cover image": { | ||
| + | "description": "URL for an image to be used on the cover of the report.", | ||
| + | "type": "url" | ||
| + | }, | ||
| + | "advisor": { | ||
| + | "description": "Advisor(s) who guided the preparation of the report.", | ||
"type": "string" | "type": "string" | ||
} | } | ||
}, | }, | ||
"description": "Template specifying metadata for publishable reports. Wiki pages linked on the same page as this template will be included in a printable report generated by the https://driedfishmatters.org/cgi-bin/report.py report tool, using the metadata supplied here.", | "description": "Template specifying metadata for publishable reports. Wiki pages linked on the same page as this template will be included in a printable report generated by the https://driedfishmatters.org/cgi-bin/report.py report tool, using the metadata supplied here.", | ||
| − | "format": "block" | + | "format": "block", |
| + | "paramOrder": [ | ||
| + | "title", | ||
| + | "author", | ||
| + | "contributor", | ||
| + | "translator", | ||
| + | "editor", | ||
| + | "series editor", | ||
| + | "technical editor", | ||
| + | "date", | ||
| + | "series", | ||
| + | "cover image", | ||
| + | "logos", | ||
| + | "license", | ||
| + | "address", | ||
| + | "acknowledgements", | ||
| + | "abstract", | ||
| + | "advisor" | ||
| + | ] | ||
} | } | ||
</templatedata> | </templatedata> | ||
</noinclude> | </noinclude> | ||
Revision as of 13:41, 23 March 2021
Template specifying metadata for publishable reports. Wiki pages linked on the same page as this template will be included in a printable report generated by the https://driedfishmatters.org/cgi-bin/report.py report tool, using the metadata supplied here.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Title | title | The title of the report | Unknown | required |
| Author | author | Author(s) of the report. If multiple authors are given, provide as a string using "and" before the final author's name.
| String | optional |
| Contributor | contributor | Contributor(s) to the report, such as authors of figures and tables. | String | optional |
| Translator | translator | Translator(s) of the report. | String | optional |
| Editor | editor | Editor(s) of the report, if different chapters or sections are authored by different people. | String | optional |
| Series editor | series editor | General or managing editor of the report series. | String | optional |
| Technical editor | technical editor | Technical editor of the report, responsible for formatting and copy-editing. | String | optional |
| Date | date | Date of publication of this version of the report.
| Date | required |
| Series | series | Title of the report series.
| Unknown | optional |
| Cover image | cover image | URL for an image to be used on the cover of the report. | URL | optional |
| Logos | logos | HTML string to be included in the institutional logos section at the top of the report cover. Use HTML <img> tags or wiki logo templates that produce them. | String | optional |
| License | license | License text for the report, generally Creative Commons BY-SA or similar. | String | optional |
| Address | address | Publisher address (should usually use the default) | String | optional |
| Acknowledgements | acknowledgements | Paragraph describing the contributions of individuals and organizations who participated in the creation of the report. | String | optional |
| Abstract | abstract | Abstract of the report. | String | optional |
| Advisor | advisor | Advisor(s) who guided the preparation of the report. | String | optional |
