Difference between revisions of "Template:Report"

From DFM Wiki
(Added advisor field and reformatted keys to use spaces instead of underscores, which are not technically necessary.)
(Updated display to use wikitext instead of raw HTML)
Line 1: Line 1:
 
<includeonly>; title : {{{title|Report}}}
 
<includeonly>; title : {{{title|Report}}}
 
; date : {{{date|}}}
 
; date : {{{date|}}}
; author : {{{author|}}}
+
; author(s) : {{{author|}}}
; contributor : {{{contributor|}}}
+
; contributor(s) : {{{contributor|}}}
 
; translator : {{{translator|}}}
 
; translator : {{{translator|}}}
 
; editor : {{{editor|}}}
 
; editor : {{{editor|}}}
 
; series editor : {{{series editor|}}}
 
; series editor : {{{series editor|}}}
 
; technical editor : {{{technical editor|}}}
 
; technical editor : {{{technical editor|}}}
; advisor : {{{advisor|}}}
+
; advisor(s) : {{{advisor|}}}
 
; series : {{{series|DFM Working paper}}}
 
; series : {{{series|DFM Working paper}}}
 
; cover image : {{{cover image|https://driedfishmatters.org/static/printjs/report-cover.jpg}}}
 
; cover image : {{{cover image|https://driedfishmatters.org/static/printjs/report-cover.jpg}}}
; 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.}}}
; address : {{{address|Dried Fish Matters<br>The University of Manitoba<br>Canada<br><a href="http://driedfishmatters.org">driedfishmatters.org</a>}}}
+
; address : {{{address|Dried Fish Matters<br>The University of Manitoba, Canada<br>[http://driedfishmatters.org driedfishmatters.org]}}}
 
; acknowledgements : {{{acknowledgements|This research is supported by the Social Sciences and Humanities Research Council of Canada.}}}
 
; acknowledgements : {{{acknowledgements|This research is supported by the Social Sciences and Humanities Research Council of Canada.}}}
 
; abstract : {{{abstract|}}}
 
; abstract : {{{abstract|}}}
 +
; organizational logos : {{{logos|<img src="https://driedfishmatters.org/DFM-logo-square.png">}}}
 
</includeonly><noinclude>
 
</includeonly><noinclude>
 
<templatedata>
 
<templatedata>
Line 52: Line 52:
 
"series": {
 
"series": {
 
"description": "Title of the report series.",
 
"description": "Title of the report series.",
"example": "DFM Working Papers",
 
 
"default": "DFM Working Papers"
 
"default": "DFM Working Papers"
 
},
 
},
 
"logos": {
 
"logos": {
"description": "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.",
+
"description": "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.",
 
"type": "string"
 
"type": "string"
 
},
 
},
Line 80: Line 79:
 
},
 
},
 
"cover image": {
 
"cover image": {
"description": "URL for an image to be used on the cover of the report.",
+
"description": "Image to be used on the cover of the report.",
"type": "url"
+
"type": "wiki-file-name"
 
},
 
},
 
"advisor": {
 
"advisor": {

Revision as of 14:46, 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.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Titletitle

The title of the report

Unknownrequired
Authorauthor

Author(s) of the report. If multiple authors are given, provide as a string using "and" before the final author's name.

Example
J. Adam and J. Doe
Stringoptional
Contributorcontributor

Contributor(s) to the report, such as authors of figures and tables.

Stringoptional
Translatortranslator

Translator(s) of the report.

Stringoptional
Editoreditor

Editor(s) of the report, if different chapters or sections are authored by different people.

Stringoptional
Series editorseries editor

General or managing editor of the report series.

Stringoptional
Technical editortechnical editor

Technical editor of the report, responsible for formatting and copy-editing.

Stringoptional
Datedate

Date of publication of this version of the report.

Example
2021
Daterequired
Seriesseries

Title of the report series.

Default
DFM Working Papers
Unknownoptional
Cover imagecover image

Image to be used on the cover of the report.

Fileoptional
Logoslogos

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.

Stringoptional
Licenselicense

License text for the report, generally Creative Commons BY-SA or similar.

Stringoptional
Addressaddress

Publisher address (should usually use the default)

Stringoptional
Acknowledgementsacknowledgements

Paragraph describing the contributions of individuals and organizations who participated in the creation of the report.

Stringoptional
Abstractabstract

Abstract of the report.

Stringoptional
Advisoradvisor

Advisor(s) who guided the preparation of the report.

Stringoptional