DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:xref

xref Plugin

Compatible with DokuWiki

  • 2017-02-19 "Frusterick Manners" unknown
  • 2016-06-26 "Elenor Of Tsort" unknown
  • 2015-08-10 "Detritus" unknown
  • 2014-09-29 "Hrun" yes

plugin Allows easy linking to a PHPXref generated documentation

Last updated on
2016-02-03
Provides
Syntax
Repository
Source

Tagged with code, links, php

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

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:

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.

plugin/xref.txt · Last modified: 2016-02-03 18:23 by andi