Module:Documentation/config: Difference between revisions
Content deleted Content added
Enwikipedia>Mr. Stradivarius add diff message back for sandbox notice - some wikis might want this to be separate from the one in the end box |
Enwikipedia>Mr. Stradivarius convert messages to use hyphens instead of camelCase, in line with MediaWiki |
||
Line 14:
----------------------------------------------------------------------------------------------------
-- cfg
-- The prefix before any error messages found by the script.
cfg
-- cfg
-- The category pages are placed into if any errors are found.
cfg
----------------------------------------------------------------------------------------------------
Line 26:
----------------------------------------------------------------------------------------------------
-- cfg
-- The error message to display if the "page" argument does not result in a
-- valid title.
cfg
----------------------------------------------------------------------------------------------------
Line 35:
----------------------------------------------------------------------------------------------------
-- cfg
-- The name of the template that displays the protection icon (a padlock on enwiki).
cfg
-- cfg['protection-template-args']
-- Any arguments to send to the protection template.
cfg
----------------------------------------------------------------------------------------------------
Line 48:
-- On sandbox pages the module can display a template notifying users that the current page is a
-- sandbox, and the location of test cases pages, etc. The module decides whether the page is a
-- sandbox or not based on the value of cfg
-- messages that the notices contains.
----------------------------------------------------------------------------------------------------
-- cfg['sandbox-notice-image']
-- The image displayed in the sandbox notice.
cfg
-- cfg['sandbox-notice-blurb']
-- The opening sentence of the sandbox notice. $1 is a link to the main template page.
cfg
-- cfg['sandbox-notice-diff-blurb']
-- cfg['sandbox-notice-diff-display']
-- cfg
-- to the main template page, and $2 is a diff link between the sandbox and the main template. The
-- display value of the diff link is set by cfg
cfg
cfg
-- cfg['sandbox-notice-testcases-blurb']
-- cfg['sandbox-notice-testcases-link-display']
-- cfg
-- corresponding to this sandbox that they can edit. $1 is a link to the test cases page.
-- cfg
cfg
cfg
-- cfg
-- A category to add to all template sandboxes.
cfg
----------------------------------------------------------------------------------------------------
Line 84:
----------------------------------------------------------------------------------------------------
-- cfg['documentation-icon-wikitext']
-- The wikitext for the icon shown at the top of the template.
cfg
-- cfg['template-namespace-heading']
-- The heading shown in the template namespace.
cfg
-- cfg['module-namespace-heading']
-- The heading shown in the module namespace.
cfg
-- cfg['file-namespace-heading']
-- The heading shown in the file namespace.
cfg
-- cfg['other-namespaces-heading']
-- The heading shown in other namespaces.
cfg
-- cfg
-- The text to display for "view" links.
cfg
-- cfg
-- The text to display for "edit" links.
cfg
-- cfg['history-link-display']
-- The text to display for "history" links.
cfg
-- cfg
-- The text to display for "purge" links.
cfg
-- cfg
-- The text to display for "create" links.
cfg
----------------------------------------------------------------------------------------------------
Line 128:
----------------------------------------------------------------------------------------------------
-- cfg['transcluded-from-blurb']
-- Notice displayed when the docs are transcluded from another page. $1 is a wikilink to that page.
cfg
-- cfg['create-module-doc-blurb']
-- Notice displayed in the module namespace when the documentation subpage does not exist.
-- $1 is a link to create the documentation page with the preload cfg
-- display cfg
cfg
----------------------------------------------------------------------------------------------------
Line 142:
----------------------------------------------------------------------------------------------------
-- cfg['experiment-blurb-template']
-- cfg['experiment-blurb-module']
-- The experiment blurb is the text inviting editors to experiment in sandbox and test cases pages.
-- It is only shown in the template and module namespaces. With the default English settings, it
Line 152:
-- In this example, "sandbox", "edit", "diff", "testcases", and "edit" would all be links.
--
-- There are two versions, cfg
-- on what namespace we are in.
--
Line 159:
-- $1 is a link to the sandbox page. If the sandbox exists, it is in the following format:
--
-- cfg
--
-- If the sandbox doesn't exist, it is in the format:
--
-- cfg
--
-- The link for cfg
-- or cfg
-- loads a default edit summary of cfg
--
-- $2 is a link to the test cases page. If the test cases page exists, it is in the following format:
--
-- cfg
--
-- If the test cases page doesn't exist, it is in the format:
--
-- cfg
--
-- If the test cases page doesn't exist, the link for cfg
-- page with cfg
-- namespace.
cfg
cfg
----------------------------------------------------------------------------------------------------
Line 187:
----------------------------------------------------------------------------------------------------
-- cfg
-- The name of the template subpage typically used for sandboxes.
cfg
-- cfg['template-sandbox-preload']
-- Preload file for template sandbox pages.
cfg
-- cfg['module-sandbox-preload']
-- Preload file for Lua module sandbox pages.
cfg
-- cfg['sandbox-link-display']
-- The text to display for "sandbox" links.
cfg
-- cfg['sandbox-edit-link-display']
-- The text to display for sandbox "edit" links.
cfg
-- cfg['sandbox-create-link-display']
-- The text to display for sandbox "create" links.
cfg
-- cfg['compare-link-display']
-- The text to display for "compare" links.
cfg
-- cfg
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the
-- template page.
cfg
-- cfg
-- The text to display for "mirror" links.
cfg
----------------------------------------------------------------------------------------------------
Line 228:
----------------------------------------------------------------------------------------------------
-- cfg
-- The name of the template subpage typically used for test cases.
cfg
-- cfg['template-testcases-preload']
-- Preload file for template test cases pages.
cfg
-- cfg['module-testcases-preload']
-- Preload file for Lua module test cases pages.
cfg
-- cfg['testcases-link-display']
-- The text to display for "testcases" links.
cfg
-- cfg['testcases-edit-link-display']
-- The text to display for test cases "edit" links.
cfg
-- cfg['testcases-create-link-display']
-- The text to display for test cases "create" links.
cfg
----------------------------------------------------------------------------------------------------
Line 256:
----------------------------------------------------------------------------------------------------
-- cfg['add-categories-blurb']
-- Text to direct users to add categories to the /doc subpage. Not used if the "content" or
-- "docname fed" arguments are set, as then it is not clear where to add the categories. $1 is a
-- link to the /doc subpage with a display value of cfg
cfg
-- cfg
-- The text to display when linking to the /doc subpage.
cfg
----------------------------------------------------------------------------------------------------
Line 270:
----------------------------------------------------------------------------------------------------
-- cfg['subpages-link-display']
-- The text to display for the "subpages of this page" link. $1 is cfg
-- cfg
--
cfg
-- cfg
-- The pagetype to display for template pages.
cfg
-- cfg
-- The pagetype to display for Lua module pages.
cfg
-- cfg
-- The pagetype to display for pages other than templates or Lua modules.
cfg
----------------------------------------------------------------------------------------------------
Line 292:
----------------------------------------------------------------------------------------------------
-- cfg
-- The name of the subpage typically used for documentation pages.
cfg
-- cfg['file-docpage-preload']
-- Preload file for documentation page in the file namespace.
cfg
-- cfg
-- Preload file for template documentation pages in all namespaces.
cfg
-- cfg
-- Preload file for Lua module documentation pages.
cfg
----------------------------------------------------------------------------------------------------
Line 312:
----------------------------------------------------------------------------------------------------
-- cfg
-- The name of the template subpage used for print versions.
cfg
-- cfg
-- The text to display when linking to the /Print subpage.
cfg
-- cfg
-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg
cfg
.. ' If you make a change to this template, please update the print version as well.'
-- cfg['display-print-category']
-- Set to true to enable output of cfg
cfg
-- cfg
-- Category to output if cfg
cfg
----------------------------------------------------------------------------------------------------
Line 337:
----------------------------------------------------------------------------------------------------
-- cfg
-- The "id" attribute of the main HTML "div" tag.
cfg
-- cfg
-- The CSS classes added to the main HTML "div" tag.
cfg
-- cfg['start-box-linkclasses']
-- The CSS classes used for the [view][edit][history] or [create] links in the start box.
cfg
-- cfg
-- The HTML "id" attribute for the links in the start box.
cfg
----------------------------------------------------------------------------------------------------
Line 357:
----------------------------------------------------------------------------------------------------
-- cfg
-- The id sent to the "id" parameter of the {{fmbox}} template.
cfg
-- cfg
-- The value to suppress image output from the "image" parameter of {{fmbox}}.
cfg
-- cfg
-- The value sent to the style parameter of {{fmbox}}.
cfg
-- cfg
-- The value sent to the "textstyle parameter of {{fmbox}}.
cfg
----------------------------------------------------------------------------------------------------
Line 377:
----------------------------------------------------------------------------------------------------
-- cfg['display-strange-usage-category']
-- Set to true to enable output of cfg
-- or a /testcases subpage.
cfg
-- cfg['strange-usage-category']
-- Category to output if cfg
-- /doc subpage or a /testcases subpage.
cfg
-- cfg['strange-usage-category-mainspace-sort']
-- Category sort key prefix to use for cfg
-- is followed by the full page name.
cfg
----------------------------------------------------------------------------------------------------
|