Template:Broken links/doc View history

Revision as of 14:52, 16 March 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
| cartouche   = yes (or any entry)
| editor      = yes (or any entry)
| external    = yes (or any entry)
| section     = yes
| wiki        = yes (or any entry)
}}

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

cartouche

Optional parameter indicating the bad link is using a URL through the Cartouche map editor. It will add [[Category:Cartouche links]] to the page. Do not capitalize this parameter. Anything following the parameter will enable it, therefore do not use entries like |cartouche=no or |cartouche=n/a; just remove it when not applicable.

editor

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 [[Category:Bad map editor links]] to the page. Do not capitalize this parameter. Anything following the parameter will enable it, therefore do not use entries like |editor=no or |editor=n/a; just remove it when not applicable.

external

Optional parameter indicating the bad link is from an external URL. It will add [[Category:Bad external links]] to the page. Do not capitalize this parameter. Anything following the parameter will enable it, therefore do not use entries like |external=no or |external=n/a; just remove it when not applicable.

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.

wiki

Optional parameter indicating the bad link is to the Waze wiki. It will add [[Category:Bad wiki links]] to the page. Do not capitalize this parameter. Anything following the parameter will enable it, therefore do not use entries like |wiki=no or |wiki=n/a; just remove it when not applicable.

Where used

Editors can find all occurrences of this template with the link to 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:

@@ Line 9: / Line 9: @@
 <pre>
 {{broken links
-| cartouche   = yes ''(or any entry)''
+| cartouche   = yes (or any entry)
-| editor      = yes ''(or any entry)''
+| editor      = yes (or any entry)
-| external    = yes ''(or any entry)''
+| external    = yes (or any entry)
 | section     = yes
+| wiki        = yes (or any entry)
 }}
 </pre>
+Note that only the {{para|section}} parameter will change the displayed text in the message box. The others will only add categories to the page.
 === Parameters ===
 '''cartouche'''
-:Optional parameter indicating the bad link is using a URL through the Cartouche map editor. 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 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.
 '''editor'''
-: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. 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.
+: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.
 '''external'''
-:Optional parameter indicating the bad link is from an external URL. 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.
+: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.
 '''section'''
-:The text can be altered to reflect the construction happening on the whole page (default) or just one or more sections. Use {{para|<var>section</var>|<var>yes</var>}} for text covering just a section. Do not include that parameter or set it to anything else to result in text covering the whole page.
+: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 ===
@@ Line 34: / Line 40: @@
 === Categories added ===
-This template will automatically add the [[:Category:Broken links]] to the page for tracking. Additional categories get added based on the parameters used. They include:
+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]]
 * [[:Category:Bad map editor links]]
 * [[:Category:Bad external links]]
+* [[:Category:Bad wiki links]]
 <includeonly>