Difference between revisions of "Template:Report"

From DFM Wiki
VisualWikitext
(Remove cover image at top of the page)
(Modified the template for use in report listings.)
Tag: 2017 source edit
Line 1: Line 1:
−
== Metadata ==
+
<includeonly><div style="width:100%; display:table-row"><div style="display:table-cell">[[{{{cover|File:Wikibooks blank cover.svg}}}frameless|300x300px]]</div><div style="display:table-cell">{{#if: {{{title|}}} |==={{{title}}}===
 +
|}}{{#if: {{{authors|}}} | {{{authors}}}
  
−
=== abstract ===
+
|}}{{#if: {{{series title|}}}|{{{series title}}} |}}{{#if: {{{report type|}}}|{{{report type}}} |}}{{#if: {{{report number|}}}|No. {{{report number}}} |}}{{#if: {{{abstract|}}}|
−
{{{abstract|}}}
 
  
−
=== series ===
+
{{{abstract}}}|}}
−
{{{series|}}}
 
  
−
=== title ===
+
{{#if:{{{DOI|}}}|DOI: {{{DOI}}} |}}{{#if: {{{Zotero|}}}|Zotero: {{{Zotero}}} |}}</div></div></includeonly>
−
{{{title|}}}
+
<noinclude>
−
 
 
−
=== short title ===
 
−
{{{short_title|}}}
 
−
 
 
−
=== date ===
 
−
{{{date|}}}
 
−
 
 
−
=== author(s) ===
 
−
{{{author|}}}
 
−
 
 
−
=== contributor(s) ===
 
−
{{{contributor|}}}
 
−
 
 
−
=== translator ===
 
−
{{{translator|}}}
 
−
 
 
−
=== editor ===
 
−
{{{editor|}}}
 
−
 
 
−
=== series editor ===
 
−
{{{series_editor|}}}
 
−
 
 
−
=== technical editor ===
 
−
{{{technical_editor|}}}
 
−
 
 
−
=== advisor(s) ===
 
−
{{{advisor|}}}
 
−
 
 
−
=== license ===
 
−
{{{license|}}}
 
−
 
 
−
=== address ===
 
−
{{{address|}}}
 
−
 
 
−
=== acknowledgements ===
 
−
{{{acknowledgements|}}}
 
−
 
 
−
== Cover media ==
 
−
 
 
−
=== logos ===
 
−
{{{logos|}}}
 
−
 
 
−
=== cover image ===
 
−
{{{cover_image|}}}
 
−
 
 
−
<span class="plainlinks">[https://driedfishmatters.org/cgi-bin/report.py?page={{urlencode:{{{pagename|{{FULLPAGENAME}}}}}|WIKI}}<span class="mw-ui-button mw-ui-progressive" role="button">Generate report</span>]</span>
 
−
 
 
−
== Contents ==
 
−
 
 
−
== Status ==
 
−
 
 
−
== Versions ==
 
−
 
 
−
</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",
−
"required": true
+
"type": "string",
−
},
 
−
"author": {
 
−
"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"
 
−
},
 
−
"contributor": {
 
−
"description": "Contributor(s) to the report, such as authors of figures and tables.",
 
−
"type": "string"
 
−
},
 
−
"translator": {
 
−
"description": "Translator(s) of the report.",
 
−
"type": "string"
 
−
},
 
−
"editor": {
 
−
"description": "Editor(s) of the report, if different chapters or sections are authored by different people.",
 
−
"type": "string"
 
−
},
 
−
"series_editor": {
 
−
"description": "General or managing editor of the report series.",
 
−
"type": "string"
 
−
},
 
−
"date": {
 
−
"description": "Date of publication of this version of the report.",
 
−
"example": "2021",
 
−
"type": "date",
 
 
"required": true
 
"required": true
 
},
 
},
−
"series": {
+
"authors": {
−
"description": "Title of the report series.",
 
−
"default": "DFM Working Papers",
 
 
"type": "string"
 
"type": "string"
 
},
 
},
−
"logos": {
+
"series title": {
−
"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]]"
+
"default": "Dried Fish Matters"
 
},
 
},
−
"license": {
+
"report type": {
−
"description": "License text for the report, generally Creative Commons BY-SA or similar.",
 
 
"type": "string",
 
"type": "string",
−
"default": "[[File:CC-BY-SA icon.svg|140px]]<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/."
+
"default": "Working Paper"
 
},
 
},
−
"address": {
+
"report number": {
−
"description": "Publisher address (should usually use the default)",
+
"type": "number"
−
"type": "string",
 
−
"default": "'''Dried Fish Matters:'''<br>Mapping the social economy of dried fish in South and Southeast Asia for enhanced wellbeing and nutrition<br>The University of Manitoba, Canada<br>[http://driedfishmatters.org driedfishmatters.org]"
 
−
},
 
−
"acknowledgements": {
 
−
"description": "Paragraph describing the contributions of individuals and organizations who participated in the creation of the report.",
 
−
"type": "string",
 
−
"default": "{{SSHRC acknowledgement}}",
 
−
"required": true
 
 
},
 
},
 
"abstract": {
 
"abstract": {
−
"description": "Abstract of the report.",
 
 
"type": "string"
 
"type": "string"
 
},
 
},
−
"technical_editor": {
+
"DOI": {
−
"description": "Technical editor of the report, responsible for formatting and copy-editing.",
+
"description": "DOI link to the PDF version of the report on Dataverse.",
−
"type": "string"
+
"type": "url"
 
},
 
},
−
"cover_image": {
+
"Zotero": {
−
"description": "Image to be used on the cover of the report.",
+
"description": "Link to the item in the DFM Zotero library",
−
"type": "wiki-file-name"
+
"type": "url"
−
},
 
−
"advisor": {
 
−
"description": "Advisor(s) who guided the preparation of the report.",
 
−
"type": "string"
 
−
},
 
−
"short_title": {
 
−
"label": "Short title",
 
−
"description": "A shortened version of the title, for use in the document footer",
 
−
"type": "string",
 
−
"required": true
 
 
}
 
}
 
},
 
},
−
"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 report tool (https://driedfishmatters.org/cgi-bin/report.py), using the metadata supplied here. \n\nThis template should be SUBSTITUTED in order to set up a metadata structure in the page source that can be invoked using the Labelled Section Transclusion mechanism.",
+
"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": [
 
−
"title",
 
−
"short_title",
 
−
"author",
 
−
"contributor",
 
−
"translator",
 
−
"editor",
 
−
"series_editor",
 
−
"technical_editor",
 
−
"date",
 
−
"series",
 
−
"cover_image",
 
−
"logos",
 
−
"license",
 
−
"address",
 
−
"acknowledgements",
 
−
"abstract",
 
−
"advisor"
 
−
]
 
 
}
 
}
 
</templatedata>
 
</templatedata>
 
</noinclude>
 
</noinclude>

Revision as of 09:55, 9 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
Retrieved from "https://driedfishmatters.org/kb/index.php?title=Template:Report&oldid=3743"