Module:Citation/CS1/Configuration/doc: Difference between revisions

Content deleted Content added

Inline

Revision as of 09:57, 23 April 2023

This configuration file contains various data that controls the functioning of Module:Citation/CS1 and hence the way that Lua-based citations are generated.

It has several sections among which are:

translation tables that contain most of the literal strings that may be included in Lua-based citation. If editors are copying this Module to another wiki using a language other than English, then they should translate each of these values into that language.
a list of error conditions specifying what text to display, what category to include (if any), and what help page section to refer to when errors are detected
a list of ID handlers specifying the recognized document IDs, such as ISBN, DOI, etc., and how to format them.

These files comprise the module support for CS1|2 citation templates:

CS1 | CS2 modules
	sandbox		diff	description
Module:Citation/CS1	Module:Citation/CS1/sandbox	[edit]	diff	Rendering and support functions
Module:Citation/CS1/Configuration	Module:Citation/CS1/Configuration/sandbox	[edit]	diff	Translation tables; error and identifier handlers
Module:Citation/CS1/Whitelist	Module:Citation/CS1/Whitelist/sandbox	[edit]	diff	List of active and deprecated CS1\|2 parameters
Module:Citation/CS1/Date validation	Module:Citation/CS1/Date validation/sandbox	[edit]	diff	Date format validation functions
Module:Citation/CS1/Identifiers	Module:Citation/CS1/Identifiers/sandbox	[edit]	diff	Functions that support the named identifiers (ISBN, DOI, PMID, etc.)
Module:Citation/CS1/Utilities	Module:Citation/CS1/Utilities/sandbox	[edit]	diff	Common functions and tables
Module:Citation/CS1/COinS	Module:Citation/CS1/COinS/sandbox	[edit]	diff	Functions that render a CS1\|2 template's metadata
Module:Citation/CS1/styles.css	Module:Citation/CS1/sandbox/styles.css	[edit]	diff	CSS styles applied to the CS1\|2 templates
Module:Citation/CS1/Suggestions	Module:Citation/CS1/Suggestions/sandbox	[edit]	diff	List that maps common erroneous parameter names to valid parameter names

@@ Line 1: / Line 1: @@
+{{#lst:Module:Citation/CS1/doc|header}}
-local name = lang_obj:formatDate('F', '2022-' .. i .. '-1');			-- get long month name for each i
+This configuration file contains various data that controls the functioning of [[Module:Citation/CS1]] and hence the way that Lua-based citations are generated.
-		long_t[name] = i;														-- save it
-		name = lang_obj:formatDate('M', '2022-' .. i .. '-1');					-- get short month name for each i
+It has several sections among which are:
-		short_t[name] = i;
+# translation tables that contain most of the literal strings that may be included in Lua-based citation.  If editors are copying this Module to another wiki using a language other than English, then they should translate each of these values into that language.
+# a list of error conditions specifying what text to display, what category to include (if any), and what help page section to refer to when errors are detected
+# a list of ID handlers specifying the recognized document IDs, such as ISBN, DOI, etc., and how to format them.
+{{#lst:Module:Citation/CS1/doc|module_components_table}}
+<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
+<!-- Categories below this line, please; interwikis at Wikidata -->
+[[Category:Modules that check for strip markers]]
+}}</includeonly>