View source for Template:Querylink/doc

{{Documentation subpage}}

== Quick overview ==
This template creates an internal link to the specified page (1) with the specified query string (qs) of the form <code>qs=name=value&name2=value2</code> and optionally the specified caption (2) which defaults to the specified page (1). The intended purpose of this template is to provide the ability to create internal links with a query string component, which addresses a limitation of the current [http://www.mediawiki.org wiki software].

Example usage:
                      ''1         query string               2''
  <nowiki>{{</nowiki>{{BASEPAGENAME}}|Special:Allpages|qs=namespace=1|See what people are talking about}}

Produces:
{{ {{BASEPAGENAME}}|Special:Allpages|qs=namespace=1|See what people are talking about}}

== Reason ==
The MediaWiki software does not support the use of a '''query string''' element of an URL as part of the internal wiki link syntax. This means that when wishing to link to a page that requires a query string in order to display the desired view of a page, an external link must be used. This is misleading when linking to a page within the wiki itself. For example, to create a link to this page's edit page, one might use the following wikitext:
<code><nowiki>[//www.festipedia.org.uk/w/index.php?title={{FULLPAGENAMEE}}&action=edit edit]</nowiki></code>.
This would produce the following link: [//www.festipedia.org.uk/w/index.php?title={{FULLPAGENAMEE}}&action=edit edit]. However, the edit page is not really an external link, so the desired result would be {{Querylink|{{FULLPAGENAMEE}}|qs=action=edit|edit}}, without the external link graphic.

== Description of use ==
Internal links with a query string URL element may be achieved through the use of this '''querylink''' template. This template has been provided as a workaround for the described wiki software limitation. The template has been designed to be usable in a similar manner to creating a normal internal link, and takes two to three parameters depending upon how you wish to use it. To create the example link from before to this page's edit page using the querylink template, the following wikitext markup was used:
  <nowiki>{{Querylink|</nowiki>{{FULLPAGENAMEE}}<nowiki>|qs=action=edit|edit}}</nowiki>

All templates are called by enclosing the template name and parameters within a pair of curly braces "<code>{{}}</code>". All parameters are separated with the pipe character "<code>|</code>". The first "parameter" is always the ''name'' of the template that you wish to use and as such is not formally a parameter at all. In this case, it is <code>Querylink</code>.

#The first formal parameter passed to the template should be the name of the internal page that you wish to link. In this case, <code>{{FULLPAGENAMEE}}</code>.
#The second parameter is the query string used to display the desired view of the page. It has the form <code>qs=</code> followed by the name and value pairs of the query string of the form <code>name=value&name2=value2</code>. In this case, just one name and value pair is used: <code>action=edit</code>.
#The third parameter is optional. If included, the text of this parameter will be used as the display name for the link text in the article, similar to piped links. If omitted, the page name will be used instead, similar to ordinary internal links. In this case, we specify a friendly name for the link: <code>edit</code>.

In some cases you might prefer to produce a query string without a page name. For that, simply omit the first parameter:
 <nowiki>{{Querylink||qs=oldid=10000|10 000th revision}}</nowiki>
This produces the link {{Querylink||qs=oldid=10000|10 000th revision}}, pointing to the location https://www.festipedia.org.uk/?oldid=10000

==Limitations==

The template normally does not work as a target for <code>#REDIRECT</code> in redirect pages. You can subst: it to achieve that: <nowiki>{{subst:querylink|...}}</nowiki>

==See also==
* [[Template:Plain link]]

<includeonly>{{Sandbox other||
[[Category:Internal link templates|{{PAGENAME}}]]
}}</includeonly>