Difference between revisions of "Template:Report"
EricThrift (talk | contribs) (Make the short title a required element) |
EricThrift (talk | contribs) |
||
Line 133: | Line 133: | ||
"label": "Short title", | "label": "Short title", | ||
"description": "A shortened version of the title, for use in the document footer", | "description": "A shortened version of the title, for use in the document footer", | ||
− | "type": "string" | + | "type": "string", |
+ | "required": true | ||
} | } | ||
}, | }, |
Revision as of 09:41, 8 April 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 |
Short title | short_title | A shortened version of the title, for use in the document footer | String | 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.
| String | optional |
Cover_image | cover_image | Image to be used on the cover of the report. | File | optional |
Logos | logos | Images 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 | required |
Abstract | abstract | Abstract of the report. | String | optional |
Advisor | advisor | Advisor(s) who guided the preparation of the report. | String | optional |