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

---- plugin ----
description: Allows easy linking to a PHPXref generated documentation
author     : Andreas Gohr
email      : andi@splitbrain.org
type       : syntax
lastupdate : 2024-04-30
compatible : Igor, Jack Jackrum
depends    : 
conflicts  : 
similar    : 
tags       : links, code, php, internal

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

This plugin makes linking to a [[https://oracle.github.io/opengrok/|OpenGrok]] generated documentation easy. You can link to functions, constants, variables, classes tables and filenames. The plugin will figure out what you meant automatically.

Please note, that this plugin is created mainly for the needs of dokuwiki.org and may change in behavior any time.

===== Download and Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

==== Changes ====

{{rss>https://github.com/dokuwiki/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 (case-sensitive!):

<code>
  * A function: [[xref>wl()]]
  * A function with arguments [[xref>cleanText($text)]]
  * A global variable: [[xref>$ID]]
  * A class: [[xref>AuthPlugin]]
  * A property: [[xref>cando]], [[xref>canPreventDefault]]
  * A constant: [[xref>AUTH_READ]]
  * 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 function with arguments [[xref>cleanText($text)]], search only for the function name
  * A global variable: [[xref>$ID]]
  * A class: [[xref>AuthPlugin]]
  * A property: [[xref>cando]], [[xref>canPreventDefault]]
  * A constant: [[xref>AUTH_READ]]
  * 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.