xref Plugin

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 dokuwiki.org and may change in behavior any time.

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

• 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)

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:

• A function: wl()
• A function with arguments cleanText($text), search only for the function name
• A global variable: $ID
• A class: AuthPlugin
• A property: cando, canPreventDefault
• A constant: AUTH_READ
• A file: inc/auth.php
• A function with a title: This is an important function

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.