plugin:linkbonus
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
plugin:linkbonus [2010-09-01 23:21] – ryan.chappelle | plugin:linkbonus [2022-11-12 14:03] – Aleksandr | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== linkbonus | + | ====== linkbonus |
---- plugin ---- | ---- plugin ---- | ||
Line 6: | Line 6: | ||
email : luis.machuca [at] gulix.cl | email : luis.machuca [at] gulix.cl | ||
type : Syntax | type : Syntax | ||
- | lastupdate : 2010-04-10 | + | lastupdate : 2010-11-12 |
- | compatible : | + | compatible : 2013-05-10a " |
depends | depends | ||
conflicts | conflicts | ||
similar | similar | ||
- | tags : links, !experimental, !maybe.broken | + | tags : links, !experimental |
- | downloadurl: | + | downloadurl: |
- | bugtracker : # eg. http:// | + | bugtracker : |
- | sourcerepo : # eg. http:// | + | sourcerepo : |
donationurl: | donationurl: | ||
+ | |||
+ | screenshot_img: | ||
---- | ---- | ||
- | **LinkBonus**((tentative name)) is an experimental plugin undergoing development right now (as of //2010/04/10//) that extends the standard DokuWiki syntax for links in order to include some extra features. Namely, it implements at least the features indicated in the **[[http:// | + | **LinkBonus**((tentative name)) is an experimental plugin undergoing development right now (as of //2010/11/12//) that extends the standard DokuWiki syntax for links in order to include some extra features. Namely, it implements at least the features indicated in the [[https:// |
- ability to set both the link name and tooltip | - ability to set both the link name and tooltip | ||
- ability to automatically fetch the name from the external page | - ability to automatically fetch the name from the external page | ||
- ability to display a visual indication if the external webpage is not available | - ability to display a visual indication if the external webpage is not available | ||
+ | - ability to display the favicon of the remote site (see // | ||
+ | - ability to enter some formatting, such as italics, in links (see // | ||
It also implements some other minor features which are explained below. | It also implements some other minor features which are explained below. | ||
- | :!: **TAKE WARNING**: This plugin is experimental and is not considered stable -- it doesn' | + | > :!: **TAKE WARNING**: This plugin is experimental and is not considered stable -- it doesn' |
- | A courtesy of your friendly DokuWiki plugin developer < | + | Once the major release is out **this page will be deleted and you will be advised to remove this plugin before installing the definitive version.** |
+ | |||
+ | A courtesy of your friendly DokuWiki plugin developer < | ||
===== Download and Installation ===== | ===== Download and Installation ===== | ||
- | Download | + | Search |
+ | |||
+ | It is recommended to **clean your DokuWiki cache** right after installing or updating this plugin. | ||
===== Syntax and Usage ===== | ===== Syntax and Usage ===== | ||
- | To use this plugin simply extend the normal DokuWiki syntax for __links__ | + | To use this plugin simply extend the normal DokuWiki syntax for **links** |
- | **External Link Syntax**: | + | === External Link Syntax |
- | An external link is a [[doku>link|standard link]] pointing to somewhere in the Web and accepts the HTTP and HTTPS protocols. | + | An external link is like a [[:link|standard link]] pointing to somewhere in the Web and accepts the HTTP and HTTPS protocols. |
[[http:// | [[http:// | ||
- | **Server Link Syntax**: | + | === Server Link Syntax |
- | A server link is a link that resolves relative to the root of the webserver where DokuWiki is installed, in a manner similar to that of the [[doku>baselink]] plugin. | + | A server link is a link that resolves relative to the root of the webserver where DokuWiki is installed, in a manner similar to that of the [[plugin:baselink]] plugin. |
[[@/my/page | Link Name | <Link Tooltip> | <extra parameters> | [[@/my/page | Link Name | <Link Tooltip> | <extra parameters> | ||
+ | ===== ===== | ||
- | The link has the following components: | + | The extended |
* **Link Name**: the name displayed for the link, the same way as the normal DokuWiki syntax. Special characters that interfere with DokuWiki syntax such as pipes (%%|%%) and braces (%%[ < > ]%%) can be escaped C-style: '' | * **Link Name**: the name displayed for the link, the same way as the normal DokuWiki syntax. Special characters that interfere with DokuWiki syntax such as pipes (%%|%%) and braces (%%[ < > ]%%) can be escaped C-style: '' | ||
Line 62: | Line 71: | ||
[[http:// | [[http:// | ||
- | === Parameters ==== | + | ==== Parameters |
- | **'' | + | === fetchname === |
+ | |||
+ | fetchname=" | ||
+ | |||
+ | If the "'' | ||
The special value **'' | The special value **'' | ||
- | **'' | + | === Dead or Alive === |
- | **'' | + | |
+ | "Dead or Alive" | ||
- | __The following parameters do not work in this version, but can be used and will work as indicated in future versions:__ | + | === Favicon === |
- | **'' | + | favicon |
- | **'' | + | If the "'' |
- | **'' | + | :!: This feature is __disabled by default__. See [[# |
+ | |||
+ | === Other Parameters === | ||
+ | |||
+ | **'' | ||
+ | |||
+ | **'' | ||
+ | |||
+ | |||
+ | === Reserved for Future Use === | ||
+ | |||
+ | **The following parameters do not work in this version, but can be used and will work as indicated in future versions: | ||
+ | |||
+ | **'' | ||
===== Demo ===== | ===== Demo ===== | ||
- | :!: [[http:// | + | :!: [[http:// |
- | There is another (unofficial) demo site which is my [[http:// | + | There is another (unofficial) demo site which is my [[http:// |
+ | |||
+ | ===== Development Information ===== | ||
+ | |||
+ | ==== Tweaking ==== | ||
+ | |||
+ | Some features are disabled or controlled. To modify their behaviour, add the required lines to your master configuration file ('' | ||
+ | |||
+ | < | ||
+ | $conf[' | ||
+ | </ | ||
+ | |||
+ | ^ Option | ||
+ | | [[# | ||
+ | | Internal formatting | ||
+ | | Connection timeout | ||
- | =====Development Information ===== | ||
==== Changelog ==== | ==== Changelog ==== | ||
Line 95: | Line 136: | ||
==== Known Issues ==== | ==== Known Issues ==== | ||
- | **Note**: This plugin does not work with [[doku>images# | + | **Note**: This plugin does not work with [[:images# |
**Note**: This plugin does not attempt to check the validity of an external title. If it has invalid characters or tags, this plugin will generate invalid XHTML code. | **Note**: This plugin does not attempt to check the validity of an external title. If it has invalid characters or tags, this plugin will generate invalid XHTML code. | ||
Line 101: | Line 142: | ||
**Note**: This plugin will increase page load time and cause a slight overhead on outgoing connections from your server. | **Note**: This plugin will increase page load time and cause a slight overhead on outgoing connections from your server. | ||
- | ====Future Development==== | + | ==== Future Development ==== |
* better handling of links with no title (eg.: images?) | * better handling of links with no title (eg.: images?) | ||
Line 109: | Line 150: | ||
* interwiki syntax? | * interwiki syntax? | ||
* extended scheme syntax? (eg.: FTP, local file) | * extended scheme syntax? (eg.: FTP, local file) | ||
- | * favicons! | + | * **a better |
- | | + | |
- | + | ||
- | + | ||
- | ==== Other Developments ==== | + | |
- | + | ||
- | ^ Other Plugins by\\ Luis Machuca B.: | [[doku> | + | |
===== Discussion ===== | ===== Discussion ===== | ||
Feel free to discuss here; just remember that this plugin is experimental and that it will be eventually superseded by another, much improved and " | Feel free to discuss here; just remember that this plugin is experimental and that it will be eventually superseded by another, much improved and " | ||
- | |||
plugin/linkbonus.txt · Last modified: 2023-12-21 15:38 by Aleksandr