Difference between revisions of "Template:Report"

From DFM Wiki
VisualWikitext
(Revert to underscores in template field keys. Python string template substitution does not work with spaces.)
Tag: 2017 source edit
 
(39 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
<includeonly>; title : {{{title|Report}}}
+
<includeonly><div style="width:100%; display:table-row"><div style="display:table-cell; vertical-align:top;width:300px">[[{{#if:{{{cover|}}}|{{{cover}}}|File:Wikibooks blank cover.svg}}|frameless|300px|border|link=]]</div><div style="display:table-cell; padding-left:2em; vertical-align:top">{{#if: {{{title|}}} |'''{{{title}}}'''|}}{{#if: {{{authors|}}} |<div style="margin:1em 0">{{{authors}}}</div>|}}<div style="margin:1em 0">{{#if: {{{series title|}}}|{{{series title}}} |}} {{#if: {{{report type|}}}| {{{report type}}} |}} {{#if: {{{report number|}}}| No. {{{report number}}} |}}</div>{{#if: {{{abstract|}}}|<div style="margin:1em 0">{{{abstract}}}</div>|}}{{#if:{{{attachments|}}}|<div style="margin:1em 0">'''Download:''' {{{attachments}}} </div>|}} {{#if: {{{title|}}}|{{#ifexist: {{{title}}} |<div style="margin:1em 0">'''HTML format:''' [[{{{title}}}]] </div> |}} |}} {{#if:{{{url|}}}|<div style="margin:1em 0">'''URL:''' {{{url}}} </div>|}} {{#if:{{{DOI|}}}|<div style="margin:1em 0">'''DOI:''' {{{DOI}}} </div>|}} {{#if: {{{zotero|}}}|<div style="margin:1em 0">'''Zotero:''' {{{zotero}}}</div> |}}</div></div></includeonly>
−
; date : {{{date|}}}
+
<noinclude>
−
; author(s) : {{{author|}}}
 
−
; contributor(s) : {{{contributor|}}}
 
−
; translator : {{{translator|}}}
 
−
; editor : {{{editor|}}}
 
−
; series editor : {{{series_editor|}}}
 
−
; technical editor : {{{technical_editor|}}}
 
−
; advisor(s) : {{{advisor|}}}
 
−
; series : {{{series|DFM Working paper}}}
 
−
; cover image : {{{cover_image|https://driedfishmatters.org/static/printjs/report-cover.jpg}}}
 
−
; 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, Canada<br>[http://driedfishmatters.org driedfishmatters.org]}}}
 
−
; acknowledgements : {{{acknowledgements|This research is supported by the Social Sciences and Humanities Research Council of Canada.}}}
 
−
; abstract : {{{abstract|}}}
 
−
; organizational logos : {{{logos|<img src="https://driedfishmatters.org/DFM-logo-square.png">}}}
 
−
</includeonly><noinclude>
 
 
<templatedata>
 
<templatedata>
 
{
 
{
 
"params": {
 
"params": {
 +
"cover": {
 +
"label": "Cover image",
 +
"type": "wiki-file-name"
 +
},
 
"title": {
 
"title": {
−
"description": "The title of the report",
+
"label": "report title",
 +
"type": "string",
 
"required": true
 
"required": true
 
},
 
},
−
"author": {
+
"authors": {
−
"description": "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",
 
 
"type": "string"
 
"type": "string"
 
},
 
},
−
"contributor": {
+
"series title": {
−
"description": "Contributor(s) to the report, such as authors of figures and tables.",
+
"type": "string",
−
"type": "string"
+
"default": "Dried Fish Matters"
 
},
 
},
−
"translator": {
+
"report type": {
−
"description": "Translator(s) of the report.",
+
"type": "string",
−
"type": "string"
+
"default": "Working Paper"
 
},
 
},
−
"editor": {
+
"report number": {
−
"description": "Editor(s) of the report, if different chapters or sections are authored by different people.",
+
"type": "number"
−
"type": "string"
 
 
},
 
},
−
"series_editor": {
+
"abstract": {
−
"description": "General or managing editor of the report series.",
 
 
"type": "string"
 
"type": "string"
 
},
 
},
−
"date": {
+
"DOI": {
−
"description": "Date of publication of this version of the report.",
+
"description": "DOI link to the PDF version of the report on Dataverse.",
−
"example": "2021",
+
"type": "url"
−
"type": "date",
 
−
"required": true
 
 
},
 
},
−
"series": {
+
"zotero": {
−
"description": "Title of the report series.",
+
"description": "Link to the item in the DFM Zotero library",
−
"default": "DFM Working Papers"
+
"type": "url"
 
},
 
},
−
"logos": {
+
"attachments": {
−
"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": "Wikitext string with links to the attachment files (downloads).",
 
"type": "string"
 
"type": "string"
 
},
 
},
−
"license": {
+
"url": {
−
"description": "License text for the report, generally Creative Commons BY-SA or similar.",
+
"description": "External URL for the file.",
−
"type": "string"
+
"type": "url"
−
},
 
−
"address": {
 
−
"description": "Publisher address (should usually use the default)",
 
−
"type": "string"
 
−
},
 
−
"acknowledgements": {
 
−
"description": "Paragraph describing the contributions of individuals and organizations who participated in the creation of the report.",
 
−
"type": "string"
 
−
},
 
−
"abstract": {
 
−
"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": "Image to be used on the cover of the report.",
 
−
"type": "wiki-file-name"
 
−
},
 
−
"advisor": {
 
−
"description": "Advisor(s) who guided the preparation of the report.",
 
−
"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 for presenting reports on the wiki and public webpage. Includes the cover, citation details, and links to Zotero and Dataverse.",
 
"format": "block",
 
"format": "block",
 
"paramOrder": [
 
"paramOrder": [
 +
"cover",
 
"title",
 
"title",
−
"author",
+
"authors",
−
"contributor",
+
"series title",
−
"translator",
+
"report type",
−
"editor",
+
"report number",
−
"series_editor",
 
−
"technical_editor",
 
−
"date",
 
−
"series",
 
−
"cover_image",
 
−
"logos",
 
−
"license",
 
−
"address",
 
−
"acknowledgements",
 
 
"abstract",
 
"abstract",
−
"advisor"
+
"DOI",
 +
"zotero",
 +
"attachments",
 +
"url"
 
]
 
]
 
}
 
}
 
</templatedata>
 
</templatedata>
 
</noinclude>
 
</noinclude>

Latest revision as of 11:00, 16 March 2022


Template for presenting reports on the wiki and public webpage. Includes the cover, citation details, and links to Zotero and Dataverse.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Cover imagecover

no description

Fileoptional
report titletitle

no description

Stringrequired
Authorsauthors

no description

Stringoptional
Series titleseries title

no description

Default
Dried Fish Matters
Stringoptional
Report typereport type

no description

Default
Working Paper
Stringoptional
Report numberreport number

no description

Numberoptional
Abstractabstract

no description

Stringoptional
DOIDOI

DOI link to the PDF version of the report on Dataverse.

URLoptional
Zoterozotero

Link to the item in the DFM Zotero library

URLoptional
Attachmentsattachments

Wikitext string with links to the attachment files (downloads).

Stringoptional
Urlurl

External URL for the file.

URLoptional
Retrieved from "https://driedfishmatters.org/kb/index.php?title=Template:Report&oldid=3914"