Плагин xref

Этот плагин упрощает создание ссылок на документацию, сгенерированную OpenGrok. Вы можете создавать ссылки на функции, константы, переменные, таблицы классов и имена файлов. Плагин автоматически определит, что вы имели в виду.

Обратите внимание, что этот плагин создан в основном для нужд dokuwiki.org и может в любое время изменить свое поведение.

Найдите и установите плагин с помощью Менеджера расширений. Инструкции по ручной установке плагинов см. в разделе «Плагины».

• Version upped (2024/05/02 00:50)
• Merge pull request #10 from Zweihorn/patch-1 (2024/05/01 18:44)
• Update plugin.info.txt (2024/04/30 22:48)
• Version upped (2023/08/09 00:50)
• Automatically use the right class for deprecated ones (2023/08/08 09:40)
• Version upped (2023/08/08 00:50)
• Merge pull request #5 from splitbrain/codesearch (2023/08/07 19:09)
• some automatic cleanup (2023/08/07 18:53)

Синтаксис похож на interwiki - ссылки. Просто начните ссылку с xref>ключевого слова, за которым следует имя функции, константы, переменной, класса, таблицы или файла.

Вот несколько примеров (регистр имеет значение!):

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

Это выглядит вот так:

• 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

Плагин можно настроить через Менеджер конфигурации. Вам необходимо указать, где в файловой системе расположены ваши документы Xref и как к ним можно получить доступ через веб-интерфейс.