Differences

This shows you the differences between two versions of the page.

--- interwiki [2014-03-23 12:44] – removed wrong information about [[this>]] ach
+++ interwiki [2024-05-08 09:27] (current) – [Table] Transfer of the information in /conf/interwiki.conf michaelsy
@@ Line 1: / Line 1: @@
 ====== InterWiki Links ======
-The original idea of InterWiki was to have one large distributed [[wp>Wiki]] over the whole Internet. Today its more of an easy way to link from one wiki to another by having some simple link syntax to accomplish so.
-In [[DokuWiki]] this is done by prefixing Wiki [[pagenames]] with a shortcut separated by a ''>'' character.
+The original idea of InterWiki was to have one large distributed [[wp>Wiki]] over the whole Internet. Today it's more of an easy way to link from one wiki to another by having some simple link syntax to accomplish so.
+In [[DokuWiki]] this is done by prefixing Wiki [[pagenames]] with a shortcut separated by a **''>''** character.
 Examples:
-| %%[[wp>InterWiki]]%%         | [[wp>InterWiki]]  | links to the English language Wikipedia |
+^  Shortcut  ^  Example  ^  Description  ^
-| %%[[phpfn>random]]%%         | [[phpfn>random]] | links to a function in the PHP manual |
+| ''%%[[amazon>Wikis]]%%''     | [[amazon>Wikis]]    | Affiliation link to Amazon. (.de and .uk available too)  |
-| %%[[google>Wiki]]%%          | [[google>Wiki]] | links to a Google search |
+| ''%%[[callto>0123456789]]%%''  | [[callto>0123456789]]  | Callto link to open phone app.  |
-| %%[[doku>interwiki]]%%       | [[doku>interwiki]] | links to the DokuWiki wiki  |
+| ''%%[[doku>interwiki]]%%''   | [[doku>interwiki]]  | links to the DokuWiki wiki  |
-| %%[[this>feed.php]]%%        | [[this>feed.php]] | links to your wiki's URL. The example links to the local [[syndication|XML feed]]. ''%%[[>this]]%%'' is a special case and the only interwiki link which **cannot be configured** through any config file. |
+| ''%%[[go>pie]]%%''           | [[go>pie]]          | Go lucky with first hit on Google  |
+| ''%%[[google>Wiki]]%%''      | [[google>Wiki]]     | links to a Google search  |
+| ''%%[[paypal>id_here]]%%''   | [[paypal>id_here]]  | links to PayPal  |
+| ''%%[[phpfn>random]]%%''     | [[phpfn>random]]    | links to a function in the PHP manual  |
+| ''%%[[rfc>9311]]%%''         | [[rfc>9311]]        | links to https://www.rfc-editor.org/rfc/rfc9311  |
+| ''%%[[skype>echo123]]%%''    | [[skype>echo123]]   | Links that opens Skype, ready to call Skype Test Call (echo123)  |
+| ''%%[[tel>123-456-7890]]%%''  | [[tel>123-456-7890]]  | Open phone app to call. More general then callto.  |
+| ''%%[[this>feed.php]]%%''    | [[this>feed.php]]   | links to your wiki's URL. The example links to the local [[syndication|XML feed]]. ''%%[[this>]]%%'' is a special case and the only interwiki link which **cannot be configured** through any config file.  |
+| ''%%[[user>username]]%%''    | [[user>username]]   | Links default to '':user:username'', on dokuwiki.org modified to its forum user profiles.  |
+| ''%%[[man>cp]]%%''           | [[man>cp]]          | links to http://man.cx/  |
+| ''%%[[wp>InterWiki]]%%''     | [[wp>InterWiki]]    | links to the English language Wikipedia  |
+| ''%%[[wpfr>InterWiki]]%%''   | [[wpfr>InterWiki]]  | links to the French language Wikipedia. Also available: ''wpde'', ''wpes'', ''wpjp'',  ''wppl'', ''wpru'', ''wpmeta''.  |
-Here's an example of how to access an arbitrary file in dokuwiki's data/media directory by clicking on an image. It's useful for videos and pdf files.
+Here's an example of how to access an arbitrary file in DokuWiki's data/media directory by clicking on an image. It's useful for videos and PDF files.
   [[this>lib/exe/fetch.php?media=video.ogg|{{image.png?300}}]]
