Table of Contents
linksenhanced Plugin
Compatible with DokuWiki
- 2022-07-31 "Igor" unknown
- 2020-07-29 "Hogfather" unknown
- 2018-04-22 "Greebo" yes
- 2017-02-19 "Frusterick Manners" unknown
Similar to xtern
This plugin is no longer maintained.
This is a simple plugin that allows using Wiki markup within a link title. My use-case was the inclusion of a fontawesome symbol, generated by the fontawesome plugin, as link name. As this wasn't easily possible, I created this plugin. It is at a very early stage in development and not well tested, so please drop me a line if you encounter any problem.
It is also possible to check external links for their status.
Installation
Copy the unzipped folder to your /lib/plugins
directory and activate the plugin.
Examples/Usage
Whenever you want the link title of any type of link to be passed through the DokuWiki renderer, prepend the URL with render^
.
Additionally, if you want the plugin to remove any added paragraph, add the word noparagraph
(note the space) in front of it.
If you want to check a link for availability, include check
in the list of options or check^
if it's the only option you specify. You can also specify link checking for all links by enabling it in configuration settings and further restrict it to a certain namespace or namespaces, separated by ',' (the namespace setting only has effect when you enable link checking by default, i.e. it narrows it down). If you enable it by default, then your link syntax does not change at all.
The link check is indicated by a colored dot in front of the link:
- orange = checking or unknown,
- green = online,
- red = offline.
There is no requirement on an external library, all checking is done internally.
Another syntax option ({{linksenhanced>}}
) displays the link overview status on any wiki page. It can be limited to a given namespace(s) (attention: separate by semicolon!) by specifying the option {{linksenhanced>namespace=wiki;test}}
.
Example
[[render^https://www.dokuwiki.org|<faicon fa fa-euro> Euro Symbol]]
This will render a Euro-Symbol using the fontawesome plugin. However, a paragraph will be added by DokuWiki. In order to prevent this, add noparagraph
:
[[render noparagraph^https://www.dokuwiki.org|<faicon fa fa-euro> Euro Symbol w/o paragraph]]
Complete Options
render | Trigger rendering as Wiki text |
---|---|
noparagraph | Remove any paragraphs from the rendered wiki text |
class=css_class | Override the CSS class of the final link (only one class is allowed) |
target=_blank | Override the link target of the final link |
check | Do an AJAX-call to check the link availability |
Admin Component
The admin component can show an overview on the status of all external links in the wiki. Beware that this might take some time to load on large wiki and it creates a lot of request to your DokuWiki server (one per link!).
Change Log
- [default] Fix a few namespace issues (2019-05-29 12:25)
- Support multiple namespaces in table option (2019-05-28 18:22)
- Remove unnecessary call to mgs() (2019-05-28 18:11)
- Support multiple namespaces and add syntax to list all link statuses (2019-05-28 18:10)
- Update plugin info (2019-01-25 23:54)
- Add admin component for displaying the status of all external links (2019-01-25 23:50)
- Add link checker (2019-01-23 05:25)
- Add possibility to specify CSS class and link target (2015-03-10 23:52)
Limitations
- linksenhanced only supports xhtml output, no other renderer plugin is currently supported.
Discussion
Please use the bug tracker at https://code.rnb-consulting.at/tag/linksenhanced_plugin/