Differences

This shows you the differences between two versions of the page.

--- plugin:xref [2015-05-16 23:38] – Aleksandr
+++ plugin:xref [2024-05-01 23:50] (current) – version upped andi
@@ Line 6: / Line 6: @@
 email      : andi@splitbrain.org
 type       : syntax
-lastupdate : 2011-02-15
+lastupdate : 2024-04-30
-compatible : 2009-12-25 2011-11-10
+compatible : Igor, Jack Jackrum
 depends    :
 conflicts  :
 similar    :
-tags       : links, code, php
+tags       : links, code, php, internal
-downloadurl: https://github.com/splitbrain/dokuwiki-plugin-xref/zipball/master
+downloadurl: https://github.com/dokuwiki/dokuwiki-plugin-xref/zipball/master
-sourcerepo : https://github.com/splitbrain/dokuwiki-plugin-xref
+sourcerepo : https://github.com/dokuwiki/dokuwiki-plugin-xref
-bugtracker : https://github.com/splitbrain/dokuwiki-plugin-xref/issues
+bugtracker : https://github.com/dokuwiki/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.
+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.
-===== Download and Installation =====
+Please note, that this plugin is created mainly for the needs of dokuwiki.org and may change in behavior any time.
-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.
+===== Download and Installation =====
-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.
+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/splitbrain/dokuwiki-plugin-xref/commits/master.atom date}}
+{{rss>https://github.com/dokuwiki/dokuwiki-plugin-xref/commits/master.atom date}}
 ===== Usage =====
@@ Line 35: / Line 35: @@
 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:
+Here are a few examples (case-sensitive!):
 <code>
   * A function: [[xref>wl()]]
-  * A variable: [[xref>$USERINFO]]
+  * A function with arguments [[xref>cleanText($text)]]
-  * A class: [[xref>auth_basic]]
+  * 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]]
@@ Line 48: / Line 51: @@
   * A function: [[xref>wl()]]
-  * A variable: [[xref>$USERINFO]]
+  * A function with arguments [[xref>cleanText($text)]], search only for the function name
-  * A class: [[xref>auth_basic]]
+  * 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]]