Difference between revisions of "Template:Document"

From Wikispooks
Jump to navigation Jump to search
m (translator info display fix)
(wikipedia)
Line 15: Line 15:
 
<s>|{{BLUE|Author}}=The name of the author. For pseudonyms, use single quotes. If anonymous, use ''Unknown''. ''([[Property:Has author]])''</s>
 
<s>|{{BLUE|Author}}=The name of the author. For pseudonyms, use single quotes. If anonymous, use ''Unknown''. ''([[Property:Has author]])''</s>
 
''OPTIONAL DETAILS:''
 
''OPTIONAL DETAILS:''
|description= ''A human readable plaintext description of less than 500 characters.''([[Property:Description]])''
+
|description= ''A human readable plaintext description of less than 500 characters.''([[Property:Description]])''<! --  
<! -- |Subtitle=The subtitle, e.g. of a book -->
+
|subtitle=The subtitle, e.g. of a book -->
 
|collection=Yes (Use if this is a collection of documents)
 
|collection=Yes (Use if this is a collection of documents)
 
|draft=Yes (Use for draft documents)
 
|draft=Yes (Use for draft documents)
Line 24: Line 24:
 
<s>|Source2URL=... |{{BLUE|SourceName2}}=... |SourceDetail2=... For more sources (Only 2 sources supported at the moment)</s>
 
<s>|Source2URL=... |{{BLUE|SourceName2}}=... |SourceDetail2=... For more sources (Only 2 sources supported at the moment)</s>
 
<s>|{{BLUE|Subject2}}= |{{BLUE|Subject3}}=... For more subjects </s>
 
<s>|{{BLUE|Subject2}}= |{{BLUE|Subject3}}=... For more subjects </s>
|{{GREEN|Recipients}}= For emails, letters, speeches etc. ''([[Property:Has recipient]])''
+
|{{GREEN|recipients}}= For emails, letters, speeches etc. ''([[Property:Has recipient]])''<!-- |{{GREEN|RecipientsDetail}}= List of human readable text notes about the receipients -->
<!-- |{{GREEN|RecipientsDetail}}= List of human readable text notes about the receipients -->
 
 
<s>|{{BLUE|Recipient}}= For emails, letters, speeches etc. ''([[Property:Has recipient]])''</s>
 
<s>|{{BLUE|Recipient}}= For emails, letters, speeches etc. ''([[Property:Has recipient]])''</s>
 
<s>|{{BLUE|Recipient2}}=... |{{BLUE|Recipient3}}=...  For more recipients</s>
 
<s>|{{BLUE|Recipient2}}=... |{{BLUE|Recipient3}}=...  For more recipients</s>
Line 62: Line 61:
 
|Credit= Note of thanks
 
|Credit= Note of thanks
 
''OPTIONAL SUBSECTIONS:''
 
''OPTIONAL SUBSECTIONS:''
|wikipedia=Wikipedia URL {{RED|Unimplemented as yet}}
+
|wikipedia=Wikipedia URL
 
|authors_note= ''Author's Note'' subsection
 
|authors_note= ''Author's Note'' subsection
 
|comment= ''Wikispooks Comment'' subsection about why this is relevant (Recommended)
 
|comment= ''Wikispooks Comment'' subsection about why this is relevant (Recommended)
Line 70: Line 69:
 
</poem>
 
</poem>
 
