Difference between revisions of "Help:Piped link"

From FamilySearch Wiki
Jump to: navigation, search
(Delete irrelevant text)
(Update text)
Line 4: Line 4:
 
*or there are multiple meanings of the word.
 
*or there are multiple meanings of the word.
  
To create the pipe ("|") character (also known as a vertical bar), you may press (SHIFT + BACKSLASH) on English-layout keyboards. 
+
To create the pipe ("|") character (also known as a vertical bar), you may press (SHIFT + BACKSLASH) on English-layout keyboards.   
  
 
There is disagreement about whether it is appropriate to pipe year numbers to "year-in-x" articles (such as <nowiki>[[1930 Census|1930]]</nowiki>).  
 
There is disagreement about whether it is appropriate to pipe year numbers to "year-in-x" articles (such as <nowiki>[[1930 Census|1930]]</nowiki>).  
Line 16: Line 16:
 
*Avoid making links longer than necessary: write "president <nowiki>[[George Washington]]</nowiki>", not "<nowiki>[[George Washington|president George Washington]]</nowiki>".  
 
*Avoid making links longer than necessary: write "president <nowiki>[[George Washington]]</nowiki>", not "<nowiki>[[George Washington|president George Washington]]</nowiki>".  
 
*It is generally not good practice to pipe links simply to avoid redirects. The number of links to a redirect page can be a useful gauge of when it would be helpful to spin off a subtopic of an article into its own page.  
 
*It is generally not good practice to pipe links simply to avoid redirects. The number of links to a redirect page can be a useful gauge of when it would be helpful to spin off a subtopic of an article into its own page.  
*Given the option to pipe a link or to "blend" an affix, preferred style is to use a blended affix. Write simply <nowiki>[[Public transport]]</nowiki>ation instead of complicated <nowiki>[[Public transport|Public transportation]],</nowiki>. Both display identically as Public transportation.  
+
*Given the option to pipe a link or to "blend" an affix, preferred style is to use a blended affix. Write simply <nowiki>[[NFS members|NFS members]]</nowiki>hip instead of complicated <nowiki>[[NFS members|NFS membership]],</nowiki>. Both display identically as NFS membership.  
*Never use piped links to convert first letter to lower case: write simply <nowiki>[[Public transport]]</nowiki> instead of complicated <nowiki>[[Public transport|public transport]]</nowiki>. Both display identically as public transport.
+
*Never use piped links to convert first letter to lower case: write simply <nowiki>[[File Organization]]</nowiki> instead of complicated <nowiki>[[File Organization|file organization]]</nowiki>. Both display identically as file organization.
  
 
[[Category:Help]]
 
[[Category:Help]]

Revision as of 06:24, 9 September 2013

Piped links are useful for preserving the grammatical structure and flow of a sentence when:

  • the wording of the exact link title does not fit in context,
  • or there are multiple meanings of the word.

To create the pipe ("|") character (also known as a vertical bar), you may press (SHIFT + BACKSLASH) on English-layout keyboards. 

There is disagreement about whether it is appropriate to pipe year numbers to "year-in-x" articles (such as [[1930 Census|1930]]).

Another possibility is to link to a more specific article about that year, for example [[1930 Census|1930]], although some people find this unintuitive because the link leads to an unexpected destination.

When not to use

First of all, keep links as simple as possible:

  • Avoid making links longer than necessary: write "president [[George Washington]]", not "[[George Washington|president George Washington]]".
  • It is generally not good practice to pipe links simply to avoid redirects. The number of links to a redirect page can be a useful gauge of when it would be helpful to spin off a subtopic of an article into its own page.
  • Given the option to pipe a link or to "blend" an affix, preferred style is to use a blended affix. Write simply [[NFS members|NFS members]]hip instead of complicated [[NFS members|NFS membership]],. Both display identically as NFS membership.
  • Never use piped links to convert first letter to lower case: write simply [[File Organization]] instead of complicated [[File Organization|file organization]]. Both display identically as file organization.