Difference between revisions of "Template:Document"

From Wikispooks
Jump to navigation Jump to search
m (Text replacement - "|Declassified" to "|declassified")
Line 12: Line 12:
 
|{{BLUE|local}}=Address of the wikispooks copy ''([[Property:Has localCopy]])''
 
|{{BLUE|local}}=Address of the wikispooks copy ''([[Property:Has localCopy]])''
 
|{{GREEN|authors}}= Comma separated list of authors
 
|{{GREEN|authors}}= Comma separated list of authors
 +
<s>|{{BLUE|Author}}=The name of the author. For pseudonyms, use single quotes. If anonymous, use ''Unknown''. ''([[Property:Has author]])''</s>
 
|{{GREEN|subjects}}= Comma separated list of subject items. For pseudonyms, use single quotes. If anonymous, use ''Unknown''. ''([[Property:Is about]])''
 
|{{GREEN|subjects}}= Comma separated list of subject items. For pseudonyms, use single quotes. If anonymous, use ''Unknown''. ''([[Property:Is about]])''
<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)
Line 22: Line 22:
 
|ContentsTitle=Mainly for backward FileProv compatibility but usable for new Documents too
 
|ContentsTitle=Mainly for backward FileProv compatibility but usable for new Documents too
 
|source_detail=Specific details, e.g. "#675", "vol. 3, chapter 20", "pp.212-213"... (Do ''not'' use this for ISBN numbers, use '|ISBN' for that)
 
|source_detail=Specific details, e.g. "#675", "vol. 3, chapter 20", "pp.212-213"... (Do ''not'' use this for ISBN numbers, use '|ISBN' for that)
|ISBN= ISBN number
 
 
<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>
Line 28: Line 27:
 
<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>
|{{BLUE|Constitutes}}= For topics which this document is not about, but directly constitutes (e.g. "censorship", "war propaganda") ''([[Property:Constitutes]])''
+
|{{GREEN|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
 
|ConstitutesDetail= Short note of explanation about the Constitutes parameter
 
|{{BLUE|Constitutes2}}=... |{{BLUE|Constitutes3}}=...  For more things which this document constitutes
 
|{{BLUE|Constitutes2}}=... |{{BLUE|Constitutes3}}=...  For more things which this document constitutes
Line 41: Line 40:
 
|ClassificationDetail= Optional note about the security classification
 
|ClassificationDetail= Optional note about the security classification
 
|leaked=Yes (Use for leaked documents)
 
|leaked=Yes (Use for leaked documents)
|declassified=Yes (Use for declassified documents)
+
|Declassified=Yes (Use for declassified documents)
 
|declassified_date=When the document was declassified
 
|declassified_date=When the document was declassified
|declassifiedDetail= Optional Note about the declassification
+
|DeclassifiedDetail= Optional Note about the declassification
 
|AuthorType=Explanatory note about authorship, e.g. "alleged"
 
|AuthorType=Explanatory note about authorship, e.g. "alleged"
 
|version=For versioned documents
 
|version=For versioned documents
Line 53: Line 52:
 
''FOR BOOKS:''
 
''FOR BOOKS:''
 
|webpage=URL of this book
 
|webpage=URL of this book
|Review=Human readable short review of the book
+
|ISBN= ISBN number ''([[Property:Has ISBN]])''
 +
|review=Human readable short review of the book
 
|{{BLUE|ReviewAuthor}}= Author of the book review
 
|{{BLUE|ReviewAuthor}}= Author of the book review
 
|PublisherURL=Web address of the publishers
 
|PublisherURL=Web address of the publishers
Line 65: Line 65:
 
|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)
|subjectsDetail= note about subjects when preferred comma-delimited subject format is used
+
|{{GREEN|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''
 
|see_also= ''See Also'' subsection (Use for related pages which cannot be linked in from the text) ''Deprecated, but still available in emergencies''
 
}}
 
}}

Revision as of 19:07, 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
|Author=The name of the author. 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)
OPTIONAL DETAILS:
|description= A human readable plaintext description of less than 500 characters.(Property:Description)
|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
|source_detail=Specific details, e.g. "#675", "vol. 3, chapter 20", "pp.212-213"... (Do not use this for ISBN numbers, use '|ISBN' for that)
|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 this book
|ISBN= ISBN number (Property:Has ISBN)
|review=Human readable short review of the book
|ReviewAuthor= Author of the book review
|PublisherURL=Web address of the publishers
|publisher_name=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
}}