Difference between revisions of "Template:Document"

From Wikispooks
Jump to navigation Jump to search
(tidy description)
m (add source_URL)
 
(323 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
<noinclude>
+
<noinclude>{{WStemplate
−
'Document Provenance' information. The template should be the first item on Document pages. See also [[template:FileProv]].
+
|summary=This template provides a standard format for documents.
−
{{BLUE|The blue parameters not be marked up at all. They should be Wikispooks page names (Whether of not the page yet exists).}}<br/>
+
|description=It ''must'' be included at the top of all pages in the {{NS|document}}.
 +
|object=document
 +
}}
 +
For pages in the {{NS|main}} ''about'' documents, use [[Template:Publication]].<br/>
 
'''Usage:'''
 
'''Usage:'''
 
<poem>
 
<poem>
−
{{DocProv
+
{{Document
−
''EITHER''
+
ESSENTIAL DETAILS
−
|Date=
+
|{{NAVY|publication_date}}= PublicationDate ''([[Property:Has publicationDate]])''
−
''OR ''
+
|type={article, essay, paper, book review, letter, memo etc.} ''([[Property:Has documentType]])''
−
|DateYear=
+
|{{GREEN|authors}}= Comma separated list of authors. For pseudonyms, use single quotes. If anonymous, use ''[[Unknown]]''. ''([[Property:Has author]])''
−
|DateMonth=
+
|{{GREEN|subjects}}= Comma separated list of subject items. For pseudonyms, use single quotes. If anonymous, use ''Unknown''. ''([[Property:Is about]])''
−
|DateDay=
+
|description= ''A human readable plaintext description of less than 500 characters.''([[Property:Description]])''<!--
−
----
+
|{{BLUE|source_name}}=General name of the source, e.g. "[[Unwelcome Guests]]", "[[Cryptome]]", ... ''([[Property:Sourced from]])''
−
''EITHER''
+
|{{PURPLE|source_URL}}=URL of the source, if it is available online ''([[Property:Has sourceURL]])''
−
|Source=Link to the original copy ''(Deprecated, i.e. old style)''
 
−
''OR ''
 
−
|SourceURL=URL of the source, if it is available online
 
−
|{{BLUE|SourceName}}=General name of the source, e.g. "Unwelcome Guests"
 
−
|SourceDetail=Specific details, e.g. "#675", "vol. 3, chapter 20", "pp.212-213"...
 
−
----
 
−
|DocType={article, essay, paper, chapter, letter, memo etc.}
 
−
|{{BLUE|Local}}=Address of the wikispooks copy
 
−
|{{BLUE|Subject}}=What the document is about
 
−
|{{BLUE|Author}}=The name of the author
 
 
''OPTIONAL DETAILS:''
 
''OPTIONAL DETAILS:''
−
|{{BLUE|Subject2}}= |{{BLUE|Subject3}}=... For more subjects
+
|subtitle=The subtitle, e.g. of a book -->
−
|{{BLUE|Author2}}=... |{{BLUE|Author3}}=... For more authors
+
|source_details            = Extra details for the reference, e.g. "#675", "vol. 3, chapter 20", "pp.212-213"... (For ISBNs, use '|ISBN') ''([[Property:Has sourceDetails]])''
−
|{{BLUE|Recipient}}= For emails, letters, speeches etc.
+
|updated_date=When the document was updated {{RED|Not Yet Implemented}}
−
|{{BLUE|Recipient2}}=... |{{BLUE|Recipient3}}=...  For more recipients
+
|{{PURPLE|iframe_URL}}=URL of page for display in an iframe.
−
|RecipientDetail=Short note about recipient #1
+
|{{PURPLE|source_URL}}=Link to the source of the document
−
|AuthorDetail= Short note about the author, (e.g. "Home Office accredited forensic pathologist")
+
|{{BLUE|local}}=Address of the wikispooks copy ''([[Property:Has localCopy]])''
−
|Author2Detail=Short note about the author2
+
|{{GREEN|subjects_detail}}= note about subjects {{RED|Deprecate?}}
−
...
+
|{{ORANGE|collection}}=Yes (Use if this is a collection of documents)
−
|AuthorType=Explanatory note about authorship, e.g. "alleged"
+
|{{ORANGE|draft}}=Yes (Use for draft documents)
 +
|title=Document title. Usually this is implicit - only specify this if the pagename is different for some reason (such as illegal characters) {{RED|Not yet implemented?}}
 +
|{{GREEN|recipients}}= For emails, letters, speeches etc. ''([[Property:Has recipient]])''
 +
|{{GREEN|constitutes}}= For topics which this document is not about, but directly constitutes (e.g. "censorship", "war propaganda") ''([[Property:Constitutes]])''
 +
|image= AN image for the document (Recommended, for example the cover if the document is a book)
 +
|image_caption=Caption for the image
 +
|image_width= The default value is "250px"
 +
<s>|AuthorDetail= Short note about the author, (e.g. "Home Office accredited forensic pathologist")</s>
 +
|classification=Original security classification, e.g. "official", "secret", "top secret"... ''([[Property:Has classification]])''
 +
|classification_detail= Optional note about the security classification
 +
|{{ORANGE|leaked}}=Yes (Use for leaked documents)
 +
|{{ORANGE|declassified}}=Yes (Use for declassified documents)
 +
|declassified_date=When the document was declassified
 +
|declassified_detail= Optional Note about the declassification
 +
|author_type=Explanatory note about authorship, e.g. "alleged"
 +
|version=For versioned documents
 +
|warning=Plaintext warning
 
''FOR FOREIGN TRANSLATIONS:''
 
''FOR FOREIGN TRANSLATIONS:''
−
|OriginalLanguage=Language name for non-English originals
+
|original_language=Language name for non-English originals ''([[Property:Has originalLanguage]])''
−
|{{BLUE|Translator}}=Who translated it
+
|original_title=The title of the original document ''([[Property:Has originalTitle]])''
−
|TranslatorDetail=Short note on the translator
+
|{{GREEN|translators}}=Who translated it ''([[Property:Has translator]])''
−
''OPTIONAL NOTE:''
+
|translators_detail=Short note on the translators
−
|Note=
+
''FOR AUDIO (readings):''
 +
|{{PURPLE|audio_URL}}=URL of this audio version
 +
|{{BLUE|audio_name}}=Name of the source of the audio version
 +
''FOR BOOKS:''
 +
|{{PURPLE|webpage}}=URL of this book
 +
|ISBN= ISBN number ''([[Property:Has ISBN]])''
 +
|{{PURPLE|publisher_URL}}=Web address of the publishers
 +
|{{BLUE|publisher_name}}=Name of the publishers
 +
|publisher_detail=Optional extra note about the publishers
 +
''OPTIONAL NOTES:''
 +
|note= Random spare note
 +
|credit= Note of thanks
 
''OPTIONAL SUBSECTIONS:''
 
''OPTIONAL SUBSECTIONS:''
−
|AuthorsNote= ''Author's Note'' subsection
+
|{{PURPLE|wikipedia}}        = URL of the document's Wikipedia page, if any ''([[Property:Has wikipediaPage]])''
−
|Comment= ''Wikispooks Comment'' subsection about why this is relevant (Recommended)
+
|wikipedia_protection      = Set to 1 if the wikipedia page is edit protected, 0 or empty otherwise ''([[Property:Has wikipediaProtection]])''
−
|Image=
+
|authors_note= ''Author's Note'' subsection
−
|SeeAlso= ''See Also'' subsection (Use for related pages which cannot be linked in from the text)
+
<s>|comment= ''Wikispooks Comment'' subsection about why this is relevant (Recommended)</s> ''Depreceated, please use [[Template:Rate]] about the document on your user page instead''<ref>Ask an administrator if you need help with this.</ref>
−
|Leaked=1 (Use for leaked documents)
+
<s>|see_also= ''See Also'' subsection (Use for related pages which cannot be linked in from the text)</s> ''Deprecated, but still available in emergencies''
−
|Review=1 (Use for book/film etc reviews)
 
−
|Notoc=1 (Use for suppress the table of contents)
 
 
}}
 
}}
 
</poem>
 
</poem>
−
</noinclude><includeonly><div style="border-style:solid; border-width:1px; border-color:#a7d7f9; margin:0px; background-color:#f5f5f5; padding: 0.5em; margin-right:0px;">
+
</noinclude><includeonly>{{DISPLAYTITLE:''{{FULLPAGENAME}}''}}{{SMWObjectHeader|Document}}<div style="border-style:solid; border-width:1px; border-color:#a7d7f9; margin:0px; background-color:#f5f5f5; padding: 1.0em; margin-right:0px;">{{Wikispooks:Site Status}}[[Has objectClass::Document| ]][[Has objectClass2::Document| ]]{{#if: {{{Badge|}}} | <div style="float:right;"> {{ {{{Badge}}} }} </div> }}{{#if: {{{image|}}} |[[Has image::File:{{{image|}}}| ]][[Has image2::File:{{{image|}}}| ]] <div style="float:right; margin:0 0 0 12px"> [[File:{{{image|}}}|{{#if: {{{image_width|}}}|{{{image_width|}}}|250px}}]] {{#if: {{{image_caption|}}} |<br/>{{{image_caption|}}}}}</div>}}{{Description|{{{description|}}}}}
−
<!--REMOVED THIS "PROVENENCE" HEADING - TIDIER WITHOUT?
+
{{DocDisclaimer}}{{#ifeq: {{{NAMESPACE}}}|Document|{{DocEditMsg}}|}}{{Infobox class icon}}'''<big>&nbsp;<!--
−
<big><big><big>Document Provenance</big></big></big>
+
Comment this out until we get it working...
−
---- --> {{#if: {{{Image|}}} | [[File:{{{Image|}}}|right|250px|]] |}}{{DocEditMsg}} {{AORAN|{{{DocType|}}}}} [[DocType::{{{DocType|}}}]] by {{AgentList|Is author|{{{Author|}}}|{{{AuthorDetail|}}}|{{{Author2|}}}|{{{Author2Detail|}}}|{{{Author3|}}}|{{{Author3Detail|}}}|{{{Author4|}}}|{{{Author4Detail|}}}|{{{Author5|}}}|{{{Author5Detail|}}}|{{{Author6|}}}|{{{Author6Detail|}}}|{{{Author7|}}}|{{{Author7Detail|}}}|{{{Author8|}}}|{{{Author8Detail|}}}|{{{Author9|}}}|{{{Author9Detail|}}}|{{{Author10|}}}|{{{Author10Detail|}}}}}{{#if: {{{AuthorType|}}} | ({{{AuthorType}}})|}} {{#if: {{{Recipient|}}} | to {{AgentList|Is recipient|{{{Recipient|}}}|{{{RecipientDetail|}}}|{{{Recipient2|}}}|{{{Recipient2Detail|}}}|{{{Recipient3|}}}|{{{Recipient3Detail|}}}|{{{Recipient4|}}}|{{{Recipient4Detail|}}}|{{{Recipient5|}}}|{{{Recipient5Detail|}}}|{{{Recipient6|}}}|{{{Recipient6Detail|}}}|{{{Recipient7|}}}|{{{Recipient7Detail|}}}|{{{Recipient8|}}}|{{{Recipient8Detail|}}}|{{{Recipient9|}}}|{{{Recipient9Detail|}}}|{{{Recipient10|}}}|{{{Recipient10Detail|}}}}}}} {{#if: {{{Date|}}} |dated [[Has publication date::{{{Date|}}}]] |dated [[Has publication date::{{ISO8601 |DateYear= {{{DateYear|}}}|DateMonth= {{{DateMonth|}}}|DateDay= {{{DateDay|}}} }} ]] }}<br/>
+
{{AORAN|{{DisplayDocType|{{{type|}}}|{{{draft|}}}|{{{collection|}}}}}}}&nbsp;-->{{DisplayDocType|{{{type|}}}|{{{draft|}}}|{{{collection|}}}}}{{#if: {{{authors|}}} | &nbsp; by {{ArrayMapPropertyListLink|{{{authors|}}}|Has author}}{{#if: {{{author_type|}}} | &nbsp;({{{author_type}}})|}}|&nbsp;of unknown authorship [[Category:Authorless documents]]}}{{#if: {{{recipients|}}}| &nbsp; to {{#arraymap:{{{recipients|}}}|,|@@@@|[[Has recipient::@@@@]]}}}} {{#if: {{{PublisherName|}}}|{{#if: {{{publication_date|}}} | published {{LinkYear|[[Has publicationDate::{{{publication_date|}}}]]}}}} {{#if: {{{PublisherName|}}} | by {{Agent|Has publisher|{{{publisher_name|}}}|{{#if: {{{publisher_URL|}}}| <nowiki>[</nowiki>[{{{publisher_URL}}} Link]<nowiki>]</nowiki>}} {{{publisher_detail|}}} }} |}}|{{#if: {{{publication_date|}}} |dated [[Has publicationDate::{{{publication_date|}}}]]}}}}</big>'''<hr/>{{#if: {{{ISBN|}}}|'''ISBN:''' {{ArrayMapPropertyListLink|{{{ISBN|}}}|Has ISBN}} <br/>}}{{#if: {{{wikipedia|}}} | <br/>'''Wikipedia: '''{{WikipediaLink|{{{wikipedia|}}}|{{{wikipedia_protection|}}}}}<br/>}}{{#if: {{{subjects|}}}|'''Subjects:''' {{#arraymap:{{{subjects|}}}|,|@@@@|[[Is about::@@@@]]}} {{{Subjects_detail|}}}<br/>|[[Category:Subjectless Documents]]}}{{#if: {{{constitutes|}}} | '''Example of:''' {{#arraymap: {{{constitutes|}}}|,|@@@@|[[Constitutes::@@@@]]}}<br/>}} {{DisplayClassification|{{{classification|}}}|{{{classification_detail|}}}|{{{Leaked|}}}|{{{declassified|}}}|{{{declassified_date|}}}|{{{declassified_detail|}}}}}{{#if: {{{source_name|}}}{{{source_URL|}}{{{source_detail|}}}|'''Source:'''&nbsp;{{DisplaySource|{{{source_URL|}}}|{{{source_name|}}}|{{{source_detail|}}}}}<br/>}}{{#if: {{{local|}}} | '''Local copy:''' {{#ifexist: {{{local|}}} | [[Has localCopy::{{{local}}}]] | {{#if:{{#pos:{{{local|}}}|http}} | [{{{local}}} Here] | {{RED|Broken Link: [[{{{local}}}]] }} }} }}<br/>|}}{{#if: {{{audio_URL|}}} | '''Audio version:''' [{{{audio_URL}}} Here] {{#if: {{{audio_name|}}}|from [[{{{audio_name}}}]]}}<br/>|}}{{#if: {{{original_language|}}} | {{#ifeq: {{{original_language|}}} | English |[[Has originalLanguage::English| ]]| <br/>Translated from [[Has originalLanguage::{{{original_language|}}}]] {{#if: {{{translators|}}} | by {{ArrayMapPropertyListLink|{{{translators|}}}|Has translator|}} {{{translators_detail|}}} |}}}}|}}{{#if: {{{original_title|}}} |&nbsp;- Original title: ''[[Has originalTitle::{{{original_title|}}}]]'' |}}{{#if: {{{Credit|}}} | <br/>'''Credit: '''{{{credit}}}}}{{#if: {{{version|}}}|'''Version:''' {{{version}}}<br/>}}{{#if: {{{warning|}}}|'''Warning:''' {{{warning}}}<br/>}}{{#if: {{{note|}}} |<br/>{{{note}}} }}{{#if: {{{comment|}}} | <br/><br/><big><big>Wikispooks Comment</big></big>
−
{{#if: {{{Subject|}}}|'''Subject{{#if: {{{Subject2|}}}|s|}}:''' {{AgentList|Is about|{{{Subject|}}}|{{{SubjectDetail|}}}|{{{Subject2|}}}|{{{Subject2Detail|}}}|{{{Subject3|}}}|{{{Subject3Detail|}}}|{{{Subject4|}}}|{{{Subject4Detail|}}}|{{{Subject5|}}}|{{{Subject5Detail|}}}}}<br/>}}
+
----
−
'''Source:''' {{#if: {{{Source|}}}|{{{Source|}}}|{{RED|Unknown}}[[Category:Unsourced Documents]]}}<br/>{{#if: {{{Local|}}} | '''Local copy:''' {{#ifexist: {{{Local|}}} | [[{{{Local}}}]] | {{#if:{{#pos:{{{Local|}}}|http}} | [{{{Local}}} Here] | {{RED|Broken Link: {{{Local}}} }} }} }}<br/>|}}{{DocDisclaimer}}{{#if: {{{OriginalLanguage|}}} | <br/>Translated from {{{OriginalLanguage|}}} {{#if: {{{Translator|}}} | by {{Agent|Is translator|{{{Translator|}}}|{{{TranslatorDetail|}}}}} |}}|}}{{#if: {{{Note|}}} | <br/>{{{Note|}}} |}}{{#if: {{{AuthorsNote|}}} | <br/><br/><big><big>Author{{#if: {{{Author2|}}}|s'|'s}} Note</big></big>
+
{{{comment}}}|}}{{#if: {{{authors_note|}}} |<br/><br/><big><big>Author{{#if: {{{Author2|}}}|s'|'s}} Note</big></big>
 +
----
 +
{{{authors_note|}}} |}}{{DisplayRatings}}{{#if: {{{permission|}}} |<br>
 
----
 
----
−
{{{AuthorsNote}}} |}}{{#if: {{{Comment|}}} | <br/><br/><big><big>Wikispooks Comment</big></big>
+
'' © {{{publication_date|}}} {{ArrayMapListLink|{{{authors|}}}}}. Republished with permission. All rights reserved. You may not republish this without explicit permission from {{{authors|}}}.''}}{{#if: {{{see_also|}}} | <br/><big><big>See Also</big></big>
 
----
 
----
−
{{{Comment}}} |}}{{#if: {{{SeeAlso|}}} | <br/><br/><big><big>See Also</big></big>
+
{{{see_also}}} |}}</div>
 +
{{#ifexist: Document_talk:{{PAGENAME}} | [[Document_talk:{{PAGENAME}} | ★ Join the Discussion about this document]] | [[Document_talk:{{PAGENAME}} | ★ Start a Discussion about this document]]}} {{#if: {{{title|}}} | <br/><big><big>{{{title}}}</big></big> |}}
 
----
 
----
−
{{{SeeAlso}}} |}}</div>
+
{{#if: {{{iframe_URL|}}} |[[Category:IframeDoc]]<br/>{{#widget:Iframe |url={{{iframe_URL}}} |width=900 |height=800 |border=0}} }}
−
{{#ifeq: {{{Notoc|}}} | 1 | __NOTOC__ | }}[[Category:Doc]]{{#if: {{{Leaked|}}} | [[Category:Leaked Documents]] |}}{{#if: {{{Review|}}} | [[Category:Reviews]] |}}{{DateCategory|Date={{{DateYear|}}}}}
+
{{#ifeq: {{{Leaked|}}} | Yes | [[Category:Leaked Documents]] |}} {{#if: {{{DateYear|}}} | {{DateCategory|publication_date={{{DateYear|}}}}} | {{DateCategory|publication_date={{#time: Y | {{{Date|}}} }} }} }}{{#ifeq: {{{Leaked|}}} | Yes | [[Category:Leaked Documents]] |}}
−
<!-- Extra categories depending upon media type-->
+
{{SMWDefaultMarkup}}</includeonly>
−
{{#ifeq: {{{DocType|}}} | An email | [[Category:Emails]]| }}
 
−
{{#ifeq: {{{DocType|}}} | A speech | [[Category:Speeches]]| }}{{#ifexist: Document_talk:{{PAGENAME}} | [[Document_talk:{{PAGENAME}} | ★ Join the Discussion about this document]] | [[Document_talk:{{PAGENAME}} | ★ Start a Discussion about this document]]}}</includeonly>
 

Latest revision as of 13:28, 4 July 2023

SMWObjects
Semantic Object Templates:        Decade • Place • Timeline • Year • Disambiguation
Concept • Document • Employment • Event • Group • Person • Publication • Website

This template provides a standard format for documents.

It must be included at the top of all pages in the document: namespace.

Blue parameters are for a single Wikispooks page name (If no suitable page exists, then pick a title for a future page)
Brown parameters are for numbers
Green parameters are for comma-separated lists of page names (Or planned page names).
Navy parameters are for dates
Orange parameters are for booleans. (Usually, either "Yes" or just leave blank).
Purple parameters are URLs.
Violet parameters are slash-separated lists.
Pink parameters are for coordinates.
Crossed out parameters were formerly available, but have been upgraded. Some may still work, but do not use these.

See document for a list of pages that use this template.

For pages in the main: namespace about documents, use Template:Publication.
Usage:

{{Document
ESSENTIAL DETAILS
|publication_date= PublicationDate (Property:Has publicationDate)
|type={article, essay, paper, book review, letter, memo etc.} (Property:Has documentType)
|authors= Comma separated list of authors. For pseudonyms, use single quotes. If anonymous, use Unknown. (Property:Has author)
|subjects= Comma separated list of subject items. For pseudonyms, use single quotes. If anonymous, use Unknown. (Property:Is about)
|description= A human readable plaintext description of less than 500 characters.(Property:Description)
 |source_details = Extra details for the reference, e.g. "#675", "vol. 3, chapter 20", "pp.212-213"... (For ISBNs, use '|ISBN') (Property:Has sourceDetails)
|updated_date=When the document was updated Not Yet Implemented
|iframe_URL=URL of page for display in an iframe.
|source_URL=Link to the source of the document
|local=Address of the wikispooks copy (Property:Has localCopy)
|subjects_detail= note about subjects Deprecate?
|collection=Yes (Use if this is a collection of documents)
|draft=Yes (Use for draft documents)
|title=Document title. Usually this is implicit - only specify this if the pagename is different for some reason (such as illegal characters) Not yet implemented?
|recipients= For emails, letters, speeches etc. (Property:Has recipient)
|constitutes= For topics which this document is not about, but directly constitutes (e.g. "censorship", "war propaganda") (Property:Constitutes)
|image= AN image for the document (Recommended, for example the cover if the document is a book)
|image_caption=Caption for the image
|image_width= The default value is "250px"
|AuthorDetail= Short note about the author, (e.g. "Home Office accredited forensic pathologist")
|classification=Original security classification, e.g. "official", "secret", "top secret"... (Property:Has classification)
|classification_detail= Optional note about the security classification
|leaked=Yes (Use for leaked documents)
|declassified=Yes (Use for declassified documents)
|declassified_date=When the document was declassified
|declassified_detail= Optional Note about the declassification
|author_type=Explanatory note about authorship, e.g. "alleged"
|version=For versioned documents
|warning=Plaintext warning
FOR FOREIGN TRANSLATIONS:
|original_language=Language name for non-English originals (Property:Has originalLanguage)
|original_title=The title of the original document (Property:Has originalTitle)
|translators=Who translated it (Property:Has translator)
|translators_detail=Short note on the translators
FOR AUDIO (readings):
|audio_URL=URL of this audio version
|audio_name=Name of the source of the audio version
FOR BOOKS:
|webpage=URL of this book
|ISBN= ISBN number (Property:Has ISBN)
|publisher_URL=Web address of the publishers
|publisher_name=Name of the publishers
|publisher_detail=Optional extra note about the publishers
OPTIONAL NOTES:
|note= Random spare note
|credit= Note of thanks
OPTIONAL SUBSECTIONS:
|wikipedia = URL of the document's Wikipedia page, if any (Property:Has wikipediaPage)
|wikipedia_protection = Set to 1 if the wikipedia page is edit protected, 0 or empty otherwise (Property:Has wikipediaProtection)
|authors_note= Author's Note subsection
|comment= Wikispooks Comment subsection about why this is relevant (Recommended) Depreceated, please use Template:Rate about the document on your user page instead[1]
|see_also= See Also subsection (Use for related pages which cannot be linked in from the text) Deprecated, but still available in emergencies
}}

  1. ↑ Ask an administrator if you need help with this.
Retrieved from "https://wikispooks.com/w/index.php?title=Template:Document&oldid=265760"