+Interwiki substitution for external images is also available.
+{{ phpfn>images/php.gif?96}}
+  {{ phpfn>images/php.gif?96}}
 ===== Configuring InterWiki Shortcuts =====
 InterWiki shortcuts are defined in two files:
-  * the ''[[https://github.com/splitbrain/dokuwiki/blob/master/conf/interwiki.conf|<dokuwiki_conf>/interwiki.conf]]'' file.\\ This is the default file, it contains a few predefined useful shortcuts (more can be found in [[http://usemod.com/intermap.txt]]). It is possible to modify this file, however this could result in your changes being overwritten when upgrading DokuWiki.
+  * Default included links are in ''[[https://github.com/dokuwiki/dokuwiki/blob/master/conf/interwiki.conf|<dokuwiki_conf>/interwiki.conf]]'' file. (more can be found in [[https://usemod.org/intermap.txt]]). Modifications of this file are overwritten on a wiki upgrade.
-  * the ''<dokuwiki_conf>/interwiki.local.conf'' file.\\ This is the file to add your own interwiki links. This will prevent the links from being overwritten on an update.
+  * Local modifications in ''<dokuwiki_conf>/interwiki.local.conf'' file.\\ This is the file to add your own interwiki links. This will prevent the links from being overwritten on an update.
+Alternatively, instead of editing the ''*.conf'' files directly, you can install and use the [[plugin:confmanager|{{https://raw.githubusercontent.com/cosmocode/confmanager/master/admin.svg?16}}]][[plugin:confmanager|Configuration File Manager]].
 The interwiki shortcut has to be in lowercase and follow the [[pagename]] rules.
@@ Line 24: / Line 45: @@
 The format of the interwiki config file is:
-  <shortcut>      <url to wiki>
+<code - conf/interwiki.local.conf>
+<shortcut>   <url to wiki>
+</code>
+Modify existing interwiki links, by reusing the shortcut:<code - conf/interwiki.local.conf>
+wp           https://fr.wikipedia.org/wiki/{NAME}
+</code>
+Or disable by mentioning no link<code - conf/interwiki.local.conf>
+wpmeta
+paypal   # or use a comment to explain why it is disabled
+</code>
 The shortcut is the one you will be able to use in the link later. In the URL you can use some placeholders to be more flexible in linking. If no placeholder is given the [[phpfn>rawurlencode|URL-encoded]] wikiname will be appended to the URL. These placeholders are available:
-^ Placeholder ^ Replaced by ^
+^ Placeholder  ^  Replaced by                                                                                                                                                                                                      ^
-| {URL}       | URL-encoded wikiname (the part which is appended to the URL in interwiki.local.conf) |
+| {URL}        | URL-encoded wikiname (the part which is appended to the URL in interwiki.local.conf)                                                                                                                              |
-| {NAME}      | wikiname without any encoding |
+| {NAME}       | This is replaced by the wikiname as given in the document. Only mandatory encoded is done, urlencoding if the link is an external URL, or encoding as a wikiname if it is an internal link (begins with a colon)  |
-| {SCHEME}    | scheme part if an URL was given as wikiname |
+| {SCHEME}     | scheme part if a URL was given as wikiname                                                                                                                                                                        |
-| {HOST}      | host part if an URL was given as wikiname |
+| {HOST}       | host part if a URL was given as wikiname                                                                                                                                                                          |
-| {PORT}      | port part if an URL was given as wikiname |
+| {PORT}       | port part if a URL was given as wikiname                                                                                                                                                                          |
-| {PATH}      | path part if an URL was given as wikiname |
+| {PATH}       | path part if a URL was given as wikiname                                                                                                                                                                          |
-| {QUERY}     | query part if an URL was given as wikiname |
+| {QUERY}      | query part if a URL was given as wikiname                                                                                                                                                                         |
-The last 5 parameters are useful when creating interwikilinks to cachesystems. Refer to the ''coral'' shortcut in the distributed ''interwiki.conf''.
+The last 5 parameters are useful when creating interwikilinks to cachesystems.
-Examples of these placeholders can found in the ''<dokuwiki_conf>/interwiki.conf'' file.
+For configuration changes to take effect on the pages, the [[devel:caching|cache must be purged]].
+==== Examples ====
+For example cached links with the old, not longer working, [[wp>Coral Content Distribution Network]] could be used by a ''coral'' shortcut, defined using a couple of placeholders:
+<code - conf/interwiki.local.conf>
+coral http://{HOST}.{PORT}.nyud.net:8090{PATH}?{QUERY}
+</code>
+For example, [[https://wiki.ubuntu.com/|Ubuntu's wiki]] uses namespaces and pagenames like this ''LaptopTestingTeam/ToshibaPortegeM700'' and without using ''{NAME}'' as a placeholder in your interwiki.local.conf file, you'll get a "Not Found" error on their wiki, because it'll interpret the forward slash as a ''%2F'' ; so what you can do is add this line to your interwiki.local.conf:
+<code - conf/interwiki.local.conf>
+ubuntu   https://wiki.ubuntu.com/{NAME}
+</code>
-For example, [[https://wiki.ubuntu.com/|Ubuntu's wiki]] uses namespaces and pagenames like this "LaptopTestingTeam/ToshibaPortegeM700" and without using {NAME} as a placeholder in your interwiki.local.conf file, you'll get a Not Found error on their wiki, because it'll interpret the forward slash as a %2F ; so what you can do is add this line to your interwiki.local.conf:
-<code>ubuntu https://wiki.ubuntu.com/{NAME}</code>
 and now create your link to it like this:
-<code>[[ubuntu>LaptopTestingTeam/ToshibaPortegeM700|Ubuntu Linux on Toshiba Portege M700 Tablet]]</code>
+<code>[[ubuntu>LaptopTestingTeam/ToshibaPortegeM700|Ubuntu on Toshiba Portege M700 Tablet]]</code>
+If the wikiname will already include encoded characters (ex: ''%26'' for ''&'') use {PATH} in your interwiki.local.conf definition.
+==== Inter(n)wiki links ====
+To refer to certain namespaces within you own wiki:((Note: the link would always appear as if the page already exists. No 'preprove'.))
+<code - conf/interwiki.local.conf>
+<shortcut>      <dokuwiki_root>:ns:..:
+</code>
+For example: <code - conf/interwiki.local.conf>
+enlib     doku.php?id=:en:lib:
+</code> would address pages in the namespace '':en:lib:pagename'' if using the link syntax ''%%[[enlib>pagename]]%%''.
 ===== Configuring InterWiki Shortcut Icons =====
 Interwiki icons should have a size of 16x16 pixels, be in PNG or GIF format, and be named after the shortcut.
   * ''<dokuwiki_root>/lib/images/interwiki''\\ The directory to place the image files in.
@@ Line 60: / Line 119: @@
 If you want to disable all or some kind of link icons, refer to [[tips:disabling link icons]].
+===== Using the number sign/hash (#), not as comment =====
+Because it is reserved to mark a comment line, a hash (''#'') needs to be escaped by a backslash (''\#'').
-=====See also=====
+e.g. if you are using the name of your interwiki in the fragment part of your URL, you need to escape it.
+Example:
+  * Configuration<file - conf/interwiki.local.conf>
+postconf  http://www.postfix.org/postconf.5.html\#{NAME}
+</file>
+  * Usage<code>
+[[postconf>smtpd_tls_received_header]]
+</code>
+===== See also =====
+  * [[tips:interwiki_shortcuts|Additional InterWiki Shortcuts]]
+  * You can install and use the [[plugin:confmanager|{{https://raw.githubusercontent.com/cosmocode/confmanager/master/admin.svg?16}}]][[plugin:confmanager|Configuration File Manager]] for editing via admin interface of the wiki
   * [[config|Configuring DokuWiki]]