xref Plugin

This plugin makes linking to a PHPXref generated documentation easy. You can link to functions, constants, variables, classes tables and filenames. The plugin will figure out what you meant automatically. The XRef documentation needs to be available on the same server as the DokuWiki install running this plugin.

Download and install the plugin using the Plugin Manager using the download link given above. Refer to Plugins on how to install plugins manually.

To make this work, a patch has to be applied to PHPXref to work around a Bug. The patch is included in the plugin download or can be obtained from the linked bug page.

• Added anchor support [[xref>filename#func]] (2011/02/16 20:40)
• fixed URL in README (2011/02/05 11:40)
• README added (2011/02/05 11:36)
• new plugininfo style (2010/06/12 18:06)
• initial checkin (2008/10/03 17:39)

The syntax is similar to interwiki links. Just start your link with the xref> keyword followed by a function, constant, variable, class, table or file name.

Here are a few examples:

  * A function: [[xref>wl()]]
  * A variable: [[xref>$USERINFO]]
  * A class: [[xref>auth_basic]]
  * A file: [[xref>inc/auth.php]]
  * A function with a title: [[xref>cleanID()|This is an important function]]

It looks like this:

• A function: wl()
• A variable: $USERINFO
• A class: auth_basic
• A file: inc/auth.php
• A function with a title: This is an important function

The plugin can be configured through the Configuration Manager. You need to specify where your Xref docs are located in the file system and how they can be accessed from the web.