====== xref Plugin ======

---- plugin ----
description: Allows easy linking to a PHPXref generated documentation
author     : Andreas Gohr
email      : andi@splitbrain.org
type       : syntax
lastupdate : 2008-10-03
compatible : 2009-12-25 2011-11-10
depends    : 
conflicts  : 
similar    : 
tags       : links, code, php

downloadurl: http://github.com/splitbrain/dokuwiki-plugin-xref/zipball/master
sourcerepo : http://github.com/splitbrain/dokuwiki-plugin-xref
bugtracker : http://github.com/splitbrain/dokuwiki-plugin-xref/issues
donationurl: http://donate.dokuwiki.org/xref
----

This plugin makes linking to a [[http://phpxref.sourceforge.net/|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:plugin|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 [[https://sourceforge.net/tracker/index.php?func=detail&aid=2144617&group_id=6321&atid=106321|Bug]]. The patch is included in the plugin download or can be obtained from the linked bug page.

==== Changes ====

{{rss>http://github.com/splitbrain/dokuwiki-plugin-xref/commits/master.atom date}}


===== 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:

<code>
  * 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]]
</code>

It looks like this:

  * 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]]

===== Configuration =====

The plugin can be configured through the [[config|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.