Difference between revisions of "Template:Report"

From DFM Wiki
(Use two-column table syntax to support easier html parsing)
Line 34: Line 34:
 
|-
 
|-
 
! license
 
! license
| {{{license|This file is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported license.}}}
+
| {{{license|[[File:CC-BY-SA icon.svg|200px]]<BR>This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/.}}}
 
|-
 
|-
 
! address
 
! address
Line 40: Line 40:
 
|-
 
|-
 
! acknowledgements
 
! acknowledgements
| {{{acknowledgements|This research is supported by the Social Sciences and Humanities Research Council of Canada.}}}
+
| {{{acknowledgements|[[File:SSHRC_CRSH_logo.svg|500px]]<BR>This research is supported by the Social Sciences and Humanities Research Council of Canada.}}}
 
|-
 
|-
 
! abstract
 
! abstract
Line 46: Line 46:
 
|-
 
|-
 
! organizational logos
 
! organizational logos
| {{{logos|<img src="https://driedfishmatters.org/DFM-logo-square.png">}}}
+
| {{{logos|[[File:DFM_logo.png|300px]]}}}
 
|}
 
|}
 
</includeonly><noinclude>
 
</includeonly><noinclude>
Line 85: Line 85:
 
"series": {
 
"series": {
 
"description": "Title of the report series.",
 
"description": "Title of the report series.",
"default": "DFM Working Papers"
+
"default": "DFM Working Papers",
 +
"type": "string"
 
},
 
},
 
"logos": {
 
"logos": {
 
"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.",
 
"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",
 +
"default": "[[File:DFM_logo.png|300px]]"
 
},
 
},
 
"license": {
 
"license": {
 
"description": "License text for the report, generally Creative Commons BY-SA or similar.",
 
"description": "License text for the report, generally Creative Commons BY-SA or similar.",
"type": "string"
+
"type": "string",
 +
"default": "[[File:CC-BY-SA icon.svg|200px]]<BR>This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/."
 
},
 
},
 
"address": {
 
"address": {
Line 101: Line 104:
 
"acknowledgements": {
 
"acknowledgements": {
 
"description": "Paragraph describing the contributions of individuals and organizations who participated in the creation of the report.",
 
"description": "Paragraph describing the contributions of individuals and organizations who participated in the creation of the report.",
"type": "string"
+
"type": "string",
 +
"default": "[[File:SSHRC_CRSH_logo.svg|500px]]<BR>This research is supported by the Social Sciences and Humanities Research Council of Canada."
 
},
 
},
 
"abstract": {
 
"abstract": {

Revision as of 16:01, 31 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
Stringoptional
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.

Default
[[File:DFM_logo.png|300px]]
Stringoptional
Licenselicense

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

Default
[[File:CC-BY-SA icon.svg|200px]]<BR>This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/.
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.

Default
[[File:SSHRC_CRSH_logo.svg|500px]]<BR>This research is supported by the Social Sciences and Humanities Research Council of Canada.
Stringoptional
Abstractabstract

Abstract of the report.

Stringoptional
Advisoradvisor

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

Stringoptional