Template:Broken links/doc View history

Revision as of 03:10, 19 March 2014 by Kentsmith9 (talk | contribs) (Updated doc to match template changes)
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 through a particular source. Only one parameter can be entered and must be all lower case.
Recognized parameters
Parameter Description
"...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.
Entering a parameter not listed here is the same as not supplying the parameter. Each parameter will add specific text to the message box related to the parameter to help the editor locate the problem link on the page. It will also add a category to the page. See the Categories added section below.

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: