Template:Broken links/doc View history

Latest revision as of 19:00, 9 August 2014

This is a documentation subpage for Template:Broken links.
It contains usage information, categories and other content that is not part of the original template page.

This template is added to pages that have bad links, which will need to be fixed, but the current editor is unable to identify a better source or is unable to study the issue.

Usage

Place {{broken links}} at the top of a page to produce the default message box.

Alternately, the following optional variables can be used to adjust the generic message:

{{broken links
| source   = cartouche
           = editor
           = external
           = multiple
           = wiki
| section  = yes
}}

Note that only the |section= parameter will change the displayed text in the message box. The others will only add categories to the page.

Parameters

source

Optional parameter indicating the bad link is using a URL from a particular source to help the editor locate the problem link on the page. Only one parameter can be entered and must be all lower case. If more than one source is on a page, either use |source=multiple one time at the top of the page, or use |section=yes and change the source for each entry of the template on the page. Each parameter will also add a category to the page. See the Categories added section below.

Parameter	Description "...contains one or more broken links..."
Recognized parameters
cartouche	from the discontinued Cartouche editor.
editor	from an older URL of the map editor.
external	from an external web source.
multiple	from multiple sources.
wiki	in the Waze wiki.
{invalid or missing}	from sources not identified.

section

The text can be altered to reflect the bad links are present on the whole page (default) or just one or more sections (this parameter). Use |section=yes for instances where the bad link(s) are specific to one section. Do not include this parameter, or set it to anything else to result in indicating the bad links are present somewhere in the whole page.

Where used

Editors can find all occurrences of this template with what links here for the Broken links template.

Categories added

This template will automatically add [[Category:Broken links]] to the page for tracking. Additional categories get added based on the parameters used. They include:

|source=cartouche adds: Category:Cartouche links
|source=editor adds: Category:Bad map editor links
|source=external adds: Category:Bad external links
|source=multiple adds: Category:Bad links
|source=wiki adds: Category:Bad wiki links
An unrecognized or no source parameter adds: Category:Bad unidentified links

@@ Line 9: / Line 9: @@
 <pre>
 {{broken links
-| cartouche   = yes (or any entry)
+| source   = cartouche
-| editor      = yes (or any entry)
+           = editor
-| external    = yes (or any entry)
+           = external
-| section     = yes
+           = multiple
-| wiki        = yes (or any entry)
+           = wiki
+| section  = yes
 }}
 </pre>
@@ Line 21: / Line 22: @@
 === Parameters ===
-'''cartouche'''
+'''source'''
-:Optional parameter indicating the bad link is using a URL through the Cartouche map editor. It will add <nowiki>[[</nowiki>[[:Category:Cartouche links]]<nowiki>]]</nowiki> to the page. Do not capitalize this parameter. Anything following the parameter will enable it, therefore do '''not''' use entries like {{para|<var>cartouche</var>|<var>no</var>}} or {{para|<var>cartouche</var>|<var>n/a</var>}}; just remove it when not applicable.
+:Optional parameter indicating the bad link is using a URL from a particular source to help the editor locate the problem link on the page. Only one parameter can be entered and must be all lower case. If more than one source is on a page, either use {{para|<var>source</var>|<var>multiple</var>}} one time at the top of the page, or use {{para|<var>section</var>|<var>yes</var>}} and change the source for each entry of the template on the page. Each parameter will also add a category to the page. See the [[#Categories added|Categories added]] section below.
-'''editor'''
+{| class="wikitable sortable" border="1"
-:Optional parameter indicating the bad link is using a URL through the current editor with an old URL or some other issue causing the link to fail. It will add <nowiki>[[</nowiki>[[:Category:Bad map editor links]]<nowiki>]]</nowiki> to the page. Do not capitalize this parameter. Anything following the parameter will enable it, therefore do '''not''' use entries like {{para|<var>editor</var>|<var>no</var>}} or {{para|<var>editor</var>|<var>n/a</var>}}; just remove it when not applicable.
+|  colspan="2" rowspan="1" style="text-align: center;" | '''Recognized parameters'''
+|-
-'''external'''
+! Parameter
-:Optional parameter indicating the bad link is from an external URL. It will add <nowiki>[[</nowiki>[[:Category:Bad external links]]<nowiki>]]</nowiki> to the page. Do not capitalize this parameter. Anything following the parameter will enable it, therefore do '''not''' use entries like {{para|<var>external</var>|<var>no</var>}} or {{para|<var>external</var>|<var>n/a</var>}}; just remove it when not applicable.
+! Description<br />"...contains one or more broken links..."
+|-
+| cartouche
+| from the discontinued Cartouche editor.
+|-
+| editor
+| from an older URL of the map editor.
+|-
+| external
+| from an external web source.
+|-
+| multiple
+| from multiple sources.
+|-
+| wiki
+| in the Waze wiki.
+|-
+| {invalid or missing}
+| from sources not identified.
+|-
+|}
 '''section'''
 :The text can be altered to reflect the bad links are present on the whole page (default) or just one or more sections (this parameter). Use {{para|<var>section</var>|<var>yes</var>}} for instances where the bad link(s) are specific to one section. Do not include this parameter, or set it to anything else to result in indicating the bad links are present somewhere in the whole page.
-'''wiki'''
-:Optional parameter indicating the bad link is to the Waze wiki. It will add <nowiki>[[</nowiki>[[:Category:Bad wiki links]]<nowiki>]]</nowiki> to the page. Do not capitalize this parameter. Anything following the parameter will enable it, therefore do '''not''' use entries like {{para|<var>wiki</var>|<var>no</var>}} or {{para|<var>wiki</var>|<var>n/a</var>}}; just remove it when not applicable.
 === Where used ===
-Editors can find all occurrences of this template with the link to [[Special:WhatLinksHere/Template:broken links|what links here for the Broken links template]].
+Editors can find all occurrences of this template with [[Special:WhatLinksHere/Template:broken links|what links here for the Broken links template]].
 === Categories added ===
 This template will automatically add <nowiki>[[</nowiki>[[:Category:Broken links]]<nowiki>]]</nowiki> to the page for tracking. Additional categories get added based on the parameters used. They include:
-* [[:Category:Cartouche links]]
+* {{para|<var>source</var>|<var>cartouche</var>}} adds: [[:Category:Cartouche links]]
-* [[:Category:Bad map editor links]]
+* {{para|<var>source</var>|<var>editor</var>}} adds: [[:Category:Bad map editor links]]
-* [[:Category:Bad external links]]
+* {{para|<var>source</var>|<var>external</var>}} adds: [[:Category:Bad external links]]
-* [[:Category:Bad wiki links]]
+* {{para|<var>source</var>|<var>multiple</var>}} adds: [[:Category:Bad links]]
+* {{para|<var>source</var>|<var>wiki</var>}} adds: [[:Category:Bad wiki links]]
+* An unrecognized or no source parameter adds: [[:Category:Bad unidentified links]]
 <includeonly>
 <!-- Add categories for the template itself below this line -->
-[[Category:Maintenance Templates]]
+[[Category:Maintenance templates]]
-[[Category:Mbox Templates]]
+[[Category:Mbox templates]]
 <!-- ADD INTERWIKIS BELOW THIS LINE -->
 </includeonly>