You are here: Foswiki>System Web>Category>AdminDocumentationCategory>Plugins>InterwikiPlugin>InterWikis (16 Jan 2015, ProjectContributor)Edit Attach

Inter-Wiki Link Rules (or Links to other Sites)

This topic lists all aliases needed to map inter-wiki links to external wikis/sites.

Whenever you write ExternalSite:Page it will be linked automatically to the page on the external site. The link points to the URL corresponding to the ExternalSite alias below, concatenated to the Page you choose. Example: Type Wiki:RecentChanges to get Wiki:RecentChanges, the RecentChanges page at the original Wiki site.

ALERT! Note: This topic needs to be visible for all users, or the plugin will not work correctly.

Inter-wiki links are defined in the tables below.
  • Each entry must be three or four columns, using the following format:
    | External site alias | URL | Tooltip help text | Optional INTERLINKFORMAT override |.
  • The Alias must start with an upper case letter and may contain alphanumeric characters.
  • The URL and Tooltip Text may contain optional $page formatting tokens; the token gets expanded to the page name.
  • The URL may contain Foswiki macros. They are expanded when the URL is rendered.
  • The Tooltip Text must not contain:
    • any HTML tags (including <nop> escape code)
    • any internal WikiWord links
    • any external links
    • Hint: Escape 'WikiWords' and '$page'.
    • If the link format override is provided, it overrides the INTERWIKIPLUGIN_INTERLINKFORMAT for just that entry.

HELP Note that Interwiki links do not properly resolve when part of an INCLUDEd page name. e.g. %INCLUDE{"Interwiki:link"}%

HELP For Foswiki and TWiki sites, both the web and the topic have to be specified: Foswiki:Webname/SomePage Foswiki:Extensions/InterwikiPlugin or Foswiki:Extensions.InterwikiPlugin

HELP For links with parentheses you will need to write as [[Wikipedia:Fork_(software_development)]], or quoted, as Wikipedia:'Fork_(software_development)' as the plugin will not include the closing parenthesis as part of the link.

The optional INTERLINKFORMAT override can incorporate the following tokens which are expanded when the link is generated:
Token Meaning
$site Site alias
$page Page (part after colon)
$url Site URL (might contain $page)
$label Equal to $site:$page
$tooltip Tooltip message

See InterwikiPlugin for more details on specifiying the INTERLINKFORMAT.

Rather than adding your own inter-wiki links to this topic, the recommended approach is to create a topic in your Main Web, for example Main.InterWikis. You can then set the INTERWIKIPLUGIN_RULESTOPIC preference setting in Main.SitePreferences as follows: 

   * Set INTERWIKIPLUGIN_RULESTOPIC = %SYSTEMWEB%.InterWikis, %USERSWEB%.InterWikis

Any inter-wikis you add to Main.InterWikis will then be available in the same way that the inter-wikis from here are. If you create a rule in Main.InterWikis which has the same alias as a rule in this topic, the rule from Main.InterWikis will take preference.

Alias: URL: Tooltip Text:
Acronym http://www.acronymfinder.com/af-query.asp?Acronym=$page&String=exact Look up '$page' on Acronym Finder site
CPAN https://metacpan.org/module/ CPAN perl repository
Dictionary http://www.dictionary.com/cgi-bin/dict.pl?term= Look up '$page' at Dictionary.com
Google http://google.com/search?q= Search for '$page' on Google
Group http://groups.google.com/groups?hl=en&safe=off&group= News group '$page' at Google.com
ISBN http://www.bookfinder.com/search/?st=sr;ac=qr;isbn= Book with ISBN $page
News http://news.google.com/news?q= Search for '$page' on Google news
RFC http://www.faqs.org/rfcs/rfc$page.html IETF RFC #$page

Alias: URL: Tooltip Text: Format override:
Advogato http://www.advogato.org/ '$page' on Advogato community site (with peer review)
C2find http://c2.com/cgi/wiki?FindPage&value= Search '$page' on the original 'WikiWikiWeb' site
DokuWiki http://wiki.splitbrain.org/wiki: '$page' on Doku Wiki site
Foswiki http://foswiki.org/ '$page' on foswiki.org
Foswikitask http://foswiki.org/Tasks/ '$page' on the 'Foswiki' issue tracking site
Foswikirev %REV2REF{$page}% revision $page of 'Foswiki' on Github $url
FoxWiki http://fox.wikis.com/wc.dll?Wiki~ '$page' on Fox Wiki site
HammondWiki http://www.dairiki.org/HammondWiki/index.php3? '$page' on 'HammondWiki' site
MeatBall http://www.usemod.com/cgi-bin/mb.pl? '$page' on 'MeatBall' site, a 'UseMod' Wiki variant
MoinMoin http://moinmo.in/ '$page' on 'MoinMoin' Wiki site
PPR http://c2.com/cgi/wiki? '$page' on the original 'PortlandPatternRepository' site
Squeak http://wiki.squeak.org/squeak/ '$page' on Squeak Smalltalk Wiki
TWiki http://twiki.org/cgi-bin/view/ '$page' on TWiki.org
TWikibug http://develop.twiki.org/~twiki4/cgi-bin/view/Bugs/ '$page' on the TWiki issue tracking site
TWikirev http://develop.twiki.org/trac/changeset/ revision $page of TWiki svn
UseMod http://www.usemod.com/cgi-bin/wiki.pl? '$page' on 'UseMod' Wiki site
Wiki http://c2.com/cgi/wiki? '$page' on the original 'WikiWikiWeb' site
Wikipedia http://en.wikipedia.org/wiki/ '$page' on 'Wikipedia'
ZWiki http://joyful.com/zwiki/ '$page' on Zope's Wiki

Note: This topic configures the InterwikiPlugin.

Related Topics: Plugins, UserDocumentationCategory, AdminDocumentationCategory

Edit  | Attach | Print version | History: r1 | Backlinks | View wiki text | Edit wiki text | More topic actions
Topic revision: r1 - 16 Jan 2015, ProjectContributor
This site is powered by FoswikiCopyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback