It's better when it's simple

User Tools

Site Tools


xref Plugin

Compatible with DokuWiki

  • 2024-02-06 "Kaos" unknown
  • 2023-04-04 "Jack Jackrum" yes
  • 2022-07-31 "Igor" yes
  • 2020-07-29 "Hogfather" unknown

plugin Allows easy linking to a PHPXref generated documentation

Last updated on

Tagged with code, internal, links, php

This plugin makes linking to a 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 and may change in behavior any time.

Download and Installation

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.



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!):

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

It looks like this:


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: 2024-05-01 23:50 by andi

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki