Draft:Manual of Style/Linking: Difference between revisions
imported>Deadfire First draft that needs heavy modification |
Tungstenchan (talk | contribs) m Text replacement - "BattleTechWiki" to "BattleIntelligence" |
||
| Line 1: | Line 1: | ||
<noinclude>{{pp-move-indef}}</noinclude> {{For|technical information about link formatting|Help:Link}} | <noinclude>{{pp-move-indef}}</noinclude> {{For|technical information about link formatting|Help:Link}} | ||
{{For|information on adding external links to articles| | {{For|information on adding external links to articles|BattleIntelligence:External links}} | ||
{{pp-semi-indef|small=yes}} | {{pp-semi-indef|small=yes}} | ||
{{Style-guideline|MOS:L|BTW:LINK|MOS:LINK|BTW:MOSLINK}} | {{Style-guideline|MOS:L|BTW:LINK|MOS:LINK|BTW:MOSLINK}} | ||
{{Style}} | {{Style}} | ||
'''Linking''' through [[w:hyperlink|hyperlink]]s is an important feature of | '''Linking''' through [[w:hyperlink|hyperlink]]s is an important feature of BattleIntelligence. [[w:Internal link|Internal link]]s bind the project together into an [[w:Web navigation|interconnected whole]], and external links bind BattleIntelligence to the [[w:World Wide Web|World Wide Web]]. | ||
Appropriate links provide instant pathways to locations within and outside the project that can increase readers' understanding of the topic at hand. Whenever writing or editing an article, consider not only what to put in the article, but what links to include to help the reader find related information, and also which other pages should have links {{em|to}} the article. Avoid both [[#Underlinking|underlinking]] and [[#Overlinking|overlinking]], as described below. | Appropriate links provide instant pathways to locations within and outside the project that can increase readers' understanding of the topic at hand. Whenever writing or editing an article, consider not only what to put in the article, but what links to include to help the reader find related information, and also which other pages should have links {{em|to}} the article. Avoid both [[#Underlinking|underlinking]] and [[#Overlinking|overlinking]], as described below. | ||
This page provides guidelines as to when links should and should not be used, and how to format links. For information about the syntax used to create links, see [[Help:Link]]. For links on [[ | This page provides guidelines as to when links should and should not be used, and how to format links. For information about the syntax used to create links, see [[Help:Link]]. For links on [[BattleIntelligence:Disambiguation|disambiguation]] pages, see [[BattleIntelligence:Manual of Style/Disambiguation pages]]. | ||
==<span id="General principles"></span> Principles== | ==<span id="General principles"></span> Principles== | ||
<!-- This span tag (subst'ed Anchor template) serves to provide a permanent target for incoming section links. Please do not move it out of the section heading. Please do not modify it, even if you modify the section title. It is always best to anchor an old section header that has been changed so that links to it won't be broken. See [[Template:Anchor]] for details. (This text was substituted from [[Template:Anchor comment]]) --> | <!-- This span tag (subst'ed Anchor template) serves to provide a permanent target for incoming section links. Please do not move it out of the section heading. Please do not modify it, even if you modify the section title. It is always best to anchor an old section header that has been changed so that links to it won't be broken. See [[Template:Anchor]] for details. (This text was substituted from [[Template:Anchor comment]]) --> | ||
{{Redirect|BTW:BUILD|the behavioral guideline| | {{Redirect|BTW:BUILD|the behavioral guideline|BattleIntelligence:Here to build an encyclopedia}} | ||
{{Shortcut|MOS:BTW|MOS:BUILD}} | {{Shortcut|MOS:BTW|MOS:BUILD}} | ||
BattleIntelligence is based on [[hypertext]], and aims to "build the web" to enable readers to access relevant information on other BattleIntelligence pages easily. The page from which the hyperlink is activated is called the ''anchor''; the page the link points to is called the ''target''. | |||
In adding or removing links, consider an article's place in the [[tree structure|knowledge tree]]. Internal links can add to the cohesion and utility of | In adding or removing links, consider an article's place in the [[tree structure|knowledge tree]]. Internal links can add to the cohesion and utility of BattleIntelligence, allowing readers to deepen their understanding of a topic by conveniently accessing other articles. Ask yourself, "How likely is it that the reader will also want to read that other article?" Consider including links where readers might want to use them; for example, in article [[BattleIntelligence:Manual of Style/Lead section|leads]], at the openings of new sections, in the cells of [[BattleIntelligence:Manual of Style/Tables|tables]], and in [[BattleIntelligence:Manual of Style/Captions|file captions]]. But as a rule of thumb, [[#MOS:REPEATLINK|link only the first occurrence of a term]] in the text of the article. | ||
===General points on linking style=== | ===General points on linking style=== | ||
| Line 24: | Line 24: | ||
* As explained in more detail at {{section link|Help:Link|Wikilinks}}, linking can be ''direct'' (<code><nowiki>[[Riverside, California]]</nowiki></code>, which results in {{xt|[[Riverside, California]]}}), or ''piped'' (<code><nowiki>[[Riverside, California|Riverside]]</nowiki></code>, which results in {{xt|[[Riverside, California|Riverside]]}} in the text, but still links to the article "[[Riverside, California]]"—although the [[Help:pipe trick|pipe trick]] is an easier way to create this particular link). | * As explained in more detail at {{section link|Help:Link|Wikilinks}}, linking can be ''direct'' (<code><nowiki>[[Riverside, California]]</nowiki></code>, which results in {{xt|[[Riverside, California]]}}), or ''piped'' (<code><nowiki>[[Riverside, California|Riverside]]</nowiki></code>, which results in {{xt|[[Riverside, California|Riverside]]}} in the text, but still links to the article "[[Riverside, California]]"—although the [[Help:pipe trick|pipe trick]] is an easier way to create this particular link). | ||
* Section headings should not themselves contain links; instead, a {{tl|main article}} or {{tl|see also}} template should be placed immediately after the heading. | * Section headings should not themselves contain links; instead, a {{tl|main article}} or {{tl|see also}} template should be placed immediately after the heading. | ||
* Links should not be placed in the [[ | * Links should not be placed in the [[BattleIntelligence:Manual of Style/Lead section#Format of the first sentence|boldface reiteration of the title]] in the opening sentence of a lead.<ref group="Note">Many, but not all, articles repeat the article title in bold face in the first line of the article. Linking the article to itself produces '''boldface text'''; this practice is discouraged as page moves will result in a useless circular link through a redirect. Linking ''part'' of the bolded text is also discouraged because it changes the visual effect of bolding; some readers will miss the visual cue which is the purpose of using bold face in the first place.</ref> | ||
* {{Shortcut|MOS:NOLINKQUOTE}}{{anchor|Linking quotations}}Be conservative when linking within quotations; link only to targets that correspond to the meaning clearly intended by the quote's author. Where possible, link from text outside of the quotation instead – either before it or soon after. | * {{Shortcut|MOS:NOLINKQUOTE}}{{anchor|Linking quotations}}Be conservative when linking within quotations; link only to targets that correspond to the meaning clearly intended by the quote's author. Where possible, link from text outside of the quotation instead – either before it or soon after. | ||
* {{Shortcut|MOS:SOB|MOS:SEAOFBLUE}}{{anchor|Sea of blue|Dribbles of blue}}When possible, do not place links next to each other, to avoid appearing like a single link, as in [[chess]] [[tournament]] (<code><nowiki>[[chess]] [[tournament]]</nowiki></code>). Instead, consider rephrasing the sentence ([[tournament]] of [[chess]]), omitting one of the links ([[chess]] tournament), or using a single, more specific link as in [[chess tournament]] (<code><nowiki>[[chess tournament]]</nowiki></code>). | * {{Shortcut|MOS:SOB|MOS:SEAOFBLUE}}{{anchor|Sea of blue|Dribbles of blue}}When possible, do not place links next to each other, to avoid appearing like a single link, as in [[chess]] [[tournament]] (<code><nowiki>[[chess]] [[tournament]]</nowiki></code>). Instead, consider rephrasing the sentence ([[tournament]] of [[chess]]), omitting one of the links ([[chess]] tournament), or using a single, more specific link as in [[chess tournament]] (<code><nowiki>[[chess tournament]]</nowiki></code>). | ||
| Line 38: | Line 38: | ||
* Articles on technical subjects might demand a higher density of links than general-interest articles, because they are likely to contain more technical terms that general dictionaries are unlikely to explain in context. | * Articles on technical subjects might demand a higher density of links than general-interest articles, because they are likely to contain more technical terms that general dictionaries are unlikely to explain in context. | ||
* Beware of linking to an article without first confirming that the target article covers the appropriate topic. For example, an article mentioning the physics unit "barn" should link to [[barn (unit)]], not [[barn]]. | * Beware of linking to an article without first confirming that the target article covers the appropriate topic. For example, an article mentioning the physics unit "barn" should link to [[barn (unit)]], not [[barn]]. | ||
* {{Shortcut|MOS:DRAFTNOLINK}}{{anchor|Draft space}}In articles, do not link to pages outside the article [[ | * {{Shortcut|MOS:DRAFTNOLINK}}{{anchor|Draft space}}In articles, do not link to pages outside the article [[BattleIntelligence:Namespace|namespace]], except in articles about BattleIntelligence itself (and even in that case with care{{snd}}see [[BattleIntelligence:Manual of Style/Self-references to avoid]]). | ||
* Do not unnecessarily make a reader chase links: if a highly technical term can be simply explained with very few words, do so. | * Do not unnecessarily make a reader chase links: if a highly technical term can be simply explained with very few words, do so. | ||
* {{Shortcut|MOS:NOFORCELINK|MOS:FORCELINK|}}{{anchor|Forced links}} Use a link when appropriate, but as far as possible do not force a reader to use that link to understand the sentence. The text needs to make sense to readers who cannot follow links. Users may print articles or read offline, and | * {{Shortcut|MOS:NOFORCELINK|MOS:FORCELINK|}}{{anchor|Forced links}} Use a link when appropriate, but as far as possible do not force a reader to use that link to understand the sentence. The text needs to make sense to readers who cannot follow links. Users may print articles or read offline, and BattleIntelligence content may be encountered in [[BattleIntelligence:Reusing BattleIntelligence content|republished form]], often without links. | ||
* Refrain from implementing [[Help:Link color|colored links]] that may impede user ability to distinguish links from regular text, or color links for purely aesthetic reasons. | * Refrain from implementing [[Help:Link color|colored links]] that may impede user ability to distinguish links from regular text, or color links for purely aesthetic reasons. | ||
| Line 49: | Line 49: | ||
====<span id="Underlinking"></span>What generally should be linked==== | ====<span id="Underlinking"></span>What generally should be linked==== | ||
{{Redirect|MOS:UL|unordered lists| | {{Redirect|MOS:UL|unordered lists|BattleIntelligence:Manual of Style/Lists#Embedded lists|underlining|BattleIntelligence:Manual of Style/Text formatting#How not to apply emphasis}} | ||
<!-- This span tag (subst'ed Anchor template) serves to provide a permanent target for incoming section links. Please do not move it out of the section heading. Please do not modify it, even if you modify the section title. It is always best to anchor an old section header that has been changed so that links to it won't be broken. See [[Template:Anchor]] for details. (This text: [[Template:Anchor comment]]) --> | <!-- This span tag (subst'ed Anchor template) serves to provide a permanent target for incoming section links. Please do not move it out of the section heading. Please do not modify it, even if you modify the section title. It is always best to anchor an old section header that has been changed so that links to it won't be broken. See [[Template:Anchor]] for details. (This text: [[Template:Anchor comment]]) --> | ||
{{Shortcut|MOS:UL|MOS:UNDERLINK}} | {{Shortcut|MOS:UL|MOS:UNDERLINK}} | ||
| Line 56: | Line 56: | ||
* Relevant connections to the subject of another article that will help readers understand the article more fully (see [[#An example article|the example]] below). This can include people, events, and topics that already have an article or that clearly deserve one, as long as the link is relevant to the article in question. | * Relevant connections to the subject of another article that will help readers understand the article more fully (see [[#An example article|the example]] below). This can include people, events, and topics that already have an article or that clearly deserve one, as long as the link is relevant to the article in question. | ||
* Articles with relevant information, for example: "{{xt|see [[Fourier series]] for relevant background}}" | * Articles with relevant information, for example: "{{xt|see [[Fourier series]] for relevant background}}" | ||
* Articles explaining words of technical terms, jargon or slang expressions or phrases—but you could also give a concise definition instead of or in addition to a link. If there is no appropriate | * Articles explaining words of technical terms, jargon or slang expressions or phrases—but you could also give a concise definition instead of or in addition to a link. If there is no appropriate BattleIntelligence article, an [[Help:Interwikimedia links|interwikimedia link]] to [[Wiktionary]] could be used. | ||
* [[Proper name]]s that are likely to be unfamiliar to readers | * [[Proper name]]s that are likely to be unfamiliar to readers | ||
If you feel that a link is relevant to the topic of the article but does not belong in the body of an article, consider moving it to a [[ | If you feel that a link is relevant to the topic of the article but does not belong in the body of an article, consider moving it to a [[BattleIntelligence:Manual of Style/Layout#See also section|"See also" section]]. | ||
Links may be created to potential articles that do not yet exist (see {{section link||Red links}}). If an article exists on a foreign-language | Links may be created to potential articles that do not yet exist (see {{section link||Red links}}). If an article exists on a foreign-language BattleIntelligence but not yet in English, consider a red link that also links to the foreign-language article (see {{slink||Links to foreign-language pages}}). | ||
==== <span id="Overlinking"></span> What generally should not be linked ==== | ==== <span id="Overlinking"></span> What generally should not be linked ==== | ||
| Line 78: | Line 78: | ||
** nationalities, ethnicities or descent (e.g., British, Japanese, Turkish, African American, Nigerian) | ** nationalities, ethnicities or descent (e.g., British, Japanese, Turkish, African American, Nigerian) | ||
** religions (e.g., Christianity, Islam, Hinduism, Buddhism) | ** religions (e.g., Christianity, Islam, Hinduism, Buddhism) | ||
:But try to be conscious of your own [[ | :But try to be conscious of your own [[BattleIntelligence:Systemic bias|demographic biases]] – what is well known in your age group, line of work, or country may be less known in others. | ||
* [[#Units of measurement that are not obscure|Common units of measurement]], e.g., units relating to time, temperature, length, area, or volume. If both non-metric and metric equivalents are given, as in {{xt|{{convert|5|cm|in|0}}}}, usually neither unit needs to be linked, because almost all readers will understand at least one of the units. | * [[#Units of measurement that are not obscure|Common units of measurement]], e.g., units relating to time, temperature, length, area, or volume. If both non-metric and metric equivalents are given, as in {{xt|{{convert|5|cm|in|0}}}}, usually neither unit needs to be linked, because almost all readers will understand at least one of the units. | ||
* Dates {{crossref|(see {{section link||Chronological items}}, below)}} | * Dates {{crossref|(see {{section link||Chronological items}}, below)}} | ||
* [[ | * [[BattleIntelligence:Disambiguation|Disambiguation]] pages should not be linked from articles unless [[BattleIntelligence:Disambiguation#Links to disambiguation pages|the link is purposeful]], such as in a hatnote. Instead, use a [[BattleIntelligence:Piped link|piped link]] to the appropriate article. | ||
**For example, for the Disney character, use | **For example, for the Disney character, use | ||
:{{tick}}<code><nowiki>[[Moana (character)|Moana]]</nowiki></code>{{emdash}}which appears as [[Moana (character)|Moana]], leading to the intended page. | :{{tick}}<code><nowiki>[[Moana (character)|Moana]]</nowiki></code>{{emdash}}which appears as [[Moana (character)|Moana]], leading to the intended page. | ||
| Line 88: | Line 88: | ||
{{Anchor|Circular|Circ}} | {{Anchor|Circular|Circ}} | ||
{{Shortcut|MOS:CIRCULAR}} | {{Shortcut|MOS:CIRCULAR}} | ||
Do not link to pages that [[ | Do not link to pages that [[BattleIntelligence:Redirect#Self-redirects|redirect back to the page]] the link is on (unless the link is to a [[:Category:Redirects with possibilities|redirect with possibilities]] that links to an appropriate ''section'' of the current article). | ||
The purpose of linking is to clarify and to provide reasonable navigation opportunities, not to emphasize a particular word. Do not link solely to draw attention to certain words or ideas, or as a mark of respect. | The purpose of linking is to clarify and to provide reasonable navigation opportunities, not to emphasize a particular word. Do not link solely to draw attention to certain words or ideas, or as a mark of respect. | ||
External links normally should not be placed in the body of an article (see [[ | External links normally should not be placed in the body of an article (see [[BattleIntelligence:External links]]). | ||
====<span id="Repeated links"></span><span id="DUPLINK"></span> Duplicate and repeat links==== | ====<span id="Repeated links"></span><span id="DUPLINK"></span> Duplicate and repeat links==== | ||
{{Shortcut|MOS:REPEATLINK|MOS:LINKONCE|MOS:DUPLINK|MOS:DL|MOS:REFLINK}} | {{Shortcut|MOS:REPEATLINK|MOS:LINKONCE|MOS:DUPLINK|MOS:DL|MOS:REFLINK}} | ||
Generally, a link should appear only {{em|once}} in an article, but it may be repeated if helpful for readers, such as in [[ | Generally, a link should appear only {{em|once}} in an article, but it may be repeated if helpful for readers, such as in [[BattleIntelligence:Manual of Style/Infoboxes|infoboxes]], tables, image captions, [[Help:Footnotes|footnotes]], [[BattleIntelligence:Hatnote|hatnotes]], and at the first occurrence in a major section. | ||
[[ | [[BattleIntelligence:Citing sources|Citations]] stand alone in their usage, so there is no problem with repeating the same link in many citations within an article; e.g. <code><nowiki>|work=[[The Guardian]]</nowiki></code>. | ||
In [[ | In [[BattleIntelligence:Manual of Style/Glossaries|glossaries]], which are primarily referred to for encyclopedic entries on specific terms rather than read from top to bottom like a regular article, it is usually desirable to repeat links (including to other terms in the glossary) that were not already linked in the same entry {{crossref|(see [[Template:Glossary link]])}}. | ||
Duplicate linking in [[ | Duplicate linking in [[BattleIntelligence:Manual of Style/Lists|stand-alone and embedded lists]] is permissible if it significantly aids the reader. This is most often the case when the list is presenting information that could just as aptly be formatted in a table, and is expected to be parsed for particular bits of data, not read from top to bottom. If the list is normal article prose that happens to be formatted as a list, treat it as normal article prose. | ||
Duplicate links in an article can be found using the [[User:Evad37/duplinks-alt|duplinks-alt]] sidebar tool. | Duplicate links in an article can be found using the [[User:Evad37/duplinks-alt|duplinks-alt]] sidebar tool. | ||
| Line 108: | Line 108: | ||
====Lead section==== | ====Lead section==== | ||
{{Shortcut|MOS:LEADLINK}} | {{Shortcut|MOS:LEADLINK}} | ||
{{for|links in the first sentence| | {{for|links in the first sentence|BattleIntelligence:Manual of Style/Lead section#Contextual links}} | ||
Too many links can make the lead hard to read. In technical articles that use uncommon terms, a higher-than-usual link density in the [[ | Too many links can make the lead hard to read. In technical articles that use uncommon terms, a higher-than-usual link density in the [[BattleIntelligence:Manual of Style/Lead section|lead section]] may be necessary. In such cases, try to provide an informal explanation in the lead, avoiding using too many technical terms until later in the article. (See [[BattleIntelligence:Make technical articles understandable]] and [[BattleIntelligence:What BattleIntelligence is not#BattleIntelligence is not a manual, guidebook, textbook, or scientific journal|BattleIntelligence is not a scientific journal]].) | ||
Most [[ | Most [[BattleIntelligence:Featured articles|Featured Articles]] contain about 12 to 25 links in the lead, with an average of about 1.5 links per sentence, or one link for every 16 words. | ||
====<span class="anchor" id="An example article"></span>An example article==== | ====<span class="anchor" id="An example article"></span>An example article==== | ||
| Line 121: | Line 121: | ||
* Do not link to the "United States", because that is an article on a very broad topic with no direct connection to supply and demand. | * Do not link to the "United States", because that is an article on a very broad topic with no direct connection to supply and demand. | ||
* Definitely do not link "wheat", because it is a common term with no particular relationship to the article on supply and demand, beyond its arbitrary use as an example of traded goods in that article. | * Definitely do not link "wheat", because it is a common term with no particular relationship to the article on supply and demand, beyond its arbitrary use as an example of traded goods in that article. | ||
* Make sure that the links are directed to the correct articles: in this example, you should link [[goods]], not [[good]], which goes to a page on the philosophical concept. Many common dictionary words are ambiguous terms in | * Make sure that the links are directed to the correct articles: in this example, you should link [[goods]], not [[good]], which goes to a page on the philosophical concept. Many common dictionary words are ambiguous terms in BattleIntelligence and linking to them is often unhelpful to readers; "Good" is a surname and the name of albums, companies, etc., and the article title [[Good (disambiguation)]] is used to index those. | ||
===Link clarity=== | ===Link clarity=== | ||
| Line 191: | Line 191: | ||
If there is no article about the most specific topic, do one of the following things: | If there is no article about the most specific topic, do one of the following things: | ||
* Consider [[ | * Consider [[BattleIntelligence:Starting an article|creating the article]] yourself. | ||
* If an article on the specific topic does not yet exist, create a redirect page to the article about a more general topic, as described in section {{section link||Redirects}}. For example, if no article yet exists on the song "Sad Statue" from the album ''Mezmerize'', create a new article called [[Sad Statue]] that is a redirect to the article ''[[Mezmerize (album)|Mezmerize]]''. | * If an article on the specific topic does not yet exist, create a redirect page to the article about a more general topic, as described in section {{section link||Redirects}}. For example, if no article yet exists on the song "Sad Statue" from the album ''Mezmerize'', create a new article called [[Sad Statue]] that is a redirect to the article ''[[Mezmerize (album)|Mezmerize]]''. | ||
* If there is no article on a more general topic either, then create a [[redlink|red link]], but first, read {{section link||Red links}} below. | * If there is no article on a more general topic either, then create a [[redlink|red link]], but first, read {{section link||Red links}} below. | ||
| Line 225: | Line 225: | ||
===Redirects=== | ===Redirects=== | ||
{{Shortcut|MOS:RDR|MOS:REDIR}} | {{Shortcut|MOS:RDR|MOS:REDIR}} | ||
{{Main| | {{Main|BattleIntelligence:Redirect}} | ||
Suppose you need to link ''poodle'', and there is no such article yet. You might want to create a redirect from "poodle" to "dog" as follows: Link as usual: <code><nowiki>She owned a [[poodle]]</nowiki></code>. When you save or preview this, you will see: {{xt|She owned a [[BTW:Red link example|poodle]]}}. Click on the red link, and you will be invited to create a new page for ''poodle''; enter (perhaps) <code><nowiki>#REDIRECT [[Dog]]</nowiki></code>, so that readers clicking on ''poodle'' will be taken, for now, to the dog article. | Suppose you need to link ''poodle'', and there is no such article yet. You might want to create a redirect from "poodle" to "dog" as follows: Link as usual: <code><nowiki>She owned a [[poodle]]</nowiki></code>. When you save or preview this, you will see: {{xt|She owned a [[BTW:Red link example|poodle]]}}. Click on the red link, and you will be invited to create a new page for ''poodle''; enter (perhaps) <code><nowiki>#REDIRECT [[Dog]]</nowiki></code>, so that readers clicking on ''poodle'' will be taken, for now, to the dog article. | ||
| Line 236: | Line 236: | ||
===Piped links=== | ===Piped links=== | ||
{{Shortcut|MOS:PIPE|MOS:PIPEDLINK}} | {{Shortcut|MOS:PIPE|MOS:PIPEDLINK}} | ||
{{Further information| | {{Further information|BattleIntelligence:Piped link}}<!--not a policy or guideline--> | ||
Though a wikilink defaults to displaying the title of the target article, it is possible to choose more specific or more appropriate display text for the intended context. This can be done with the use of the pipe character ('''|'''). For example, {{xt|<code><nowiki>[[Henry II of England|Henry II]]</nowiki></code>}} displays as {{xt|[[Henry II of England|Henry II]]}}. However, make sure that it is still clear what the link is about without having to follow the link. Think about what the reader may believe the text refers to. For example, when seeing the link {{xt|<code><nowiki>[[Archery at the 2008 Summer Olympics|Archery]]</nowiki></code>}}, which displays as {{xt|[[Archery at the 2008 Summer Olympics|Archery]]}}, the reader will probably expect this link to go to a general article on [[archery]], rather than {{xt|[[Archery at the 2008 Summer Olympics]]}} specifically. An exception to this is when it is clear from the context that a link refers to a specific article; for instance, in {{xt|[[Template:Events at the 2008 Summer Olympics]]}} all links go to articles about these particular games. | Though a wikilink defaults to displaying the title of the target article, it is possible to choose more specific or more appropriate display text for the intended context. This can be done with the use of the pipe character ('''|'''). For example, {{xt|<code><nowiki>[[Henry II of England|Henry II]]</nowiki></code>}} displays as {{xt|[[Henry II of England|Henry II]]}}. However, make sure that it is still clear what the link is about without having to follow the link. Think about what the reader may believe the text refers to. For example, when seeing the link {{xt|<code><nowiki>[[Archery at the 2008 Summer Olympics|Archery]]</nowiki></code>}}, which displays as {{xt|[[Archery at the 2008 Summer Olympics|Archery]]}}, the reader will probably expect this link to go to a general article on [[archery]], rather than {{xt|[[Archery at the 2008 Summer Olympics]]}} specifically. An exception to this is when it is clear from the context that a link refers to a specific article; for instance, in {{xt|[[Template:Events at the 2008 Summer Olympics]]}} all links go to articles about these particular games. | ||
| Line 243: | Line 243: | ||
{{shortcut|MOS:PIPESTYLE}} | {{shortcut|MOS:PIPESTYLE}} | ||
* '''Plurals and other derived names.''' {{xt|<code><nowiki>[[apple]]s</nowiki></code>}} displays as {{xt|[[apple]]s}}, and this is simpler and clearer than {{xt|<code><nowiki>[[apple|apples]]</nowiki></code>}}. Similarly: {{xt|<code><nowiki>[[appeal]]ing</nowiki></code>}}, {{xt|<code><nowiki>[[hyperlink]]ed</nowiki></code>}}, {{xt|<code><nowiki>[[red]]dest</nowiki></code>}}. Some characters will not work after the link; see [[Help:Link]] for more details. | * '''Plurals and other derived names.''' {{xt|<code><nowiki>[[apple]]s</nowiki></code>}} displays as {{xt|[[apple]]s}}, and this is simpler and clearer than {{xt|<code><nowiki>[[apple|apples]]</nowiki></code>}}. Similarly: {{xt|<code><nowiki>[[appeal]]ing</nowiki></code>}}, {{xt|<code><nowiki>[[hyperlink]]ed</nowiki></code>}}, {{xt|<code><nowiki>[[red]]dest</nowiki></code>}}. Some characters will not work after the link; see [[Help:Link]] for more details. | ||
* '''Case sensitivity.''' Links are not sensitive to initial capitalization, so there is no need to use the pipe character where the case of the initial letter is the only difference between the link text and the target page. ( | * '''Case sensitivity.''' Links are not sensitive to initial capitalization, so there is no need to use the pipe character where the case of the initial letter is the only difference between the link text and the target page. (BattleIntelligence article titles almost always begin with a capital, whereas the linked words in context often do not.) However, links are case-sensitive for all characters after the initial one. | ||
====Intuitiveness==== | ====Intuitiveness==== | ||
| Line 250: | Line 250: | ||
[[File:Easter egg hunt.JPG|alt=young child looks under some green plants|thumb|Is there anything hidden in here?]] | [[File:Easter egg hunt.JPG|alt=young child looks under some green plants|thumb|Is there anything hidden in here?]] | ||
Keep piped links as intuitive as possible. Per the [[ | Keep piped links as intuitive as possible. Per the [[BattleIntelligence:Principle of least astonishment|principle of least astonishment]], make sure that the reader knows what to expect when clicking on a link. You should plan your page structure and links so that everything appears reasonable and makes sense. If a link takes readers to somewhere other than where they thought it would, it should at least take them somewhere that makes sense. | ||
A link's visible label does not need to match the exact title of the article being linked, such as in {{Mxt|<nowiki>[[Truck|Lorry]]</nowiki>}} or {{Mxt|<nowiki>[[Passing (sports)|passed the ball]]</nowiki>}}. However, avoid "[[Easter egg (media)|Easter egg]]" or "submarine" links, which are links that unexpectedly hide relevant information underneath the link's label. For example, do not write:<br />{{in5}}<code>{{!mxt|Richard Feynman was also known for work in <nowiki>[[Parton (particle physics)|particle physics]]</nowiki>.}}</code><br />Here readers would see the link displayed as {{xt|[[Parton (particle physics)|particle physics]]}}, not the hidden reference to the page {{xt|[[Parton (particle physics)]]}}, unless they clicked on the link or hovered their [[mouse cursor]] over it. If a physical copy of the article were printed, the reference to the parton model would be lost. | A link's visible label does not need to match the exact title of the article being linked, such as in {{Mxt|<nowiki>[[Truck|Lorry]]</nowiki>}} or {{Mxt|<nowiki>[[Passing (sports)|passed the ball]]</nowiki>}}. However, avoid "[[Easter egg (media)|Easter egg]]" or "submarine" links, which are links that unexpectedly hide relevant information underneath the link's label. For example, do not write:<br />{{in5}}<code>{{!mxt|Richard Feynman was also known for work in <nowiki>[[Parton (particle physics)|particle physics]]</nowiki>.}}</code><br />Here readers would see the link displayed as {{xt|[[Parton (particle physics)|particle physics]]}}, not the hidden reference to the page {{xt|[[Parton (particle physics)]]}}, unless they clicked on the link or hovered their [[mouse cursor]] over it. If a physical copy of the article were printed, the reference to the parton model would be lost. | ||
| Line 281: | Line 281: | ||
| <code>{{!mxt|<nowiki>[[Richard Feynman|Feynman]] diagram</nowiki>}}</code> || → [[Richard Feynman|Feynman]] diagram | | <code>{{!mxt|<nowiki>[[Richard Feynman|Feynman]] diagram</nowiki>}}</code> || → [[Richard Feynman|Feynman]] diagram | ||
|} | |} | ||
The above applies regardless of whether linking to the full name creates a [[ | The above applies regardless of whether linking to the full name creates a [[BattleIntelligence:Red link|red link]]; for example, even if there is no article titled [[Lafayette Avenue (Brooklyn)]]: | ||
{| style="text-align:right; margin-left:44.8px" | {| style="text-align:right; margin-left:44.8px" | ||
! Do not write: | ! Do not write: | ||
| Line 291: | Line 291: | ||
====Piping and redirects<span class="anchor" id="NOPIPE"></span><span class="anchor" id="Piping and redirects"></span>==== | ====Piping and redirects<span class="anchor" id="NOPIPE"></span><span class="anchor" id="Piping and redirects"></span>==== | ||
{{Shortcut|MOS:NOPIPE|MOS:DYKPIPE}} | {{Shortcut|MOS:NOPIPE|MOS:DYKPIPE}} | ||
As per [[BTW:NOTBROKEN]] and {{section link||Link specificity}} above, do not use a piped link where it is possible to use a redirected term that fits well within the scope of the text. For example, the page {{xt|[[Papageno]]}} is a redirect to the article about Mozart's opera ''[[The Magic Flute]]''. While editing some other article, you might want to link the term {{xt|Papageno}}; here, you might be tempted to avoid the redirect by using a pipe within the link, as in {{!xt|<code><nowiki>[[The Magic Flute|Papageno]]</nowiki></code>}}. Instead, write simply {{xt|<code><nowiki>[[Papageno]]</nowiki></code>}} and let the system handle the rest. This has two advantages: first, if an article is written later about the more specific subject (in this case, "Papageno"), fewer links will need to be changed to accommodate the new article; second, it indicates that the article is [[BTW:Most-wanted articles|wanted]]. An exception to this rule is when linking to articles in [[BTW:Did you know|Did you know]] (DYK) "[[ | As per [[BTW:NOTBROKEN]] and {{section link||Link specificity}} above, do not use a piped link where it is possible to use a redirected term that fits well within the scope of the text. For example, the page {{xt|[[Papageno]]}} is a redirect to the article about Mozart's opera ''[[The Magic Flute]]''. While editing some other article, you might want to link the term {{xt|Papageno}}; here, you might be tempted to avoid the redirect by using a pipe within the link, as in {{!xt|<code><nowiki>[[The Magic Flute|Papageno]]</nowiki></code>}}. Instead, write simply {{xt|<code><nowiki>[[Papageno]]</nowiki></code>}} and let the system handle the rest. This has two advantages: first, if an article is written later about the more specific subject (in this case, "Papageno"), fewer links will need to be changed to accommodate the new article; second, it indicates that the article is [[BTW:Most-wanted articles|wanted]]. An exception to this rule is when linking to articles in [[BTW:Did you know|Did you know]] (DYK) "[[BattleIntelligence:Did you know#DYK rules|hooks]]" [[Main Page#mp-dyk-h2|on the Main Page]], where piping links to prevent readers from seeing a redirect notice is preferable, and the hook will be live only for a short time. {{crossref|(See also {{section link|BTW:Piped link#When not to use}}.)}} | ||
====<span id="Linking to sections of articles"></span> Piped links and redirects to sections of articles==== | ====<span id="Linking to sections of articles"></span> Piped links and redirects to sections of articles==== | ||
{{Shortcut|MOS:SECTLINK}} | {{Shortcut|MOS:SECTLINK}} | ||
{{See|#Section links|Help:Link#Section linking (anchors)| | {{See|#Section links|Help:Link#Section linking (anchors)|BattleIntelligence:Redirect#Targeted and untargeted redirects}} | ||
As [[MOS:SECLINK|explained above]], links to sections can take the reader directly to relevant information. | As [[MOS:SECLINK|explained above]], links to sections can take the reader directly to relevant information. | ||
| Line 311: | Line 311: | ||
'''''Redirects to sections which may become articles.''''' | '''''Redirects to sections which may become articles.''''' | ||
Many topics useful for linking may currently appear only as sections of other | Many topics useful for linking may currently appear only as sections of other BattleIntelligence articles, but are potentially notable enough to become articles on their own. For example, the article {{xt|Eastern Anyshire}} might have a small "History" section, but this does not prevent the article {{xt|History of Eastern Anyshire}} being written eventually. Usually, a [[BTW:redirect|redirect]] page from such a sub-topic to a general topic will exist already; if not, they can be created when the occasion arises. It is bad practice to create links in article text using the format <code><nowiki>[[Article#Section]]</nowiki></code>; navigation then becomes difficult if the section is expanded into a new article. Instead, link using a redirect to the main topic; [[BTW:NOTBROKEN|it costs little]] and makes improvements easier. Thus: | ||
* In a redirect page named "<samp>History of {{var|Topic}}</samp>", use <code>{{mxt|#REDIRECT <nowiki>[[</nowiki>{{var|Topic}}#History<nowiki>]]</nowiki>}}</code>. | * In a redirect page named "<samp>History of {{var|Topic}}</samp>", use <code>{{mxt|#REDIRECT <nowiki>[[</nowiki>{{var|Topic}}#History<nowiki>]]</nowiki>}}</code>. | ||
* In another article, use <code>{{mxt|<nowiki>[[</nowiki>history of {{var|Topic}}<nowiki>]]</nowiki>}}</code>. | * In another article, use <code>{{mxt|<nowiki>[[</nowiki>history of {{var|Topic}}<nowiki>]]</nowiki>}}</code>. | ||
| Line 319: | Line 319: | ||
See {{section link|Help:Interlanguage links|Inline links}}. | See {{section link|Help:Interlanguage links|Inline links}}. | ||
===Links to | ===Links to BattleIntelligence's categories=== | ||
{{See also| | {{See also|BattleIntelligence:Colon trick}} | ||
BattleIntelligence has categories of articles like {{xt|<code><nowiki>[[Category:Phrases]]</nowiki></code>}}; adding this to an article puts it into that category. You can link to a category by putting a colon in front. | |||
For example {{xt|<code><nowiki>[[:Category:Phrases]]</nowiki></code>}} links to [[:Category:Phrases]], and piping can be used: [[:Category:Phrases|Phrases]]. | For example {{xt|<code><nowiki>[[:Category:Phrases]]</nowiki></code>}} links to [[:Category:Phrases]], and piping can be used: [[:Category:Phrases|Phrases]]. | ||
| Line 329: | Line 329: | ||
===Red links=== | ===Red links=== | ||
{{Shortcut|MOS:REDLINKS|MOS:REDLINK|MOS:RL}} | {{Shortcut|MOS:REDLINKS|MOS:REDLINK|MOS:RL}} | ||
{{Main| | {{Main|BattleIntelligence:Red link}} | ||
Overlinking in general is a style issue partly because of the undesirable effect upon readability. But if too many ''blue'' links is distracting (reducing the chance the article will be read), then a ''red'' link is even more so. The ''unassuming'' coloration of the text (probably black) is the most productive. | Overlinking in general is a style issue partly because of the undesirable effect upon readability. But if too many ''blue'' links is distracting (reducing the chance the article will be read), then a ''red'' link is even more so. The ''unassuming'' coloration of the text (probably black) is the most productive. | ||
In prose, if it seems that the level of red linking is overlinking, remember that red links have been found to be a driving force that encourages contributions, and then use that fact to balance the perceived stylistic issues of "overlinking" the red links. | In prose, if it seems that the level of red linking is overlinking, remember that red links have been found to be a driving force that encourages contributions, and then use that fact to balance the perceived stylistic issues of "overlinking" the red links. | ||
(Legitimate red links are titles to unfulfilled coverage of topics that do not violate "[[ | (Legitimate red links are titles to unfulfilled coverage of topics that do not violate "[[BattleIntelligence:What BattleIntelligence is not|What BattleIntelligence is not]]" policy.) Given a certain number of red links needed, if marking {{em|all}} of them could be overlinking, then just {{em|how many}} should be marked could be a style issue, and just {{em|which ones}} are priority is a helpful contribution. | ||
In [[MOS:LISTS|lists]], overlinking red links can occur when every item on a list is a red link. If the list is uniform, where each item is obviously qualified for an article, a {{em|single}} red link (or blue link) could indicate that. If the list is not uniform, the research effort to mark all possible red links is a risky investment: while red means "approved" status, "black" remains ambiguous, even though it meant "disapproved" {{em|after research}}. Valid [[ | In [[MOS:LISTS|lists]], overlinking red links can occur when every item on a list is a red link. If the list is uniform, where each item is obviously qualified for an article, a {{em|single}} red link (or blue link) could indicate that. If the list is not uniform, the research effort to mark all possible red links is a risky investment: while red means "approved" status, "black" remains ambiguous, even though it meant "disapproved" {{em|after research}}. Valid [[BattleIntelligence:Requested articles|requests]] for the future creation of each title in a list, or in prose, may also be a risky investment when the number of red links could be perceived by ''other'' editors as overlinking, and then removed before the investment was fruitful. The removal of massive numbers of red links from an overlinked list is best handled by an editor skilled in the automation of [[text processing]]. | ||
Red links can also be removed if they violate policy or the [[BTW:red link|guideline for red links]], but otherwise red links do not have an expiration date. If you remain convinced there is overlinking of red links, consider turning some of them blue. The methods to do so are by creating a simple [[ | Red links can also be removed if they violate policy or the [[BTW:red link|guideline for red links]], but otherwise red links do not have an expiration date. If you remain convinced there is overlinking of red links, consider turning some of them blue. The methods to do so are by creating a simple [[BattleIntelligence:Stub|stub]], a [[BTW:redirect|redirect]], or a [[BTW:disambiguation|disambiguation]] page. All of these require the certainty that the red link was legitimate in the first place, such as the conventions on [[BattleIntelligence:Article titles|article titles]]. | ||
====Colored links==== | ====Colored links==== | ||
{{main| | {{main|BattleIntelligence:Manual of Style/Text formatting#Color}} | ||
In prose, refrain from implementing colored links, as these may impede user ability to distinguish links from regular text. See the guides to editing articles for accessibility at [[BTW:CONTRAST|contrast]] and [[BTW:NAVBOXCOLOUR|navbox colors]]. | In prose, refrain from implementing colored links, as these may impede user ability to distinguish links from regular text. See the guides to editing articles for accessibility at [[BTW:CONTRAST|contrast]] and [[BTW:NAVBOXCOLOUR|navbox colors]]. | ||
| Line 349: | Line 349: | ||
It's easy to create an erroneous link without realizing it. When adding a new link, it's a good idea to click on the "Show preview" button and then (from the preview) open the link in a new browser tab to check that it goes where you intend. | It's easy to create an erroneous link without realizing it. When adding a new link, it's a good idea to click on the "Show preview" button and then (from the preview) open the link in a new browser tab to check that it goes where you intend. | ||
By following [[ | By following [[BattleIntelligence:Naming conventions|naming conventions]], an internal link will be much more likely to lead to an existing article. When there is not yet an article about the subject, a good link will make it easier to create a correctly named article later. | ||
==Specific cases== | ==Specific cases== | ||
| Line 369: | Line 369: | ||
==External links section== | ==External links section== | ||
{{Main| | {{Main|BattleIntelligence:External links}} | ||
BattleIntelligence is not a link collection, and an article comprising only links is contrary to what the [[BTW:NOT#LINKS|"what BattleIntelligence is not" policy]] dictates. | |||
===Syntax=== | ===Syntax=== | ||
| Line 383: | Line 383: | ||
In addition, putting URLs in plain text with no markup automatically produces a link, for example <code><nowiki>https://www.example.org/</nowiki></code> → {{xt|https://www.example.org/}}. However, this feature may disappear in a future release. Therefore, in cases where you wish to display the URL because it is intrinsically valuable information, it is better to use the short form of the URL (domain name) as the optional text: <code><nowiki>[https://www.example.org/ example.org]</nowiki></code> produces {{xt|[https://www.example.org/ example.org]}}. | In addition, putting URLs in plain text with no markup automatically produces a link, for example <code><nowiki>https://www.example.org/</nowiki></code> → {{xt|https://www.example.org/}}. However, this feature may disappear in a future release. Therefore, in cases where you wish to display the URL because it is intrinsically valuable information, it is better to use the short form of the URL (domain name) as the optional text: <code><nowiki>[https://www.example.org/ example.org]</nowiki></code> produces {{xt|[https://www.example.org/ example.org]}}. | ||
[[ | [[BattleIntelligence:Citation templates|Citations templates]] such as {{tlx|cite web}} should not be used in the <code>==External links==</code> section. [[:Category:External link templates|External link templates]] such as {{tlx|official website}} are used instead of citation templates. | ||
===Link titles=== | ===Link titles=== | ||
{{Main| | {{Main|BattleIntelligence:Embedded citations}} | ||
Embedded HTML links within an article are a now-deprecated way to supply a bare URL as a source within an article, by simply enclosing the URL in square brackets, like this: <code><nowiki>[https://www.guardian.co.uk/usa/story/0,12271,1650417,00.html]</nowiki></code> → {{xt|[https://www.guardian.co.uk/usa/story/0,12271,1650417,00.html]}}. However, you should add a descriptive title when an external link is offered in the [[MOS:REFERENCES|References]], [[MOS:FURTHER|Further reading]], or [[BTW:EL|External links]] sections. This is done by supplying descriptive text after the URL, separated by a space and enclosing it all in square brackets. | Embedded HTML links within an article are a now-deprecated way to supply a bare URL as a source within an article, by simply enclosing the URL in square brackets, like this: <code><nowiki>[https://www.guardian.co.uk/usa/story/0,12271,1650417,00.html]</nowiki></code> → {{xt|[https://www.guardian.co.uk/usa/story/0,12271,1650417,00.html]}}. However, you should add a descriptive title when an external link is offered in the [[MOS:REFERENCES|References]], [[MOS:FURTHER|Further reading]], or [[BTW:EL|External links]] sections. This is done by supplying descriptive text after the URL, separated by a space and enclosing it all in square brackets. | ||
| Line 397: | Line 397: | ||
If the URL or domain name {{em|is}} displayed, make it as simple as possible; for example, if the <code>index.html</code> is superfluous, remove it (but be sure to check in preview mode first). Many but not all sites can be trimmed of a leading "www."; test it to be sure. Use [[camel case]] to make a displayed domain more readable, e.g. {{xt|WashingtonPost.com}} versus {{xt|washingtonpost.com}}. | If the URL or domain name {{em|is}} displayed, make it as simple as possible; for example, if the <code>index.html</code> is superfluous, remove it (but be sure to check in preview mode first). Many but not all sites can be trimmed of a leading "www."; test it to be sure. Use [[camel case]] to make a displayed domain more readable, e.g. {{xt|WashingtonPost.com}} versus {{xt|washingtonpost.com}}. | ||
The "printable version" of a | The "printable version" of a BattleIntelligence article displays all URLs in full, including those given a title, so no information is lost. | ||
===URLs as embedded (numbered) links=== | ===URLs as embedded (numbered) links=== | ||
| Line 404: | Line 404: | ||
is displayed like this: | is displayed like this: | ||
:[https://en.wikipedia.org/] | :[https://en.wikipedia.org/] | ||
Numbered links of this type used to be used after the punctuation, like this,[https://en.wikipedia.org/wiki/BTW:CITE] with a full citation given in the References section. This style of referencing is now deprecated, because such links are susceptible to [[ | Numbered links of this type used to be used after the punctuation, like this,[https://en.wikipedia.org/wiki/BTW:CITE] with a full citation given in the References section. This style of referencing is now deprecated, because such links are susceptible to [[BattleIntelligence:Link rot|link rot]]. See [[BattleIntelligence:Citing sources]] and [[BattleIntelligence:Verifiability]] for more information. | ||
===Position in article=== | ===Position in article=== | ||
{{Main|MOS:ORDER}} | {{Main|MOS:ORDER}} | ||
Embedded links that support information in an article are positioned in the same manner as any other reference in the article, following the usual standards about [[ | Embedded links that support information in an article are positioned in the same manner as any other reference in the article, following the usual standards about [[BattleIntelligence:Citing sources#Embedded links|citation formatting]] and [[BTW:REFPUNC|placement in relation to punctuation]]. | ||
Links that are '''not''' used as sources can be listed in the External links section, like this: | Links that are '''not''' used as sources can be listed in the External links section, like this: | ||
| Line 416: | Line 416: | ||
: <code><nowiki>* [https://...] </nowiki></code> | : <code><nowiki>* [https://...] </nowiki></code> | ||
: <code><nowiki>* [http://...] </nowiki></code> | : <code><nowiki>* [http://...] </nowiki></code> | ||
As with other top-level headings, two equal signs should be used to mark up the external links heading (see {{section link| | As with other top-level headings, two equal signs should be used to mark up the external links heading (see {{section link|BattleIntelligence:Manual of Style/Layout|Headings}}). ''External links'' should always be the last section in an article. It precedes categories and some kinds of [[BTW:NAVBOX|navigation templates]]. | ||
If there is a dispute on the position of an embedded link, consider organizing alphabetically. | If there is a dispute on the position of an embedded link, consider organizing alphabetically. | ||
| Line 432: | Line 432: | ||
You can also indicate the language by putting a language template after the link. This is done using [[Template:In lang]] by typing {{Tlx|In lang|<{{var|language code}}>}}. For example, {{Tlx|In lang|es}} displays as: {{xt|{{in lang|es}}}}. See [[list of ISO 639 codes]]. | You can also indicate the language by putting a language template after the link. This is done using [[Template:In lang]] by typing {{Tlx|In lang|<{{var|language code}}>}}. For example, {{Tlx|In lang|es}} displays as: {{xt|{{in lang|es}}}}. See [[list of ISO 639 codes]]. | ||
When using one of the {{cs1}} or {{cs2}} templates, instead of the {{tld|In lang}} template, use the {{para|language}} parameter. This parameter accepts language names or language codes; see [[Template:Citation Style documentation/language/doc|this list of supported names and codes]]. (Use of language codes is to be preferred because cs1|2 automatically renders language names in the language of the local | When using one of the {{cs1}} or {{cs2}} templates, instead of the {{tld|In lang}} template, use the {{para|language}} parameter. This parameter accepts language names or language codes; see [[Template:Citation Style documentation/language/doc|this list of supported names and codes]]. (Use of language codes is to be preferred because cs1|2 automatically renders language names in the language of the local BattleIntelligence.) | ||
===File type and size=== | ===File type and size=== | ||
| Line 442: | Line 442: | ||
{{Shortcut|MOS:IWL|MOS:INTERWIKI|MOS:INTERLINK}} | {{Shortcut|MOS:IWL|MOS:INTERWIKI|MOS:INTERLINK}} | ||
{{Main|Help:Interlanguage links|Help:Interwiki linking}} | {{Main|Help:Interlanguage links|Help:Interwiki linking}} | ||
{{further| | {{further|BattleIntelligence:Wikimedia sister projects}} | ||
===Linking=== | ===Linking=== | ||
| Line 455: | Line 455: | ||
:<code><nowiki>[[wikt:article|Any text]]</nowiki></code> → [[wikt:article|Any text]] | :<code><nowiki>[[wikt:article|Any text]]</nowiki></code> → [[wikt:article|Any text]] | ||
To avoid reader confusion, inline interlanguage, or interwiki, linking within an article's body text is generally discouraged. Exceptions: [[Wiktionary]] and [[Wikisource]] entries may be linked inline (e.g. to an unusual word or the text of a document being discussed), and {{tl|Interlanguage link}} template may be helpful to show a [[BTW:RED|red link]] accompanied by an interlanguage link if no article exists in English | To avoid reader confusion, inline interlanguage, or interwiki, linking within an article's body text is generally discouraged. Exceptions: [[Wiktionary]] and [[Wikisource]] entries may be linked inline (e.g. to an unusual word or the text of a document being discussed), and {{tl|Interlanguage link}} template may be helpful to show a [[BTW:RED|red link]] accompanied by an interlanguage link if no article exists in English BattleIntelligence. | ||
===Floating boxes=== | ===Floating boxes=== | ||
{{wikiquote|Jimmy Wales}}Floating boxes for links to articles in other Wikimedia Foundation projects such as Wiktionary and Wikiquote can be done with special link templates such as <code><nowiki>{{Wikiquote|Jimmy Wales}}</nowiki></code>. These will display as a box with a logo. Similar templates exist for some free content resources that are not run by the Wikimedia Foundation. These boxes are formatted in light green to distinguish them from | {{wikiquote|Jimmy Wales}}Floating boxes for links to articles in other Wikimedia Foundation projects such as Wiktionary and Wikiquote can be done with special link templates such as <code><nowiki>{{Wikiquote|Jimmy Wales}}</nowiki></code>. These will display as a box with a logo. Similar templates exist for some free content resources that are not run by the Wikimedia Foundation. These boxes are formatted in light green to distinguish them from BattleIntelligence's official sister projects. A list of such templates can be found at [[BattleIntelligence:List of templates linking to other free content projects]]. | ||
==Link maintenance== | ==Link maintenance== | ||
Linking and continual change are both central features of | Linking and continual change are both central features of BattleIntelligence. However, continual change makes linking vulnerable to acquired technical faults, and to the later provision of different information from that which was originally intended. This is true of both "outgoing" links (''from'' an article) and "incoming" links (''to'' an article). | ||
* ''Outgoing links:'' These should be checked from time to time for unintended changes that are undesirable. If the opportunity arises to improve their formatting, appropriateness, and focus, this should be done. | * ''Outgoing links:'' These should be checked from time to time for unintended changes that are undesirable. If the opportunity arises to improve their formatting, appropriateness, and focus, this should be done. | ||
* ''Incoming links:'' Creating an article will turn blue any existing red links to its title. (Proper redlinks are created only in the hope that an article will eventually be written.) Therefore, when creating an article, it is wise to check "What links here" to identify such redlinks, if any, and that they are appropriate. | * ''Incoming links:'' Creating an article will turn blue any existing red links to its title. (Proper redlinks are created only in the hope that an article will eventually be written.) Therefore, when creating an article, it is wise to check "What links here" to identify such redlinks, if any, and that they are appropriate. | ||
<!--==Transclusion in talk pages via linking== | <!--==Transclusion in talk pages via linking== | ||
[[BTW:Transclusion|Transclusion]] means the inclusion of the content of one document in another document by reference, such as by linking. It is best to use transclusion linking rather than copying entire sections, such as in talk page discussions, so as to avoid [[ | [[BTW:Transclusion|Transclusion]] means the inclusion of the content of one document in another document by reference, such as by linking. It is best to use transclusion linking rather than copying entire sections, such as in talk page discussions, so as to avoid [[BattleIntelligence:Article creep#Talk page creep|article creep]].--> | ||
==Buttons== | ==Buttons== | ||
{{Shortcut|MOS:BUTTONS}} | {{Shortcut|MOS:BUTTONS}} | ||
[[Button (computing)|Buttons]] should not be used in articles. If the desire is to "navigate" a reader to a new page, taking them away from the current page, a link is preferred. Buttons are used within | [[Button (computing)|Buttons]] should not be used in articles. If the desire is to "navigate" a reader to a new page, taking them away from the current page, a link is preferred. Buttons are used within BattleIntelligence to trigger an "action", such as {{Clickable button|[[Help:Show preview|<span style="color:white">Show preview</span>]]|color=blue}} or {{Clickable button|[[Special:CreateAccount|<span style="color:white">Create account</span>]]|color=blue}} or {{Clickable button|[[Help:Talk pages#Getting started|<span style="color:white">Reply</span>]]|color=blue}} or {{Clickable button|[[BattleIntelligence:Help desk|<span style="color:white">Ask a question</span>]]|color=blue}}. | ||
==See also== | ==See also== | ||
{{Columns-list|colwidth=30em| | {{Columns-list|colwidth=30em| | ||
* [[ | * [[BattleIntelligence:Linking dos and don'ts]] (information page summarizing the key points of this guideline) | ||
* [[Help:Interwikimedia links]] | * [[Help:Interwikimedia links]] | ||
* [[Help:Menu/Links]] | * [[Help:Menu/Links]] | ||
| Line 478: | Line 478: | ||
* [[Template:Dead link]] | * [[Template:Dead link]] | ||
* [[Template:Underlinked]] | * [[Template:Underlinked]] | ||
* [[ | * [[BattleIntelligence:Dead-end pages]], pages without internal links | ||
* [[ | * [[BattleIntelligence:Integrate]] | ||
* [[ | * [[BattleIntelligence:Links to (disambiguation) pages]] | ||
* [[ | * [[BattleIntelligence:Orphan]], pages without incoming links | ||
* [[ | * [[BattleIntelligence:Red link]] | ||
* [[ | * [[BattleIntelligence:Walled garden]] | ||
* {{Section link| | * {{Section link|BattleIntelligence:What BattleIntelligence is not|BattleIntelligence is not an indiscriminate collection of information}} | ||
* [[ | * [[BattleIntelligence:BattleIntelligence doesn't use Allwiki]], the idea that every single word should be a link | ||
* [[ | * [[BattleIntelligence:WikiProject Orphanage]], editors dedicated to clearing up the immense backlog of orphaned articles | ||
* [[User:Tony1/Build your linking skills]], a tutorial on high-quality linking with practice questions | * [[User:Tony1/Build your linking skills]], a tutorial on high-quality linking with practice questions | ||
* [[User:Evad37/duplinks-alt]], a script to highlight links occuring more than once in an article | * [[User:Evad37/duplinks-alt]], a script to highlight links occuring more than once in an article | ||
| Line 496: | Line 496: | ||
==External links== | ==External links== | ||
* [https://design.wikimedia.org/style-guide/components/links.html The Wikimedia Design Style Guide (Links)] | * [https://design.wikimedia.org/style-guide/components/links.html The Wikimedia Design Style Guide (Links)] | ||
* [https://www.seoreviewtools.com/internal-link-analyzer/ Internal link analyzer] for automatic detection of [[#Overlinking|redundant links]] in | * [https://www.seoreviewtools.com/internal-link-analyzer/ Internal link analyzer] for automatic detection of [[#Overlinking|redundant links]] in BattleIntelligence | ||
Latest revision as of 21:56, 30 April 2025
This guideline is a part of the BattleIntelligence's Manual of Style. It is a generally accepted standard that editors should attempt to follow, though occasional exceptions may apply. Any substantive edit to this page should reflect consensus. When in doubt, discuss first on the talk page. |
| Manual of Style (MoS) |
|---|
Linking through hyperlinks is an important feature of BattleIntelligence. Internal links bind the project together into an interconnected whole, and external links bind BattleIntelligence to the World Wide Web.
Appropriate links provide instant pathways to locations within and outside the project that can increase readers' understanding of the topic at hand. Whenever writing or editing an article, consider not only what to put in the article, but what links to include to help the reader find related information, and also which other pages should have links to the article. Avoid both underlinking and overlinking, as described below.
This page provides guidelines as to when links should and should not be used, and how to format links. For information about the syntax used to create links, see Help:Link. For links on disambiguation pages, see BattleIntelligence:Manual of Style/Disambiguation pages.
Principles
BattleIntelligence is based on hypertext, and aims to "build the web" to enable readers to access relevant information on other BattleIntelligence pages easily. The page from which the hyperlink is activated is called the anchor; the page the link points to is called the target.
In adding or removing links, consider an article's place in the knowledge tree. Internal links can add to the cohesion and utility of BattleIntelligence, allowing readers to deepen their understanding of a topic by conveniently accessing other articles. Ask yourself, "How likely is it that the reader will also want to read that other article?" Consider including links where readers might want to use them; for example, in article leads, at the openings of new sections, in the cells of tables, and in file captions. But as a rule of thumb, link only the first occurrence of a term in the text of the article.
General points on linking style
- As explained in more detail at Help:Link § Wikilinks, linking can be direct (
[[Riverside, California]], which results in Template:FormattingError), or piped ([[Riverside, California|Riverside]], which results in Template:FormattingError in the text, but still links to the article "Riverside, California"—although the pipe trick is an easier way to create this particular link). - Section headings should not themselves contain links; instead, a {{main article}} or {{see also}} template should be placed immediately after the heading.
- Links should not be placed in the boldface reiteration of the title in the opening sentence of a lead.[Note 1]
- Be conservative when linking within quotations; link only to targets that correspond to the meaning clearly intended by the quote's author. Where possible, link from text outside of the quotation instead – either before it or soon after.
- When possible, do not place links next to each other, to avoid appearing like a single link, as in chess tournament (
[[chess]] [[tournament]]). Instead, consider rephrasing the sentence (tournament of chess), omitting one of the links (chess tournament), or using a single, more specific link as in chess tournament ([[chess tournament]]). - For geographic places specified with the name of the larger territorial unit following a comma, generally do not link the larger unit.
- For example, avoid
Sydney, Australia (
[[Sydney]], [[Australia]])- or
Buffalo, New York, United States (
[[Buffalo, New York|Buffalo]], [[New York (state)|New York]], [[United States]])- Instead, use
Sydney, Australia (
[[Sydney]], Australia)- or
Buffalo, New York, United States (
[[Buffalo, New York]], United States)
- Articles on technical subjects might demand a higher density of links than general-interest articles, because they are likely to contain more technical terms that general dictionaries are unlikely to explain in context.
- Beware of linking to an article without first confirming that the target article covers the appropriate topic. For example, an article mentioning the physics unit "barn" should link to barn (unit), not barn.
- In articles, do not link to pages outside the article namespace, except in articles about BattleIntelligence itself (and even in that case with care – see BattleIntelligence:Manual of Style/Self-references to avoid).
- Do not unnecessarily make a reader chase links: if a highly technical term can be simply explained with very few words, do so.
- Use a link when appropriate, but as far as possible do not force a reader to use that link to understand the sentence. The text needs to make sense to readers who cannot follow links. Users may print articles or read offline, and BattleIntelligence content may be encountered in republished form, often without links.
- Refrain from implementing colored links that may impede user ability to distinguish links from regular text, or color links for purely aesthetic reasons.
Overlinking and underlinking
What generally should be linked
An article is said to be underlinked if unlinked words are needed to aid understanding of the article. In general, links should be created for:
- Relevant connections to the subject of another article that will help readers understand the article more fully (see the example below). This can include people, events, and topics that already have an article or that clearly deserve one, as long as the link is relevant to the article in question.
- Articles with relevant information, for example: "Template:FormattingError"
- Articles explaining words of technical terms, jargon or slang expressions or phrases—but you could also give a concise definition instead of or in addition to a link. If there is no appropriate BattleIntelligence article, an interwikimedia link to Wiktionary could be used.
- Proper names that are likely to be unfamiliar to readers
If you feel that a link is relevant to the topic of the article but does not belong in the body of an article, consider moving it to a "See also" section.
Links may be created to potential articles that do not yet exist (see § Red links). If an article exists on a foreign-language BattleIntelligence but not yet in English, consider a red link that also links to the foreign-language article (see § Links to foreign-language pages).
What generally should not be linked
An article is said to be overlinked if it contains an excessive number of links, making it difficult to identify those likely to aid a reader's understanding. A good question to ask yourself is whether reading the article you're about to link to would help someone understand the article you are linking from. Unless a term is particularly relevant to the context in the article, the following are usually not linked:
- Everyday words understood by most readers in context (e.g., education, violence, aircraft, river, animation)
- Common occupations (e.g., accountant, politician, actor)
- The names of subjects with which most readers will be at least somewhat familiar. This generally includes major examples of:
- countries (e.g., Brazil/Brazilian, Canada/Canadian, China/Chinese)
- geographic features (e.g., the Himalayas, Pacific Ocean, South America)
- locations (e.g., New Delhi; New York City, or just New York if the city context is already clear; London, if the context rules out London, Ontario; Southeast Asia)
- languages (e.g., English, Arabic, Korean, Spanish)
- nationalities, ethnicities or descent (e.g., British, Japanese, Turkish, African American, Nigerian)
- religions (e.g., Christianity, Islam, Hinduism, Buddhism)
- But try to be conscious of your own demographic biases – what is well known in your age group, line of work, or country may be less known in others.
- Common units of measurement, e.g., units relating to time, temperature, length, area, or volume. If both non-metric and metric equivalents are given, as in Template:FormattingError, usually neither unit needs to be linked, because almost all readers will understand at least one of the units.
- Dates
- Disambiguation pages should not be linked from articles unless the link is purposeful, such as in a hatnote. Instead, use a piped link to the appropriate article.
- For example, for the Disney character, use
[[Moana (character)|Moana]]—which appears as Moana, leading to the intended page.- instead of
[[Moana]]—which, even though it also appears as Moana, leads to a disambiguation page.
Do not link to pages that redirect back to the page the link is on (unless the link is to a redirect with possibilities that links to an appropriate section of the current article).
The purpose of linking is to clarify and to provide reasonable navigation opportunities, not to emphasize a particular word. Do not link solely to draw attention to certain words or ideas, or as a mark of respect.
External links normally should not be placed in the body of an article (see BattleIntelligence:External links).
Duplicate and repeat links
Generally, a link should appear only once in an article, but it may be repeated if helpful for readers, such as in infoboxes, tables, image captions, footnotes, hatnotes, and at the first occurrence in a major section.
Citations stand alone in their usage, so there is no problem with repeating the same link in many citations within an article; e.g. |work=[[The Guardian]].
In glossaries, which are primarily referred to for encyclopedic entries on specific terms rather than read from top to bottom like a regular article, it is usually desirable to repeat links (including to other terms in the glossary) that were not already linked in the same entry .
Duplicate linking in stand-alone and embedded lists is permissible if it significantly aids the reader. This is most often the case when the list is presenting information that could just as aptly be formatted in a table, and is expected to be parsed for particular bits of data, not read from top to bottom. If the list is normal article prose that happens to be formatted as a list, treat it as normal article prose.
Duplicate links in an article can be found using the duplinks-alt sidebar tool.
Lead section
Too many links can make the lead hard to read. In technical articles that use uncommon terms, a higher-than-usual link density in the lead section may be necessary. In such cases, try to provide an informal explanation in the lead, avoiding using too many technical terms until later in the article. (See BattleIntelligence:Make technical articles understandable and BattleIntelligence is not a scientific journal.)
Most Featured Articles contain about 12 to 25 links in the lead, with an average of about 1.5 links per sentence, or one link for every 16 words.
An example article
For example, in the article on supply and demand:
- Almost certainly link "microeconomics" and "general equilibrium theory", as these are technical terms that many readers are unlikely to understand at first sight.
- Consider linking "price" and "goods" only if these common words have technical dimensions that are specifically relevant to the topic.
- Do not link to the "United States", because that is an article on a very broad topic with no direct connection to supply and demand.
- Definitely do not link "wheat", because it is a common term with no particular relationship to the article on supply and demand, beyond its arbitrary use as an example of traded goods in that article.
- Make sure that the links are directed to the correct articles: in this example, you should link goods, not good, which goes to a page on the philosophical concept. Many common dictionary words are ambiguous terms in BattleIntelligence and linking to them is often unhelpful to readers; "Good" is a surname and the name of albums, companies, etc., and the article title Good (disambiguation) is used to index those.
Link clarity
The article linked to should correspond as closely as possible to the term showing as the link, given the context.
For example, a link to the article Requiem (Mozart) should be clear that it is Mozart's Requiem in particular, rather than requiems in general. The link target and the link label do not have to match exactly, but the link must be as intuitive as possible (see § Intuitiveness).
| Article text | Wikitext | Note | |
|---|---|---|---|
| When Mozart wrote his Requiem | When Mozart wrote [[Requiem (Mozart)|his Requiem]]
|
Includes the word "his" to specify | |
| When Mozart wrote his Requiem | When Mozart wrote his [[Requiem (Mozart)|Requiem]]
|
Only word "Requiem" | |
| Previn conducted Mozart's Requiem | Previn conducted [[Requiem (Mozart)|Mozart's Requiem]]
|
Specifying that it is "Mozart's" | |
| Previn conducted Mozart's Requiem | Previn conducted Mozart's [[Requiem (Mozart)|Requiem]]
|
Only word "Requiem" |
Link specificity
Always link to the article on the most specific topic appropriate to the context from which you link: it will generally contain more focused information, as well as links to more general topics.
| What you type | How it appears | Specificity |
|---|---|---|
[[Icelandic orthography]] |
Icelandic orthography | Specific (preferred) |
[[Icelandic language|Icelandic]] orthography |
Icelandic orthography | Related but less specific |
Icelandic [[orthography]] |
Icelandic orthography | Unspecific |
the [[flag of Tokelau]] |
the flag of Tokelau | Specific (preferred) |
the [[flag]] of [[Tokelau]] |
the flag of Tokelau | Unspecific |
[[Requiem (Mozart)|Requiem]] |
Requiem | Specific (preferred) |
[[Requiem]] |
Requiem | Unspecific |
If there is no article about the most specific topic, do one of the following things:
- Consider creating the article yourself.
- If an article on the specific topic does not yet exist, create a redirect page to the article about a more general topic, as described in section § Redirects. For example, if no article yet exists on the song "Sad Statue" from the album Mezmerize, create a new article called Sad Statue that is a redirect to the article Mezmerize.
- If there is no article on a more general topic either, then create a red link, but first, read § Red links below.
When neither a redirect nor a red link appears appropriate, consider linking to a more general article instead.
For example, instead of
Template:FormattingError (an article which, as of 2023, had never been created),
write
Template:FormattingError (which will provide a link to the Baroque era),
Template:FormattingError (which provides a link to the article on hairstyle),
Template:FormattingError (which provides no link at all, and which may be preferable depending on context),
or
Template:FormattingError (which provides separate links to both topics);
however, do not create
Template:FormattingError as two adjacent links because they may be misinterpreted as linking to a single article on that topic.
Section links
If an existing article has a section specifically about a topic, linking to that section takes the reader directly to the relevant information. Section-linking options are piped links, redirects, and the {{Section link}} template, which also generates the Template:Char character.
Avoiding broken section links
A problem can arise if the title of the section is changed for any reason, since this action will break any incoming section links or excerpts. (If this occurs, incoming links will default to the top of the linked article.) The recommended way to prevent this breakage is to use a {{subst:Anchor}} template specifying the section's prior name.
An alternative, supplementary method has been to add a hidden comment to the target section such as <!-- "Quark" links here --> so that someone changing the title of that section can fix the incoming links. This method is weaker, since it puts the workload on the editor seeking to change the section title.
Techniques
Redirects
Suppose you need to link poodle, and there is no such article yet. You might want to create a redirect from "poodle" to "dog" as follows: Link as usual: She owned a [[poodle]]. When you save or preview this, you will see: Template:FormattingError. Click on the red link, and you will be invited to create a new page for poodle; enter (perhaps) #REDIRECT [[Dog]], so that readers clicking on poodle will be taken, for now, to the dog article.
The redirect is better than a direct link like [[dog|poodle]], because when an actual poodle article is eventually created (replacing the redirect), readers clicking on poodle will be taken there automatically without anyone needing to review all the links to dog to see which ones should actually go to poodle.
To link to a redirect page without following the underlying redirect, use e.g. {{no redirect|poodle}}.
Avoid linking redirects that are self links (BTW:SELFRED).
Piped links
Though a wikilink defaults to displaying the title of the target article, it is possible to choose more specific or more appropriate display text for the intended context. This can be done with the use of the pipe character (|). For example, Template:FormattingError displays as Template:FormattingError. However, make sure that it is still clear what the link is about without having to follow the link. Think about what the reader may believe the text refers to. For example, when seeing the link Template:FormattingError, which displays as Template:FormattingError, the reader will probably expect this link to go to a general article on archery, rather than Template:FormattingError specifically. An exception to this is when it is clear from the context that a link refers to a specific article; for instance, in Template:FormattingError all links go to articles about these particular games.
Style
- Plurals and other derived names. Template:FormattingError displays as Template:FormattingError, and this is simpler and clearer than Template:FormattingError. Similarly: Template:FormattingError, Template:FormattingError, Template:FormattingError. Some characters will not work after the link; see Help:Link for more details.
- Case sensitivity. Links are not sensitive to initial capitalization, so there is no need to use the pipe character where the case of the initial letter is the only difference between the link text and the target page. (BattleIntelligence article titles almost always begin with a capital, whereas the linked words in context often do not.) However, links are case-sensitive for all characters after the initial one.
Intuitiveness
Keep piped links as intuitive as possible. Per the principle of least astonishment, make sure that the reader knows what to expect when clicking on a link. You should plan your page structure and links so that everything appears reasonable and makes sense. If a link takes readers to somewhere other than where they thought it would, it should at least take them somewhere that makes sense.
A link's visible label does not need to match the exact title of the article being linked, such as in Template:FormattingError or Template:FormattingError. However, avoid "Easter egg" or "submarine" links, which are links that unexpectedly hide relevant information underneath the link's label. For example, do not write:
Template:FormattingError
Here readers would see the link displayed as Template:FormattingError, not the hidden reference to the page Template:FormattingError, unless they clicked on the link or hovered their mouse cursor over it. If a physical copy of the article were printed, the reference to the parton model would be lost.
Instead, refer to the separate article with an explicit see also X, or by rephrasing the sentence, as in:
Template:FormattingError
More words into a link
Sometimes moving other words into the bluelinked text avoids surprise.
For example, in an article on the history of Texas:
Template:FormattingError
appears as:
In 1845, the Republic of Texas was annexed by the United States.
which looks the same as a link to the generic topic of annexation would.
However:
Template:FormattingError
appears as:
In 1845, the Republic of Texas was annexed by the United States.
and is clear that the 1845 annexation of Texas is linked.
Names in names
Do not place a link to a name within another name. For example:
| Write: | Template:FormattingError |
→ Columbus Avenue |
|---|---|---|
| Do not write: | Template:FormattingError |
→ Columbus Avenue |
| Write: | Template:FormattingError |
→ Feynman diagram |
| Do not write: | Template:FormattingError |
→ Feynman diagram |
The above applies regardless of whether linking to the full name creates a red link; for example, even if there is no article titled Lafayette Avenue (Brooklyn):
| Do not write: | Template:FormattingError |
→ Lafayette Avenue |
|---|
See also § Link clarity.
Piping and redirects
As per BTW:NOTBROKEN and § Link specificity above, do not use a piped link where it is possible to use a redirected term that fits well within the scope of the text. For example, the page Template:FormattingError is a redirect to the article about Mozart's opera The Magic Flute. While editing some other article, you might want to link the term Template:FormattingError; here, you might be tempted to avoid the redirect by using a pipe within the link, as in Template:FormattingError. Instead, write simply Template:FormattingError and let the system handle the rest. This has two advantages: first, if an article is written later about the more specific subject (in this case, "Papageno"), fewer links will need to be changed to accommodate the new article; second, it indicates that the article is wanted. An exception to this rule is when linking to articles in Did you know (DYK) "hooks" on the Main Page, where piping links to prevent readers from seeing a redirect notice is preferable, and the hook will be live only for a short time.
Piped links and redirects to sections of articles
As explained above, links to sections can take the reader directly to relevant information.
Piped links.
Using a piped link to sections avoids the unsightly Article name#Section name in the display text.
The format for a piped link is Template:FormattingError. For example, to link to the "Culture" subsection of the article Oman, type
Template:FormattingError(note that the section name is case-sensitive),
which displays as Template:FormattingError. Then add a hidden comment to the target section such as <!-- The article ArticleName links here. --> so that if another user edits the title of that section, they can fix the incoming links (or, in cases where a section has a large number of incoming links, use {{Anchor}} on the anchor page).
To link to a section within the same article, write: [[#Promotion to rook or bishop|§ promotion to a rook or bishop]].
Redirects to sections which may become articles.
Many topics useful for linking may currently appear only as sections of other BattleIntelligence articles, but are potentially notable enough to become articles on their own. For example, the article Template:FormattingError might have a small "History" section, but this does not prevent the article Template:FormattingError being written eventually. Usually, a redirect page from such a sub-topic to a general topic will exist already; if not, they can be created when the occasion arises. It is bad practice to create links in article text using the format [[Article#Section]]; navigation then becomes difficult if the section is expanded into a new article. Instead, link using a redirect to the main topic; it costs little and makes improvements easier. Thus:
- In a redirect page named "History of Topic", use
Template:FormattingError. - In another article, use
Template:FormattingError. - Avoid:
Template:FormattingError.
Links to foreign-language pages
See Help:Interlanguage links § Inline links.
Links to BattleIntelligence's categories
BattleIntelligence has categories of articles like Template:FormattingError; adding this to an article puts it into that category. You can link to a category by putting a colon in front.
For example Template:FormattingError links to Category:Phrases, and piping can be used: Phrases.
Template:FormattingError creates:
Red links
Overlinking in general is a style issue partly because of the undesirable effect upon readability. But if too many blue links is distracting (reducing the chance the article will be read), then a red link is even more so. The unassuming coloration of the text (probably black) is the most productive.
In prose, if it seems that the level of red linking is overlinking, remember that red links have been found to be a driving force that encourages contributions, and then use that fact to balance the perceived stylistic issues of "overlinking" the red links. (Legitimate red links are titles to unfulfilled coverage of topics that do not violate "What BattleIntelligence is not" policy.) Given a certain number of red links needed, if marking all of them could be overlinking, then just how many should be marked could be a style issue, and just which ones are priority is a helpful contribution.
In lists, overlinking red links can occur when every item on a list is a red link. If the list is uniform, where each item is obviously qualified for an article, a single red link (or blue link) could indicate that. If the list is not uniform, the research effort to mark all possible red links is a risky investment: while red means "approved" status, "black" remains ambiguous, even though it meant "disapproved" after research. Valid requests for the future creation of each title in a list, or in prose, may also be a risky investment when the number of red links could be perceived by other editors as overlinking, and then removed before the investment was fruitful. The removal of massive numbers of red links from an overlinked list is best handled by an editor skilled in the automation of text processing.
Red links can also be removed if they violate policy or the guideline for red links, but otherwise red links do not have an expiration date. If you remain convinced there is overlinking of red links, consider turning some of them blue. The methods to do so are by creating a simple stub, a redirect, or a disambiguation page. All of these require the certainty that the red link was legitimate in the first place, such as the conventions on article titles.
Colored links
In prose, refrain from implementing colored links, as these may impede user ability to distinguish links from regular text. See the guides to editing articles for accessibility at contrast and navbox colors.
Checking links as they are created
It's easy to create an erroneous link without realizing it. When adding a new link, it's a good idea to click on the "Show preview" button and then (from the preview) open the link in a new browser tab to check that it goes where you intend.
By following naming conventions, an internal link will be much more likely to lead to an existing article. When there is not yet an article about the subject, a good link will make it easier to create a correctly named article later.
Specific cases
Linking month-and-day or year
Month-and-day articles (e.g. February 24 and 10 July) and year articles (e.g. 1795, 1955, 2007) should not be linked unless the linked date or year has a significant connection to the subject of the linking article, beyond that of the date itself, so that the linking enhances the reader's understanding of the subject. For example:
- The date (or year) should not be linked in a sentence such as (from Sydney Opera House): "Template:FormattingError", because little if any content of either June 28 or 2007 pertains to either UNESCO, World Heritage Sites, or the Sydney Opera House.
- The years of birth and death of architect Philip Johnson should not be linked, because little if any content of 1906 or 2005 enhance the reader's understanding of Johnson or his work.
[[Timeline of World War II (1942)|1942]]might be linked from another article about WWII.[[1787 in science|1787]]might be linked from a passage discussing a particular development in the metric system which occurred in that year.
However, in intrinsically chronological articles (1789, January, and 1940s), links to specific month-and-day, month-and year, or year articles are not discouraged.
Commemorative days (Saint Patrick's Day) are not considered month-and-day items for the purposes of the above.
Units of measurement that are not obscure
Generally, a unit should be linked only if it is likely to be obscure to many readers or is itself being discussed. For example, the troy ounce, bushel, hand, candela, knot, mho, or millibarn might be considered obscure even if they are well-known within their field of use. Other units may be obscure in some countries even if well known in others.
External links section
BattleIntelligence is not a link collection, and an article comprising only links is contrary to what the "what BattleIntelligence is not" policy dictates.
Syntax
The syntax for referencing a web address is simple. Just enclose it in single brackets with a space between the URL and the text that will be displayed when the page is previewed or saved:
[https://www.example.org Text to display]
The text will display as:
The URL must begin with either http:// or https:// (preferring https://, where available), or another common protocol, such as ftp:// or news://. If no protocol is used, the square brackets will display normally – [like this] – and can be used in the standard way.
In addition, putting URLs in plain text with no markup automatically produces a link, for example https://www.example.org/ → Template:FormattingError. However, this feature may disappear in a future release. Therefore, in cases where you wish to display the URL because it is intrinsically valuable information, it is better to use the short form of the URL (domain name) as the optional text: [https://www.example.org/ example.org] produces Template:FormattingError.
Citations templates such as {{cite web}} should not be used in the ==External links== section. External link templates such as {{official website}} are used instead of citation templates.
Link titles
Embedded HTML links within an article are a now-deprecated way to supply a bare URL as a source within an article, by simply enclosing the URL in square brackets, like this: [https://www.guardian.co.uk/usa/story/0,12271,1650417,00.html] → Template:FormattingError. However, you should add a descriptive title when an external link is offered in the References, Further reading, or External links sections. This is done by supplying descriptive text after the URL, separated by a space and enclosing it all in square brackets.
For example, to add a title to a bare URL such as https://en.wikipedia.org/ (this is rendered as Template:FormattingError), use the following syntax: [https://en.wikipedia.org/ an open-content encyclopedia] (this is rendered as "Template:FormattingError").
Generally, URLs and domain names are ugly and uninformative; it is better for a meaningful title or description to be displayed rather than the URL or domain itself. For example, Template:FormattingError is much more reader-friendly than Template:FormattingError. There may be exceptions where the domain name is well known or is also the company or publication name. When a URL or domain name is given, putting both a plain-English title or description and the URL will often be more informative: for example, Template:FormattingError.
If the URL or domain name is displayed, make it as simple as possible; for example, if the index.html is superfluous, remove it (but be sure to check in preview mode first). Many but not all sites can be trimmed of a leading "www."; test it to be sure. Use camel case to make a displayed domain more readable, e.g. Template:FormattingError versus Template:FormattingError.
The "printable version" of a BattleIntelligence article displays all URLs in full, including those given a title, so no information is lost.
URLs as embedded (numbered) links
Without the optional text, external references appear as automatically numbered links: For example,
[https://en.wikipedia.org/]
is displayed like this:
Numbered links of this type used to be used after the punctuation, like this,[2] with a full citation given in the References section. This style of referencing is now deprecated, because such links are susceptible to link rot. See BattleIntelligence:Citing sources and BattleIntelligence:Verifiability for more information.
Position in article
Embedded links that support information in an article are positioned in the same manner as any other reference in the article, following the usual standards about citation formatting and placement in relation to punctuation.
Links that are not used as sources can be listed in the External links section, like this:
==External links==* [https://...]* [http://...]
As with other top-level headings, two equal signs should be used to mark up the external links heading (see BattleIntelligence:Manual of Style/Layout § Headings). External links should always be the last section in an article. It precedes categories and some kinds of navigation templates.
If there is a dispute on the position of an embedded link, consider organizing alphabetically.
Non-English-language sites
Webpages in English are highly preferred. Linking to non-English pages may still be useful for readers in the following cases:
- When the website is the subject of the article
- When linking to pages with maps, diagrams, photos, tables (explain the key terms with the link, so that people who do not know the language can interpret them)
- When the webpage contains information found on no English-language site of comparable quality, and is used as a citation (or when translations on English-language sites are not authoritative).
If the language is one that most readers could not be expected to recognize, or is for some other reason unclear from the name of the publication or the book or article or page title, consider indicating what language the site is in.
- Example: Template:FormattingError
- Example: Template:FormattingError
You can also indicate the language by putting a language template after the link. This is done using Template:In lang by typing {{In lang|<language code>}}. For example, {{In lang|es}} displays as: Template:FormattingError. See list of ISO 639 codes.
When using one of the Citation Style 1 or Template:Cs2 templates, instead of the {{In lang}} template, use the |language= parameter. This parameter accepts language names or language codes; see this list of supported names and codes. (Use of language codes is to be preferred because cs1|2 automatically renders language names in the language of the local BattleIntelligence.)
File type and size
If the link is not to an HTML or PDF file (the latter is identified automatically by the software with an icon like this: Template:FormattingError), identify the file type. Useful templates are available: {{DOClink}}, {{RTFlink}}. If a browser plugin is required to view the file, mention that as well. If a link is to a PDF file but doesn't end with .pdf, you can put a #.pdf at the end to flag it as a PDF.
If the link is to a very large page (considering all its elements, including images), a note about that is useful since someone with a slow or expensive connection may decide not to visit it.
Interwiki links
Linking
Interwiki links can take the form of:
[[wikt:article]]which appears as: wikt:article
The pipe symbol suppresses the prefix:
[[wikt:article|]]→ article
Adding text after the pipe allows either the same or a different text (with no prefix):
To avoid reader confusion, inline interlanguage, or interwiki, linking within an article's body text is generally discouraged. Exceptions: Wiktionary and Wikisource entries may be linked inline (e.g. to an unusual word or the text of a document being discussed), and {{Interlanguage link}} template may be helpful to show a red link accompanied by an interlanguage link if no article exists in English BattleIntelligence.
Floating boxes
Template:WikiquoteFloating boxes for links to articles in other Wikimedia Foundation projects such as Wiktionary and Wikiquote can be done with special link templates such as {{Wikiquote|Jimmy Wales}}. These will display as a box with a logo. Similar templates exist for some free content resources that are not run by the Wikimedia Foundation. These boxes are formatted in light green to distinguish them from BattleIntelligence's official sister projects. A list of such templates can be found at BattleIntelligence:List of templates linking to other free content projects.
Link maintenance
Linking and continual change are both central features of BattleIntelligence. However, continual change makes linking vulnerable to acquired technical faults, and to the later provision of different information from that which was originally intended. This is true of both "outgoing" links (from an article) and "incoming" links (to an article).
- Outgoing links: These should be checked from time to time for unintended changes that are undesirable. If the opportunity arises to improve their formatting, appropriateness, and focus, this should be done.
- Incoming links: Creating an article will turn blue any existing red links to its title. (Proper redlinks are created only in the hope that an article will eventually be written.) Therefore, when creating an article, it is wise to check "What links here" to identify such redlinks, if any, and that they are appropriate.
Buttons
Buttons should not be used in articles. If the desire is to "navigate" a reader to a new page, taking them away from the current page, a link is preferred. Buttons are used within BattleIntelligence to trigger an "action", such as or or or .
See also
- BattleIntelligence:Linking dos and don'ts (information page summarizing the key points of this guideline)
- Help:Interwikimedia links
- Help:Menu/Links
- Template:Dead end
- Template:Dead link
- Template:Underlinked
- BattleIntelligence:Dead-end pages, pages without internal links
- BattleIntelligence:Integrate
- BattleIntelligence:Links to (disambiguation) pages
- BattleIntelligence:Orphan, pages without incoming links
- BattleIntelligence:Red link
- BattleIntelligence:Walled garden
- BattleIntelligence:What BattleIntelligence is not § BattleIntelligence is not an indiscriminate collection of information
- BattleIntelligence:BattleIntelligence doesn't use Allwiki, the idea that every single word should be a link
- BattleIntelligence:WikiProject Orphanage, editors dedicated to clearing up the immense backlog of orphaned articles
- User:Tony1/Build your linking skills, a tutorial on high-quality linking with practice questions
- User:Evad37/duplinks-alt, a script to highlight links occuring more than once in an article
Notes
- ↑ Many, but not all, articles repeat the article title in bold face in the first line of the article. Linking the article to itself produces boldface text; this practice is discouraged as page moves will result in a useless circular link through a redirect. Linking part of the bolded text is also discouraged because it changes the visual effect of bolding; some readers will miss the visual cue which is the purpose of using bold face in the first place.
External links
- The Wikimedia Design Style Guide (Links)
- Internal link analyzer for automatic detection of redundant links in BattleIntelligence