Template:Document

From Wikispooks
Revision as of 09:26, 1 August 2015 by Robin (talk | contribs) (Icon and better presentation of metadata)
Jump to navigation Jump to search
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.

SMWObjects
Semantic Object Templates:        DecadePlaceTimelineYearDisambiguation
ConceptDocumentEmploymentEventGroupPersonPublicationWebsite

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.

Usage:

{{Document
ESSENTIAL DETAILS
|publication_date= PublicationDate (Property:Has publicationDate)
|type={article, essay, paper, book review, letter, memo etc.} (Property:Has documentType)
|source_URL=URL of the source, if it is available online
|iframe_URL=URL of page for display in an iframe.
|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. 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)
|subjectsDetail= note about subjects when preferred comma-delimited subject format is used
|collection=Yes (Use if this is a collection of documents)
|draft=Yes (Use for draft documents)
|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)
|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=
|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
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 translator
FOR BOOKS:
|webpage=URL of this book
|ISBN= ISBN number (Property:Has ISBN)
|review=Human readable short review of the book
|review_author= Author of the book review
|publisher_URL=Web address of the publishers
|publisher_name=Name of the publishers
|publisher_detail=Optional extra note about the publishers
OPTIONAL NOTES:
|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)
|see_also= See Also subsection (Use for related pages which cannot be linked in from the text) Deprecated, but still available in emergencies
}}