Difference between revisions of "Template:Report"

From DFM Wiki
(Created metadata template for use by report-generation script.)
 
m (Don't show the metadata table on the template page itself.)
Line 1: Line 1:
; title : {{{title|Report}}}
+
<includeonly>; title : {{{title|Report}}}
 
; author : {{{author|}}}
 
; author : {{{author|}}}
 
; contributor : {{{contributor|}}}
 
; contributor : {{{contributor|}}}
Line 14: Line 14:
 
; 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|}}}
<noinclude>
+
</includeonly><noinclude>
 
<templatedata>
 
<templatedata>
 
{
 
{

Revision as of 13:35, 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
Example
DFM Working Papers
Unknownoptional
cover imagecover_image

URL for an image to be used on the cover of the report.

URLoptional
Logoslogos

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.

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