Actions

JDOC

Difference between revisions of "Local interwiki links"

From Joomla! Documentation

m
m (Linking to a board in forum.joomla.org)
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<p style="text-align:center;border:1px solid #ccc">[[Local wiki templates]] &bull; [[Local wiki extensions]] &bull; [[Local interwiki links]]</p>
+
<p style="text-align:center;border:1px solid #ccc">[[JDOC:Local wiki templates|Local wiki templates]] &bull; [[JDOC:Local wiki extensions|Local wiki extensions]] &bull; [[JDOC:Local interwiki links|Local interwiki links]]</p>
 
An interwiki link is a kind of short-cut link that allows you to link to an external website (it doesn't have to be another wiki) using a simple syntax similar to an internal page link.  The interwiki reference takes a single parameter and uses it to construct the full URL to the external site.
 
An interwiki link is a kind of short-cut link that allows you to link to an external website (it doesn't have to be another wiki) using a simple syntax similar to an internal page link.  The interwiki reference takes a single parameter and uses it to construct the full URL to the external site.
  
Line 9: Line 9:
 
[[jforum:#####]]
 
[[jforum:#####]]
 
</pre>
 
</pre>
where ##### is replaced by the board number.  For example, the Developer Documentation Forum is board number 60 and so can be linked to by inserting <nowiki>[[jforum:60]]</nowiki> into the wiki page.  Just to prove it works, here it is: [[jforum:60]].  Piped links work too, so <pre>[[jforum:60|Developer Documentation Forum]]</pre> is rendered as: [[jforum:60|Developer Documentation Forum]]
+
where ##### is replaced by the board number.  For example, the Developer Documentation Forum is board number 303 and so can be linked to by inserting <nowiki>[[jforum:303]]</nowiki> into the wiki page.  Just to prove it works, here it is: [[jforum:303]].  Piped links work too, so <pre>[[jforum:303|Documentation - Feedback/Information/Suggestions]]</pre> is rendered as: [[jforum:303|Documentation - Feedback/Information/Suggestions]]
  
To make things a little bit easier when linking to any of the well-known ''Working Group'' fora you can use the {{tlx|jforum}} template. It accepts a (hopefully) easy to remember keyword instead of a number to create a link. Instead of <nowiki>[[jforum:60]]</nowiki> you can use {{tlx|jforum|devdoc}} or {{tlx|jforum|ddt}} ('''D'''eveloper '''D'''ocumentation '''T'''eam). And to prove the template works equally well, here's how both keywords are rendered: {{jforum|devdoc}} and {{jforum|ddt}}.
+
To make things a little bit easier when linking to any of the well-known ''Working Group'' fora you can use the {{tlx|jforum}} template. It accepts a (hopefully) easy to remember keyword instead of a number to create a link. Instead of <nowiki>[[jforum:303]]</nowiki> you can use {{tlx|jforum|devdoc}} or {{tlx|jforum|ddt}} ('''D'''eveloper '''D'''ocumentation '''T'''eam). And to prove the template works equally well, here's how both keywords are rendered: {{jforum|devdoc}} and {{jforum|ddt}}.
  
 
===Linking to a topic in forum.joomla.org===
 
===Linking to a topic in forum.joomla.org===
Line 40: Line 40:
 
</pre>
 
</pre>
 
where xxxxxxxxx is replaced by a word, usually a PHP function name.  For example, the reference page for the PHP strlen() function can be linked to by inserting <nowiki>[[php:strlen]]</nowiki> into the wiki page.  Just to prove it works, here it is: [[php:strlen]].  Piped links work too, so <pre>[[php:strlen|strlen()]]</pre> is rendered as: [[php:strlen|strlen()]].
 
where xxxxxxxxx is replaced by a word, usually a PHP function name.  For example, the reference page for the PHP strlen() function can be linked to by inserting <nowiki>[[php:strlen]]</nowiki> into the wiki page.  Just to prove it works, here it is: [[php:strlen]].  Piped links work too, so <pre>[[php:strlen|strlen()]]</pre> is rendered as: [[php:strlen|strlen()]].
 +
 +
===Linking to Wikipedia===
 +
To link to a page on (english) wikipedia.org you can use this syntax:
 +
<pre>
 +
[[wikipedia:xxxxxxxxx]]
 +
</pre>
 +
where xxxxxxxxx is the target page name.  For example, the Joomla! page can be linked to by inserting <nowiki>[[wikipedia:Joomla!]]</nowiki>.  Just to prove it works, here it is: [[wikipedia:Joomla!]].  Piped links work too, so <nowiki>[[wikipedia:Joomla!|]]</nowiki> is rendered as: [[wikipedia:Joomla!|Joomla!]].

Revision as of 15:36, 1 May 2012

Local wiki templatesLocal wiki extensionsLocal interwiki links

An interwiki link is a kind of short-cut link that allows you to link to an external website (it doesn't have to be another wiki) using a simple syntax similar to an internal page link. The interwiki reference takes a single parameter and uses it to construct the full URL to the external site.

The following Joomla!-specific interwiki links are supported in this wiki.

Contents

Linking to a board in forum.joomla.org

To link to a specific forum board in forum.joomla.org you can use this syntax:

[[jforum:#####]]

where ##### is replaced by the board number. For example, the Developer Documentation Forum is board number 303 and so can be linked to by inserting [[jforum:303]] into the wiki page. Just to prove it works, here it is: jforum:303. Piped links work too, so

[[jforum:303|Documentation - Feedback/Information/Suggestions]]

is rendered as: Documentation - Feedback/Information/Suggestions

To make things a little bit easier when linking to any of the well-known Working Group fora you can use the {{jforum}} template. It accepts a (hopefully) easy to remember keyword instead of a number to create a link. Instead of [[jforum:303]] you can use {{jforum|devdoc}} or {{jforum|ddt}} (Developer Documentation Team). And to prove the template works equally well, here's how both keywords are rendered: Developer Documentation forum and DevDocs forum.

Linking to a topic in forum.joomla.org

To link to a specific forum topic (thread) in forum.joomla.org you can use this syntax:

[[jtopic:#####]]

where ##### is replaced by the topic number. For example, the forum thread announcing the first Joomla! Doc Camp is topic number 248141 and so can be linked to by inserting [[jtopic:248141]] into the wiki page. Just to prove it works, here it is: jtopic:248141. Piped links work too, so

[[jtopic:248141|Joomla! Doc Camp]]

is rendered as: Joomla! Doc Camp

Linking to a tracker item in JoomlaCode.org

To link to a specific tracker item (eg. a bug report) in JoomlaCode.org you can use this syntax:

[[jtracker:#####]]

where ##### is replaced by the tracker ID number. For example, the tracker item "Issue with (Today) string" is tracker number 8867 and so can be linked to by inserting [[jtracker:8867]] into the wiki page. Just to prove it works, here it is: jtracker:8867. Piped links work too, so

[[jtracker:8867|Issue with (Today) string]]

is rendered as: Issue with (Today) string. Note that you will probably need to be logged into JoomlaCode for these links to work as expected.

Linking to a help screen on help.joomla.org

To link to a help screen on the Joomla! help site using a key reference you can use this syntax:

[[jhelp:#####]]

where ##### is replaced by the help screen key reference. For example, the help screen for the Global Configuration screen in Joomla! 1.5 has key reference "screen.config.15" and so can be linked to by inserting [[jhelp:screen.config.15]] into the wiki page. Just to prove it works, here it is: jhelp:screen.config.15. Piped links work too, so

[[jhelp:screen.config.15|Global Configuration]]

is rendered as: Global Configuration.

Linking to PHP documentation

To link to a reference page on php.net you can use this syntax:

[[php:xxxxxxxxx]]

where xxxxxxxxx is replaced by a word, usually a PHP function name. For example, the reference page for the PHP strlen() function can be linked to by inserting [[php:strlen]] into the wiki page. Just to prove it works, here it is: php:strlen. Piped links work too, so

[[php:strlen|strlen()]]

is rendered as: strlen().

Linking to Wikipedia

To link to a page on (english) wikipedia.org you can use this syntax:

[[wikipedia:xxxxxxxxx]]

where xxxxxxxxx is the target page name. For example, the Joomla! page can be linked to by inserting [[wikipedia:Joomla!]]. Just to prove it works, here it is: wikipedia:Joomla!. Piped links work too, so [[wikipedia:Joomla!|]] is rendered as: Joomla!.