This is an old revision of the document!
Table of Contents
xref Plugin
Compatible with DokuWiki
Hrun,Ponder Stibbons
This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.
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 Installation
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.
Changes
- Version upped (2024-05-01 23:50)
- Merge pull request #10 from Zweihorn/patch-1 (2024-05-01 17:44)
- Update plugin.info.txt (2024-04-30 21:48)
- Version upped (2023-08-08 23:50)
- Automatically use the right class for deprecated ones (2023-08-08 08:40)
- Version upped (2023-08-07 23:50)
- Merge pull request #5 from splitbrain/codesearch (2023-08-07 18:09)
- some automatic cleanup (2023-08-07 17:53)
Usage
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
Configuration
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.