</noinclude><includeonly><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| ]]{{#if: {{{Badge|}}} | <div style="float:right;"> {{ {{{Badge}}} }} </div> }}{{#if: {{{image|}}} | <div style="float:right; margin:0 0 0 12px"> [[File:{{{image|}}}|{{#if: {{{image_width|}}}|{{{image_width|}}}|250px}}]] </div>}}{{Description|{{{description|}}}}}
 
</noinclude><includeonly><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| ]]{{#if: {{{Badge|}}} | <div style="float:right;"> {{ {{{Badge}}} }} </div> }}{{#if: {{{image|}}} | <div style="float:right; margin:0 0 0 12px"> [[File:{{{image|}}}|{{#if: {{{image_width|}}}|{{{image_width|}}}|250px}}]] </div>}}{{Description|{{{description|}}}}}
{{#ifeq: {{{NAMESPACE}}}|Document|{{DocEditMsg}}|}} {{DisplayDocType|{{{type|}}}|{{{draft|}}}|{{{collection|}}}}}{{#if: {{{authors|}}} | &nbsp; by {{ArrayMapPropertyListLink|{{{authors|}}}|Has author}}{{AgentList|Has author|{{{Author|}}}|{{{AuthorDetail|}}}|{{{Author2|}}}|{{{Author2Detail|}}}|{{{Author3|}}}|{{{Author3Detail|}}}|{{{Author4|}}}|{{{Author4Detail|}}}|{{{Author5|}}}|{{{Author5Detail|}}}|{{{Author6|}}}|{{{Author6Detail|}}}|{{{Author7|}}}|{{{Author7Detail|}}}|{{{Author8|}}}|{{{Author8Detail|}}}|{{{Author9|}}}|{{{Author9Detail|}}}|{{{Author10|}}}|{{{Author10Detail|}}}|{{{Author11|}}}|{{{Author11Detail|}}}|{{{Author12|}}}|{{{Author12Detail|}}}|{{{Author13|}}}|{{{Author13Detail|}}}|{{{Author14|}}}|{{{Author14Detail|}}}|{{{Author15|}}}|{{{Author15Detail|}}}}}{{#if: {{{AuthorType|}}} | &nbsp;({{{AuthorType}}})|}}|&nbsp;of unknown authorship [[Category:Authorless documents]]}}{{#if: {{{Recipients|}}}| &nbsp; to {{#arraymap:{{{Recipients|}}}|,|@@@@|[[Has recipient::@@@@]]}}}}{{#if: {{{Recipient|}}} | &nbsp; to {{AgentList|Has recipient|{{{Recipient|}}}|{{{RecipientDetail|}}}|{{{Recipient2|}}}|{{{Recipient2Detail|}}}|{{{Recipient3|}}}|{{{Recipient3Detail|}}}|{{{Recipient4|}}}|{{{Recipient4Detail|}}}|{{{Recipient5|}}}|{{{Recipient5Detail|}}}|{{{Recipient6|}}}|{{{Recipient6Detail|}}}|{{{Recipient7|}}}|{{{Recipient7Detail|}}}|{{{Recipient8|}}}|{{{Recipient8Detail|}}}|{{{Recipient9|}}}|{{{Recipient9Detail|}}}|{{{Recipient10|}}}|{{{Recipient10Detail|}}}|{{{Recipient11|}}}|{{{Recipient11Detail|}}}|{{{Recipient12|}}}|{{{Recipient12Detail|}}}}}}} {{#if: {{{PublisherName|}}}|{{#if: {{{publication_date|}}} | published [[Has publicationDate::{{{publication_date|}}}]]}} {{#if: {{{PublisherName|}}} | by {{Agent|Has publisher|{{{PublisherName|}}}|{{#if: {{{PublisherURL|}}}| <nowiki>[</nowiki>[{{{PublisherURL}}} Link]<nowiki>]</nowiki>}} {{{PublisherDetail|}}} }} |}}|{{#if: {{{publication_date|}}} |dated [[Has publicationDate::{{{publication_date|}}}]]}}}}<br/>{{#if: {{{ISBN|}}}|'''ISBN{{#if: {{{ISBN2|}}}|s|}}:''' {{AgentList|Has ISBN|{{{ISBN|}}}|{{{ISBNDetail|}}}|{{{ISBN2|}}}|{{{ISBN2Detail|}}}|{{{ISBN3|}}}|{{{ISBN3Detail|}}}|{{{ISBN4|}}}|{{{ISBN4Detail|}}}|{{{ISBN5|}}}|{{{ISBN5Detail|}}}}}<br/>}}{{#if: {{{subjects|}}}|'''Subjects:''' {{#arraymap:{{{subjects|}}}|,|@@@@|[[Is about::@@@@]]}} {{{SubjectsDetail|}}}<br/>}}{{#if: {{{Subject|}}}|'''Subject{{#if: {{{Subject2|}}}|s|}}:''' {{AgentList|Is about|{{{Subject|}}}|{{{SubjectDetail|}}}|{{{Subject2|}}}|{{{Subject2Detail|}}}|{{{Subject3|}}}|{{{Subject3Detail|}}}|{{{Subject4|}}}|{{{Subject4Detail|}}}|{{{Subject5|}}}|{{{Subject5Detail|}}}|{{{Subject6|}}}|{{{Subject6Detail|}}}|{{{Subject7|}}}|{{{Subject7Detail|}}}|{{{Subject8|}}}|{{{Subject8Detail|}}}|{{{Subject9|}}}|{{{Subject9Detail|}}}|{{{Subject10|}}}|{{{Subject10Detail|}}}}}<br/>|{{#if: {{{Subjects|}}}||[[Category:Subjectless Documents]]}}}}{{#if: {{{Constitutes|}}} | '''Example of:''' {{AgentList|Constitutes|{{{Constitutes|}}}|{{{ConstitutesDetail|}}}|{{{Constitutes2|}}}|{{{Constitutes2Detail|}}}|{{{Constitutes3|}}}|{{{Constitutes3Detail|}}}|{{{Constitutes4|}}}|{{{Constitutes4Detail|}}}|{{{Constitutes5|}}}|{{{Constitutes5Detail|}}}|{{{Constitutes6|}}}|{{{Constitutes6Detail|}}}|{{{Constitutes7|}}}|{{{Constitutes7Detail|}}}|{{{Constitutes8|}}}|{{{Constitutes8Detail|}}}|{{{Constitutes9|}}}|{{{Constitutes9Detail|}}}|{{{Constitutes10|}}}}}<br/>}} {{DisplayClassification|{{{Classification|}}}|{{{ClassificationDetail|}}}|{{{Leaked|}}}|{{{Declassified|}}}|{{{DeclassifiedDate|}}}|{{{DeclassifiedDetail|}}}}}{{#if: {{{Source2Name|}}}|'''Sources:'''&nbsp;{{DisplaySource|{{{Source2URL|}}}|{{{Source2Name|}}}|{{{Source2Detail|}}}}}, |'''Source:'''&nbsp;}}{{DisplaySource|{{{sourceURL|}}}|{{{source_name|}}}|{{{SourceDetail|}}}}}<br/> {{#if: {{{local|}}} | '''Local copy:''' {{#ifexist: {{{local|}}} | [[Has localCopy::{{{local}}}]] | {{#if:{{#pos:{{{local|}}}|http}} | [{{{local}}} Here] | {{RED|Broken Link: {{{local}}} }} }} }}<br/>|}}{{DocDisclaimer}}{{#if: {{{original_language|}}} | {{#ifeq: {{{original_language|}}} | English |[[Has originalLanguage::English| ]]| <br/>Translated from [[Has original language::{{{original_language|}}}]] {{#if: {{{translators|}}} | by {{Agent|Has translator|{{{translators|}}}|{{{TranslatorDetail|}}}}} |}}}}|}}{{#if: {{{original_title|}}} |&nbsp;- Original title: ''[[Has originalTitle::{{{original_title|}}}]]'' |}}{{#if: {{{Credit|}}} | <br/>'''Credit: '''{{{Credit}}}}}{{#if: {{{version|}}}|'''Version:''' {{{version}}}<br/>}}{{#if: {{{Review|}}} | {{QB|"{{{Review|}}}" {{Agent|Has reviewer|{{{ReviewAuthor|}}}}}}}|}}{{#if: {{{note|}}} |<br/>{{{note}}} }}{{#if: {{{comment|}}} | <br/><br/><big><big>Wikispooks Comment</big></big>
+
{{#ifeq: {{{NAMESPACE}}}|Document|{{DocEditMsg}}|}} {{DisplayDocType|{{{type|}}}|{{{draft|}}}|{{{collection|}}}}}{{#if: {{{authors|}}} | &nbsp; by {{ArrayMapPropertyListLink|{{{authors|}}}|Has author}}{{AgentList|Has author|{{{Author|}}}|{{{AuthorDetail|}}}|{{{Author2|}}}|{{{Author2Detail|}}}|{{{Author3|}}}|{{{Author3Detail|}}}|{{{Author4|}}}|{{{Author4Detail|}}}|{{{Author5|}}}|{{{Author5Detail|}}}|{{{Author6|}}}|{{{Author6Detail|}}}|{{{Author7|}}}|{{{Author7Detail|}}}|{{{Author8|}}}|{{{Author8Detail|}}}|{{{Author9|}}}|{{{Author9Detail|}}}|{{{Author10|}}}|{{{Author10Detail|}}}|{{{Author11|}}}|{{{Author11Detail|}}}|{{{Author12|}}}|{{{Author12Detail|}}}|{{{Author13|}}}|{{{Author13Detail|}}}|{{{Author14|}}}|{{{Author14Detail|}}}|{{{Author15|}}}|{{{Author15Detail|}}}}}{{#if: {{{AuthorType|}}} | &nbsp;({{{AuthorType}}})|}}|&nbsp;of unknown authorship [[Category:Authorless documents]]}}{{#if: {{{Recipients|}}}| &nbsp; to {{#arraymap:{{{Recipients|}}}|,|@@@@|[[Has recipient::@@@@]]}}}}{{#if: {{{Recipient|}}} | &nbsp; to {{AgentList|Has recipient|{{{Recipient|}}}|{{{RecipientDetail|}}}|{{{Recipient2|}}}|{{{Recipient2Detail|}}}|{{{Recipient3|}}}|{{{Recipient3Detail|}}}|{{{Recipient4|}}}|{{{Recipient4Detail|}}}|{{{Recipient5|}}}|{{{Recipient5Detail|}}}|{{{Recipient6|}}}|{{{Recipient6Detail|}}}|{{{Recipient7|}}}|{{{Recipient7Detail|}}}|{{{Recipient8|}}}|{{{Recipient8Detail|}}}|{{{Recipient9|}}}|{{{Recipient9Detail|}}}|{{{Recipient10|}}}|{{{Recipient10Detail|}}}|{{{Recipient11|}}}|{{{Recipient11Detail|}}}|{{{Recipient12|}}}|{{{Recipient12Detail|}}}}}}} {{#if: {{{PublisherName|}}}|{{#if: {{{publication_date|}}} | published [[Has publicationDate::{{{publication_date|}}}]]}} {{#if: {{{PublisherName|}}} | by {{Agent|Has publisher|{{{PublisherName|}}}|{{#if: {{{PublisherURL|}}}| <nowiki>[</nowiki>[{{{PublisherURL}}} Link]<nowiki>]</nowiki>}} {{{PublisherDetail|}}} }} |}}|{{#if: {{{publication_date|}}} |dated [[Has publicationDate::{{{publication_date|}}}]]}}}}<br/>{{#if: {{{ISBN|}}}|'''ISBN{{#if: {{{ISBN2|}}}|s|}}:''' {{AgentList|Has ISBN|{{{ISBN|}}}|{{{ISBNDetail|}}}|{{{ISBN2|}}}|{{{ISBN2Detail|}}}|{{{ISBN3|}}}|{{{ISBN3Detail|}}}|{{{ISBN4|}}}|{{{ISBN4Detail|}}}|{{{ISBN5|}}}|{{{ISBN5Detail|}}}}}<br/>}}{{#if: {{{subjects|}}}|'''Subjects:''' {{#arraymap:{{{subjects|}}}|,|@@@@|[[Is about::@@@@]]}} {{{SubjectsDetail|}}}<br/>}}{{#if: {{{Subject|}}}|'''Subject{{#if: {{{Subject2|}}}|s|}}:''' {{AgentList|Is about|{{{Subject|}}}|{{{SubjectDetail|}}}|{{{Subject2|}}}|{{{Subject2Detail|}}}|{{{Subject3|}}}|{{{Subject3Detail|}}}|{{{Subject4|}}}|{{{Subject4Detail|}}}|{{{Subject5|}}}|{{{Subject5Detail|}}}|{{{Subject6|}}}|{{{Subject6Detail|}}}|{{{Subject7|}}}|{{{Subject7Detail|}}}|{{{Subject8|}}}|{{{Subject8Detail|}}}|{{{Subject9|}}}|{{{Subject9Detail|}}}|{{{Subject10|}}}|{{{Subject10Detail|}}}}}<br/>|{{#if: {{{Subjects|}}}||[[Category:Subjectless Documents]]}}}}{{#if: {{{Constitutes|}}} | '''Example of:''' {{AgentList|Constitutes|{{{Constitutes|}}}|{{{ConstitutesDetail|}}}|{{{Constitutes2|}}}|{{{Constitutes2Detail|}}}|{{{Constitutes3|}}}|{{{Constitutes3Detail|}}}|{{{Constitutes4|}}}|{{{Constitutes4Detail|}}}|{{{Constitutes5|}}}|{{{Constitutes5Detail|}}}|{{{Constitutes6|}}}|{{{Constitutes6Detail|}}}|{{{Constitutes7|}}}|{{{Constitutes7Detail|}}}|{{{Constitutes8|}}}|{{{Constitutes8Detail|}}}|{{{Constitutes9|}}}|{{{Constitutes9Detail|}}}|{{{Constitutes10|}}}}}<br/>}} {{DisplayClassification|{{{Classification|}}}|{{{ClassificationDetail|}}}|{{{Leaked|}}}|{{{Declassified|}}}|{{{DeclassifiedDate|}}}|{{{DeclassifiedDetail|}}}}}{{#if: {{{Source2Name|}}}|'''Sources:'''&nbsp;{{DisplaySource|{{{Source2URL|}}}|{{{Source2Name|}}}|{{{Source2Detail|}}}}}, |'''Source:'''&nbsp;}}{{DisplaySource|{{{sourceURL|}}}|{{{source_name|}}}|{{{SourceDetail|}}}}}<br/> {{#if: {{{local|}}} | '''Local copy:''' {{#ifexist: {{{local|}}} | [[Has localCopy::{{{local}}}]] | {{#if:{{#pos:{{{local|}}}|http}} | [{{{local}}} Here] | {{RED|Broken Link: {{{local}}} }} }} }}<br/>|}}{{DocDisclaimer}}{{#if: {{{original_language|}}} | {{#ifeq: {{{original_language|}}} | English |[[Has originalLanguage::English| ]]| <br/>Translated from [[Has original language::{{{original_language|}}}]] {{#if: {{{translators|}}} | by {{Agent|Has translator|{{{translators|}}}|{{{TranslatorDetail|}}}}} |}}}}|}}{{#if: {{{original_title|}}} |&nbsp;- Original title: ''[[Has originalTitle::{{{original_title|}}}]]'' |}}{{#if: {{{Credit|}}} | <br/>'''Credit: '''{{{Credit}}}}}{{#if: {{{version|}}}|'''Version:''' {{{version}}}<br/>}}{{#if: {{{Review|}}} | {{QB|"{{{Review|}}}" {{Agent|Has reviewer|{{{ReviewAuthor|}}}}}}}|}}{{#if: {{{note|}}} |<br/>{{{note}}} }}{{#if: {{{wikipedia|}}} | <br/>'''Wikipedia: '''{{{wikipedia|}}}<br/>}}{{#if: {{{comment|}}} | <br/><br/><big><big>Wikispooks Comment</big></big>
 
----
 
----
 
{{{comment}}} |}}{{#if: {{{authors_note|}}} | <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>

Revision as of 04:40, 7 July 2014

Broom.png This template still uses old format parameters (upper case and numerical). These are being replaced. In the meantime, the template should work more or less as documented below and can still be used.

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.

Usage:

{{Document
ESSENTIAL DETAILS
|publication_date= PublicationDate (Property:Has publicationDate)
|type={article, essay, paper, book review, letter, memo etc.} (Property:Has documentType)
|sourceURL=URL of the source, if it is available online
|source_name=General name of the source, e.g. "Unwelcome Guests", "Cryptome", ... (Property:Sourced from)
|local=Address of the wikispooks copy (Property:Has localCopy)
|authors= Comma separated list of authors
|subjects= Comma separated list of subject items. For pseudonyms, use single quotes. If anonymous, use Unknown. (Property:Is about)
|Author=The name of the author. For pseudonyms, use single quotes. If anonymous, use Unknown. (Property:Has author)
OPTIONAL DETAILS:
|description= A human readable plaintext description of less than 500 characters.(Property:Description)<! --
|subtitle=The subtitle, e.g. of a book -->
|collection=Yes (Use if this is a collection of documents)
|draft=Yes (Use for draft documents)
|Badge= The name of an existing badge template, e.g. "[[template:CryptomeBadge|]]"
|ContentsTitle=Mainly for backward FileProv compatibility but usable for new Documents too
|SourceDetail=Specific details, e.g. "#675", "vol. 3, chapter 20", "pp.212-213"...
|Source2URL=... |SourceName2=... |SourceDetail2=... For more sources (Only 2 sources supported at the moment)
|Subject2= |Subject3=... For more subjects
|recipients= For emails, letters, speeches etc. (Property:Has recipient)
|Recipient= For emails, letters, speeches etc. (Property:Has recipient)
|Recipient2=... |Recipient3=... For more recipients
|Constitutes= For topics which this document is not about, but directly constitutes (e.g. "censorship", "war propaganda") (Property:Constitutes)
|ConstitutesDetail= Short note of explanation about the Constitutes parameter
|Constitutes2=... |Constitutes3=... For more things which this document constitutes
|image=
|image_width= The default value is "250px"
|RecipientDetail=Short note about recipient #1
|AuthorDetail= Short note about the author, (e.g. "Home Office accredited forensic pathologist")
|Author2Detail=Short note about the author2
|SubjectDetail=
|Subject2Detail= short note about Subject2 ... Subject3Detail=... for more subject details
|Classification=Original security classification, e.g. "official", "secret", "top secret"... (Property:Has classification)
|ClassificationDetail= 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
|DeclassifiedDetail= Optional Note about the declassification
|AuthorType=Explanatory note about authorship, e.g. "alleged"
|version=For versioned documents
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)
|TranslatorDetail=Short note on the translator
FOR BOOKS:
|Webpage=URL of the book
|Review=Human readable short review of the book
|ReviewAuthor= Author of the book review
|PublisherURL=Web address of the publishers
|PublisherName=Name of the publishers
|PublisherDetail=Optional extra note about the publishers
OPTIONAL NOTES:
|note=
|Credit= Note of thanks
OPTIONAL SUBSECTIONS:
|wikipedia=Wikipedia URL
|authors_note= Author's Note subsection
|comment= Wikispooks Comment subsection about why this is relevant (Recommended)
|subjectsDetail= note about subjects when preferred comma-delimited subject format is used
|see_also= See Also subsection (Use for related pages which cannot be linked in from the text) Deprecated, but still available in emergencies
}}