View source for Template:Broken ref/doc

{{about|incorrect &lt;ref> formatting|inaccessible external links|Template:Dead link}}
{{Documentation subpage}}<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
{{Used in system|in many system messages}}
{{Lua|Module:Namespace detect}}
{{Uses TemplateStyles|Template:Broken ref/styles.css}}
{{Cite.php}} is the software extension for the footnotes system. Cite.php includes error checking and generates error messages using MediaWiki interface messages. When Cite.php encounters an error, it generates a message pulled from a [[Help:MediaWiki namespace|MediaWiki interface page]]. The MediaWiki pages are customized to use {{tl|Broken ref}} to control the display of the error message and to add a category. {{tl|Broken ref}} uses namespace detection to choose whether pages are categorized or not and if error messages show or not.

==Namespaces==
This template causes error messages to show only in certain namespaces. Category sorting is set by a sortkey in the template.

<section begin=sortkeys />
{| class="wikitable"
|-
! Namespace !! Sortkey !! Uppercase
|-
| main (article) || alphabetic ||
|-
| category || γ || {{uc:γ}}
|-
| template || τ || {{uc:τ}}
|-
| file || ι || {{uc:ι}}
|-
| help || ω || {{uc:ω}}
|-
| portal || ρ || {{uc:ρ}}
|-
| wikipedia || ψ || {{uc:ψ}}
|-
| draft || δ || {{uc:δ}}
|}
<section end=sortkeys />

{{shortcut|H:SHOWCITEERROR}}
Errors on talk and other pages do not show by default but can be enabled by adding a rule to {{yourcss}}:

<syntaxhighlight lang="css">
.mw-parser-output span.brokenref {
  display: inline;
}
</syntaxhighlight>

==Categories==
The template causes pages that show and error to be placed in a maintenance category. Pages in these categories are then repaired by editors. Errors on talk and other pages do not add the category. Category management is done through {{tl|broken ref/cat}}.

* [[:Category:Pages with citation errors]]: main category.
** [[:Category:Pages with incorrect ref formatting]]: default category.
** [[:Category:Pages with broken reference names]]
*** [[MediaWiki:Cite error references no text]]
** [[:Category:Pages with missing references list]]
*** [[MediaWiki:Cite error group refs without references]]

==Parameters==
Error messages use:
* {{para|msg}} text of the error message
* {{para|lang}} language using ISO code
* {{para|help}} subpagename of [[Special:PrefixIndex/Help:Cite errors/|help page]]. This parameter is also used to determine the category by [[Template:Broken ref/cat]].
* {{para|nocat}} set to 'true' to suppress the category and the <code>brokenref</code> class; use when transcluding the WikiMedia interface page for documentation purposes

Prefix interface pages use:
* {{para|prefix}} text that precedes the message
* {{para|lang}} language using ISO code

==Examples==

Use the following example when editing MediaWiki error message pages:

<syntaxhighlight lang="wikitext">
{{broken ref
|msg=The <code><ref></code> tag has too many names
|lang=en
|help=Cite error ref too many keys
|nocat={{{nocat|}}}
}}
</syntaxhighlight>

By including {{para|nocat|2={{param|nocat|nested=yes}}}}, the {{para|nocat}} parameter can be passed to {{tl|broken ref}}.

==Transcluding error messages==

When creating documentation, the error messages can be transcluded so that the messages are automatically updated. Add {{para|nocat|true}} to suppress the error category and the class that hides the error in some namespaces. The message transclusion always adds a hard line break at the end.

{{markup
|<nowiki>{{int:Cite error ref too many keys|nocat=true}}</nowiki>
|2={{int:Cite error ref too many keys|nocat=true}}
}}

To style the text in red to more closely simulate the message, use the {{tl|red}} template.
{{markup
|<nowiki>{{red|{{int:Cite error ref too many keys|nocat=true}}}}</nowiki>
|{{red|{{int:Cite error ref too many keys|nocat=true}}}}
}}

To style the text to exactly simulate the message, use the {{tl|error}} template.
{{markup
|<nowiki>{{error|{{int:Cite error ref too many keys|nocat=true}}}}</nowiki>
|{{error|{{int:Cite error ref too many keys|nocat=true}}}}
}}

==Languages==
These languages are supported. The list of languages is selected from the top uses at [[Wikipedia:Database reports/User preferences]]. Language management is done through {{tl|broken ref/lang}}.

*en: {{#language:en}}
*es: {{#language:es}}
*fr: {{#language:fr}}
*pt-br: {{#language:pt-br}}
*ru: {{#language:ru}}
*de: {{#language:de}}
*id: {{#language:id}}
*ar: {{#language:ar}}
*nl: {{#language:nl}}
*zh-cn: {{#language:zh-cn}}
*ro: {{#language:ro}}
*it: {{#language:it}}
*tr: {{#language:tr}}

Plus the English variants:
* en-gb: {{#language:en-gb}}
* en-ca: {{#language:en-ca}}
Originally these were transcluded, but not all MediaWiki pages support such transclusion.

==Interface pages==
Complete list of interface pages by language:
{{collapse top}}
{{broken ref/cite error list|lang=en}}
{{broken ref/cite error list|lang=en-gb}}
{{broken ref/cite error list|lang=en-ca}}
{{broken ref/cite error list|lang=es}}
{{broken ref/cite error list|lang=fr}}
{{broken ref/cite error list|lang=pt-br}}
{{broken ref/cite error list|lang=ru}}
{{broken ref/cite error list|lang=de}}
{{broken ref/cite error list|lang=id}}
{{broken ref/cite error list|lang=ar}}
{{broken ref/cite error list|lang=nl}}
{{broken ref/cite error list|lang=zh-cn}}
{{broken ref/cite error list|lang=ro}}
{{broken ref/cite error list|lang=it}}
{{broken ref/cite error list|lang=tr}}
{{collapse bottom}}

<includeonly>{{Sandbox other||<!--
++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, INSIDE INCLUDEONLY TAGS, THANK YOU. -->
[[Category:Citation and verifiability maintenance templates]]
}}</includeonly>