Module:IntrawikiCite

From Errapedia
Jump to navigation Jump to search

Documentation for this module may be created at Module:IntrawikiCite/doc

-- This module was designed for creating in-universe citations that reference other pages on the wiki which refer to in-universe documents, pages, and other similar materials.
-- It builds citations like those used in the real world, but does so in a universe-friendly way. We use checks to see if certain keys exist to dynamically shape the data and how it's cited. In the structure document below, any item preceeded by a ">" character represents a portion of data that may not always exist.
--
-- === Document Citation Table Structure ===
-- 
--  datatype: "CitableDoc"
--  document_name - String
--  document_type - String
--  title - String
--  > publication_title - String : The document that this was published as a part of. This is included if the document is part of a larger work, like a journal or collection.
--  publication_date - Datetime table - Tracks D/M/Y in-universe - See Module:ErraCalendar.
--  > authorship - DocAuthor table, see below.
--  > publisher_data - DocPublisher table, see below.
--  > periodical_data - DocPeriodical table, see below
--  > page_data - DocPageRange table, see below
--
-- === === DocPublisher === ===
--
--  datatype: "CitableDocPublisher"
--  publisher_name - String 
--  publisher_location - String
--
-- === === DocPeriodical === ===
-- 
--  datatype: "CitableDocPeriodical"
--  volume - String or Integer
--  issue - String or Integer
--  series - String
--  edition - String or Integer
--
-- === === DocPageRange === ===
--
-- datatype: "CitableDocPageRange"
-- page_start - Integer -- If the document is only one page, page_start and page_end are the same. 
-- page_end - Integer