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

Content deleted Content added

Inline

Revision as of 15:24, 28 April 2021

This module contains a list of all parameters that Module:Citation/CS1 knows about. Each parameter is assigned a state.

true: These parameters are valid and supported parameters
false: These parameters are deprecated but still supported
'tracked': These parameters are valid and supported parameters tracked in an eponymous properties category.
nil: Parameters not present are not supported, or no longer supported.

The basic_arguments table is supported by all templates.

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}}
-This page contains a list of all parameters considered by [[Module:Citation/CS1]], though not all parameters would be used for all citations.
+This module contains a list of all parameters that [[Module:Citation/CS1]] knows about. Each parameter is assigned a state.
+* '''true''': These parameters are valid and supported parameters
-The content shown here was initially generated by [[Module:Citation/CS1/Arguments]] but is now maintained by hand to allow parameters to be assigned one of several defined states.  Current states are: active (<code>true</code>), deprecated (<code>false</code>), and obsolete (<code>nil</code>).
+* '''false''': These parameters are deprecated but still supported
+* '''{{'}}tracked{{'}}''': These parameters are valid and supported parameters tracked in an eponymous properties category.
+* '''nil''': Parameters not present are not supported, or no longer supported.
+The <code>basic_arguments</code> table is supported by all templates.
 {{#lst:Module:Citation/CS1/doc|module_components_table}}