worldwide open-source software

box

anonymous@undisclosed.example.com (Anonymous) — Sat, 19 Apr 2025 13:50:03 +0000

Плагин Box

Совместим с «Докувики»

2024-02-06 "Kaos" неизвестно
2023-04-04 "Jack Jackrum" неизвестно
2022-07-31 "Igor" неизвестно
2020-07-29 "Hogfather" да

Выделение секций информации с помощью блоков с настраиваемым стилем

Последнее обновление:: 2016-02-17
Предоставляет: Syntax
Репозиторий: исходный код

Похож на note, wrap

Теги: boxes, style

- Christopher Smith

Хотя этот плагин по-прежнему работает нормально, его функциональные возможности включены в плагин Wrap Plugin.

Этот плагин добавляет в DokuWiki блоки, что позволяет выделять особо важные секции в прямоугольниках с настраиваемым стилем, в том числе со скруглёнными углами, Snazzy (разновидность онлайн-открыток с узорным обрамлением), заголовками, настраиваемой шириной (включая процентную). <!– не понятно –> Разметка «ДокуВики» разрешена и внутри блока - там, где все идет хорошо - и внутри заголовка, где следует использовать только текстовую разметку, ссылки, смайлы и тому подобное.

Наиболее часто используемый стиль, вероятно, имеет смысл установить в качестве базового. Подробнее ниже

Заметки

Мою версию этой страницы, которая может быть обновлена совсем недавно, можно найти здесь
- 24.09.2009 эта ссылка не работает :(
- 28.10.2009 эта ссылка, кажется, теперь работает
- 13.12.2009 опять битая :(
- 30.01.2010 Скопирован и вставлен ниже код в style.css и syntax.php (./plugins/box/ ..). Работает с последней версией Lemming.

Благодарности

Закругленные углы основаны на snazzy borders от Stu Nicholls из CSS Play, который, в свою очередь, был вдохновлён nifty corners от Alessandro Fulciniti. До развития CSS до 3 версии не было более практичного способа красивой стилизации. В настоящее время в GitHub имеются правки плагина, вводящие более простые CSS 3 - решения. <!– проверено до сюда –>

Синтаксис

Простой box:

<box> содержимое </box>

Ещё несколько сложных box'ов:

<box 80% round orange|заголовок> Содержимое</box>
<box 50% left blue>Содержимое</box|подпись>
<box 60% round #f99 #fc9 #fcc #f60|заголовок>Содержимое</box|подпись>

Полный синтаксис:

<box width classes colours | текст заголовка> содержимое </box>

width — любое допустимое значение ширины
classes — любое количество классов, которые используют стили в вашем шаблоне или собственную таблицу стилей плагина для определения внешнего вида коробки. Плагины коробки поставляются со следующими уже определенными классами:
- round — у коробки будут закругленные углы
- blue — синяя цветовая гамма
- red — красная цветовая гамма
- green — зеленая цветовая гамма
- orange — оранжевая цветовая гамма
- left — переместить поле влево на странице вики
- right — разместить поле прямо внутри вики-страницы

Если классы не указаны, будут использоваться стили по умолчанию, то есть квадратные углы в цветовой схеме, основанной на цветовой схеме «ДокуВики» по умолчанию.

colours — 1–4 цвета в шестнадцатеричном формате CSS или RGB, например: #F00 #fcab94 rgb(255,255,0). Цвета применяются для того, чтобы изменять:
1. фон содержимого
2. фон заголовка
3. внешний фон коробки
4. границы

если указано менее четырех цветов, первый цвет используется для отсутствующих цветов.

текст заголовка — текст (включая разметку «ДокуВики»), отображаемый над содержимым поля, с отличным стилем.
подпись — текст (без разметки), отображаемый под содержимым поля, с отличным стилем.

Открытие <box … > включая заголовок, должно быть в одной строке. Содержимое box'ов может занимать столько строк, сколько необходимо.

Посмотрите, как работает плагин здесь. На странице-образце показаны все стили, доступные в плагине.

Конфигурация

Плагин не имеет настроек конфигурации, хотя вы можете проверить цветовую схему по умолчанию в style.css чтобы убедиться, что она подходит для вашей вики.

Установка

Найдите и установите плагин с помощью Extension Manager.

В качестве альтернативы см. Plugins чтобы узнать, как установить плагины вручную. Чтобы установить плагин вручную, загрузите исходный код в папку плагина lib/plugins чтобы узнать, как установить плагины вручную. Чтобы установить плагин вручную, загрузите исходный код в папку плагина lib/plugins/box, и установите плагин.

Источники:

Текущее: zip format (6k), формат tar.gz (5k)
Предыдущие версии «ДокуВики»:
- для «ДокуВики» 2006-03-xx zip format (5k), tar.gz format (4k) ТРЕБУЕТСЯ security fix 2
- для «ДокуВики» 22 сентября 2005 г. zip формат (4k), tar.gz format (3k) ТРЕБУЕТСЯ security fix

Список изменений

11.11.2008 — Добавить print.css, изменить URL плагина + другие мелкие изменения
2008-03-03 — Исправление безопасности + добавлена поддержка указания цветов в синтаксисе поля
2006-04-25 — исправлена XSS-уязвимость
2006-04-20 — только обновление darcs
- встроенная разметка обновлена с исправлениями DokuWiki для блока PType
- исправления в описании синтаксиса
- незначительные изменения стиля для высот линий
2006-03-11 — 2006-01-24 Патч применен к не-darcs пакету;
- добавлена поддержка всех единиц длины CSS
- стили добавлены для поддержки вложенности боксов
- списки теперь можно включать в коробки
24.01.2006 — только обновление darcs (выпуск пакета состоится до следующего обновления «ДокуВики»)
- поддержка вложенности ящиков
- стиль по умолчанию теперь использует подстановки CSS «ДокуВики»
2005-11-25 — Добавлен текст заголовка (отображается под содержимым основного окна). Добавлены левые и правые стили.
2005-10-25 — Исправлена ошибка, связанная с объединением абзацев в боксы (спасибо, Матиас).
2005-10-17 — Исправлена ошибка в некоторых установках PHP для Windows (спасибо Пабло).
2005-10-12 — Выпущено.

Исправление безопасности

Это исправление применимо только к тем, кто использует подключаемый модуль box'ов более старых версий с версиями «ДокуВики» до марта 2006 г. Те, кто использует «ДокуВики» от марта 2006 г. или более позднюю версию, должны обновить подключаемый модуль, используя приведенные выше списки sources.

Также примените Исправление № 2, описанное ниже.

Инструкции

найдите файл lib/plugins/box/syntax.php
откройте его для редактирования в текстовом редакторе

замените функцию _boxstyle($str) (около строки #150) приведенным ниже кодом.

    function _boxstyle($str) {
      if (!strlen($str)) return array();
 
      $styles = array();
 
      $tokens = preg_split('/\s+/', $str, 9);                      // limit is defensive
      foreach ($tokens as $token) {
          if (preg_match('/^\d*\.?\d+(%|px|em|ex|pt|cm|mm|pi|in)$/', $token)) {
            $styles['width'] = $token;
            continue;
          }
 
          // restrict token (class names) characters to prevent any malicious data
          if (preg_match('/[^A-Za-z0-9_-]/',$token)) continue;
          $styles['class'] = (isset($styles['class']) ? $styles['class'].' ' : '').$token;
      }
 
      return $styles;
    }

сохраните файл

Этот скрип ограничивает символы, доступные для использования в именах любых настраиваемых стилей, буквенно-цифровыми символами, а также тире и подчеркиванием (например A-Z, a-z, 0-9, _ -). Он также обновляет определение ширины поля для поддержки любого допустимого значения длины CSS . Смотрите подробности в синтаксисе.

Исправление безопасности 2

Это исправление применяется ко всем версиям плагина до 3 марта 2008 г. Рекомендуется, чтобы пользователи плагина обновили DW и этот плагин до самых последних версий. Для тех, кто желает исправить уязвимость без обновления.

          case 'box_close' : 
            $renderer->doc .= "</div>\n";
 
            if ($data) { 
-              $renderer->doc .= "<p class='box_caption'>".$data."</p>\n";
+              $renderer->doc .= "<p class='box_caption'>".$renderer->_xmlEntities($data)."</p>\n";
            }
            $renderer->doc .= $this->_xhtml_boxclose(); 
            break;

Спасибо Энди Уэбберу из группы этического взлома Oracle за обнаружение этого недостатка. — Christopher Smith 2008-03-03 17:46

Что нужно сделать

Ошибки

Боксы могут перекрывать оглавление вверху страницы. Требуется исправление CSS .

Ошибка рендеринга в IE 6.0 - Запуск плагина box с шаблоном круглого box. Прокрутка (или, если поле достаточно велико, просто обновляется страница) иногда приводит к тому, что строки / блоки поля не обновляются, оставляя цвет фона на дисплее. Удалось воспроизвести проблему на домашней странице box'а «ДокуВики»здесь. Плохая область кажется больше, если прямоугольник больше (в нем больше текста). — Jonathan Alexander 2005-12-06 14:49

Нашел исправление, которое, кажется, работает для меня от communitymx (спасибо Google) просто вставил код ниже под объявлением «div.box .box_content» в style.css выше.

/* Hides from IE5-mac \*/
* HTML .div.box.box_content {height: 1%;}
/* End hide from IE5-mac */

Отсутствуют </p>s (больше W3C-предупреждений):

<box>
foo

bar
</box>

приводит к этому HTML:

<div class='box_content'><p> foo
<p>
bar 
</p>
</div>

как видите, одного </p> не хватает. — Bernd Zeimetz 2007-03-03 02:39 CET
Решение CET: измените две строки в рендере функции (рядом с 'box_open'):

--- syntax.php  2008-02-27 23:44:08.000000000 +0100
+++ syntax.php.new  2008-02-27 23:55:23.000000000 +0100
@@ -129,9 +129,9 @@
           case 'box_open' :   
             if ($this->title_mode) {
                 $this->title_mode = false;
-                $renderer->doc .= "</p>\n<div class='box_content'><p>";
+                $renderer->doc .= "</p>\n<div class='box_content'>";
             } else {
-                $renderer->doc .= $this->_xhtml_boxopen($data)."<div class='box_content'><p>";
+                $renderer->doc .= $this->_xhtml_boxopen($data)."<div class='box_content'>";
             }
             break;

строки, начинающиеся с «-» являются исходными строками, строки «+»- новыми. — Stefan Kuchling

Этот патч добавлен в последнюю версию плагина. Спасибо Бернд и Стефан за ваши усилия. — Christopher Smith 2008-03-03 17:46

Подсказки

Альтернативный синтаксис и разрешающая разметка в подписях

Отличный плагин! Я изменил свою копию и подумал, что другим может быть интересно. Смотреть пример.

Изменения:

Изменен синтаксис: <<< width classes | title ::: content ::: caption >>>
Разметка разрешена в подписях
Заголовок и подпись могут занимать несколько строк (т. е. несколько абзацев).
Ширина может быть указана в %, px, em или ex (теперь включено в версию выпуска)

Возможность разместить разметку в подписи хороша, когда вы хотите привлечь внимание к примечанию, скажем, об альтернативной версии какого-либо программного обеспечения - это выглядит очень хорошо, если в подписи есть ссылка для скачивания.

Он хорошо работает на моем сайте, и единственная проблема, с которой он, кажется, заключается в том, что я не могу вкладывать box'ы (не знаю почему).

Полный код см. в разделе: Модифицированные Box'ы

— Robert Meerman 2006/02/24 17:13

Привет, Роберт! Вы пробовали свой синтаксис с патчем вложенности, я кратко посмотрел на ваш код и не увидел ничего, что должно препятствовать вложению. Ура — Christopher Smith 2006-02-24 19:26

Backporting на 2005-07-13

Вот что я сделал для резервного копирования этого плагина в выпуск 2005-07-13.

Добавьте style.css tв конец вашего шаблона design.css и print.css:

$ cd .../lib/plugins/box
$ cat style.css >> ../../tpl/template_name/design.css
$ cat style.css >> ../../tpl/template_name/print.css

Примените следующий патч:

--- box-orig/syntax.php 2005-11-24 13:28:17.000000000 -0800
+++ box/syntax.php      2005-12-16 14:52:48.000000000 -0800
@@ -45,6 +45,19 @@
 
     function getType(){ return 'container';}
     function getAllowedTypes() { return array('container','substition','protected','disabled','formatting','paragraphs'); }
+
+    function syntax_plugin_box(){
+        global $PARSER_MODES;
+        $this->allowedModes = array_merge(
+            $PARSER_MODES['container'],
+            $PARSER_MODES['substition'],
+            $PARSER_MODES['protected'],
+            $PARSER_MODES['disabled'],
+            $PARSER_MODES['formatting'],
+            $PARSER_MODES['paragraphs']
+        );
+    }
+
     function getPType(){ return 'normal';}
     
     // must return a number lower than returned by native 'code' mode (200)
@@ -54,9 +67,9 @@
      * Connect pattern to lexer
      */
     function connectTo($mode) {       
-      $this->Lexer->addEntryPattern('<box>(?=.*?</box.*?>)',$mode,'plugin_box');
-      $this->Lexer->addEntryPattern('<box\s[^\r\n\|]*?>(?=.*?</box.*?>)',$mode,'plugin_box');
-      $this->Lexer->addEntryPattern('<box\s[^\r\n\|]*?\|(?=[^\r\n]*?>.*?</box.*?>)',$mode,'plugin_box');      
+      $this->Lexer->addEntryPattern('<box>(?=.*?\x3C/box.*?\x3E)',$mode,'plugin_box');
+      $this->Lexer->addEntryPattern('<box\s[^\r\n\|]*?>(?=.*?\x3C/box.*?\x3E)',$mode,'plugin_box');
+      $this->Lexer->addEntryPattern('<box\s[^\r\n\|]*?\|(?=[^\r\n]*?>.*?\x3C/box.*?\x3E)',$mode,'plugin_box');      
     }
     
     function postConnect() {
@@ -182,4 +195,4 @@
     
 }

Более подробный CSS с дополнительными параметрами цвета

Это очень удобный плагин! Я начал экспериментировать с CSS, чтобы сделать некоторые нестандартные вещи (я собираюсь использовать этот плагин в 3-4 установках «ДокуВики»), а именно, чтобы скрыть внутреннюю границу и пару других небольших настроек цвета. В итоге я получил кое-что, что, на мой взгляд, было бы более гибко изменять (отдельные определения для отдельных границ), больше прокомментировал (я попытался отметить некоторые разделы немного лучше) и, возможно, более дружественный к IE (я думаю, что исправил проблему с тем, что один из цветов фона не отображается в IE 6).

Я не эксперт в области CSS , поэтому не могу гарантировать, что сделал это на 100% эффективно, но он работает со всеми браузерами, которые поддерживает browsershots.org.

CSS можно увидеть здесь: http://wiki.ryanjacobs.name/public/tech/dokuwiki_box_plugin_css

Если кому-то интересно… Ура! — Ryan Jacobs

Добавить поддержку экспорта ODT

Это добавляет базовую поддержку OpenOffice/ODT экспорт плагина; нет цветов; без выравнивания, без причудливого форматирования; но излучается основной контент.

$ diff -u syntax.php.dist syntax.php
--- syntax.php.dist        2009-06-22 06:45:22.000000000 +0100
+++ syntax.php        2009-06-24 12:55:14.000000000 +0100
@@ -157,6 +157,45 @@
         }

         return true;
+      } elseif($mode == 'odt'){
+          switch ($instr) {
+          case 'title_open' :
+            $this->title_mode = true;
+            $renderer->table_open(1);
+            $renderer->tablerow_open();
+            $renderer->tableheader_open(1, "left");
+            break;
+
+          case 'box_open' :
+            if ($this->title_mode) {
+              $this->title_mode = false;
+              $renderer->tableheader_close();
+              $renderer->tablerow_close();
+              $renderer->tablerow_open();
+              $renderer->tablecell_open();
+            } else {
+              $renderer->table_open(1);
+              $renderer->tablerow_open();
+              $renderer->tablecell_open();
+            }
+            break;
+
+          case 'data' :
+            $renderer->doc .= $renderer->cdata($data);
+            break;
+
+          case 'box_close' :
+            $renderer->tablecell_close();
+            $renderer->tablerow_close();
+            $renderer->table_close();
+            if ($data) {
+              $renderer->p_open('legendcenter');
+              $renderer->doc .= $renderer->cdata($data);
+              $renderer->p_close();
+            }
+            break;
+        }
+        return true;
       }
       return false;
     }

Обсуждение

Спасибо за плагин. У меня вопрос, могу ли я что-то сделать, чтобы сохранить пустую строку в исходном тексте без использования синтаксиса '\\' или любого другого редактирования исходного текста? Спасибо и пока — pronto 2014-07-30 11:31

Спасибо за плагин, выглядит действительно здорово. Однако я хочу использовать его для выделения различного контента. Например, я хотел бы использовать <math>, чтобы выделить математику. Как мне изменить источник для синтаксического анализа другого класса CSS на <math>?

Вам нужно изменить базовый шаблон (в connectTo и postConnect) на математический из окна. Для каждого другого шаблона выхода вам понадобится другой плагин, поэтому необходимо изменить имя плагина и ссылки на него в connectTo и postConnect. Лучше всего использовать <box math>… </box>, <box somethingelse> … </box> и настроить / добавить имена стилей так, чтобы соответствующие цвета и углы отображались для конкретного имени. — Christopher Smith 2005-10-29 10:07

Вместо того, чтобы использовать множество различных предопределенных стилей, как насчет использования синтаксиса, аналогичного цветовому плагину phpBB, и позволить пользователю точно определять свой выбор цветов? — ta' Lajzar 2005-10-30 02:16

Может быть. Я не хотел определять стили как цвета. Было бы лучше выбирать имена стилей семантически, например, ошибка, предупреждение, информация, синтаксис, формулы, предупреждение и т. д. Однако значение каждого стиля блока, вероятно, изменится от вики к вики, поэтому я дал им нейтральные, но информативные имена. Для всего этого я рассмотрю возможность добавления необязательного синтаксиса для тех, кто этого хочет. — Christopher Smith 2005-10-30 10:39
Но если люди используют блоки на странице, то есть included, они могут так же легко получить семантический контекст, и это сохраняет дополнительную гибкость свободно определяемых цветов для синтаксиса блока. — ta' lajzar 2005-10-31 07:27

В последнюю версию добавлена индивидуальная цветовая спецификация. — Christopher Smith 2008-03-03 17:46

Код, возвращаемый плагином, на самом деле не является стандартным XHTML, потому что все теги B пусты. Чтобы исправить это, вы должны написать & nbsp; во всех тегах b в строках

$html .="  <b class='xtop'><b class='xb1'></b><b class='xb2'></b><b class='xb3'></b><b class='xb4'></b></b>\n";
//and
$html .= "  <b class='xbottom'><b class='xb4'></b><b class='xb3'></b><b class='xb2'></b><b class='xb1'></b></b>\n";

Насколько мне известно, стандарт xhtml не возражает против пустых элементов (см. http://www.w3.org/TR/xhtml1/#C_3 и валидатор w3c не помечает их как ошибку или предупреждение. — Christopher Smith 2005-10-31 15:17

Плагин Box у меня не работает. Я выполняю новую установку «ДокуВики» 09.03.2006 без каких-либо других правок, плагинов или шаблонов. Плагин Box был установлен через менеджер плагинов. http://www.ssdonline.us/wiki/doku.php?id=wiki:playground — Scott Mouser

Плагин работает, стили не подхватываются. Я добавил комментарий и несколько идей на страницу вашей игровой площадки. — Christopher Smith 2006-03-24 01:22
;;>Спасибо. Очистка кеша - это именно то, что нужно для работы. Я не видел этого где-либо еще. Я продолжу и отправлю отчет об ошибке, потому что вы правы, .css должен был быть восстановлен после установки плагина. — Scott Mouser

В «ДокуВики» и диспетчер плагинов внесены исправления, позволяющие истечь срок хранения кеша и гарантировать, что новый CSS будет сгенерирован после установки любого плагина. — Christopher Smith 2006-04-19 03:14
~~Может кто-нибудь опубликовать ЗДЕСЬ, как очистить кеш, потому что www.ssdonline.us похоже, не работает.~~
Я уже разобрался с этим, а для всех остальных используйте плагин Cache and Revisions Eraser!

—-

Этот плагин имеет XSS-уязвимость!

Попробуйте это в IE:

<box ' style="background-image:url(javascript:alert('bla'))">
  XSS test
</box>

Это исправление работает для меня (строки 160-168):

      foreach ($tokens as $token) {
          if (preg_match('/^\d*\.?\d+(%|px|em|ex|pt|cm|mm|pi|in)$/', $token)) {
            $styles['width'] = $token;
            continue;
          }
	  $token = trim(ereg_replace('[^a-zA-Z0-9_-]','',$token));            // <<-- this is new line
          $styles['class'] = (isset($styles['class']) ? $styles['class'].' ' : '').$token;
      }

Спасибо. Обновлены основные скрипты и источники плагинов. Также см.Исправление безопасности. — Christopher Smith 2006-04-25 18:17.

Обновление плагина незаметно перезаписывает style.css. Есть ли решение с сохранением в локализованном style.css? Например, каталог локализации, который перекрывает любые свойства CSS ? Спасибо. — Burt Rosenberg 2006-05-22 02:56

Как насчет ./conf/userstyle.css? Кажется, это работает. Теперь, чтобы выяснить макрос url () при обработке файла .css — Burt Rosenberg 2006-05-22 04:12

Я хотел бы использовать ===== Level 2 Headline ===== внутри <box>…</box>. Как я могу это сделать? Заранее спасибо.

В настоящее время вы не можете, по крайней мере, не напрямую. Должна быть возможность использовать синтаксис include плагина внутри box'а. Включенная страница будет отображаться внутри box'а.

Note: It would be best to use my альтернативный include плагин поскольку он не пытается объединить включенную страницу в структуру раздела текущей страницы, что может дать неожиданные результаты. — Christopher Smith 2006-06-16 01:41

Это именно то, что я сделал, но я не знал о вашей «альтернативной» версии плагина include, поэтому я взломал исходную :)

Похоже, что слой для блока закрывает блок оглавления, если <box></box> в первом или двух абзацах (содержание, конечно, зависит).

Да. Я добавил это в баги. Я предполагаю, что исправление CSS требуется либо для TOC, либо для коробки. — Christopher Smith 2006-07-04 23:42

Я думаю, вы должны упомянуть, что плагин будет работать только в том случае, если в конфигурации «ДокуВики» включен параметр «Разрешить встроенный HTML» . Я просто потратил целую вечность, задаваясь вопросом, почему я не могу заставить его работать, пока не понял это. — madra 2006-08-05

Не требует включения «Разрешить встроенный HTML ». Однако при редактировании файлов конфигурации вики истечет срок действия всех кешей «ДокуВики», что вызовет регенерацию страниц и CSS . И то, и другое необходимо для появления box'ов. Как упоминалось выше, это известная ошибка, исправленная в release 2006-11-06 & и предыдущих выпусках-кандидатах.

<box 90% green round>
У меня небольшая проблема с коробками, и мне было интересно, может ли кто-нибудь мне помочь? Когда я помещаю рамку на страницу и пытаюсь поставить некоторый интервал для новых строк после рамки с обычной разметкой, кажется, что она отображается неправильно. Текст всегда отображается справа от поля, что бы я ни пытался.
Я также заметил, что на этом сайте, похоже, нет необходимости использовать типичную разметку для новой строки. Это почему?
</box>

Ящики, стилизованные влево или вправо, перемещаются. Очищенный элемент должен появиться после поля, чтобы не допустить появления следующего содержимого рядом с ним. Возможно, вам удастся что-то поработать с плагином div / span. Я не уверен, что вы имели в виду в своем последнем предложении. Вам нужно только использовать
для одиночного разрыва строки в абзаце или для добавления дополнительных разрывов строки между абзацами. — Christopher Smith 2006-08-15 09:33

Благодарим вас за обновление, Крис, но я не уверен, что вы имеете в виду под очищенным элементом? Значит, без плагина div / span нет способа решить проблему?

Вы также можете использовать clearfloat плагин (ищите его в plugins). Другие предлагали делать это через entities (к сожалению, я нигде не нашел такого предложения). Просто поставьте что-то вроде этого
~CL~    <br style="clear: both;" />
в conf/entities.conf и используйте ~CL~ после каждого соответствующего box'а. (Лучше использовать защиту от обновлений conf/entities.local.conf, и добавлять такие строки, как

<hr> <hr /> <br> <br /> <hrr> <hr style=«clear:both» /> <brr> <br style=«clear:both» /> — dr-yukon 2020-09-06 14:32)

Что насчет | до и после текста?

Спасибо за отличный плагин. Мне очень нравятся коробки . У меня есть одно предложение / отчет об ошибке. Кажется, что текущая реализация ящиков не любит вложенные ящики. Например, хотелось бы иметь что-то подобное.

  <box round 840px>
    <box round 120px left>{{xvdm:module:apdf:2d-apdf-overview-1.jpg?100|}}</box| Initial Partition>
    <box round 120px left>{{xvdm:module:apdf:2d-apdf-overview-2.jpg?100|}}</box| 1st Iteration>
    <box round 120px left>{{xvdm:module:apdf:2d-apdf-overview-3.jpg?100|}}</box| 2nd Iteration>
    <box round 120px left>{{xvdm:module:apdf:2d-apdf-overview-4.jpg?100|}}</box| 3rd Iteration>
    <box round 120px left>{{xvdm:module:apdf:2d-apdf-overview-5.jpg?100|}}</box| 4th Iteration>
    <box round 120px left>{{xvdm:module:apdf:2d-apdf-overview-6.jpg?100|}}</box| 5th Iteration>
  </box| Creation of the APDF Tree>

Если я это сделаю, я получу перекрывающиеся box'ы. Однако, если я это сделаю:

<box round 840px>
<html>
<table><tr><td></html>
<box round 120px left>{{xvdm:module:apdf:2d-apdf-overview-1.jpg?100|}}</box| Initial Partition>
<box round 120px left>{{xvdm:module:apdf:2d-apdf-overview-2.jpg?100|}}</box| 1st Iteration>
<box round 120px left>{{xvdm:module:apdf:2d-apdf-overview-3.jpg?100|}}</box| 2nd Iteration>
<box round 120px left>{{xvdm:module:apdf:2d-apdf-overview-4.jpg?100|}}</box| 3rd Iteration>
<box round 120px left>{{xvdm:module:apdf:2d-apdf-overview-5.jpg?100|}}</box| 4th Iteration>
<box round 120px left>{{xvdm:module:apdf:2d-apdf-overview-6.jpg?100|}}</box| 5th Iteration>
<html></td></tr></table></html>
</box| Creation of the APDF Tree>

Тогда получается то, чего можно было ожидать. Скорее всего, моя работа дает совершенно неверный HTML- код, хотя Firefox показывает довольно хорошие результаты

Пожалуйста, добавьте print.css. Мне нужно не очень много контента, просто div.box.left{float:left} так. В настоящее время серия изображений <box 20% left>…</box> выглядит довольно странно в режиме печати и занимает много листов без поплавка: left. — Viktor Söderqvist 2007-02-28 05:06

Добавлен — Christopher Smith 2008/11/11 06:26

Переключатель для очистки плавающих элементов будет хорошим вариантом, поскольку я обычно не предпочитаю обтекать поле текстом. Единственный раз, когда я разрешил перенос текста, - это когда мои поля находятся рядом с ToC. Я жестко запрограммировал некоторую очистку с плавающей запятой, поскольку я обычно не хочу, чтобы текст обтекал поля, однако это может испортить ToC Div. Следовательно, переключение было бы здорово.

Это создает плохой XHTML, по-видимому, в div box_content отсутствует закрытие </p>

исправить?

143 $renderer->doc .= "</p></div>\n";
</p> was missing

Привет - Спасибо за отличный плагин. У меня проблемы с рамками и подписями при печати. Я скопировал plugins / box / style.css → plugins / box / print.css, и он работает, но когда я добавляю заголовок вверху, между верхней частью поля и заголовком вставляется дополнительная строка. Я использую шаблон монокниги.Щелкните, чтобы увидеть пример на моей вики-площадке. Буду очень признателен за любые предложения. —Tobias (5/10/2007)

Хороший плагин. Мне интересно, можно ли сделать так, чтобы заголовок работал как заголовок, где в него можно встроить ссылки?

Привет, у меня много ссылок. Я часто копирую и вставляю. Можно ли сохранить возврат каретки и избежать добавления вручную «\\» в конце каждой новой строки? Тогда как хороший плагин.

Я заметил, что когда я копирую код третьего поля http://wiki.jalakai.co.uk/dokuwiki/doku.php/test/boxes и вставляю сюда (или в мою «ДокуВики»), текстовое поле находится только на одном линия. Я не включаю подпись

<box green > this is
also 
boxed
</box|boxed & captioned>

e.g. <box green > this is also boxed </box|boxed & captioned>

На вашей тестовой странице текстовое поле состоит из 3 строк. Почему на вашей странице 1 строчка, а у вас - 3 строчки? Я копирую и вставляю точно такой же исходный код. На вашей странице сохраняется возврат каретки.
Как я могу вести себя так же? Так что я смогу скопировать и вставить, сохраняя CR.

Да. См. Плагин разрыва строки — Christopher Smith 2007-07-26 13:08
Также см. Рендеринг разрыва строки — Christopher Smith 2008/11/11 06:26

Привет Крис, Очень красивые и полезные эффекты. Есть мысли о добавлении значка в строку заголовка?
См., например, http://www.headshift.com/
Я просто не понимаю, как они это сделали!
С уважением, Peter Chan 2007-10-02

Привет, я пытаюсь использовать коробки в последней версии «ДокуВики» (2006-06-26b), но, похоже, это не работает. Единственное поведение плагина, которое мне удалось определить, - это разметка в заголовках. Если я выделю заголовок жирным шрифтом, он отобразит звездочки. Если бы плагин просто нюхал, не сработала бы разметка? Почему это не сработает? Спасибо. Рик Рейнольдс 16 января 2008 г.

В настоящее время форматирование субтитров не поддерживается. Однако модифицированный плагин боксов, в котором используется немного другой синтаксис, позволяет форматировать подписи. См. Ссылки выше. — Christopher Smith 2008-03-03 17:46
Это верно, но box_mod не обновлен для поддержки DokuWiki 2008-05-05: небольшие ошибки макета, особенно когда на странице больше одного поля… По моему опыту, <box> работает гораздо более плавно. Gijs van Gemert

У меня это начало работать, когда я перешел на шаблон dokucms. С шаблоном по умолчанию у меня это не сработает. 2008-02-11

Можно ли добавить поддержку абсолютной (или минимальной) высоты ящиков? Я пробовал делать это сам, но моих знаний PHP и CSS недостаточно для реализации этого.

Да, теперь есть поддержка высоты. Проверьте мой модифицированный плагин: boxwh плагин

—- Есть ли шанс разрешить изменение цвета текста (поскольку черный цвет на темных цветах часто нечитаем)? Боб 4 апреля 2008 г.

Я заметил, что необходимо очистить кеш, чтобы можно было вставить инструкции CSS нового плагина :

Я последовал советам « ДокуВики» по caching (кешированию),
Я коснулся conf / local.php, отредактировал и сохранил …
Я выбрал встроенный HTML в форме конфигурации

тем не менее, в моем листе CSS нет инструкции CSS div.box , и поле не отображается должным образом. Наконец-то я обнаружил проблему с разрешением файла:

ls -l box/style.css
-rwx------ 1  box/style.css

это нужно исправить в archive.tgz?

Спасибо за этот плагин. Я сделал небольшое изменение в трех строках в syntax.php, чтобы создать XHTML-совместимый документ. (Это просто некоторые пропущенные символы…)

(line 133)  $renderer->doc .= $this->_xhtml_boxopen($data)."<p class='box_title' {$this->_title_colours}>";
...
(line 139)  $renderer->doc .= "</p>\n<div class='box_content' {$this->_content_colours}>";
...
(line 153)  $renderer->doc .= "<p class='box_caption' {$this->_title_colours}>".$renderer->_xmlEntities($data)."</p>\n";

Добавьте пробел между class='box_title' и {$this→_title_colours}
Добавьте пробел между class='box_content' и {$this→_content_colours}
Добавьте пробел между class='box_caption' и {$this→_title_colours}

—ZebulonT – 2009-07-05 16:37

У меня новая версия dokuwiki (Муравьед). Плагин Box теперь помещает еще один </div> в конец поля и уничтожает все оставшиеся макеты и стили. Это ошибка плагина box или самой dokuwiki? Pletiplot – 2010-12-20

Пожалуйста, исправьте свой CSS .

Правило @CHARSET «UTF-8»; в вашем print.css недопустимо.

— flam 2011/01/05 12:03

Можно ли добавить к нему кнопку закрытия, чтобы использовать ее как уведомление?

Плагин Box не может правильно работать с плагином Include. Обычно Box хранит любой контент в формате div.box div.xbox div.box_content. Но Include вставки выпадают в div.box div.xbox. Возможно, это из-за неправильного состояния getType и / или getPType. — dr-yukon 2019-01-03 13:26

Базовый движок «Докувики» работает с изображениями только в пикселях. Этот плагин можно использовать как процентное увеличение. Добавьте

div.box.img > .xbox > .box_content > a > img {
	width: 100%;
	width: -moz-available;
	width: -webkit-fill-available;
	width: stretch;
}

в /lib/plugins/box/style.css и опишите как <box center img 90%>{{your image}}</box> для увеличения на экране — dr-yukon 2020-09-06 14:37

Дополнения и Файлы

blogging

anonymous@undisclosed.example.com (Anonymous) — Mon, 26 Aug 2024 05:50:34 +0000

Блог на «Докувики»

Страница в РАЗРАБОТКЕ! Если вы видите, что можно добавить, добавляйте без сомнения!

Несмотря на то, что блоги не является основным предназначением «Докувики», есть немало плагинов, позволяющих превратить «Докувики» в полноценную платформу для блога.

На этой странице приведены основные шаги, благодаря которым можно начать деятельность блоггера на движке «Докувики». Здесь также можно узнать, как обойти возможные проблемы.

Желающие найти существующие блоги на основе «Докувики» могут посетить Planet DokuWiki, или воспользоваться поиском: inurl:doku.php+inurl:blog.

Необходимые плагины

В первую очередь стоит поставить несколько плагинов. Основной «набор блоггера» составляют blog, include и pagelist. Они составляют необходимый минимум.

В дополнение к необходимым можно добавить discussion, linkback, bloglinks, feedmod, avatar и tag.

Основная масса этих плагинов зависит друг от друга. В помощь начинающим существует Blogsuite Bundle Hub. Ссылка не действует! ответ 404 Здесь можно взять самое необходимое в виде одного архива и установить посредством центра управления плагинами (Внимание плагины в пакете могут быть устаревшими, следите за версиями).

Настройка

Индивидуальный блог

В этом случае у нас только один пользователь, и один блог, который нужно вести. В настройках блога можно указать пространство имён, в котором будут сохранены записи. По умолчанию там указано :blog, и этого вполне достаточно для большинства.

Перед созданием блога следует решить, какая страница будет «лицом» блога, и создать её. Если хочется, чтобы блог был на стартовой странице, то ей будет :start. На ней следует разместить синтаксическую вставку блога и сохранить.

{{blog>?5}}

Эта вставка отобразит 5 последних записей в блоге. Раз это индивидуальный блог, нет необходимости указывать, из какого пространства имён следует брать записи. Но перед добавлением первой записи следует обратить внимание на пункт конфигурации dateprefix. При помощи него можно указать, под какими именами будут создаваться новые записи. Достаточно удачной установкой может послужить %Y:%m%d_. Если вы назовёте запись «Мой новый блог», то страница будет создана под именем blog:2008:0512_мой_новый_блог. Как видно из примера, это позволяет держать пространство имён блога в порядке.

Чтобы другие не могли редактировать ваш блог, следует обратиться к ACL и назначить там несколько правил (для примера — блог на стартовой странице).

start    @ALL 1
start    вашник 16
blog:*   @ALL 1
blog:*   вашник 16

Многопользовательский

Это случай, когда мы хотим разрешить пользователям вести свои блоги. Для этого каждый пользователь должен обзавестись своим собственным пространством имён для блога, где только он может распоряжаться содержимым. Для примера возьмём трёх пользователей: Васю, Петю и Машу. Каждый пользователь получает собственное пространство в пространстве :blog и собственную страницу с лентой там же. Теперь нужно установить права доступа для каждого (к примеру, для Васи):

blog:вася    @ALL 1
blog:вася:*  @ALL 1
blog:вася    joey 16
blog:вася:*  joey 16

Now you have to create the page :blog:joey and insert the following blog plugin syntax to setup the blog. После этого следует создать страницу пользователю :blog:вася, куда поместить вставку для блога.

{{blog>blog:вася?5}}

То же самое надо повторить для всех остальных пользователей. После этого каждый может начать вести блог.

Настройка новостной ленты

Одной из важнейших вещей в блоге является RSS-лента. «Докувики» автоматически создаёт все виды лент, однако может потребоваться настроить одну ленту специально для блога.

Примечание: С тех пор как «Докувики» стал создавать полноценный HTML в лентах, не рекомендуется использовать плагин feed (хотя он всё ещё полезен для обсуждений).

URL новостной ленты

Необходимо несколько параметров, чтобы создать RSS-ленту. Первый, и самый необходимый — ns, который ограничит ленту только записями в блоге. Не стоит в RSS давать стартовую страницу — так вы получите все записи в виде одной записи в ленте!

Вот пример простого адреса ленты:

http://www.example.com/feed.php?ns=blog&num=10

Следует также убедиться, что ссылки на ней ведут к актуальной версии страницы. Это можно установить в настройках или передать в внутри адреса:

http://www.example.com/feed.php?ns=blog&num=10&linkto=current

Также вполне возможно, следует включить HTML в ленте:

http://www.example.com/feed.php?ns=blog&num=10&linkto=current&content=html

Красивые адреса лент посредством .htaccess

Если включено переписывание адресов посредством .htaccess, то можно добавить специальные правила и получить красивые адреса для лент. Правило для приведённого выше адреса будет выглядеть следующим образом:

RewriteRule ^_feed/(.*) feed.php?ns=$1&num=10&linkto=current&content=html [QSA,L]

Его можно добавить рядом с правилом для _export.

Теперь ленту можно получить по адресу http://yourdomain.org/_feed/blog.

Автоматическое обнаружение лент

Браузеры могут сами обнаруживать RSS-ленты, анализируя специальные метаданные в HTML. По умолчанию «Докувики» предоставляет стандартные ленты сам. В нашем случае предпочтительнее отключить стандартные, а добавлять только собственно ленту блога. Это можно сделать, исправив в используемом шаблоне оформления main.php. Вот пример заголовка:

<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <title><?php tpl_pagetitle()?> [<?php echo strip_tags($conf['title'])?>]</title>
 
  <?php tpl_metaheaders(false)?>
  <link rel="alternate" type="application/rss+xml" title="Blog" href="/feed.php?ns=blog&amp;linkto=page" />
</head>

Обратите внимание на параметр false, передаваемый функции tpl_metaheaders. Это подавляет все стандартные теги обнаружения лент.

Использование

Черновики

С черновыми записями можно обращаться двумя основными способами. Первый способ — завести отдельное пространство имён для черновиков. Чтобы опубликовать статью, достаточно будет скопировать её в блог. Второй способ представляет сам плагин blog. Он позволяет пометить черновик вставкой маркера ~~DRAFT~~ в текст перед сохранением. Тогда она не будет отображаться в блоге до тех пор, пока вы снова не уберёте маркер из текста. При использовании этого способа следует также поставить плагин feedmod, который удалит черновики из RSS-ленты.

Примечание: страницы помеченные как черновики тем не менее будут обнаруживаться при использовании поиска.

Управление комментариями

Плагин discussion предоставляет панель управления в административном интерфейсе «Докувики», где можно открывать и закрывать обсуждения, а также производить действия над отдельными комментариями.

Управление обратными ссылками

Плагин linkback даёт возможность управлять обратными ссылками через административный интерфейс «Докувики» — удалять их или включать и выключать на отдельных страницах.

Управление метками

Плагин tag последней версии даёт возможность управлять метками, перестраивать индекс меток через административный интерфейс. Посредством плагина tagentry можно получить дополнительные возможности по управлению метками.

Украшение

Отображение только первого подраздела страницы

Иногда нежелательно отображать всю длинную статью в блоге на первой странице. Обрезать её можно добавив пустой заголовок первого уровня. Чтобы это сработало следует добавить параметр firstseconly в плагине include.

Далее будет длинная статья.

====== ======

Собственно длинная статья здесь.

Тонкая настройка ленты

Стандартная RSS-лента «Докувики» не слишком пригодна для ведения блога. К примеру, она в заголовок ставит название страницы, а не первый заголовок внутри статьи. Это можно исправить при помощи плагина feedmod. Добавляет заголовок статьи в ленту, а также включает в новость метки и ссылки на обсуждение. Также можно добавить ссылки для добавления в закладки, для чего стоит отредактировать шаблон «подвала» новости (подробности на feedmod).

Другой простой путь добавить функций — использовать Feedburner. Зарегистрируйтесь на том сайте, добавьте туда свою ленту (см. URL новостной ленты) и добавьте ленту Feedburner в метаданные. Эта операция также перенесёт часть нагрузки с вашего сайта на Feedburner.

Борьба со спамом

Спам в комментариях — серьёзная проблема в наши дни. К счастью «Докувики» предоставляет ряд антиспам-плагинов для борьбы с ним. Также поддержка captcha встроена в плагин discussion. Всё что нужно — это установить нужные средства и настроить их.

Проблемы

Treat your filesystem carefully

Хитрости

Правка неверных дат

Some timestamp issues I came across:

As mentioned in the discussion of the meta plugin, feed.php ignores settings of . (Usually getRecents() from changelog.php is called, which doesn't seem to support it?) This results in a mismatch between blog listing like {{blog>blog?5}} and feed.php?ns=blog&num=5, which is unexpected.
Also, it is currently not possible to let feed.php list only newly created pages (and sort them by descending creation date). (Because getRecents() does provide listing only newly created pages.) I note that this listing is possible with the changes plugin, but this code isn't used in feed.php.
An alternative approach using alphabetic ordering of pages by name could also solve issues if the items have pagenames like :blog:YYYY-MM:DD-pagetitle or similar. Then the feed.php is consistent with the permalinks of the blog, which would be nice.

— Louwrens van Dellen 2010/05/03 23:23

Обсуждение

Изменение порядка следования «обратных ссылок» и «обуждения» на странице

Is it possible (without changing source/templates) to change the order of the discussion and the linkback plugin? If there is no way without editing, could anybody who is more often editing the code than me, give a hint into the right direction? (I am «speaking» HTML/CSS/PHP)

Thanks, Ralf

myedit

anonymous@undisclosed.example.com (Anonymous) — Mon, 25 Aug 2025 07:23:09 +0000

Правки для этой конфигурации Dokuwiki

Панель инструментов

"Jack Jackrum", "Kaos" и "Librarian"

dokuwiki/inc/toolbar.php
Пример правки панели инструментов

«См.подробности правки»

toolbar.php

<?php
 
/**
 * Editing toolbar functions
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Andreas Gohr <andi@splitbrain.org>
 */
 
use dokuwiki\Extension\Event;
 
/**
 * Prepares and prints an JavaScript array with all toolbar buttons
 *
 * @emits  TOOLBAR_DEFINE
 * @param  string $varname Name of the JS variable to fill
 * @author Andreas Gohr <andi@splitbrain.org>
 */
function toolbar_JSdefines($varname)
{
    global $lang;
 
    $menu = [];
 
    $evt = new Event('TOOLBAR_DEFINE', $menu);
    if ($evt->advise_before()) {
        // build button array
        $menu = array_merge($menu, [
            [
                'type'   => 'format',
                'title'  => $lang['qb_bold'],
                'icon'   => 'bold.png',
                'key'    => 'b',
                'open'   => '**',
                'close'  => '**',
                'block'  => false
            ],
            [
                'type'   => 'format',
                'title'  => $lang['qb_italic'],
                'icon'   => 'italic.png',
                'key'    => 'i',
                'open'   => '//',
                'close'  => '//',
                'block'  => false
            ],
            [
                'type'   => 'format',
                'title'  => $lang['qb_underl'],
                'icon'   => 'underline.png',
                'key'    => 'u',
                'open'   => '__',
                'close'  => '__',
                'block'  => false
            ],
            [
                'type'   => 'format',
                'title'  => $lang['qb_code'],
                'icon'   => 'mono.png',
                'key'    => 'm',
                'open'   => "''",
                'close'  => "''",
                'block'  => false
            ],
            [
                'type'   => 'format',
                'title'  => $lang['qb_strike'],
                'icon'   => 'strike.png',
                'key'    => 'd',
                'open'  => '<del>',
                'close'   => '</del>',
                'block'  => false
            ],
			/*Редактируем малоиспользуемый пункт меню "Выбор заголовка"*/
            [
                'type'   => 'picker',
                'title'  => $lang['qb_hs'],
                'icon'   => 'h.png',
                'class'  => 'pk_hl',
                'list'   => [
				    /*Убираем во вложеные кнопку "Подставить подпись"*/
                    [
                        'type'   => 'signature',
                        'title'  => $lang['qb_sig'],
                        'icon'   => 'sig.png',
                        'key'    => 'y',
                    ],
                    /*Убираем во вложеные кнопку "Заголовок текущего уровня [8]"*/
                    [
                        'type'   => 'autohead',
                        'title'  => $lang['qb_hequal'],
                        'icon'   => 'hequal.png',
                        'key'    => '8',
                        'text'   => $lang['qb_h'],
                        'mod'    => 0,
                    ],
					/*Убираем во вложеные кнопку "Заголовок меньшего уровня (подзаголовок)[9]"*/
                    [
                        'type'   => 'autohead',
                        'title'  => $lang['qb_hminus'],
                        'icon'   => 'hminus.png',
                        'key'    => '9',
                        'text'   => $lang['qb_h'],
                        'mod'    => 1,
                    ],
                    /*Убираем во вложеные кнопку "Заголовок большего уровня [0]"*/
                    [
                        'type'   => 'autohead',
                        'title'  => $lang['qb_hplus'],
                        'icon'   => 'hplus.png',
                        'key'    => '0',
                        'text'   => $lang['qb_h'],
                        'mod'    => -1,
                    ],
                    [
                        'type'   => 'format',
                        'title'  => $lang['qb_h1'],
                        'icon'   => 'h1.png',
                        'key'    => '1',
                        'open'   => '===== ',
                        'close'  => ' =====\n'
                    ],
                    [
                        'type'   => 'format',
                        'title'  => $lang['qb_h2'],
                        'icon'   => 'h2.png',
                        'key'    => '2',
                        'open'   => '===== ',
                        'close'  => ' =====\n'
                    ],
                    [
                        'type'   => 'format',
                        'title'  => $lang['qb_h3'],
                        'icon'   => 'h3.png',
                        'key'    => '3',
                        'open'   => '==== ',
                        'close'  => ' ====\n'
                    ],
                    [
                        'type'   => 'format',
                        'title'  => $lang['qb_h4'],
                        'icon'   => 'h4.png',
                        'key'    => '4',
                        'open'   => '=== ',
                        'close'  => ' ===\n'
                    ],
                    [
                        'type'   => 'format',
                        'title'  => $lang['qb_h5'],
                        'icon'   => 'h5.png',
                        'key'    => '5',
                        'open'   => '== ',
                        'close'  => ' ==\n'
                    ]
                ],
                'block'  => true
            ],
            [
                'type'   => 'linkwiz',
                'title'  => $lang['qb_link'],
                'icon'   => 'link.png',
                'key'    => 'l',
                'open'   => '[[',
                'close'  => ']]',
                'block'  => false
            ],
            [
                'type'   => 'format',
                'title'  => $lang['qb_extlink'],
                'icon'   => 'linkextern.png',
                'open'   => '[[',
                'close'  => ']]',
                'sample' => 'http://example.com|' . $lang['qb_extlink'],
                'block'  => false
            ],
            [
                'type'   => 'formatln',
                'title'  => $lang['qb_ol'],
                'icon'   => 'ol.png',
                'open'   => '  - ',
                'close'  => '',
                'key'    => '-',
                'block'  => true
            ],
            [
                'type'   => 'formatln',
                'title'  => $lang['qb_ul'],
                'icon'   => 'ul.png',
                'open'   => '  * ',
                'close'  => '',
                'key'    => '.',
                'block'  => true
            ],
            [
                'type'   => 'insert',
                'title'  => $lang['qb_hr'],
                'icon'   => 'hr.png',
                'insert' => '\n----\n',
                'block'  => true
            ],
            [
                'type'   => 'mediapopup',
                'title'  => $lang['qb_media'],
                'icon'   => 'image.png',
                'url'    => 'lib/exe/mediamanager.php?ns=',
                'name'   => 'mediaselect',
                'options' => 'width=750,height=500,left=20,top=20,scrollbars=yes,resizable=yes',
                'block'  => false
            ],
            [
                'type'   => 'picker',
                'title'  => $lang['qb_smileys'],
                'icon'   => 'smiley.png',
                'list'   => getSmileys(),
                'icobase' => 'smileys',
                'block'  => false
            ],
            [
                'type'   => 'picker',
                'title'  => $lang['qb_chars'],
                'icon'   => 'chars.png',
                'list' => [
                    'À', 'à', 'Á', 'á', 'Â', 'â', 'Ã', 'ã', 'Ä', 'ä', 'Ǎ', 'ǎ', 'Ă', 'ă', 'Å', 'å',
                    'Ā', 'ā', 'Ą', 'ą', 'Æ', 'æ', 'Ć', 'ć', 'Ç', 'ç', 'Č', 'č', 'Ĉ', 'ĉ', 'Ċ', 'ċ',
                    'Ð', 'đ', 'ð', 'Ď', 'ď', 'È', 'è', 'É', 'é', 'Ê', 'ê', 'Ë', 'ë', 'Ě', 'ě', 'Ē',
                    'ē', 'Ė', 'ė', 'Ę', 'ę', 'Ģ', 'ģ', 'Ĝ', 'ĝ', 'Ğ', 'ğ', 'Ġ', 'ġ', 'Ĥ', 'ĥ', 'Ì',
                    'ì', 'Í', 'í', 'Î', 'î', 'Ï', 'ï', 'Ǐ', 'ǐ', 'Ī', 'ī', 'İ', 'ı', 'Į', 'į', 'Ĵ',
                    'ĵ', 'Ķ', 'ķ', 'Ĺ', 'ĺ', 'Ļ', 'ļ', 'Ľ', 'ľ', 'Ł', 'ł', 'Ŀ', 'ŀ', 'Ń', 'ń', 'Ñ',
                    'ñ', 'Ņ', 'ņ', 'Ň', 'ň', 'Ò', 'ò', 'Ó', 'ó', 'Ô', 'ô', 'Õ', 'õ', 'Ö', 'ö', 'Ǒ',
                    'ǒ', 'Ō', 'ō', 'Ő', 'ő', 'Œ', 'œ', 'Ø', 'ø', 'Ŕ', 'ŕ', 'Ŗ', 'ŗ', 'Ř', 'ř', 'Ś',
                    'ś', 'Ş', 'ş', 'Š', 'š', 'Ŝ', 'ŝ', 'Ţ', 'ţ', 'Ť', 'ť', 'Ù', 'ù', 'Ú', 'ú', 'Û',
                    'û', 'Ü', 'ü', 'Ǔ', 'ǔ', 'Ŭ', 'ŭ', 'Ū', 'ū', 'Ů', 'ů', 'ǖ', 'ǘ', 'ǚ', 'ǜ', 'Ų',
                    'ų', 'Ű', 'ű', 'Ŵ', 'ŵ', 'Ý', 'ý', 'Ÿ', 'ÿ', 'Ŷ', 'ŷ', 'Ź', 'ź', 'Ž', 'ž', 'Ż',
                    'ż', 'Þ', 'þ', 'ß', 'Ħ', 'ħ', '¿', '¡', '¢', '£', '¤', '¥', '€', '¦', '§', 'ª',
                    '¬', '¯', '°', '±', '÷', '‰', '¼', '½', '¾', '¹', '²', '³', 'µ', '¶', '†', '‡',
                    '·', '•', 'º', '∀', '∂', '∃', 'Ə', 'ə', '∅', '∇', '∈', '∉', '∋', '∏', '∑', '‾',
                    '−', '∗', '×', '⁄', '√', '∝', '∞', '∠', '∧', '∨', '∩', '∪', '∫', '∴', '∼', '≅',
                    '≈', '≠', '≡', '≤', '≥', '⊂', '⊃', '⊄', '⊆', '⊇', '⊕', '⊗', '⊥', '⋅', '◊', '℘',
                    'ℑ', 'ℜ', 'ℵ', '♠', '♣', '♥', '♦', 'α', 'β', 'Γ', 'γ', 'Δ', 'δ', 'ε', 'ζ', 'η',
                    'Θ', 'θ', 'ι', 'κ', 'Λ', 'λ', 'μ', 'Ξ', 'ξ', 'Π', 'π', 'ρ', 'Σ', 'σ', 'Τ', 'τ',
                    'υ', 'Φ', 'φ', 'χ', 'Ψ', 'ψ', 'Ω', 'ω', '★', '☆', '☎', '☚', '☛', '☜', '☝', '☞',
                    '☟', '☹', '☺', '✔', '✘', '„', '“', '”', '‚', '‘', '’', '«', '»', '‹', '›', '—',
                    '–', '…', '←', '↑', '→', '↓', '↔', '⇐', '⇑', '⇒', '⇓', '⇔', '©', '™', '®', '′',
                    '″', '[', ']', '{', '}', '~', '(', ')', '%', '§', '$', '#', '|', '@'
                ],
                'block'  => false
            ]
 
        ]);
    } // end event TOOLBAR_DEFINE default action
    $evt->advise_after();
    unset($evt);
 
    // use JSON to build the JavaScript array
    echo "var $varname = " . json_encode($menu, JSON_THROW_ON_ERROR) . ";\n";
}
 
/**
 * prepares the signature string as configured in the config
 *
 * @author Andreas Gohr <andi@splitbrain.org>
 */
function toolbar_signature()
{
    global $conf;
    global $INFO;
    /** @var Input $INPUT */
    global $INPUT;
 
    $sig = $conf['signature'];
    $sig = dformat(null, $sig);
    $sig = str_replace('@USER@', $INPUT->server->str('REMOTE_USER'), $sig);
    if (is_null($INFO)) {
        $sig = str_replace(['@NAME@', '@MAIL@'], '', $sig);
    } else {
        $sig = str_replace('@NAME@', $INFO['userinfo']['name'] ?? "", $sig);
        $sig = str_replace('@MAIL@', $INFO['userinfo']['mail'] ?? "", $sig);
    }
    $sig = str_replace('@DATE@', dformat(), $sig);
    $sig = str_replace('\\\\n', '\\n', $sig);
    return json_encode($sig, JSON_THROW_ON_ERROR);
}
 
//Setup VIM: ex: et ts=4 :

Скачать файл toolbar.php с правками

Шаблон dokuwiki

tpl_footer.php

"Jack Jackrum", "Kaos" и "Librarian"

lib/tpl/dokuwiki/tpl_footer.php
Счетчик посещений сайта Dokuwiki с регистрацией IP - адреса в .txt файле

«См.подробности правки»

tpl_footer.php

<?php
/**
 * Template footer, included in the main and detail files
 */
 
// must be run from within DokuWiki
if (!defined('DOKU_INC')) die();
?>
 
<!-- ********** FOOTER ********** -->
<footer id="dokuwiki__footer"><div class="pad">
    <div class="license">Если не указано иное, содержимое этой вики предоставляется на&nbsp;условиях следующей лицензии: <bdi><a href="doku.php?id=public_domain_mark" rel="license" class="urlextern">Public Domain</a></bdi></div>
 
    <div class="buttons">
        <a href="https://php.net" title="Powered by PHP" <?php echo $target?>><img
            src="<?php echo tpl_basedir(); ?>images/button-php.gif" width="80" height="15" alt="Powered by PHP" /></a>
        <a href="//validator.w3.org/check/referer" title="Valid HTML5" <?php echo $target?>><img
            src="<?php echo tpl_basedir(); ?>images/button-html5.png" width="80" height="15" alt="Valid HTML5" /></a>
        <a href="//jigsaw.w3.org/css-validator/check/referer?profile=css3" title="Valid CSS" <?php echo $target?>><img
            src="<?php echo tpl_basedir(); ?>images/button-css.png" width="80" height="15" alt="Valid CSS" /></a>
        <a href="https://dokuwiki.org/" title="Driven by DokuWiki" <?php echo $target?>><img
            src="<?php echo tpl_basedir(); ?>images/button-dw.png" width="80" height="15"
            alt="Driven by DokuWiki" /></a>
        <a>
            <?php 
                $file = file("count.txt");
                $count = implode("", $file);
                $count++;
                $myfile = fopen("count.txt","w");
                fputs($myfile,$count);
                fclose($myfile);
				$filename = file("stat.txt");
            ?>
        <style>
            .container {
            position: absolute;
            font-family: Georgia, 'Times New Roman', Times, serif;
            }
            .text-block {
            position: absolute;
            bottom: 0px;
            right: 4px;
            color: black;
            }
        </style>
            <a class="container">
                <span><img src="<?php echo tpl_basedir(); ?>images/button-yandex.png" width="85" height="15" alt="yandex" / >
                    <div class="text-block"><?=$count ?></div>
                </span>
            </a>
        </a>
    </div>
    <?php tpl_includeFile('footer.html'); ?>
	<?php // Счетчик определителя IP посетителя
	    $client  = @$_SERVER['HTTP_CLIENT_IP'];
        $forward = @$_SERVER['HTTP_X_FORWARDED_FOR'];
        $remote  = @$_SERVER['REMOTE_ADDR']; // Определяем IP посетителя
        $bravo   = @$_SERVER["HTTP_USER_AGENT"];//Определяем браузер
            if(filter_var($client, FILTER_VALIDATE_IP)) $ip_address = $client;
            elseif(filter_var($forward, FILTER_VALIDATE_IP)) $ip_address = $forward;
            else $ip_address = $remote;
        $file2 = $_SERVER['DOCUMENT_ROOT'] . '/lib/tpl/dokuwiki/debug.txt';
        file_put_contents($file2, date("F d  H:i:s."). ('    ') . $ip_address . ('    ') . $bravo .  PHP_EOL, FILE_APPEND | LOCK_EX);
	?>
</div></footer><!-- /footer -->

Скачать файл toolbar.php с правками
Поместить в папку Dokuwiki\lib\tpl\dokuwiki.
Сохранить как button-yandex.png в папке Dokuwiki\lib\tpl\dokuwiki\images.
Скачать файл count.txt
Поместить в корень сайта Dokuwiki
Скачать файл debug.txt
Поместить в папку Dokuwiki\lib\tpl\dokuwiki\.

Скачать архив jack_jackrum.zip с правками для «Jack Jackrum»
Разорхивировать и копировать с заменой файлов в папке dokuwiki

"Jack Jackrum", "Kaos" и "Librarian"

lib/tpl/dokuwiki/tpl_footer.php
Счетчик посещений сайта Dokuwiki с регистрацией IP - адреса в .txt файле

«См.подробности правки»

tpl_footer.php

<?php
 
/**
 * Template footer, included in the main and detail files
 */
 
// must be run from within DokuWiki
if (!defined('DOKU_INC')) die();
?>
 
<!-- ********** FOOTER ********** -->
<footer id="dokuwiki__footer"><div class="pad">
    <?php tpl_license(''); // license text ?>
 
    <div class="buttons">
        <?php
            tpl_license('button', true, false, false); // license button, no wrapper
            $target = ($conf['target']['extern']) ? 'target="' . $conf['target']['extern'] . '"' : '';
        ?>
        <a href="https://php.net" title="Powered by PHP" <?php echo $target?>><img
            src="<?php echo tpl_basedir(); ?>images/button-php.gif" width="80" height="15" alt="Powered by PHP" /></a>
        <a href="//validator.w3.org/check/referer" title="Valid HTML5" <?php echo $target?>><img
            src="<?php echo tpl_basedir(); ?>images/button-html5.png" width="80" height="15" alt="Valid HTML5" /></a>
        <a href="//jigsaw.w3.org/css-validator/check/referer?profile=css3" title="Valid CSS" <?php echo $target?>><img
            src="<?php echo tpl_basedir(); ?>images/button-css.png" width="80" height="15" alt="Valid CSS" /></a>
        <a href="https://dokuwiki.org/" title="Driven by DokuWiki" <?php echo $target?>><img
            src="<?php echo tpl_basedir(); ?>images/button-dw.png" width="80" height="15"
            alt="Driven by DokuWiki" /></a>
        <a>
            <?php 
                $file = file("count.txt");
                $count = implode("", $file);
                $count++;
                $myfile = fopen("count.txt","w");
                fputs($myfile,$count);
                fclose($myfile);
            ?>
        <style>
            .container {
            position: absolute;
            font-family: Georgia, 'Times New Roman', Times, serif;
            }
            .text-block {
            position: absolute;
            bottom: 0px;
            right: 4px;
            color: black;
            }
        </style>
            <a class="container">
                <span><img src="<?php echo tpl_basedir(); ?>images/button-yandex.png" width="85" height="15" alt="yandex" / >
                    <div class="text-block"><?=$count ?></div>
                </span>
            </a>
        </a>
    </div>
 
    <?php tpl_includeFile('footer.html'); ?>
	<?php
	    $client  = @$_SERVER['HTTP_CLIENT_IP'];
        $forward = @$_SERVER['HTTP_X_FORWARDED_FOR'];
        $remote  = @$_SERVER['REMOTE_ADDR']; // Определяем IP посетителя
        $bravo   = @$_SERVER["HTTP_USER_AGENT"];//Определяем браузер
            if(filter_var($client, FILTER_VALIDATE_IP)) $ip_address = $client;
            elseif(filter_var($forward, FILTER_VALIDATE_IP)) $ip_address = $forward;
            else $ip_address = $remote;
        $file2 = $_SERVER['DOCUMENT_ROOT'] . '/lib/tpl/dokuwiki/debug.txt';
        file_put_contents($file2, date("F d  H:i:s."). ('    ') . $ip_address . ('    ') . $bravo .  PHP_EOL, FILE_APPEND | LOCK_EX);
	?>
</div></footer><!-- /footer -->

Скачать архив kaos.zip с правками для «Kaos»
Разорхивировать и копировать с заменой файлов в папке dokuwiki

_links.css

"Jack Jackrum", "Kaos" и "Librarian"

lib/tpl/dokuwiki/css/_links.css
Убрана (закомментированна) иконка перед ссылками и стиль

_links.css

/*____________ other link types ____________*/
 
/*.dokuwiki a.urlextern,*/
/*.dokuwiki a.windows,*/
/*.dokuwiki a.mail,*/
.dokuwiki a.mediafile,
.dokuwiki a.interwiki {
    background-size: 1.2em;
    background-repeat: no-repeat;
    background-position: 0 center;
    padding: 0 0 0 1.4em;
}
/* внешние ссылки */
.dokuwiki a.urlextern {
/* background-image: url(../../images/media_link_displaylnk.png);*/
}
}

«См.подробности правки файла _links.css»

_links.css

/**
 * Этот файл предоставляет стили для всех типов ссылок.
 */
 
/*____________ ссылки на вики-страницы ____________*/
 
/* существующая вики-страница */
.dokuwiki a.wikilink1 {
 
}
/* не существующая вики-страница */
.dokuwiki a.wikilink2 {
    text-decoration: none;
}
.dokuwiki a.wikilink2:link,
.dokuwiki a.wikilink2:visited {
    border-bottom: 1px dashed;
}
.dokuwiki a.wikilink2:hover,
.dokuwiki a.wikilink2:active,
.dokuwiki a.wikilink2:focus {
    border-bottom-width: 0;
}
 
/* любая ссылка на текущую страницу */
.dokuwiki span.curid a {
    font-weight: bold;
}
 
/*____________ other link types ____________*/
 
/*.dokuwiki a.urlextern,*/
/*.dokuwiki a.windows,*/
/*.dokuwiki a.mail,*/
.dokuwiki a.mediafile,
.dokuwiki a.interwiki {
    background-size: 1.2em;
    background-repeat: no-repeat;
    background-position: 0 center;
    padding: 0 0 0 1.4em;
}
/* внешние ссылки */
.dokuwiki a.urlextern {
/* background-image: url(../../images/media_link_displaylnk.png);*/
}
/* сетевые ресурсы windows */
.dokuwiki a.windows {
/* background-image: url(../../images/unc.svg);*/
}
/* почтовые ссылки */
.dokuwiki a.mail {
/* background-image: url(../../images/email.svg);*/
}
 
/* Следующие значки установлены dokuwiki в lib/exe/css.php */
/* ссылка на некоторые встроенные носители */
.dokuwiki a.mediafile {
}
/* interwiki ссылки */
.dokuwiki a.interwiki {
}
 
/* RTL исправления; если значки ссылок не работают должным образом, удалите следующие строки */
[dir=rtl] .dokuwiki a.urlextern,
[dir=rtl] .dokuwiki a.windows,
[dir=rtl] .dokuwiki a.mail,
[dir=rtl] .dokuwiki a.interwiki,
[dir=rtl] .dokuwiki a.mediafile {
    background-position: right center;
    padding: 0 18px 0 0;
}

См. также

style.ini

"Jack Jackrum", "Kaos" и "Librarian"

lib/tpl/dokuwiki/style.ini
Изменен цвет для внутренней ссылки с зеленого на синий __existing__ = "#080" и __missing__ = "#d30""

_links.css

; these are used for wiki links
__existing__        = "#0000cd"         ; @ini_existing
__missing__         = "#f30"            ; @ini_missing

См. также

Редактированный файл style.ini

mime.conf

"Jack Jackrum", "Kaos" и "Librarian"

conf/mime.conf
Добавлены расширения разрешенных файлов для загрузки в dokuwiki __missing__ = "#d30""

mime.conf

tgz     !application/octet-stream
tar     application/x-gtar
tar.xz  application/tar.xz
gz      application/octet-stream
bz2     application/octet-stream
zip     application/zip
rar     application/rar
7z      application/x-7z-compressed

См. также

Конфигурация MIME

smileys.conf

"Jack Jackrum", "Kaos" и "Librarian"

conf/smileys.conf
Убраны неиспользуемые иконки смайликов dokuwiki

smileys.conf

# Smileys configured here will be replaced by the
# configured images in the smiley directory
 
8-)         sm.png
8-O         eek.svg
:-(         sm_1.png
:-)         sm_2.png
=)          sm_3.png
:-/         sm_4.png
:-\         sm_5.png
:-?         sm_6.png
:-D         sm_7.png
LOL         sm_8.png
:?:         question.svg
:!:         exclaim.svg
{{:icons:16:hourglass-select.png?|Устаревший}}  hourglass-select.png
{{:icons:16:flask.png?|Экспериментальный}}  flask.png
{{:icons:16:jar.png?|Нестандартный}}   jar.png
[[|{{:icons:16:flask.png?|Экспериментальный}}]] flask.png
FIXME       fixme.jpg
DELETEME    deleteme.jpg

smileys.local.conf

"Jack Jackrum", "Kaos" и "Librarian"

conf/smileys.local.conf
Добавлен новый файл smileys.local.conf со своим набором иконок dokuwiki

smileys.local.conf

:&: address-book-open.png
:&1: book-open.png
:&2: book-open-bookmark.png
:&3: hourglass-select.png
:&4: flask.png
:&5: jar.png
:&6: wand-hat.png
:&7: balloon.png
:&8: exclamation--frame.png
:&9: exclamation-red.png
:&10: information.png
:&11: light-bulb-off.png
:&12: light-bulb.png
:&13: magnifier-left.png
:&14: navigation-000-button-white.png
:&15: pin.png
:&16: tick.png
:&17: tick-red.png
:&18: leaf.png
:&19: leaf-yellow.png
:&20: leaf-red.png
:&21: lightning.png
:&22: box.png
:&esc: esc.png
:&enter:  enter.png
:&primenite:  primenite.png
:&ctrl+x:  ctrl+x.png
:&ctrl+o:  ctrl+o.png
:&ok:  ok.png
:&sbros:  sbros.png
:&dalee:  dalee.png
:&nazad:  nazad.png
:&gal:  gal.png
:&sozdate:  sozdate.png
:&otmena:  otmena.png
:ctrl_o_enter_ctrl_x.png:  ctrl_o_enter_ctrl_x.png

иконки для смайликов

dokuwiki/Kaos/dokuwiki/lib/images/smileys

Новый набор иконок

См. также

interwiki.conf

"Jack Jackrum", "Kaos" и "Librarian"

conf/interwiki.conf
Убраны (закомментированы) неиспользуемые иконки interwiki dokuwiki

interwiki.conf

# Each URL may contain one of these placeholders
# {URL}  is replaced by the URL encoded representation of the wikiname
#        this is the right thing to do in most cases
# {NAME} this is replaced by the wikiname as given in the document
#        only mandatory encoded is done, urlencoding if the link
#        is an external URL, or encoding as a wikiname if it is an
#        internal link (begins with a colon)
# {SCHEME}
# {HOST}
# {PORT}
# {PATH}
# {QUERY} these placeholders will be replaced with the appropriate part
#         of the link when parsed as a URL
# If no placeholder is defined the urlencoded name is appended to the URL
 
# To prevent losing your added InterWiki shortcuts after an upgrade,
# you should add new ones to interwiki.local.conf
 
# world     https://
# wp        https://en.wikipedia.org/wiki/{NAME}
# wpfr      https://fr.wikipedia.org/wiki/{NAME}
# wpde      https://de.wikipedia.org/wiki/{NAME}
# wpes      https://es.wikipedia.org/wiki/{NAME}
# wppl      https://pl.wikipedia.org/wiki/{NAME}
# wpjp      https://ja.wikipedia.org/wiki/{NAME}
# wpru      https://ru.wikipedia.org/wiki/{NAME}
# wpmeta    https://meta.wikipedia.org/wiki/{NAME}
# doku      https://www.dokuwiki.org/
# rfc       https://tools.ietf.org/html/rfc
# man       http://man.cx/
# google    https://www.google.com/search?q=
# amazon    https://www.amazon.com/dp/{URL}?tag=splitbrain-20
# amazon.de https://www.amazon.de/dp/{URL}?tag=splitbrain-21
# amazon.uk https://www.amazon.co.uk/dp/{URL}
# paypal    https://www.paypal.com/cgi-bin/webscr?cmd=_xclick&amp;business=
# skype     skype:{NAME}
# google.de https://www.google.de/search?q=
# go        https://www.google.com/search?q={URL}&amp;btnI=lucky
# user      :user:{NAME}
# skype     skype:{NAME}
 
# To support VoIP/SIP/TEL links
# user      :user:{NAME}
# callto    callto://{NAME}
# tel       tel:{NAME}
# mail      mail:{NAME}
# address   address:{NAME}

interwiki.local.conf

"Jack Jackrum", "Kaos" и "Librarian"

conf/interwiki.local.conf
Добавлен новый файл interwiki.local.conf со своим набором иконок dokuwiki

interwiki.local.conf

coral http://{HOST}.{PORT}.nyud.net:8090{PATH}?{QUERY}
 
world     https://
wp        https://en.wikipedia.org/wiki/{NAME}
doku      https://www.dokuwiki.org/
google    https://www.google.com/search?q=
windows   https://support.microsoft.com/ru-ru/
ubuntu    https://wiki.ubuntu.com/{NAME}
phpfn     https://secure.php.net/{NAME}
xref      doku.php?id=wiki:xref:dokuwiki:
# [[this>feed.php]] - Ссылки на URL вашей вики. (находиться в mylink)
 
# To support VoIP/SIP/TEL links
user      :user:{NAME}
# callto    callto://{NAME}
tel       tel:{NAME}
mail      mail:{NAME}
address   address:{NAME}

иконки для interwiki

dokuwiki/Kaos/dokuwiki/lib/images/interwiki

Новый набор иконок

Скругление углов плагина Wrap

Файл CSS - lib/plugin/wrap/all.less

/*____________ rounded corners ____________*/
/* (only for modern browsers) */
 
div.wrap_round {
    border-radius: 0.2em;
}
span.wrap_round {
    border-radius: 0.2em;
}

См. также

Установка новой dokuwiki

Загружаем архив с последней ревизией dokuwiki

Создаем папку с поддерикториями аналогичной структуре папок dokuwiki и в ней разладываем модифицированные файлы и папки с иконками.
Устанавливаем новую dokuwiki и на неё копируем нашу папку с заменой файлов

Обновление модефицированной dokuwiki

Делаем бэкап нашей dokuwiki
Создаем папку с поддерикториями аналогичной структуре папок dokuwiki и в ней разложенны модифицированные файлы и папки с иконками.
Обновляем нашу dokuwiki через менеджер обновлений и на неё копируем нашу папку с заменой файлов

smileys

anonymous@undisclosed.example.com (Anonymous) — Tue, 14 Jan 2025 09:50:59 +0000

Смайлики

Использование

Докувики может преобразовывать текстовые смайлики в их графический эквивалент. Изображения по умолчанию и пользовательские изображения автоматически отображаются в окне выбора смайликов на панели инструментов.

Изображения смайликов по умолчанию хранятся в каталоге lib/images/smileys/ и настраиваются в conf/smileys.conf файле. Администраторы вики могут настраивать свои собственные смайлики, см. Ниже.

Вместо использования пиксельной графики на основе gif в версиях DokuWiki, начиная с выпуска Igor 2022, используются смайлики SVG, основанные на проекте Twemoji.

Настройка смайликов

Чтобы добавить свои собственные смайлики, а также защетить их от перезаписи при обновлении, вы должны следовать этим инструкциям, а не смешивать их со смайликами по умолчанию из пакета докувики:

Создайте новую папку с именем local внутри папки smileys
```
lib/images/smileys/local
```

и поместите в него файлы изображений (убедитесь, что изображения доступны для чтения веб-сервером). По умолчанию смайлики в докувики имеют высоту около 24 пикселей.

Создайте пользовательский файл конфигурации смайликов по адресу
```
conf/smileys.local.conf
```
и поместите туда ваши комбинации смайдликов с именем файла изображения (имя файла изображения должно начинатся с local/).

Пример файла конфигурации может выглядеть следующим образом:

conf/smileys.local.conf

# Пользовательские смайлики
# Изображения отображаются по относительному адресу из каталога смайликов lib/images/smileys/
# ТЕКСТ_ДЛЯ_ЗАМЕНЫ           ФАЙЛ_ИЗОБРАЖЕНИЯ
#
:MYFACE:                     local/i_am_so_pretty.png

# или удалите смайлик, указав ключ, без пути к изображению.
DELETEME

Примечания и подсказки

Хорошей практикой считается окружать свои собственные текстовые макросы двоеточиями (:), например :REPLACEME:
Поскольку символ # (хэш) зарезервирован для обозначения строки комментария, он должен быть экранирован обратной косой чертой (\#). Символ $ (доллар) не может быть использован в кофигурационном файле.
Если ваш недавно добавленный смайлик не отображается во всплывающем окне панели инструментов редактирования, это почти всегда проблема кэширования. Возможно, вам придется очистить кеш, а затем обновить страницу.
Убедитесь, что при добавлении в статью вики перед и после смайлика есть пробел (например, Test :NEW: smiley).

Дополнительные смайлики от пользователей

Следующие смайлики были созданы пользователями Докувики, используя стиль, аналогичный стандартным. Если они вам нравятся, поместите их в свой каталог смайликов и настройте конфигурационный файл.

Изображение смайлика	Создатель
	Toby
	Toby
	Kevin Locke
	Kevin Locke
	Kevin Locke
	Kevin Locke
	Kevin Locke
	Kevin Locke
	Kevin Locke
	Kevin Locke
	Kevin Locke
	Kevin Locke
	Kevin Locke
	Kevin Locke
	Hella Breitkopf
	Hella Breitkopf
	Cyrille37
Different sets: dokuwiki-smileys-local	Davidjimenez75

Дополнительные пакеты смайликов

Следующие наборы смайликов были созданы пользователями DokuWiki, используя стиль, аналогичный стандартным. Если они вам нравятся, поместите их в свой локальный каталог смайликов (lib/images/smileys/local) и создайте / скопируйте / настройте конфигурационный файл (conf/smileys.local.conf). Не забудьте обновить conf/local.php чтобы обновить кэш редактора WYSIWYG.

Пакет изображений смайликов	url	Создатель
	dokuwiki-tags-en	Davidjimenez75
	emojione-faces	Davidjimenez75
	github-tags-en	Davidjimenez75
	openmoji32-faces	Davidjimenez75

Больше примеров на https://github.com/davidjimenez75/dokuwiki-smileys-local

Смотри таже

Настройка Докувики

syntax

anonymous@undisclosed.example.com (Anonymous) — Sun, 24 Aug 2025 14:58:37 +0000

Formatting Syntax

DokuWiki supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing «Edit this page». If you want to try something, just use the playground page. The simpler markup is easily accessible via quickbuttons, too.

Basic Text Formatting

DokuWiki supports bold, italic, underlined and monospaced texts. Of course you can combine all these.

DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.
Of course you can **__//''combine''//__** all these.

You can use _subscript and ^superscript, too.

You can use <sub>subscript</sub> and <sup>superscript</sup>, too.

You can mark something as ~~deleted~~ as well.

You can mark something as <del>deleted</del> as well.

Paragraphs are created from blank lines. If you want to force a newline without a paragraph, you can use two backslashes followed by a whitespace or the end of line.

This is some text with some linebreaks
Note that the two backslashes are only recognized at the end of a line
or followed by
a whitespace \\this happens without it.

This is some text with some linebreaks\\ Note that the
two backslashes are only recognized at the end of a line\\
or followed by\\ a whitespace \\this happens without it.

You should use forced newlines only if really needed.

Links

DokuWiki supports multiple ways of creating links.

External

External links are recognized automagically: http://www.google.com or simply www.google.com - You can set the link text as well: This Link points to google. Email addresses like this one: andi@splitbrain.org are recognized, too.

DokuWiki supports multiple ways of creating links. External links are recognized
automagically: http://www.google.com or simply www.google.com - You can set
link text as well: [[http://www.google.com|This Link points to google]]. Email
addresses like this one: <andi@splitbrain.org> are recognized, too.

Internal

Internal links are created by using square brackets. You can either just give a pagename or use an additional link text.

Internal links are created by using square brackets. You can either just give
a [[pagename]] or use an additional [[pagename|link text]].

Wiki pagenames are converted to lowercase automatically, special characters are not allowed.

You can use namespaces by using a colon in the pagename.

You can use [[some:namespaces]] by using a colon in the pagename.

For details about namespaces see namespaces.

Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to this Section.

This links to [[syntax#internal|this Section]].

Notes:

Links to existing pages are shown in a different style from nonexisting ones.
DokuWiki does not use CamelCase to automatically create links by default, but this behavior can be enabled in the config file. Hint: If DokuWiki is a link, then it's enabled.
When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much.

Interwiki

DokuWiki supports Interwiki links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis: Wiki.

DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis.
For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]].

Windows Shares

Windows shares like this are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate Intranet.

Windows Shares like [[\\server\share|this]] are recognized, too.

Notes:

For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the «local zone»).
For Mozilla and Firefox it can be enabled through different workaround mentioned in the Mozilla Knowledge Base. However, there will still be a JavaScript warning about trying to open a Windows Share. To remove this warning (for all users), put the following line in conf/lang/en/lang.php (more details at localization):
conf/lang/en/lang.php
```
<?php
/**
 * Customization of the english language file
 * Copy only the strings that needs to be modified
 */
$lang['js']['nosmblinks'] = '';
```

Image Links

You can also use an image to link to another internal or external page by combining the syntax for links and images (see below) like this:

[[http://php.net|{{wiki:dokuwiki-128.png}}]]

Please note: The image formatting is the only formatting syntax accepted in link names.

The whole image and link syntax is supported (including image resizing, internal and external images and URLs and interwiki links).

Footnotes

You can add footnotes ¹⁾ by using double parentheses.

You can add footnotes ((This is a footnote)) by using double parentheses.

Sectioning

You can use up to five different levels of headlines to structure your content. If you have more than three headlines, a table of contents is generated automatically – this can be disabled by including the string ~~NOTOC~~ in the document.

Headline Level 3

Headline Level 4

Headline Level 5

==== Headline Level 3 ====
=== Headline Level 4 ===
== Headline Level 5 ==

By using four or more dashes, you can make a horizontal line:

Media Files

You can include external and internal images, videos and audio files with curly brackets. Optionally you can specify the size of them.

Real size:

Resize to given width:

Resize to given width and height²⁾:

Resized external image:

Real size:                        {{wiki:dokuwiki-128.png}}
Resize to given width:            {{wiki:dokuwiki-128.png?50}}
Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}}
Resized external image:           {{https://www.php.net/images/php.gif?200x50}}

By using left or right whitespaces you can choose the alignment.

{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}

Of course, you can add a title (displayed as a tooltip by most browsers), too.

{{ wiki:dokuwiki-128.png |This is the caption}}

For linking an image to another page see Image Links above.

Supported Media Formats

DokuWiki can embed the following media formats directly.

Image	`gif`, `jpg`, `png`
Video	`webm`, `ogv`, `mp4`
Audio	`ogg`, `mp3`, `wav`
Flash	`swf`

If you specify a filename that is not a supported media format, then it will be displayed as a link instead.

By adding ?linkonly you provide a link to the media without displaying it inline

{{wiki:dokuwiki-128.png?linkonly}}

dokuwiki-128.png This is just a link to the image.

Fallback Formats

Unfortunately not all browsers understand all video and audio formats. To mitigate the problem, you can upload your file in different formats for maximum browser compatibility.

For example consider this embedded mp4 video:

{{video.mp4|A funny video}}

When you upload a video.webm and video.ogv next to the referenced video.mp4, DokuWiki will automatically add them as alternatives so that one of the three files is understood by your browser.

Additionally DokuWiki supports a «poster» image which will be shown before the video has started. That image needs to have the same filename as the video and be either a jpg or png file. In the example above a video.jpg file would work.

Lists

Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a * for unordered lists or a - for ordered ones.

This is a list
The second item
- You may have different levels
Another item

The same list but ordered
Another item
1. Just use indention for deeper levels
That's it

  * This is a list
  * The second item
    * You may have different levels
  * Another item

  - The same list but ordered
  - Another item
    - Just use indention for deeper levels
  - That's it

Also take a look at the FAQ on list items.

Text Conversions

DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML.

The text to image conversion is mainly done for smileys. And the text to HTML conversion is used for typography replacements, but can be configured to use other HTML as well.

Text to Image Conversions

DokuWiki converts commonly used emoticons to their graphical equivalents. Those Smileys and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki:

8-)
8-O
:-(
:-)
=)
:-/
:-\
:-?
:-D
:-P :-P
:-O :-O
:-X :-X
:-| :-|
;-) ;-)
^_^ ^_^
m( m(
:?:
:!:
LOL
FIXME
DELETEME

Text to HTML Conversions

Typography: DokuWiki can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® «He thought 'It's a man's world'…»

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."

The same can be done to produce any kind of HTML, it just needs to be added to the pattern file.

There are three exceptions which do not come from that pattern file: multiplication entity (640×480), 'single' and «double quotes». They can be turned off through a config option.

Quoting

Some times you want to mark some text to show it's a reply or comment. You can use the following syntax:

I think we should do it

> No we shouldn't

>> Well, I say we should

> Really?

>> Yes!

>>> Then lets do it!

I think we should do it

No we shouldn't

Well, I say we should

Really?

Yes!

Then lets do it!

Tables

DokuWiki supports a simple syntax to create tables.

Heading 1	Heading 2	Heading 3
Row 1 Col 1	Row 1 Col 2	Row 1 Col 3
Row 2 Col 1	some colspan (note the double pipe)
Row 3 Col 1	Row 3 Col 2	Row 3 Col 3

Table rows have to start and end with a | for normal rows or a ^ for headers.

^ Heading 1      ^ Heading 2       ^ Heading 3          ^
| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
| Row 2 Col 1    | some colspan (note the double pipe) ||
| Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        |

To connect cells horizontally, just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators!

Vertical tableheaders are possible, too.

	Heading 1	Heading 2
Heading 3	Row 1 Col 2	Row 1 Col 3
Heading 4	no colspan this time
Heading 5	Row 2 Col 2	Row 2 Col 3

As you can see, it's the cell separator before a cell which decides about the formatting:

|              ^ Heading 1            ^ Heading 2          ^
^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        |
^ Heading 4    | no colspan this time |                    |
^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |

You can have rowspans (vertically connected cells) by adding ::: into the cells below the one to which they should connect.

Heading 1	Heading 2	Heading 3
Row 1 Col 1	this cell spans vertically	Row 1 Col 3
Row 2 Col 1		Row 2 Col 3
Row 3 Col 1		Row 2 Col 3

Apart from the rowspan syntax those cells should not contain anything else.

^ Heading 1      ^ Heading 2                  ^ Heading 3          ^
| Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        |
| Row 2 Col 1    | :::                        | Row 2 Col 3        |
| Row 3 Col 1    | :::                        | Row 2 Col 3        |

You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text.

Table with alignment
right	center	left
left	right	center
xxxxxxxxxxxx	xxxxxxxxxxxx	xxxxxxxxxxxx

This is how it looks in the source:

^           Table with alignment           ^^^
|         right|    center    |left          |
|left          |         right|    center    |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Note: Vertical alignment is not supported.

No Formatting

If you need to display text exactly like it is typed (without any formatting), enclose the area either with <nowiki> tags or even simpler, with double percent signs %%.

This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. The same is true for //__this__ text// with a smiley ;-).

<nowiki>
This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.
</nowiki>
The same is true for %%//__this__ text// with a smiley ;-)%%.

Code Blocks

You can include code blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags <code> or <file>.

This is text is indented by two spaces.

This is preformatted code all spaces are preserved: like              <-this

This is pretty much the same, but you could use it to show that you quoted a file.

Those blocks were created by this source:

  This is text is indented by two spaces.

<code>
This is preformatted code all spaces are preserved: like              <-this
</code>

<file>
This is pretty much the same, but you could use it to show that you quoted a file.
</file>

Syntax Highlighting

DokuWiki can highlight sourcecode, which makes it easier to read. It uses the GeSHi Generic Syntax Highlighter – so any language supported by GeSHi is supported. The syntax uses the same code and file blocks described in the previous section, but this time the name of the language syntax to be highlighted is included inside the tag, e.g. <code java> or <file java>.

/**
 * The HelloWorldApp class implements an application that
 * simply displays "Hello World!" to the standard output.
 */
class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!"); //Display the string.
    }
}

The following language strings are currently recognized: 4cs 6502acme 6502kickass 6502tasm 68000devpac abap actionscript3 actionscript ada aimms algol68 apache applescript apt_sources arm asm asp asymptote autoconf autohotkey autoit avisynth awk bascomavr bash basic4gl batch bf biblatex bibtex blitzbasic bnf boo caddcl cadlisp ceylon cfdg cfm chaiscript chapel cil c_loadrunner clojure c_mac cmake cobol coffeescript c cpp cpp-qt cpp-winapi csharp css cuesheet c_winapi dart dcl dcpu16 dcs delphi diff div dos dot d ecmascript eiffel email epc e erlang euphoria ezt f1 falcon fo fortran freebasic freeswitch fsharp gambas gdb genero genie gettext glsl gml gnuplot go groovy gwbasic haskell haxe hicest hq9plus html html4strict html5 icon idl ini inno intercal io ispfpanel java5 java javascript jcl j jquery julia kixtart klonec klonecpp kotlin latex lb ldif lisp llvm locobasic logtalk lolcode lotusformulas lotusscript lscript lsl2 lua m68k magiksf make mapbasic mathematica matlab mercury metapost mirc mk-61 mmix modula2 modula3 mpasm mxml mysql nagios netrexx newlisp nginx nimrod nsis oberon2 objc objeck ocaml-brief ocaml octave oobas oorexx oracle11 oracle8 oxygene oz parasail parigp pascal pcre perl6 perl per pf phix php-brief php pic16 pike pixelbender pli plsql postgresql postscript povray powerbuilder powershell proftpd progress prolog properties providex purebasic pycon pys60 python qbasic qml q racket rails rbs rebol reg rexx robots roff rpmspec rsplus ruby rust sas sass scala scheme scilab scl sdlbasic smalltalk smarty spark sparql sql sshconfig standardml stonescript swift systemverilog tclegg tcl teraterm texgraph text thinbasic tsql twig typoscript unicon upc urbi uscript vala vbnet vb vbscript vedit verilog vhdl vim visualfoxpro visualprolog whitespace whois winbatch wolfram xbasic xml xojo xorg_conf xpp yaml z80 zxbasic

There are additional advanced options available for syntax highlighting, such as highlighting lines or adding line numbers.

Downloadable Code Blocks

When you use the <code> or <file> syntax as above, you might want to make the shown code available for download as well. You can do this by specifying a file name after language code like this:

<file php myexample.php>
<?php echo "hello world!"; ?>
</file>

myexample.php

<?php echo "hello world!"; ?>

If you don't want any highlighting but want a downloadable file, specify a dash (-) as the language code: <code - myfile.foo>.

RSS/ATOM Feed Aggregation

DokuWiki can integrate data from external XML feeds. For parsing the XML feeds, SimplePie is used. All formats understood by SimplePie can be used in DokuWiki as well. You can influence the rendering by multiple additional space separated parameters:

Parameter	Description
any number	will be used as maximum number items to show, defaults to 8
reverse	display the last items in the feed first
author	show item authors names
date	show item dates
description	show the item description. All HTML tags will be stripped
nosort	do not sort the items in the feed
n[dhm]	refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours).

The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. DokuWiki will generally try to supply a cached version of a page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells DokuWiki to re-render the page if it is more than refresh period since the page was last rendered.

By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the reverse parameter, or display the feed as is with nosort.

Example:

{{rss>http://slashdot.org/index.rss 5 author date 1h }}

The US Military Quietly Turned GPS Into a Global 'Numbers Station,' Evidence Suggests — BeauHD (2026/06/06 02:00)
Google Will Pay SpaceX $920 Million Per Month For Compute — BeauHD (2026/06/06 01:00)
Bitcoin Falls To $60,000 As Zcash Bug Rocks Crypto — BeauHD (2026/06/06 00:00)
340 Local News Outlets Now Blocking the Internet Archive — BeauHD (2026/06/05 23:00)
GOV.UK Goes Dutch On Payments As It Dumps Stripe — BeauHD (2026/06/05 22:00)

Control Macros

Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:

Macro	Description
~~NOTOC~~	If this macro is found on the page, no table of contents will be created
~~NOCACHE~~	DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the <php> syntax above is used), adding this macro will force DokuWiki to rerender a page on every call

Syntax Plugins

DokuWiki's syntax can be extended by Plugins. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation:

Auto-Tooltip 2026-01-15 — Eli Fenton
Syntax and helper plugins for tooltips, including automatically generated tips based on page abstract.
Cells background color plugin 2013-10-09 — dr4Ke
Sets background of a cell with a specific color
Code Prettifier 2023-09-16 — Satoshi Sahara
syntax highlighting of source code snippets in wiki page using Javascript code prettifier
dbquery plugin 2025-07-24 — Andreas Gohr
Display query results from a database
description plugin 2025-05-16 — Mark C. Prins, Ikuo Obataya, Matthias Schulte
Add a specified string to a description meta header
Diagrams plugin 2025-10-15 — Innovakom + CosmoCode
Embed diagrams.net editor (formerly draw.io)
Diagram plugin 2021-02-21 — Nikita Melnichenko
Constructs diagrams
discussion plugin 2021-12-31 — Michael Hamann, Gerrit Uitslag, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner, Matthias Schulte
Provides discussion funtionality for wiki pages
DokuTeaser Plugin 2016-01-16 — Andreas Gohr
A plugin for internal use on dokuwiki.org only
fontawesome plugin 2013-10-10 — Mikhail Medvedev
Embed Font Awesome icons
Gallery Plugin 2024-04-30 — Andreas Gohr
Creates a gallery of images from a namespace or RSS/ATOM feed
HTML Details Tag Plugin 2021-03-18 — Sascha Klawohn
Use the HTML <details> and <summary> tag for toggling information
htmlmetatags plugin 2024-03-04 — Heiko Heinz
Set html and open graph meta tags.
htmlok plugin 2023-05-10 — saggi, glen
Allows embed HTML and PHP
Icons Plugin 2024-10-30 — Giuseppe Di Terlizzi
Embed icons in Dokuwiki
Info Plugin 2020-06-04 — Andreas Gohr
Displays information about various DokuWiki internals
Meta plugin 2024-08-07 — Michael Hamann
Set Metadata for the current page. (previous authors: Esther Brunner, Gina Häußge, Michael Klier)
Note Plugin 2024-04-15 — Anael Mobilia
Add Note/Important/Tip/Warning Capability (DIV+CSS box)
Pagelist Plugin 2023-08-27 — Matthias Schulte, Michael Hamann, Michael Klier, Gina Haeussge
Lists pages in a nice formatted way
PHP Wikify 2020-06-05 — Trailjeep
Allows one the possibility of having output of PHP scripts parsed
Repository plugin 2024-02-09 — Andreas Gohr/Håkan Sandell
Helps organizing the plugin and template repository
rating plugin 2016-01-13 — Andreas Gohr
Allows rating a page
Stars2 Plugin 2025-02-07 — Zahno Silvan
Embedding Rating Stars
DokuWiki statdisplay plugin 2022-12-12 — Andreas Gohr
Displays log statistics about your DokuWiki
StepByStep plugin 2023-09-25 — saggi
Displays step-by-step tutorials, spoilers, or more information about a topic
tablelayout plugin 2022-03-28 — Michael Große
Set the width of table columns and set which lines to fix
Tag Plugin 2023-10-17 — Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
tag wiki pages
Translation Plugin 2025-05-20 — Andreas Gohr
Supports the easy setup of a multi-language wiki.
Typography plugin 2020-07-31 — Satoshi Sahara
Enable typesetting capabilities with CSS font properties such as font face, size, weight, and color of text
Wrap Plugin 2023-08-13 — Anika Henke
Universal plugin which combines functionalities of many other plugins. Wrap wiki text inside containers (divs or spans) and give them a class (choose from a variety of preset classes), a width and/or a language with its associated text direction.
PHPXref Plugin 2024-04-30 — Andreas Gohr
Makes linking to a PHPXref generated API doc easy.

¹⁾

This is a footnote

²⁾

when the aspect ratio of the given width and height doesn't match that of the image, it will be cropped to the new ratio before resizing

javascript

anonymous@undisclosed.example.com (Anonymous) — Wed, 14 Aug 2024 22:53:02 +0000

JavaScript

Для удобства «ДокуВики» позволяет использовать программистам JavaScript. Также как и страницы стилей CSS, все файлы JavaScript загружаются через программу-диспетчер с целью уменьшения количества HTTP-запросов, для кэширования, а также удаления пробелов и комментариев (настройка compress).

Эта статья даст общее представление о том, как скрипты JavaScript загружаются из ядра «ДокуВики», плагинов и шаблонов. Также здесь содержится информация об обработке событий и стиля программирования, когда JavaScript используются в ДокуВики.

Загрузка JavaScript

Все Java скрипты собираются и загружаются через js.php, который объединяет все найденные файлы яваскрипта, убирает пробелы и комментарии (если включена опция compress) и помещает результат в кэш. Также он (js.php) даёт команду браузеру помещать в кэш результат, так что, когда вы разрабатываете новый яваскрит, не забывайте сбрасывать кэш браузера (например Shift+F5, Shift+CTL+R и тому подобное) всякий раз, когда ваш скрипт изменён. Если ваш сайт сидит в облаке, в отдельных случаях может потребоваться touch его настроек.

«ДокуВики» получает JavaScript из:

автоматически сгенерированные яваскрипты (языковые строки, настройки конфигурации, панель инструментов);
lib/scripts/*.js ³⁾;
lib/plugins/*/script.js;
lib/tpl/<currenttemplate>/script.js;
conf/userscript.js.

Из вышеизложенного следует, что использование яваскриптов возможно в шаблонах и плагинах (с помощью файла script.js), а также возможно определить свои собственные скрипты в conf/userscript.js.

Также яваскрипт может быть добавлен в main.php, расположенном в lib/tpl/<currenttemplate>. Хорошо знакомый HTML-код <head> </head> принимает JavaScript.

Об атрибутах внешних скриптов

Однако до загрузки файла скрипта, особенно если он крупный, рендеринг сайта будет останавливаться, это стандартное поведение браузеров служит очень частой причиной для недовольства «Dokuwiki». Кроме того, скрипт исполняется немедленно после загрузки, не дожидаясь окончания сборки самой страницы. До появления атрибутов defer в HTML 4.01 (откладывающего запуск скрипта до окончания загрузки его цели) и async в HTML 5 (процесса, полностью независимого от рендеринга) для тега <script> работающие со страницей скрипты рекомендовалось размещать в конце неё. Async рекомендуется для библиотечных скриптов, а defer - для обрабатывающих страницу, и размещать теги с такими атрибутами можно на привычном месте внутри тега head. Но если defer-скрипт опирается на async-библиотеку и та так увесиста, что не всегда успевает грузиться даже до его старта, то defer-скрипт всё же придётся поставить в конец шаблона.

Синтаксис подключения, использования (include)

Диспетчер яваскриптов «ДокуВики» позволяет использовать специальные (особые) комментарии, чтобы подгружать отличные от вышеописанных файлы скриптов. Это важно для случаев, когда в основном только один файл яваскрипт подвергается анализу (разбору) диспетчером, например в плагинах и шаблонах.

Подключаемые файлы не проверяются механизмом кэширования на предмет обновления. Необходимо изменить основной файл, чтобы запустить механизм кэширования.

Либо использовать самообновляющий детектор <script charset=«UTF-8» src=«/lib/tpl/шаблон/editor.js?ver=' . date ( «y-m-d_H:i:s», filemtime ( '/var/www/сайт/lib/tpl/шаблон/editor.js' ) ) . '» defer></script>

Подключения (includes) не поддерживаются внутри подключаемых файлов с целью предотвращения кольцевых ссылок (рекурсии).

Путь для подключения (includepath) должен содержать только буквы, цифры, знак подчёркивания, знак дроби и точку.

include

/* DOKUWIKI:include somefile.js */

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

include_once

/* DOKUWIKI:include_once common_library.js */

Указанный файл будет подключен (использован), только если файл с аналогичным имененм не подгружался ранее с помощью оператора include_once. Данное имя файла будет доступно через любые другие скриптовые файлы (из всех плагинов), поэтому стоит давать понятное наименование такому файлу.

Использование этого оператора имеет смысл, если разрабатываются несколько независимых плагинов, каждый из которых использует одну и ту же библиотеку яваскрипт. Использование оператора include_once несколько раз с одинаковым именем подключаемого файла даст гарантию того, что библиотека будет подгружена только один раз, даже если будет установлено несколько плагинов одновременно.

DokuWiki JavaScript Library

DokuWiki does not use any of the bigger JavaScript libraries like Prototype, Dojo or JQuery. Instead it comes with a small set of handy classes and functions that may help you with writing JavaScript code for DokuWiki.

Event Handling

As said in Avoid Inappropriate Mixing, event handlers should not be mixed into HTML code. Instead those handlers should be assigned when the Document Object Model (DOM) was loaded. The DOM is a tree-based object representation of the HTML that is available to the JavaScript. Your JavaScript need merely figure out which objects to attach functions to and then to attach functions to them.

To attach functions to any given DOM Object in a cross-browser compatible way, the addEvent() function is provided. It takes the DOM object, an event name (like 'click') and a callback function (the handler) as arguments. This function also takes care of multiple plugins trying to register an event on the same DOM object.

Additionally, addEvent() changes the properties and methods of the event in Internet Explorer - so you can use the target property and can call the preventDefault() and stopPropagation() methods.

Unfortunately, the JavaScript in your script.js loads before the HTML has finished loading and before the DOM tree has been made. The objects that the JavaScript needs don't yet exist. However, you may still run JavaScript when script.js loads, as long as that JavaScript doesn't require DOM.

To solve this problem DokuWiki provides the addInitEvent() function. This function will register a given callback to be run as soon as the DOM is ready.

Here's an example (from the summary_enforcement tip) using both methods:

function enforceSummary() {
    /*...*/
}
 
function installSummaryEnforcement()
{
    var summary_input = document.getElementById('edit__summary');
    if(summary_input !== null)
    {
        /*...*/
        addEvent(summary_input, 'change', enforceSummary);
        addEvent(summary_input, 'keyup', enforceSummary);
    }
}
 
addInitEvent(installSummaryEnforcement);

In this example, we need to attach enforceSummary() to the onchange and onkeyup handlers for the summary input field. installSummaryEnforcement() does this.

The call to addInitEvent() will run the installSummaryEnforcement() function as soon as the DOM is loaded.

Notice how installSummaryEnforcement() itself works. First it acquires a DOM object by ID (though there are other ways to acquire it). In this case the object may not exist since the summary field is only shown when editing a page, so the function first tests to see if it got the object. If it did, it calls addEvent() to attach enforceSummary() to the event handlers.

The DokuWiki event functions were originally provided by Dean Edwards here and here.

For deeper insight on the event system see the source

Predefined Global Variable

DokuWiki defines certain JavaScript variables for the use in your script:

DOKU_BASE – the full webserver path to the DokuWiki installation
DOKU_TPL – the full webserver path to the used Template
LANG – an array of languagestrings

SACK (AJAX) Library

DokuWiki provides a simple AJAX library named SACK by Gregory Wild-Smith.

See the Source tw-sack.js for details on how to use it.

$()

The $() function is a handy shortcut to the all-too-frequent document.getElementById() function of the DOM. Like the DOM function, this one returns the element that has the id passed as an argument. Unlike the DOM function, though, this one goes further. You can pass more than one id and $() will return an Array object with all the requested elements.

Taken from the prototype library
See Docs by Sergio Pereira

Additional functions

DokuWiki provides various other tool methods. Especially the following might be useful for your development: isset, getElementsByClass, findPosX, findPosY, jsEscape, prependChild.

For details check the source of these files:
- script.js
- helpers.js

JSINFO

Since november 23, 2009 DokuWiki passes the global $JSINFO to javascript. (see the mailinglist mailinglist)

The usual way in a plugin is this:

function register(Doku_Event_Handler $controller) {
    $controller->register_hook('DOKUWIKI_STARTED', 'AFTER',  $this, '_adduser');
}
function _adduser(&$event, $param) {
    global $JSINFO;
    $JSINFO['user'] = $_SERVER['REMOTE_USER'];
}

add exact time when the array is send to JavaScript

³⁾

чтобы избежать излишней загрузки скриптов для тех, кто читает статью, содержимое edit.js и media.js загружается только в режиме редактирования или отображения медиафайлов

⁴⁾

Please note as well that there is no language attribute of the script tag! Instead use type=«text/javascript» to be standards compliant.

logging

anonymous@undisclosed.example.com (Anonymous) — Mon, 19 Jan 2026 18:13:22 +0000

Ведение журнала

Вводная запись в блоге.

Лесозаготовительные объекты

Системы логирования классифицируют зарегистрированные сообщения об ошибках. Они соответствуют каталогам в директории data/log/ Плагины могут использовать свои собственные системы..

В DokuWiki по умолчанию определены три средства ведения журналов:

error – всё, что не должно произойти и является результатом проблемы с кодом, средой, конфигурацией или взаимодействием с пользователем.
deprecated – регистрирует использование устаревшего кода. Трассировка стека должна помочь определить код, который необходимо обновить.
debug – сообщения, которые помогают в процессе разработки или настройки, но обычно не требуются.

Какие именно объекты следует регистрировать, можно настроить с помощью опции dontlog.

Если вам нужно только записывать сообщения об ошибках, без устаревших команд, и отлаживать код, то используйте следующую строку в файле.

conf/dokuwiki.php

Должно выглядеть вот так.

$conf['dontlog'] = 'deprecated,debug';

Автоматическая регистрация ошибок

DokuWiki регистрирует обработчики ошибок, которые автоматически пытаются перехватить все возникающие исключения, ошибки и фатальные события. При этом отображается информационное сообщение для конечного пользователя, а ошибка регистрируется в error соответствующей системе.

Формат журнала

Пользовательское ведение журнала

parser

anonymous@undisclosed.example.com (Anonymous) — Fri, 17 Jan 2025 10:53:47 +0000

Парсер «Докувики»

В этом документе излагаются детали функционирования парсера «Докувики», которые могут понадобиться разработчикам для модификации поведения парсера или получения контроля над выходным документом, возможно, изменив сгенерированный HTML или реализовав другие форматы вывода.

Обзор

Парсер разбивает процесс трансформации исходного документа «Докувики» в финальный выходной документ (обычно XHTML) на дискретные стадии. Каждая стадия представлена одним или несколькими PHP-классами.

В общем рассмотрении этими элементами являются;

Lexer¹⁾ (лексический анализатор): сканирует²⁾ исходный документ «Докувики» и выводит последовательность «вхождений» (токенов³⁾), соответствующих синтаксической структуре документа.
Handler⁴⁾ (обработчик): получает вхождения от анализатора и преобразует их в последовательность «инструкций»⁵⁾. Он описывает, как должет быть сформирован выходной документ, от начала до конца.
Parser⁶⁾ (парсер): «связывает» лексический анализатор с обработчиком, предоставляя синтаксические правила «Докувики», а также точку доступа к системе (метод Parser::parse())
Renderer⁷⁾ (преобразователь): принимает инструкции от обработчика и «отрисовывает» готовый к выводу документ (например, в виде XHTML).

Механизма для соединения Handler (обработчика) с Renderer (логическим преобразователем) не предусмотрено — для этого требуется кодирование для каждого конкретного случая использования.

Схематическая диаграмма связей между компонентами;

    ┌────────────┐           ┌────────────┐
    │            │   Ввод    │ Клиентский │
    │   Парсер   ◄───────────┤ код        │
    │            │  Строка   │            │
    └─────┬──────┘           └─────▲──────┘
  Режимы  │                        │
    +     │        Инструкции      │
  Строка  │        преобразователя │
  ввода   │                        │
    ┌─────▼──────┐           ┌─────┴──────┐
    │            │           │            │
    │ Анализатор ├───────────► Обработчик │
    │            │ Вхождения │            │
    └─────┬──────┘           └────────────┘
          │
          │
     ┌────┴───┐
     │ Режимы ├─┐
     └─┬──────┘ ├─┐
       └─┬──────┘ │
         └────────┘

«Клиентский код» (код, использующий парсер) вызывает парсер, передавая ему входную строку. В ответ ему возвращается перечень «инструкций» преобразователя, построенных обработчиком. Они могут быть использованы неким объектом, реализующим преобразователь.

Примечание: критическим моментом здесь является намерение позволить преобразователю быть настолько «тупым», насколько это возможно. От него не требуется осуществлять дальнейшую интерпретацию или модификацию переданных инструкций, но полностью сконцентрироваться на формировании выходных данных (например, XHTML) — в особенности, преобразователю не следует отслеживать состояния. Соблюдение этого принципа и, кроме того, составление преобразователя достаточно простым для реализации (сосредоточенной исключтельно на том, что следует выводить), также сделает возможным преобразователю быть взаимозаменяемым (например, вывод PDF в качестве альтернативы XHTML). В то же самое время, выходные инструкции обработчика направляются для преобразования в XHTML и не всегда могут быть пригодынми для всех выходных форматов.

Лексический анализатор

Определяется в inc/Parsing/Lexer/Lexer.php

В самом общем смысле, он реализует инструмент для управления комплексными регулярными выражениями, где важным является состояние. Анализатор появился из Simple Test , но содержит три модификации (читай: «хака»):

поддержка шаблонов просмотра назад и просмотра вперед⁸⁾;
поддержка изменения модификаторов шаблона в пределах шаблона;
уведомление обработчика о начальном индексе байта в необработанном тексте, где был сопоставлен токен.

Короче говоря, лексер Simple Test действует как инструмент, упрощающий управление регулярными выражениями — вместо гигантских регулярных выражений вы пишете много маленьких/простых. Лексер заботится об их эффективном объединении, а затем предоставляет вам API обратного вызова в стиле SAX , чтобы вы могли писать код для ответа на соответствующие «события».

В целом Lexer состоит из трех основных классов;

inc/Parsing/Lexer/ParallelRegex: позволяет строить регулярные выражения из нескольких отдельных шаблонов, каждый шаблон связан с идентифицирующей «меткой», класс объединяет их в одно регулярное выражение с помощью подшаблонов. При использовании Lexer вам не нужно беспокоиться об этом классе.
inc/Parsing/Lexer/StateStack: предоставляет простой конечный автомат, чтобы лексирование могло быть «контекстно-зависимым». При использовании Lexer вам не нужно беспокоиться об этом классе.
inc/Parsing/Lexer/Lexer: предоставляет точку доступа для клиентского кода с помощью Lexer. Управляет несколькими экземплярами ParallelRegex, используя StateStack для применения правильного экземпляра ParallelRegex в зависимости от «контекста». При обнаружении «интересного текста» вызывает функции для предоставленного пользователем объекта (Handler).

Необходимость в состояниях

Синтаксис вики, используемый в «Докувики», содержит разметку, «внутри» которой применяются только определённые синтаксические правила. Самый очевидный пример — тэг <code/> , внутри которого синтаксис вики не будет распознаваться анализатором. Для других синтаксических конструкций, таких как списки или таблицы, следует позволять использовать некоторую разметку, но не всю, например, в списка можно использовать ссылки, но не таблицы.

Анализатор обеспечивает «осведомлённость о состояниях», позволяющую применять корректные синтаксические правила в зависимости от текущий позиции (контекста) в сканируемом тексте. Если он видит открывающий тэг <code>, он переключается в другое состояние, в пределах которого другие синтаксические правила не применяются (т. е. что-либо, что выглядит как синтаксис вики должно восприниматься как «простой» текст), до тех пор, пока не найдёт закрывающий тэг </code>.

Режимы анализатора

Термин режим обозначает особенное состояние лексического анализа ⁹⁾. Код, использующий анализатор, регистрирует один или более шаблон регулярного выражения с особенным наименованием режима. Затем анализатор, сравнивая эти паттерны со сканируемым текстом, вызывает функции обработчика с тем же самым наименованием режима (если метод mapHandler не был использован для создания псевдонимов — см. ниже).

API анализатора

Краткое введение в лексический анализатор можно найти в Simple Test Lexer Notes. Здесь предлагается более подробное описание.

Ключевыми методами анализатора являются:

Конструктор

Принимает ссылку на объект Handler, имя начального режима, в котором должен запускаться Lexer, и (необязательно) логический флаг, указывающий, должно ли сопоставление с образцом учитывать регистр.

Пример:

$handler  =  new MyHandler ( ) ; 
$lexer  =  new dokuwiki\Lexer\Lexer ( $handler ,  'base' ,  true ) ;

Здесь указан начальный режим 'base'.

addEntryPattern / addExitPattern

addEntryPattern() в Lexer.php

Lexer.php

    public function addEntryPattern($pattern, $mode, $new_mode)
    {
        if (! isset($this->regexes[$mode])) {
            $this->regexes[$mode] = new ParallelRegex($this->case);
        }
        $this->regexes[$mode]->addPattern($pattern, $new_mode);
    }

addExitPattern() в Lexer.php

Lexer.php

    public function addExitPattern($pattern, $mode)
    {
        if (! isset($this->regexes[$mode])) {
            $this->regexes[$mode] = new ParallelRegex($this->case);
        }
        $this->regexes[$mode]->addPattern($pattern, "__exit");
    }

addEntryPattern() и addExitPattern() используются для регистрации шаблона для входа и выхода из определенного режима анализа. Например;

// arg0: регулярное выражение для сопоставления — обратите внимание, что нет необходимости добавлять разделители начального/конечного шаблона 
// arg1: имя режима, в котором может использоваться этот шаблон записи 
// arg2: имя режима для ввода 
$lexer -> addEntryPattern ( '<file>' , 'base' , 'file' ) ;
 
// arg0: регулярное выражение для сопоставления 
// arg1: имя режима для выхода 
$lexer -> addExitPattern ( '</file>' , 'file' ) ;

Код, приведённый выше, позволяет тэгу <file/> быть использованный при входе из базового в новый режим (file). Если в дальнейшем следует применить режимы, пока анализатор находится в режиме file, они должны быть зарегистрированы с режимом file.

Замечание: в паттернах не требуется использование ограничителей (разделителей начала и конца шаблона).

addPattern

addEntryPattern() в Lexer.php

Lexer.php

    public function addPattern($pattern, $mode = "accept")
    {
        if (! isset($this->regexes[$mode])) {
            $this->regexes[$mode] = new ParallelRegex($this->case);
        }
        $this->regexes[$mode]->addPattern($pattern);
    }

addEntryPattern() в ParallelRegex.php

ParallelRegex.php

    public function addPattern($pattern, $label = true)
    {
        $count = count($this->patterns);
        $this->patterns[$count] = $pattern;
        $this->labels[$count] = $label;
        $this->regex = null;
    }

addEntryPattern() используется, чтобы реагировать на дополнительные «вхождения» внутри существующего режима (без переходов). Он принимает паттерн и наименование режима, внутри которого должен использоваться.

Это наиболее наглядно видно из разбора парсером синтаксиса списков. Синтаксис списков выглядит в «Докувики» следующим образом;

До списка
  * Ненумерованный элемент списка
  * Ненумерованный элемент списка
  * Ненумерованный элемент списка
После списка

Использование addPattern() делает возможным сравнивать полный список, одновременно корректно захватывая каждый элемент списка;

// Сопоставляем открывающий элемент списка и меняем режим 
$lexer -> addEntryPattern ( '\n {2,}[\*]' , 'base' , 'list' ) ;
 
// Сопоставить новые элементы списка, но остаться в режиме списка 
$lexer -> addPattern ( '\n {2,}[\*]' , 'list' ) ;
 
// Если это перевод строки, который не соответствует указанному выше правилу addPattern, выходим из режима 
$lexer -> addExitPattern ( '\n' , 'list' ) ;

addSpecialPattern

addSpecialPattern() в Lexer.php

Lexer.php

    public function addSpecialPattern($pattern, $mode, $special)
    {
        if (! isset($this->regexes[$mode])) {
            $this->regexes[$mode] = new ParallelRegex($this->case);
        }
        $this->regexes[$mode]->addPattern($pattern, "_$special");
    }

addSpecialPattern() используется для входа в новый режим только для совпадения, а затем сразу возвращается в «родительский» режим. Принимает шаблон, имя режима, в котором он может быть применен, и имя «временного» режима для входа для совпадения. Обычно это используется, если вы хотите заменить разметку wiki чем-то другим. Например, чтобы сопоставить смайлик, например :-), у вас может быть:

$lexer -> addSpecialPattern ( ':-)' , 'base' , 'smiley' ) ;

mapHandler

mapHandler() в Lexer.php

Lexer.php

    public function mapHandler($mode, $handler)
    {
        $this->mode_handlers[$mode] = $handler;
    }

mapHandler() позволяет сопоставить определенный именованный режим с методом с другим именем в Handler. Это может быть полезно, когда разный синтаксис должен обрабатываться одинаково, например, синтаксис DokuWiki для отключения другого синтаксиса внутри определенного текстового блока;

$lexer -> addEntryPattern ( '<nowiki>' , 'base' ,  'unformatted' ) ; 
$lexer -> addEntryPattern ( '%%' , 'base' ,  'unformattedalt' ) ; 
$lexer -> addExitPattern ( '</nowiki>' ,  'unformatted' ) ; 
$lexer -> addExitPattern ( '%%' ,  'unformattedalt' ) ;
 
// Оба синтаксиса должны обрабатываться одинаково... 
$lexer -> mapHandler ( 'unformattedalt' ,  'unformatted' ) ;

Подшаблоны не допускаются

Поскольку Lexer (анализатор) сам использует подшаблоны (внутри класса ParallelRegex), код, использующий анализатор, этого не может. Иногда это может пригодиться, но, по общему правилу, метод addPattern() может быть применён для решения проблем, когда обычно применяются подшаблоны. Его преимущество в том, что он делает регулярные выражения более простыми и, следовательно, более простыми в управлении.

Замечание: если вы используете в шаблоне круглые скобки, они будут автоматически пропущены анализатором.

Синтаксические ошибки и состояния

Для предотвращение «плохо форматируемой» (особенно при пропуске закрывающих тэгов) разметки, приводящей к тому, что Lexer (анализатор) входит в состояние (режим), который он никогда не покинет, может быть полезным использование паттерна просмотра вперёд для проверки наличия закрывающей разметки¹⁰⁾. Например:

// Использование просмотра вперёд во входном шаблоне...
// Использовать предпросмотр в шаблоне записи... 
$lexer -> addEntryPattern ( '<file>(?=.*</file>)' , 'base' , 'file' ) ; 
$lexer -> addExitPattern ( '</file>' , 'file' ) ;

Шаблон входа проверяет, может ли он найти закрывающий </file> тег, прежде чем войти в состояние.

Handler (Обработчик)

Определено в inc/parser/handler.php и папке inc/Parsing/Handler


	Handler
	Handler
			AbstractRewriter.php
			AbstractRewriter.php
			Block.php
			Block.php
			CallWriter.php
			CallWriter.php
			Nest.php
			Nest.php
			Lists.php
			Lists.php
			CallWriterInterface.php
			CallWriterInterface.php
			Preformatted.php
			Preformatted.php
			Quote.php
			Quote.php
			ReWriterInterface.php
			ReWriterInterface.php
			Table.php
			Table.php

Handler — это класс, предоставляющий методы, которые вызывает Lexer, когда он сопоставляет токены. Затем он «тонко настраивает» токены в последовательность инструкций, готовых для Renderer.

Обработчик в целом содержит следующие классы:

Doku_Handler: все вызовы из Lexer производятся в этот класс. Для каждого режима, зарегистрированного в Lexer, будет соответствующий метод в Handler

Doku_Handler в /dokuwiki/inc/Extension/SyntaxPlugin.php

SyntaxPlugin.php

 6  use Doku_Handler;
57  * @see Doku_Handler_Block
75  * @param Doku_Handler $handler The Doku_Handler object
77  * @param   Doku_Handler $handler The Doku_Handler object
80  abstract public function handle($match, $state, $pos, Doku_Handler $handler);

Doku_Handler в /dokuwiki/inc/Parsing/Parser.php

Parser.php

6 use Doku_Handler;
17  /** @var Doku_Handler */
32  * @param Doku_Handler $handler
34  public function __construct(Doku_Handler $handler)

Doku_Handler в /dokuwiki/inc/parser/handler.php

handler.php

16   * Class Doku_Handler
18   class Doku_Handler {
40   * Doku_Handler constructor.
795  $link[1] = Doku_Handler_Parse_Media($link[1]);
878  $p = Doku_Handler_Parse_Media($match);
1023 function Doku_Handler_Parse_Media($match) {

CallWriter: обеспечивает слой между массивом инструкций (массив Doku_Handler::$calls) и методами Handler, записывающими эти инструкции. Пока идёт лексический анализ, он будет временно перемещён другими объектами, вроде dokuwiki\Parsing\Handler\List.
List: отвечает за преобразование токенов списка в инструкции, пока выполняется лексический анализ
Quote: отвечает за преобразование токенов blockquote (текст, начинающийся с одного или нескольких >) в инструкции, пока выполняется лексический анализ
Table: отвечает за преобразование токенов таблицы в инструкции, пока выполняется лексический анализ
Block: отвечает за вставку инструкций «p_open» и «p_close», при этом отслеживая инструкции «уровня блока», после завершения всего лексического анализа (т.е. выполняет цикл один раз по всему списку инструкций и вставляет больше инструкций)
AbstractRewriter: расширено Preformattedи Nest…
Nest: …
Preformatted: отвечает за преобразование предварительно отформатированных токенов (отступ в тексте dokuwiki) в инструкции, пока лексический анализ еще выполняется

Методы токенов обработчиков

Обработчик должен предоставлять методы, названные в соответствии с режимами, зарегистрированными в лексическом анализаторе (имея в виду mapHandler() метод лексического анализатора — см. выше).

Например, если вы зарегистрировали режим файла с помощью Lexer, например:

$lexer->addEntryPattern('<file>(?=.*</file>)','base','file');
$lexer->addExitPattern('</file>','file');

Обработчику понадобится такой метод:

class Doku_Handler {
 
    /**
    * @param string match содержит совпавший текст
    * @param int state - тип найденного соответствия (см. ниже)
    * @param int pos - индекс байта, где было найдено совпадение
    */
    public function file($match, $state, $pos) {
        return true;
    }
}

Примечание: метод Handler должен возвращать true, иначе Lexer немедленно остановится. Такое поведение может быть полезным при работе с другими типами проблем синтаксического анализа, но для парсера DokuWiki все методы Handler всегда будут возвращать true.

Аргументы, реализумые методом обработчика;

$match: текст, который был обнаружен;
$state: содержит константу, которая описывает как именно было найдено совпадение:
1. DOKU_LEXER_ENTER: найден входной паттерн (см. Lexer::addEntryPattern);
2. DOKU_LEXER_MATCHED: найден паттерн (см. Lexer::addPattern);
3. DOKU_LEXER_UNMATCHED: внутри режима не было совпадений;
4. DOKU_LEXER_EXIT: найден выходной паттерн (см. Lexer::addExitPattern);
5. DOKU_LEXER_SPECIAL: найден специальный паттерн (см. Lexer::addSpecialPattern);
$pos: это индекс байта (длина строки от начала), где было найдено начало вхождения. $pos + strlen($match) даёт индекс байта конца совпадения.

В качестве более сложного примера, для поиска списков в парсере определено следующее;

    function connectTo($mode) {
        $this->Lexer->addEntryPattern('\n {2,}[\-\*]',$mode,'listblock');
        $this->Lexer->addEntryPattern('\n\t{1,}[\-\*]',$mode,'listblock');
 
        $this->Lexer->addPattern('\n {2,}[\-\*]','listblock');
        $this->Lexer->addPattern('\n\t{1,}[\-\*]','listblock');
 
    }
 
    function postConnect() {
        $this->Lexer->addExitPattern('\n','listblock');
    }

Метод listblock в обработчике (вызов просто list приводит к ошибке обработчика PHP, поскольку list зарезервировано в PHP) выглядит как:

    function listblock($match, $state, $pos) {
 
        switch ( $state ) {
 
            // Начало списка...
            case DOKU_LEXER_ENTER:
                // Создать List rewrite, пропуская текущий CallWriter
                $ReWriter = & new Doku_Handler_List($this->CallWriter);
 
                // Заменить текущий CallWriter на List rewriter
                // все поступающие вхождения (даже, если они не являются вхождениями list)
                // теперь направляются в list
                $this->CallWriter = & $ReWriter;
 
                $this->__addCall('list_open', array($match), $pos);
            break;
 
            // Для конца списка
            case DOKU_LEXER_EXIT:
                $this->__addCall('list_close', array(), $pos);
 
                // Дать указание List rewriter об очистке
                $this->CallWriter->process();
 
                // Восстановить прежний CallWriter
                $ReWriter = & $this->CallWriter;
                $this->CallWriter = & $ReWriter->CallWriter;
 
            break;
 
            case DOKU_LEXER_MATCHED:
                $this->__addCall('list_item', array($match), $pos);
            break;
 
            case DOKU_LEXER_UNMATCHED:
                $this->__addCall('cdata', array($match), $pos);
            break;
        }
        return TRUE;
    }

Конвертирование вхождений

«Тонкая обработка» задействует вставку символа дроби «/», переименование или удаление вхождений, переданных анализатором.

Например, список вроде:

This is not a list
  * This is the opening list item
  * This is the second list item
  * This is the last list item
This is also not a list

в результате превратиться в последовательность вхождений вроде;

base: «This is not a list", DOKU_LEXER_UNMATCHED
listblock: «\n *", DOKU_LEXER_ENTER
listblock: « This is the opening list item", DOKU_LEXER_UNMATCHED
listblock: «\n *", DOKU_LEXER_MATCHED
listblock: « This is the second list item", DOKU_LEXER_UNMATCHED
listblock: «\n *", DOKU_LEXER_MATCHED
listblock: « This is the last list item", DOKU_LEXER_UNMATCHED
listblock: «\n", DOKU_LEXER_EXIT
base: «This is also not a list", DOKU_LEXER_UNMATCHED

Но чтобы быть использованными преобразователем, это может быть конвертировано в следующие инструкции:

p_open:
cdata: «This is not a list"
p_close:
listu_open:
listitem_open:
cdata: « This is the opening list item"
listitem_close:
listitem_open:
cdata: « This is the second list item"
listitem_close:
listitem_open:
cdata: « This is the last list item"
listitem_close:
list_close:
p_open:
cdata: «This is also not a list"
p_close:

В случае со списками, это требует помощи класса Doku_Handler_List, который принимает вхождения, заменяя их на корректные инструкции для Преобразователя.

Parser (Парсер)

Определено в /dokuwiki/inc/Parsing/Parser.php и /dokuwiki/inc/parser/parser.php.

dokuwiki \Parsing\Parser действует как интерфейс для внешнего кода и настраивает Lexer с помощью шаблонов и режимов, описывающих синтаксис DokuWiki.

Использование парсера обычно выглядит так:

// Создаем обработчик Handler
$handler = new Doku_Handler();
 
// Создаем парсер с обработчиком 
$parser = new dokuwiki\Parsing\Parser($handler);
 
// Добавить требуемые режимы синтаксиса в парсер 
$parser->addMode('footnote', new dokuwiki\Parsing\ParserMode\Footnote());
$parser->addMode('hr', new dokuwiki\Parsing\ParserMode\Hr());
$parser->addMode('unformatted', new dokuwiki\Parsing\ParserMode\Unformatted());
# etc.

$doc = file_get_contents('wikipage.txt.');
$instructions = $parser->parse($doc);

Более подробные примеры приведены ниже.

В целом Parser также содержит классы, представляющие каждый доступный режим синтаксиса, базовым классом для всех них является dokuwiki\Parsing\ParserMode\AbstractMode. Поведение этих режимов лучше всего понять, рассмотрев примеры добавления синтаксиса далее в этом документе.

Причина представления режимов с помощью классов заключается в том, чтобы избежать повторных вызовов методов Lexer. Без них пришлось бы жестко кодировать каждое правило шаблона для каждого режима, в котором может быть сопоставлен шаблон, например, регистрация одного правила шаблона для синтаксиса ссылок CamelCase потребовала бы чего-то вроде:

$lexer->addSpecialPattern('\b[A-Z]+[a-z]+[A-Z][A-Za-z]*\b', 'base', 'camelcaselink');
$lexer->addSpecialPattern('\b[A-Z]+[a-z]+[A-Z][A-Za-z]*\b', 'footnote', 'camelcaselink');
$lexer->addSpecialPattern('\b[A-Z]+[a-z]+[A-Z][A-Za-z]*\b', 'table', 'camelcaselink');
$lexer->addSpecialPattern('\b[A-Z]+[a-z]+[A-Z][A-Za-z]*\b', 'listblock', 'camelcaselink');
$lexer->addSpecialPattern('\b[A-Z]+[a-z]+[A-Z][A-Za-z]*\b', 'strong', 'camelcaselink');
$lexer->addSpecialPattern('\b[A-Z]+[a-z]+[A-Z][A-Za-z]*\b', 'underline', 'camelcaselink');
// и т.д.

Каждый режим, которому разрешено содержать ссылки CamelCase, должен быть явно назван.

Вместо того, чтобы жестко кодировать это, вместо этого это реализовано с использованием одного класса, например:

namespace dokuwiki\Parsing\ParserMode;
 
class CamelCaseLink extends AbstractMode {
 
    public function connectTo($mode) {
        $this->Lexer->addSpecialPattern(
            '\b[A-Z]+[a-z]+[A-Z][A-Za-z]*\b', $mode, 'camelcaselink'
        );
    }
}

При настройке лексического анализатора парсер вызывает connectTo() метод объекта dokuwiki\Parsing\ParserMode\CamelCaseLink для каждого другого режима, который принимает синтаксис CamelCase (некоторым такой <code /> синтаксис не нравится).

За счет усложнения понимания настройки лексического анализатора это позволяет сделать код более гибким при добавлении нового синтаксиса.

Формат данных инструкций

Плагин Parserarray — это экспортный рендерер, который показывает инструкции для текущей страницы. Он может помочь вам понять формат данных. Ниже показан пример сырого текста вики и соответствующий вывод парсера;

Исходный текст (содержит таблицу):

abc
| Row 0 Col 1    | Row 0 Col 2     | Row 0 Col 3        |
| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
def

После обработки будет возвращён следующий массив PHP (описан ниже):

Array(
    [0] => Array(
            [0] => document_start
            [1] => Array()
            [2] => 0
        )
    [1] => Array(
            [0] => p_open
            [1] => Array()
            [2] => 0
        )
    [2] => Array(
            [0] => cdata
            [1] => Array(
                    [0] => 

abc
                )
            [2] => 0
        )
    [3] => Array(
            [0] => p_close
            [1] => Array()
            [2] => 5
        )
    [4] => Array(
            [0] => table_open
            [1] => Array(
                    [0] => 3
                    [1] => 2
                )
            [2] => 5
        )
    [5] => Array(
            [0] => tablerow_open
            [1] => Array()
            [2] => 5
        )
    [6] => Array(
            [0] => tablecell_open
            [1] => Array(
                    [0] => 1
                    [1] => left
                )
            [2] => 5
        )
    [7] => Array(
            [0] => cdata
            [1] => Array(
                    [0] =>  Row 0 Col 1
                )
            [2] => 7
        )
    [8] => Array(
            [0] => cdata
            [1] => Array(
                    [0] =>     
                )
            [2] => 19
        )
    [9] => Array(
            [0] => tablecell_close
            [1] => Array()
            [2] => 23
        )
    [10] => Array(
            [0] => tablecell_open
            [1] => Array(
                    [0] => 1
                    [1] => left
                )
            [2] => 23
        )
    [11] => Array(
            [0] => cdata
            [1] => Array(
                    [0] =>  Row 0 Col 2
                )
            [2] => 24
        )
    [12] => Array(
            [0] => cdata
            [1] => Array(
                    [0] =>      
                )
            [2] => 36
        )
    [13] => Array(
            [0] => tablecell_close
            [1] => Array()
            [2] => 41
        )
    [14] => Array(
            [0] => tablecell_open
            [1] => Array(
                    [0] => 1
                    [1] => left
                )
            [2] => 41
        )
    [15] => Array(
            [0] => cdata
            [1] => Array(
                    [0] =>  Row 0 Col 3
                )
            [2] => 42
        )
    [16] => Array(
            [0] => cdata
            [1] => Array(
                    [0] =>         
                )
            [2] => 54
        )
    [17] => Array(
            [0] => tablecell_close
            [1] => Array()
            [2] => 62
        )
    [18] => Array(
            [0] => tablerow_close
            [1] => Array()
            [2] => 63
        )
    [19] => Array(
            [0] => tablerow_open
            [1] => Array()
            [2] => 63
        )
    [20] => Array(
            [0] => tablecell_open
            [1] => Array(
                    [0] => 1
                    [1] => left
                )
            [2] => 63
        )
    [21] => Array(
            [0] => cdata
            [1] => Array(
                    [0] =>  Row 1 Col 1
                )
            [2] => 65
        )
    [22] => Array(
            [0] => cdata
            [1] => Array(
                    [0] =>     
                )
            [2] => 77
        )
    [23] => Array(
            [0] => tablecell_close
            [1] => Array()
            [2] => 81
        )
    [24] => Array(
            [0] => tablecell_open
            [1] => Array(
                    [0] => 1
                    [1] => left
                )
            [2] => 81
        )
    [25] => Array(
            [0] => cdata
            [1] => Array(
                    [0] =>  Row 1 Col 2
                )
            [2] => 82
        )
    [26] => Array(
            [0] => cdata
            [1] => Array(
                    [0] =>      
                )
            [2] => 94
        )
    [27] => Array(
            [0] => tablecell_close
            [1] => Array()
            [2] => 99
        )
    [28] => Array(
            [0] => tablecell_open
            [1] => Array(
                    [0] => 1
                    [1] => left
                )
            [2] => 99
        )
    [29] => Array(
            [0] => cdata
            [1] => Array(
                    [0] =>  Row 1 Col 3
                )
            [2] => 100
        )
    [30] => Array(
            [0] => cdata
            [1] => Array(
                    [0] =>         
                )
            [2] => 112
        )
    [31] => Array(
            [0] => tablecell_close
            [1] => Array()
            [2] => 120
        )
    [32] => Array(
            [0] => tablerow_close
            [1] => Array()
            [2] => 121
        )
    [33] => Array(
            [0] => table_close
            [1] => Array()
            [2] => 121
        )
    [34] => Array(
            [0] => p_open
            [1] => Array()
            [2] => 121
        )
    [35] => Array(
            [0] => cdata
            [1] => Array(
                    [0] => def

                )
            [2] => 122
        )
    [36] => Array(
            [0] => p_close
            [1] => Array()
            [2] => 122
        )
    [37] => Array(
            [0] => document_end
            [1] => Array()
            [2] => 122
        )
)

Верхний уровень массива — это просто список. Каждый из его дочерних элементов описывает возвратную функцию, которая будет запущена под преобразователем (см. описание Renderer ниже), также как и индекс байта исходного текста, где был найден особенный «элемент» синтаксиса вики.

Единственная инструкция

Рассмотрим единственный элемент, который представляет единственную инструкцию, из списка инструкций, приведённого выше:

    [35] => Array
        (
            [0] => cdata
            [1] => Array
                (
                    [0] => def

                )
            [2] => 122
        )

Первый элемент (индекс 0) — это имя метода или функции в Renderer, которую необходимо выполнить.

Второй элемент (индекс 1) сам по себе является массивом, каждый из элементов которого является аргументом для метода Renderer, который будет вызван.

В этом случае имеется один аргумент со значением "def\n", поэтому вызов метода будет выглядеть так:

$Render->cdata("def\n");

Третий элемент (индекс 2) — это индекс байта первого символа, который «запустил» эту инструкцию в необработанном текстовом документе. Он должен быть таким же, как значение, возвращаемое функцией PHP strpos. Это можно использовать для извлечения разделов необработанного текста вики на основе позиций сгенерированных из него инструкций (пример ниже).

Примечание: Метод парсера parse дополняет необработанный текст вики предшествующим и последующим символом перевода строки, чтобы гарантировать корректный выход определенных состояний лексера, поэтому вам может потребоваться вычесть 1 из индекса байта, чтобы получить правильное местоположение в исходном необработанном тексте вики. Парсер также нормализует переводы строк в соответствии со стилем Unix (т. е. все \r\n становятся \n), поэтому документ, который видит лексер, может быть меньше того, который вы ему фактически дали.

Пример массив инструкций страницы с описанием синтаксиса можно найти здесь.

Renderer (преобразователь)

Renderer (преобразователь) — это класс (или коллекция функций), определяемый вами. Его интерфейс описан в файле inc/parser/renderer.php и выглядит так:

<?php
class Doku_Renderer {
 
    // вырезка
 
    public function header($text, $level) {}
 
    public function section_open($level) {}
 
    public function section_close() {}
 
    public function cdata($text) {}
 
    public function p_open() {}
 
    public function p_close() {}
 
    public function linebreak() {}
 
    public function hr() {}
 
    // вырезка
}

Он используется для документирования Renderer, хотя его также можно расширить, если вы хотите написать Renderer, который захватывает только определенные вызовы.

Основной принцип того, как инструкции, возвращаемые парсером, используются против Renderer, аналогичен понятию SAX XML API - инструкции представляют собой список имен функций/методов и их аргументов. Проходя по списку инструкций, каждая инструкция может быть вызвана против Renderer (т. е. методы, предоставляемые Renderer, являются callbacks). Unlike the SAX API, where only a few, fairly general, callbacks are available (e.g. tag_start, tag_end, cdata etc.). В отличие от SAX API , где доступно только несколько, довольно общих, обратных вызовов (например, tag_start, tag_end, cdata и т. д.), Renderer определяет более явный API , где методы обычно соответствуют один к одному акту генерации вывода. В разделе Renderer, показанном выше, методы p_open и p_close будут использоваться для вывода тегов <p> и </p> в XHTML, соответственно, в то время как header функция принимает два аргумента — некоторый текст для отображения и «уровень» заголовка, поэтому вызов типа header('Some Title', 1) будет выведен в XHTML типа <h1>Some Title</h1>.

Вызов рендерера с инструкциями

Клиентскому коду, использующему Parser, остается выполнить список инструкций для Renderer. Обычно это делается с помощью функции PHP call_user_func_array() function. Например;

// Получить список инструкций от парсера 
$instructions = $parser->parse($rawDoc);
 
// Создаем рендерер 
$renderer = new Doku_Renderer_xhtml();
 
// Проходим по инструкциям 
foreach ($instructions as $instruction) {
    // Выполняем обратный вызов для Renderer 
    call_user_func_array([$renderer, $instruction[0]], $instruction[1]);
}

Методы связи с рендерером

Ключевые методы Renderer для обработки различных типов ссылок:

function camelcaselink($link) {} // $link like "SomePage"
- Вероятно, это можно проигнорировать для проверки на спам — никто не должен иметь возможности ссылаться на сторонние сайты с таким синтаксисом.
function internallink($link, $title = null) {} // $link like "[[syntax]]"
- Хотя $link сам по себе является внутренним, $title может быть изображением, которое находится вне сайта, поэтому необходимо проверить
function externallink($link, $title = null) {}
- Оба изображения $link и $title (изображения) нуждаются в проверке
function interwikilink($link, $title = null, $wikiName, $wikiUri) {}
- Необходимость $title проверки изображений
function filelink($link, $title = null) {}
- Технически должны совпадать только действительные file:// URL-адреса, но, вероятно, лучше все равно проверить, плюс $title может быть стороннее изображение
function windowssharelink($link, $title = null) {}
- Должен соответствовать только допустимым URL-адресам общих ресурсов Windows, но в любом случае проверять наличие $title изображений
function emaillink($address, $title = null) {}
- $title может быть изображение. Проверить почту тоже?$titleможет быть изображение. Проверить почту тоже?
function internalmedialink($src, $title = null, $align = null, $width = null, $height = null, $cache = null) {}
- Это не требует проверки — должно ссылаться только на локальные изображения. $title само по себе не может быть изображением
function externalmedialink($src, $title = null, $align = null, $width = null, $height = null, $cache = null) {}
- $src нуждается в проверке

Особого внимания требуют методы, которые принимаютe $title аргумент, представляющий видимый текст ссылки, например;

<a href="https://www.example.com">This is the title</a>

Аргумент $title может иметь три возможных типа значений;

null: в вики-документе заголовок не указан.
string: в качестве заголовка использовалась простая текстовая строка
array (hash): в качестве заголовка использовано изображение.

Если это $title массив, он будет содержать ассоциативные значения, описывающие изображение;

$title = [
    // Может быть 'internalmedia' (локальное изображение) или 'externalmedia' (внешнее изображение) 
    'type' => 'internalmedia',
 
    // URL-адрес изображения (может быть URL-адресом wiki или https://static.example.com/img.png) 
    'src' => 'wiki:php-powered.png',
 
    // Для атрибута alt - строка или null 
    'title' => 'Powered by PHP',
 
    // 'left', 'right', 'center' или null
    'align' => 'right',
 
    // Ширина в пикселях или null 
    'width' => 50,
 
    // Высота в пикселях или null 
    'height' => 75,
 
    // Кэшировать ли изображение (для внешних изображений)
    'cache' => false,
];

Примеры

Следующие примеры показывают общие задачи, которые будут решаться с помощью парсера.

Основной вызов

Чтобы вызвать парсер со всеми режимами, и обработать синтаксис документа «Докувики»:

require_once DOKU_INC . 'parser/parser.php';
 
// Создать парсер
$Parser = & new Doku_Parser();
 
// Добавить обработчик
$Parser->Handler = & new Doku_Handler();
 
// Загрузить все режимы
$Parser->addMode('listblock',new Doku_Parser_Mode_ListBlock());
$Parser->addMode('preformatted',new Doku_Parser_Mode_Preformatted()); 
$Parser->addMode('notoc',new Doku_Parser_Mode_NoToc());
$Parser->addMode('header',new Doku_Parser_Mode_Header());
$Parser->addMode('table',new Doku_Parser_Mode_Table());
 
$formats = array (
    'strong', 'emphasis', 'underline', 'monospace',
    'subscript', 'superscript', 'deleted',
);
foreach ( $formats as $format ) {
    $Parser->addMode($format,new Doku_Parser_Mode_Formatting($format));
}
 
$Parser->addMode('linebreak',new Doku_Parser_Mode_Linebreak());
$Parser->addMode('footnote',new Doku_Parser_Mode_Footnote());
$Parser->addMode('hr',new Doku_Parser_Mode_HR());
 
$Parser->addMode('unformatted',new Doku_Parser_Mode_Unformatted());
$Parser->addMode('php',new Doku_Parser_Mode_PHP());
$Parser->addMode('html',new Doku_Parser_Mode_HTML());
$Parser->addMode('code',new Doku_Parser_Mode_Code());
$Parser->addMode('file',new Doku_Parser_Mode_File());
$Parser->addMode('quote',new Doku_Parser_Mode_Quote());
 
// Здесь требуются данные. Функции ''get*''остаются на ваше усмотрение
$Parser->addMode('acronym',new Doku_Parser_Mode_Acronym(array_keys(getAcronyms())));
$Parser->addMode('wordblock',new Doku_Parser_Mode_Wordblock(array_keys(getBadWords())));
$Parser->addMode('smiley',new Doku_Parser_Mode_Smiley(array_keys(getSmileys())));
$Parser->addMode('entity',new Doku_Parser_Mode_Entity(array_keys(getEntities())));
 
$Parser->addMode('multiplyentity',new Doku_Parser_Mode_MultiplyEntity());
$Parser->addMode('quotes',new Doku_Parser_Mode_Quotes());
 
$Parser->addMode('camelcaselink',new Doku_Parser_Mode_CamelCaseLink());
$Parser->addMode('internallink',new Doku_Parser_Mode_InternalLink());
$Parser->addMode('media',new Doku_Parser_Mode_Media());
$Parser->addMode('externallink',new Doku_Parser_Mode_ExternalLink());
$Parser->addMode('email',new Doku_Parser_Mode_Email());
$Parser->addMode('windowssharelink',new Doku_Parser_Mode_WindowsShareLink());
$Parser->addMode('filelink',new Doku_Parser_Mode_FileLink());
$Parser->addMode('eol',new Doku_Parser_Mode_Eol());
 
// Загрузить исходный документ вики
$doc = file_get_contents(DOKU_DATA . 'wiki/syntax.txt');
 
// Получить список инструкций
$instructions = $Parser->parse($doc);
 
// Создать преобразователь
require_once DOKU_INC . 'parser/xhtml.php';
$Renderer = & new Doku_Renderer_XHTML();
 
# Здесь загрузите в преобразователь данные (например, типа смайлов)

// Проходимся по всем инструкциям
foreach ( $instructions as $instruction ) {
 
    // Выполняем обратный вызов через преобразователь
    call_user_func_array(array(&$Renderer, $instruction[0]),$instruction[1]);
}
 
// Отображаем выходные данные
echo $Renderer->doc;

Выбор текста (для фрагментов)

Следующий код показывает, как выбрать фрагмент исходного текста, используя инструкции, полученные из парсера;

// Создаём парсер
$Parser = & new Doku_Parser();
 
// Добавляем обработчик
$Parser->Handler = & new Doku_Handler();
 
// Загружаем режим header для поиска заголовков
$Parser->addMode('header',new Doku_Parser_Mode_Header());
 
// Загружаем режимы, которые могут содержать разметку,
// которая может быть принята за заголовок
$Parser->addMode('listblock',new Doku_Parser_Mode_ListBlock());
$Parser->addMode('preformatted',new Doku_Parser_Mode_Preformatted()); 
$Parser->addMode('table',new Doku_Parser_Mode_Table());
$Parser->addMode('unformatted',new Doku_Parser_Mode_Unformatted());
$Parser->addMode('php',new Doku_Parser_Mode_PHP());
$Parser->addMode('html',new Doku_Parser_Mode_HTML());
$Parser->addMode('code',new Doku_Parser_Mode_Code());
$Parser->addMode('file',new Doku_Parser_Mode_File());
$Parser->addMode('quote',new Doku_Parser_Mode_Quote());
$Parser->addMode('footnote',new Doku_Parser_Mode_Footnote());
$Parser->addMode('internallink',new Doku_Parser_Mode_InternalLink());
$Parser->addMode('media',new Doku_Parser_Mode_Media());
$Parser->addMode('externallink',new Doku_Parser_Mode_ExternalLink());
$Parser->addMode('email',new Doku_Parser_Mode_Email());
$Parser->addMode('windowssharelink',new Doku_Parser_Mode_WindowsShareLink());
$Parser->addMode('filelink',new Doku_Parser_Mode_FileLink());
 
// Загружаем исходный документ вики
$doc = file_get_contents(DOKU_DATA . 'wiki/syntax.txt');
 
// Получаем перечень инструкций
$instructions = $Parser->parse($doc);
 
// Используем эти переменные, чтобы узнать,
// находимся ли мы внутри необходимого фрагмента
$inSection = FALSE;
$startPos = 0;
$endPos = 0;
 
// Проходимся по всем инструкциям
foreach ( $instructions as $instruction ) {
 
    if ( !$inSection ) {
 
        // Ищем заголовки в списках
        if ( $instruction[0] == 'header' &&
                trim($instruction[1][0]) == 'Lists' ) {
 
            $startPos = $instruction[2];
            $inSection = TRUE;
        }
    } else {
 
        // Ищем конец фрагмента
        if ( $instruction[0] == 'section_close' ) {
            $endPos = $instruction[2];
            break;
        }
    }
}
 
// Нормализуем и разбиваем документ
$doc = "\n".str_replace("\r\n","\n",$doc)."\n";
 
// Получаем текст, идущий перед фрагментом, который нам необходим
$before = substr($doc, 0, $startPos);
$section = substr($doc, $startPos, ($endPos-$startPos));
$after = substr($doc, $endPos);

Управление входными файлами с данными в шаблонах

«Докувики» хранит части некоторых шаблонов во внешних файлах (например, смайлы). Поскольку парсинг и вывод документа являются отдельными стадиями, обрабатываемыми различными компонентами, при использовании данных также требуется дифференцированный подход.

Каждый подходящий режим принимает простой список элементов, который он собирает в список шаблонов для регистрации в анализаторе.

Например:

// Простой список вхождений смайлов...
$smileys = array(
    ':-)',
    ':-(',
    ';-)',
    // и т. д.
    );
 
// Создать режим
$SmileyMode = & new Doku_Parser_Mode_Smiley($smileys);
 
// Добавить режим в парсер
$Parser->addMode($SmileyMode);

Для парсера не имеет значения выходной формат смайлов.

Другие режимы, где применяется подобный подход, определяются классами;

Doku_Parser_Mode_Acronym — для сокращений;
Doku_Parser_Mode_Wordblock — для блоков специфических слов (например, ненормативной лексики);
Doku_Parser_Mode_Entity — для типографических символов.

Конструктор каждого класса принимает в качестве параметра список указанных элементов.

На практике возникает необходимость в функциях для извлечения данных из конфигурационных файлов и размещение ассоциативных массивов в статической переменной, например:

function getSmileys() {
 
    static $smileys = NULL;
 
    if ( !$smileys ) {
 
        $smileys = array();
 
        $lines = file( DOKU_CONF . 'smileys.conf');
 
        foreach($lines as $line){
 
            // игнорировать комментарии
            $line = preg_replace('/#.*$/','',$line);
 
            $line = trim($line);
 
            if(empty($line)) continue;
 
            $smiley = preg_split('/\s+/',$line,2);
 
            // Собрать ассоциативный массив
            $smileys[$smiley[0]] = $smiley[1];
        }
    }
 
    return $smileys;
}

Эта функция может быть использована следующим образом:

// Загрузить шаблоны смайлов в режим
$SmileyMode = & new Doku_Parser_Mode_Smiley(array_keys(getSmileys()));

// Загрузить ассоциативный массив в Преобразователь
$Renderer->smileys = getSmileys();

Замечание: проверка ссылок, которые необходимо блокировать, обрабатывается другим способом, описанным ниже.

Проверка ссылок на спам

В идеале ссылки требуется проверять на спам до размещения документа (после редактирования).

Этот пример следует использовать осторожно. Он создаёт полезные точки связывания, но по результатам тестирования является очень медленным — возможно проще использовать функцию, которая «закрывает глаза» на синтаксис, но ищет во всем документе ссылки, сверяя их с «чёрным списком». Между тем, этот пример может быть полезным как основа для построения «карты вики» или поиска «требуемых страниц» посредством проверки внутренних ссылок.

Это можно сделать, создав специальный преобразователь, который проверяет только относящиеся к ссылкам обратные вызовы и сверяет ULR с «чёрным списком».

Требуется функция для загрузки файла spam.conf и связывания его с единственным регулярным выражением:

Недавно протестировал этот подход (единственное регулярное выражение) с использованием последней версии «чёрного списка» с blacklist.chongqed.org и получил ошибки о том, что окончательное регулярное выражение слишком велико. Возможно, следует разбить регулярное выражение на маленькие кусочки и возвращать их как массив.

function getSpamPattern() {
    static $spamPattern = NULL;
 
    if ( is_null($spamPattern) ) {
 
        $lines = @file(DOKU_CONF . 'spam.conf');
 
        if ( !$lines ) {
 
            $spamPattern = '';
 
        } else {
 
            $spamPattern = '#';
            $sep = '';
 
            foreach($lines as $line){
 
                $line = preg_replace('/#.*$/','',$line);
 
                // Игнорировать пустые строки
                $line = trim($line);
                if(empty($line)) continue;
 
                $spamPattern.= $sep.$line;
 
                $sep = '|';
            }
 
            $spamPattern .= '#si';
        }
    }
 
    return $spamPattern;
}

Теперь нам нужно расширить основной преобразователь ещё одним, который проверяет только ссылки:

require_once DOKU_INC . 'parser/renderer.php';
 
class Doku_Renderer_SpamCheck extends Doku_Renderer {
 
    // Здесь должен быть код, выполняющий инструкции
    var $currentCall;
 
    // Массив инструкций, которые содержат спам
    var $spamFound = array();
 
    // PCRE-шаблон для нахождения спама
    var $spamPattern = '#^$#';
 
    function internallink($link, $title = NULL) {
        $this->__checkTitle($title);
    }
 
    function externallink($link, $title = NULL) {
        $this->__checkLinkForSpam($link);
        $this->__checkTitle($title);
    }
 
    function interwikilink($link, $title = NULL) {
        $this->__checkTitle($title);
    }
 
    function filelink($link, $title = NULL) {
        $this->__checkLinkForSpam($link);
        $this->__checkTitle($title);
    }
 
    function windowssharelink($link, $title = NULL) {
        $this->__checkLinkForSpam($link);
        $this->__checkTitle($title);
    }
 
    function email($address, $title = NULL) {
        $this->__checkLinkForSpam($address);
        $this->__checkTitle($title);
    }
 
    function internalmedialink ($src) {
        $this->__checkLinkForSpam($src);
    }
 
    function externalmedialink($src) {
        $this->__checkLinkForSpam($src);
    }
 
    function __checkTitle($title) {
        if ( is_array($title) && isset($title['src'])) {
            $this->__checkLinkForSpam($title['src']);
        }
    }
 
    // Поиск по шаблону осуществляется здесь
    function __checkLinkForSpam($link) {
        if( preg_match($this->spamPattern,$link) ) {
            $spam = $this->currentCall;
            $spam[3] = $link;
            $this->spamFound[] = $spam;
        }
    }
}

Обратите внимание на строку $spam[3] = $link; в методе __checkLinkForSpam. Она вставляет дополнительный элемент в список найденных спамовых инструкций, позволяя легко определить, какие URL были «плохими».

Наконец мы можем использовать преобразователь с проверкой на спам:

// Создать парсер
$Parser = & new Doku_Parser();
 
// Добавить обработчик
$Parser->Handler = & new Doku_Handler();
 
// Добавить режимы, которые могут содержать разметку,
// которая ошибочно будет принята за ссылку
$Parser->addMode('preformatted',new Doku_Parser_Mode_Preformatted()); 
$Parser->addMode('unformatted',new Doku_Parser_Mode_Unformatted());
$Parser->addMode('php',new Doku_Parser_Mode_PHP());
$Parser->addMode('html',new Doku_Parser_Mode_HTML());
$Parser->addMode('code',new Doku_Parser_Mode_Code());
$Parser->addMode('file',new Doku_Parser_Mode_File());
$Parser->addMode('quote',new Doku_Parser_Mode_Quote());
 
// Загружаем режим link...
$Parser->addMode('internallink',new Doku_Parser_Mode_InternalLink());
$Parser->addMode('media',new Doku_Parser_Mode_Media());
$Parser->addMode('externallink',new Doku_Parser_Mode_ExternalLink());
$Parser->addMode('email',new Doku_Parser_Mode_Email());
$Parser->addMode('windowssharelink',new Doku_Parser_Mode_WindowsShareLink());
$Parser->addMode('filelink',new Doku_Parser_Mode_FileLink());
 
// Загружаем исходный документ вики
$doc = file_get_contents(DOKU_DATA . 'wiki/spam.txt');
 
// Получить список инструкций
$instructions = $Parser->parse($doc);
 
// Создать преобразователь
require_once DOKU_INC . 'parser/spamcheck.php';
$Renderer = & new Doku_Renderer_SpamCheck();
 
// Загрузить шаблон спама
$Renderer->spamPattern = getSpamPattern();
 
// Пройтись по всем инструкциям
foreach ( $instructions as $instruction ) {
 
    // Сохранить текущую инструкцию
    $Renderer->currentCall = $instruction;
 
    call_user_func_array(array(&$Renderer, $instruction[0]),$instruction[1]);
}
 
// Что за спам был найден?
echo '<pre>';
print_r($Renderer->spamFound);
echo '</pre>';

Поскольку нам не нужны все режимы синтаксиса, проверка спама таким способом будет быстрее, чем обычный парсинг документа.

Добавление синтаксической конструкции

Предупреждение: приведённый ниже код ещё не испытан — это только пример.

Простая задача по модификации парсера: этот пример будет добавлять тэг-«закладку», который может быть использован для создания якоря в документе для создания ссылки на него.

Синтаксис для тэга будет таким:

BM{Моя закладка}

Строка «Моя закладка» является наименование закладки, а BM {} идентифицируется как сама закладка. В HTML эта конструкция будет соответствовать:

<a name="Моя закладка"></a>

Добавление этой синтаксической конструкции требует следующих шагов:

создать синтаксический режим парсера, для регистрации в лексическом анализаторе;
обновить код функции Doku_Parser_Substition, находящейся в конце файла parser.php и которая используется для быстрого получения списка режимов (используется в классах вродеDoku_Parser_Mode_Table);
обновить код обработчика, дополнив его методом, «ловящим» вхождения закладок;
обновление абстрактного класса преобразователя и какого-нибудь конкретного преобразователя.

Создание режима парсера подразумевает расширение класса Doku_Parser_Mode и перегрузкой метода connectTo:

class Doku_Parser_Mode_Bookmark extends Doku_Parser_Mode {
 
    function connectTo($mode) {
        // Разрешаются слова и пробелы
        $this->Lexer->addSpecialPattern('BM\{[\w ]+\}',$mode,'bookmark');
    }
 
}

Будет осуществляться поиск целой закладки с использованием единственного шаблона (извлечение имени закладки из остального синтаксиса будет осущевляться обработчиком). Используется метод addSpecialPattern анализатора, так что закладка присутствует в своём собственном состоянии.

Замечание: анализатор не требует ограничителей шаблона — он заботиться об этом за вас.

Поскольку ничто внутри закладки не должно рассматриваться как годная разметка вики, связывание с другими режимами, которые может принимать этот, отсутствует.

Следующая функция Doku_Parser_Substition в файле inc/parser/parser.php требует обновления, чтобы она возвращала в списке новый режим с наименованием bookmark;

function Doku_Parser_Substition() {
    $modes = array(
        'acronym','smiley','wordblock','entity','camelcaselink',
        'internallink','media','externallink','linebreak','email',
        'windowssharelink','filelink','notoc','multiplyentity',
        'quotes','bookmark',
 
    );
    return $modes;
}

Эта функция лишь помогает в регистрации режима с другими режимами, которые получают его (например, списки могут содержать этот режим — ваша ссылка может быть внутри списка).

Замечание: существует похожая функция, вроде Doku_Parser_Protected и Doku_Parser_Formatting, которые возвращают разные группы режимов. Группировка различных типов синтаксиса не является полностью совершенной, но всё равно остаётся полезной для экономии кода.

Описав синтаксис, мы должны добавить в обработчик новый метод, который сравнивает наименование режима (т. е.bookmark).

class Doku_Handler {
 
    // ...
 
    // $match - строка, которая сравнивается анализатором
    //          с регулярным выражением для закладок
    // $state идентифицирует тип совпадения (см. выше)
    // $pos - индекс байта первого символа совпадения в исходном документе
    function bookmark($match, $state, $pos) {
 
        // Технически не следует беспокоится о состоянии:
        // оно всегда будет DOKU_LEXER_SPECIAL, если
        // нет серьёзных багов
        switch ( $state ) {
 
            case DOKU_LEXER_SPECIAL:
 
                // Попытка извлечения наименования закладки
                if ( preg_match('/^BM\{(\w{1,})\}$/', $match, $nameMatch) ) {
 
                    $name = $nameMatch[1];
 
                    // arg0: наименование вызываемого метода преобразователя
                    // arg1: массив аргументов для метода преобразователя
                    // arg2: индекс байта
                    $this->__addCall('bookmark', array($name), $pos);
 
                // Если у закладки нет годного имени,
                //  пропускаем не меняя как cdata
                } else {
 
                    $this->__addCall('cdata', array($match), $pos);
 
                }
            break;
 
        }
 
        // Должно вернуть TRUE или анализатор будет остановлен
        return TRUE;
    }
 
    // ...
 
}

Последний этап — обновление кода преобразователя (renderer.php) новой функцией и её реализация в XHTML преобразовании (xhtml.php):

class Doku_Renderer {
 
    // ...
 
    function bookmark($name) {}
 
    // ...
 
}

class Doku_Renderer_XHTML {
 
    // ...
 
    function bookmark($name) {
        $name = $this->__xmlEntities($name);
 
        // id is required in XHTML while name still supported in 1.0
        echo '<a class="bookmark" name="'.$name.'" id="'.$name.'"></a>';
 
    }
 
    // ...
 
}

См. скрипт tests/parser_replacements.test.php в качестве примера того, как можно использовать этот код.

Добавление синтаксиса форматирования (с состоянием)

Предупреждение: нижеприведённый код ещё не протестирован — это только пример.

Для того, чтобы показать расширенное использование анализатора, этот пример добавляет разметку, которая позволяет пользователям менять цвет обрамляемый текст на красный, жёлтый или зелёный.

Разметка будет выглядеть так:

<red>Это красный цвет</red>.
Это чёрный цвет
<yellow>Это жёлтый цвет</yellow>.
Это тоже чёрный цвет
<green>Это зелёный цвет</green>.

Шаги, необходимые для внедрения данной возможности, в сущности, являются такими же, как в предыдущем примере, начинаются с нового синтаксического режима, но добавляет некоторые детали, поскольку задействуются другие режимы:

class Doku_Parser_Mode_TextColors extends Doku_Parser_Mode {
 
    var $color;
 
    var $colors = array('red','green','blue');
 
    function Doku_Parser_Mode_TextColor($color) {
 
        // Предотвращает ошибки использования этого режима
        if ( !array_key_exists($color, $this->colors) ) {
            trigger_error('Invalid color '.$color, E_USER_WARNING);
        }
 
        $this->color = $color;
 
        // Этот режим принимает другие режимы:
        $this->allowedModes = array_merge (
            Doku_Parser_Formatting($color),
            Doku_Parser_Substition(),
            Doku_Parser_Disabled()
        );
 
    }
 
    // connectTo вызывается однократно для каждого режима, зарегистрированного анализатором
    function connectTo($mode) {
 
        // Шаблон с просмотром вперёд проверяет наличие закрывающего тэга...
        $pattern = '<'.$this->color.'>(?=.*</'.$this->color.'>)';
 
        // arg0: шаблон сравнения при входе в режим;
        // arg1: другие режимы, может сравниваться этот шаблон;
        // arg2: наименование режима.
        $this->Lexer->addEntryPattern($pattern,$mode,$this->color);
    }
 
    // post connect вызывается однократно
    function postConnect() {
 
        // arg0: шаблон сравнения при выходе из режима;
        // arg1: наименование режима.
        $this->Lexer->addExitPattern('</'.$this->color.'>',$this->color);
 
    }
 
}

Некоторые особенности вышеприведённых классов:

В действительности представляют множество режимов, один для каждого цвета. Цвета следует выделять в отдельные режимы так, что, например, </green> не будет закрывающим тэгом для <red>.
Эти режимы могут содержать, например, <red>**Предупреждение**</red> для полужирного текста красного цвета. Это регистрируется в конструкторе класса назначением полученных наименований режимов свойству allowedModes.
Когда регистрируется входной шаблон, имеет смысл проверить существование выходного шаблона (с помощью просмотра вперёд). Это поможет в защите пользователей от них самих, когда они забудут добавить закрывающий тэг.
Входной шаблон требует регистрации для каждого режима, внутри которого тэги <color /> могут использоваться. Нам требуется толь один выходной шаблон, помещённый в метод postConnect, который исполняется однократно, после всех вызовов connectTo по всем вызванным режимам.

Когда с классом режимами обработки покончено, новые режимы требуется добавить в в функцию Doku_Parser_Formatting:

function Doku_Parser_Formatting($remove = '') {
    $modes = array(
        'strong', 'emphasis', 'underline', 'monospace', 
        'subscript', 'superscript', 'deleted',
        'red','yellow','green',
        );
    $key = array_search($remove, $modes);
    if ( is_int($key) ) {
        unset($modes[$key]);
    }
 
    return $modes;
}

Замечание: эта функция обрабатывается, чтобы снять режим для предотвращения включения режима форматирования в самого себя (так, например, нежелательно: <red>Срочное<red>и важное</red>сообщение</red>).

Далее обработчик должен быть обновлён методами для каждого цвета:

class Doku_Handler {
 
    // ...
 
    function red($match, $state, $pos) {
        // Метод nestingTag в обработчике предотвращает
        // многократное повторение одного и того же кода.
        // Он создаёт открывающий и закрывающий инструкции
        // для входных и выходных шаблонов,
        // пропуская остальные как cdata.
        $this->__nestingTag($match, $state, $pos, 'red');
        return TRUE;
    }
 
    function yellow($match, $state, $pos) {
        $this->__nestingTag($match, $state, $pos, 'yellow');
        return TRUE;
    }
 
    function green($match, $state, $pos) {
        $this->__nestingTag($match, $state, $pos, 'green');
        return TRUE;
    }
 
    // ...
 
}

Наконец мы может обновить преобразователи:

class Doku_Renderer {
 
    // ...
 
    function red_open() {}
    function red_close() {}
 
    function yellow_open() {}
    function yellow_close() {}
 
    function green_open() {}
    function green_close() {}
 
    // ...
 
}

class Doku_Renderer_XHTML {
 
    // ...
 
    function red_open() {
        echo '<span class="red">';
    }
    function red_close() {
        echo '</span>';
    }
 
    function yellow_open() {
        echo '<span class="yellow">';
    }
    function yellow_close() {
        echo '</span>';
    }
 
    function green_open() {
        echo '<span class="green">';
    }
    function green_close() {
        echo '</span>';
    }
 
    // ...
 
}

См. скрипт tests/parser_formatting.test.php в качестве примера того, как можно использовать этот код.

Добавление блочных синтаксических конструкций

Предупреждение: приведённый ниже код ещё не тестировался — это только пример.

Развивая предыдущий пример, этот будет создавать новый тэг для разметки сообщений о том, что ещё предстоит сделать. Пример использования может выглядеть так:

===== Синтаксис цитирования в вики =====

Этот синтаксис позволяет

<todo>
Опишите синтаксис цитирования '>'
</todo>

Другой текст

Этот синтаксис позволяет искать страницы вики и находить вопросы, которые предстоит решить, выделяя их в документе бросающимся в глаза стилем.

Особенностью данного синтаксиса является то, что он должен отображаться в отдельном блоке документа (например, внутри

, так что он с помощью CSS может «плавать»). Это требует модификации класса Doku_Handler_Block, который пробегает по всем инструкциям, после того, как обработчиком найдены все вхождения, и заботиться о добавлении тэгов <p/>.

Режим парсера для этого синтаксиса может быть таким:

class Doku_Parser_Mode_Todo extends Doku_Parser_Mode {
 
    function Doku_Parser_Mode_Todo() {
 
        $this->allowedModes = array_merge (
            Doku_Parser_Formatting(),
            Doku_Parser_Substition(),
            Doku_Parser_Disabled()
        );
 
    }
 
    function connectTo($mode) {
 
        $pattern = '<todo>(?=.*</todo>)';
        $this->Lexer->addEntryPattern($pattern,$mode,'todo');
    }
 
    function postConnect() {
        $this->Lexer->addExitPattern('</todo>','todo');
    }
 
}

Затем этот режим добавляется в функцию Doku_Parser_BlockContainers в файле parser.php:

function Doku_Parser_BlockContainers() {
    $modes = array(
        'footnote', 'listblock', 'table','quote',
        // горизонтальные разрывы нарушают принцип, но они не могут использоваться в таблицах / списках, 
        // так что вставляем их сюда
        'hr',
        'todo',
    );
    return $modes;
}

Обновление класса Doku_Handler:

class Doku_Handler {
 
    // ...
 
    function todo($match, $state, $pos) {
        $this->__nestingTag($match, $state, $pos, 'todo');
        return TRUE;
    }
 
    // ...
 
}

Класс Doku_Handler_Block (см. файл inc/parser/handler.php) также нуждается в обновлении, чтобы регистрировать открывающие и закрывающие инструкции todo:

class Doku_Handler_Block {
 
    // ...
 
    var $blockOpen = array(
            'header',
            'listu_open','listo_open','listitem_open',
            'table_open','tablerow_open','tablecell_open','tableheader_open',
            'quote_open',
            'section_open', // Needed to prevent p_open between header and section_open
            'code','file','php','html','hr','preformatted',
            'todo_open',
        );
 
    var $blockClose = array(
            'header',
            'listu_close','listo_close','listitem_close',
            'table_close','tablerow_close','tablecell_close','tableheader_close',
            'quote_close',
            'section_close', // Needed to prevent p_close after section_close
            'code','file','php','html','hr','preformatted',
            'todo_close',
        );

Регистрация todo_open и todo_close в массивах $blockOpen и $blockClose сообщает классу Doku_Handler_Block, что любые предыдущие абзацы должны быть закрыты до входа в секцию todo, а новый абзац должен начинаться после секции todo. Внутри todo дополнительные абзацы не вставляются.

После этого должен быть обновлён код преобразователя:

class Doku_Renderer {
 
    // ...
 
    function todo_open() {}
    function todo_close() {}
 
    // ...
 
}

class Doku_Renderer_XHTML {
 
    // ...
 
    function todo_open() {
        echo '<div class="todo">';
    }
    function todo_close() {
        echo '</div>';
    }
 
    // ...
 
}

Сериализация инструкций преобразователя

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

Самая простая реализация может быть такой:

$ID = DOKU_DATA . 'wiki/syntax.txt';
$cacheID = DOKU_CACHE . $ID.'.cache';
 
// Если кэш-файл отсутствует или утратил актуальность
// (исходный документ модифицирован), получить «свежий» список инструкций
if ( !file_exists($cacheID) || (filemtime($ID) > filemtime($cacheID)) ) {
 
    require_once DOKU_INC . 'parser/parser.php';
 
    // Создать парсер
    $Parser = & new Doku_Parser();
 
    // Добавить обработчик
    $Parser->Handler = & new Doku_Handler();
 
    // Загрузить все режимы
    $Parser->addMode('listblock',new Doku_Parser_Mode_ListBlock());
    $Parser->addMode('preformatted',new Doku_Parser_Mode_Preformatted()); 
    $Parser->addMode('notoc',new Doku_Parser_Mode_NoToc());
    $Parser->addMode('header',new Doku_Parser_Mode_Header());
    $Parser->addMode('table',new Doku_Parser_Mode_Table());
 
    // и т. д., и т. п.
 
    $instructions = $Parser->parse(file_get_contents($filename));
 
    // Сериализировать и кэшировать 
    $sInstructions = serialize($instructions);
 
    if ($fh = @fopen($cacheID, 'a')) {
 
        if (fwrite($fh, $sInstructions) === FALSE) {
            die("Cannot write to file ($cacheID)");
        }
 
        fclose($fh);
    }
 
} else {
    // Загрузить и десериализировать
    $sInstructions = file_get_contents($cacheID);
    $instructions = unserialize($sInstructions);
}
 
$Renderer = & new Doku_Renderer_XHTML();
 
foreach ( $instructions as $instruction ) {
    call_user_func_array(
        array(&$Renderer, $instruction[0]),$instruction[1]
        );
}
 
echo $Renderer->doc;

Замечание: эта реализация не является полной. Что должно просходить, если кто-либо, например, модифицирует файл smiley.conf, добавив новый смайл? Это изменение должно порождать изменение кэша с обработкой нового смайла. Также необходимо позаботиться о блокировке файлов (или их переименовании).

Сериализация парсера

По аналогии с приведённым выше примером, возможна сериализация самого парсера до начала обработки. Поскольку установка режимов поддерживает довольно высокую перегрузку, этот пример может немного увеличить производительность. По неточной оценке, обработка страницы syntax в медленной системе занимает около 1,5-а секунд для завершения без сериализации и около 1,25-х секунды в версии парсера с поддержкой сериализации.

Если коротко, то сериализация может быть реализована таким способом:

$cacheId = DOKU_CACHE . 'parser.cache';
 
if ( !file_exists($cacheId) ) {
 
    // Создаём парсер
    $Parser = & new Doku_Parser();
    $Parser->Handler = & new Doku_Handler();
 
    // Загружаем все режимы
    $Parser->addMode('listblock',new Doku_Parser_Mode_ListBlock());
    $Parser->addMode('preformatted',new Doku_Parser_Mode_Preformatted());
 
    # и т. д., и т. п.
    
    // ВАЖНО: вызов connectModes()
    $Parser->connectModes();
 
    // Сериализация
    $sParser = serialize($Parser);
 
    // Запись в файл
    if ($fh = @fopen($cacheID, 'a')) {
 
        if (fwrite($fh, $sParser) === FALSE) {
            die("Cannot write to file ($cacheID)");
        }
 
        fclose($fh);
    }
 
} else {
    // Загружаем сериализированную версию
    $sParser = file_get_contents($cacheID);
    $Parser = unserialize($sParser);
}
 
$Parser->parse($doc);

Некоторые замечания по реализации, не упомянутые выше:

Для некоторых файлов вместо записи требуется блокировка, в противном случае в ответ на запрос может быть получен частично кэшированный файл, если он будет считываться, пока продолжается запись.
Что следует делать, если обновляется один из файлов *.conf? Необходимо очистить кэш.
Могут быть различные версии парсера (например, с проверкой на спам), так что используйте кэш-идентификаторы (cache IDs).

Тестирование

Тесты программных единиц обеспечивают использование «Simple Test for PHP». «Simple Test» является отличным инструментом для тестирования единиц php-кода. Особенно выделяются блестящая документация (см. simpletest.sourceforge.net и www.lastcraft.com/simple_test.php) и хорошо продуманый код, обеспечивающий «прозрачное» решение многих вопросов (вроде перехвата ошибок PHP и сообщения о них в результатах тестирования).

Для парсера «Докувики» тесты проводились по всем внедряемым синтаксическим конструкциям, и я очень сильно рекомендую написание новых тестов, если добавляется новый синтаксис.

Чтобы запустить тесты, вам следует модифицировать файл tests/testconfig.php, указав корректные директории «Simple Test» и «Докувики».

Некоторые заметки и рекомендации:

Повторно запускайте тесты каждый раз, когда вы меняете что-нибудь в парсере — проблемы немедленно выплывают на поверхность, экономя кучу времени.
Это только тесты для специфических ситуаций. Они не гарантируют отсутствие ошибок, если в этих специфических ситуациях работают корректно.
Если найдена ошибка, в процессе её устранения напишите тесты (даже лучше, до её устранения), чтобы предотвратить её повторное возникновение.

Ошибки и проблемы

Некоторые вопросы остаются за рамками подробного рассмотрения.

Важность порядка добавления режимов

Требуется выполение не столько «правил», сколько порядка, в котором добавляются режимы (парсер этого не проверяет). В особенности, режим eol должен быть загружен последним, т. к. он «съедает» «обёрточные» символы, что может нарушить корректную работу других режимов, вроде list или table.

В общем случае рекомендуется загружать режимы в порядке, описанном выше в первом примере.

По моим наработкам, порядок важен, только если два и более режима имеют шаблоны, с которыми могут сравниваться одинаковые совокупности символов - в этом случае «выиграет» режим, имеющий низший порядковый номер. Синтаксический плагин может извлечь из этого выгоду, заменяя оригинальный обработчик, в качестве примера см. плагин «Code» — ChrisS 2005-07-30

Замены «блокиратора слов»

В оригинале функционирование «блокиратора слов» wordblock заключалось в сравнении URL ссылок с «чёрным списком». Сейчас этот режим используется для нахождения грубых слов. Для блокирования спамовых URL лучше использовать приведённый выше пример.

Рекомендация — файл conf/wordblock.conf следует переименовать в conf/spam.conf, содержащий «чёрный список» URL. Новый файлconf/badwords.conf будет содержать список цензурируемых грубых слов.

Слабые моменты

С точки зрения архитектуры, наихудшие части кода находятся в файле inc/parser/handler.php, преимущественно в «re-writing»-классах;

Doku_Handler_List (inline re-writer)
Doku_Handler_Preformatted (inline re-writer)
Doku_Handler_Quote (inline re-writer)
Doku_Handler_Table (inline re-writer)
Doku_Handler_Section (post processing re-writer)
Doku_Handler_Block (post processing re-writer)
Doku_Handler_Toc (post processing re-writer)

«Inline re-writers» используются, пока обработчик получает вхождения от анализатора, в то время как «post processing re-writers», вызываются из Doku_Handler::__finalize() и выполняются однократно в отношении полного списка инструкций, созданных обработчиком.

Возможно лучше устранить Doku_Handler_List, Doku_Handler_Quote и Doku_Handler_Table, использовав взамен многострочные лексические режимы.

Также возможно лучше изменить Doku_Handler_Section и Doku_Handler_Toc в «inline re-writers«, срабатывающие на вхождения заголовков, принимаемых Обработчиком.

Самое «больное место» — это класс Doku_Handler_Block, отвечающий за вставку абзацев в инструкции. Имеет значение добавить в него больше абстракций для облегчения разработки, но в общем-то я не вижу каких-либо путей полного его устранения.

«Жадные» тэги

Рассмотрим следующий синтаксис вики:

Привет, <sup>Мир! 

----

<sup>Пока,</sup> Мир...

Пользователь забыл закрыть первый тэг <sup>.

В результате получится:

Привет, ^{Мир!

—-

<sup>Пока,} Мир…

Первый тэг <sup> оказался слишком «жадным» в проверке своего входного шаблона.

Это применимо ко всем подобным режимам. Входные шаблоны проверяют наличие закрывающего тэга, но также они должны проверять, чтобы раньше не встретился второй открывающий тэг.

Сноски через список

В сущности, если сноска закрывается через несколько элементов списка, это вызывает эффект открывающей инструкции сноски без соответствующей закрывающей. Вот пример синтаксиса, вызывающего проблему:

  *((A))
    *(( B
  * C ))

Это будет происходить до тех пор, пока пользователи не поправят страницу. Решение — разбить захват элементов списка в многострочные режимы (сейчас для списков есть только единственный режим listblock).

Захват «обёрточных» символов

Баг № 261.

Поскольку синтаксис заголовка, горизонтальной линии, списка, таблицы, цитаты и неформатируемого (выделяемого) текста полагается на «обёрточные» символы для разметки своих начала и окончания, им требуются регулярные выражения, которые поглощают «обёрточные» символы. Это означает, что пользователь должен добавлять «обёрточные» символы, если таблица находится сразу после списка, например:

До списка
  - Элемент списка
  - Элемент списка
| Ячейка A | Ячейка B |
| Ячейка C | Ячейка D |
После таблицы

Выдаёт:

До списка

Элемент списка
Элемент списка

| Ячейка A | Ячейка B |

Ячейка C

Ячейка D

После таблицы

Заметьте, что первая строка таблицы воспринимается как обычный текст.

Чтобы скорректировать это, синтаксис вики должен иметь дополнительную «обёртку» между списком и таблицей:

До списка
  - Элемент списка
  - Элемент списка

| Ячейка A | Ячейка B |
| Ячейка C | Ячейка D |
После таблицы

Что будет выглядеть следующим образом:

До списка

Элемент списка
Элемент списка

Ячейка A	Ячейка B
Ячейка C	Ячейка D

После таблицы

Без сканирования текста множества раз (некая разновидность «предварительных» операций, которые вставляют «обёртку»), едва ли можно найти простое решение.

Проблемы списков, таблиц и цитат

Для синтаксиса списков, таблиц и цитат есть вероятность, что использование внутри их другого синтаксиса «съест» несколько строк. Например, таблица вроде:

| Cell A | <sup>Cell B |
| Cell C | Cell D</sup> |
| Cell E | Cell F |

выдаёт:

Cell A	^{Cell B \| \| Cell C \| Cell D}
Cell E	Cell F

В идеале должно быть преобразовано так:

Cell A	<sup>Cell B
Cell C	Cell D</sup>
Cell E	Cell F

Т. е. открывающий тэг <sup> должен игнорироваться, если в текущей ячейке отсутствует закрывающий тэг.

Для устранения этого требуется поддержка многострочного режима внутри таблиц, списков и цитат.

Сноски и блоки

Внутри сносок блоки игнорируются, вместо этого используется эквивалент инструкции <br/>. Это связано с неудобным в разработке классом Doku_Handler_Block. Если внутри сноски используются таблица, список, цитата или горизонтальная линия, это сработает как абзац.

Устраняется модификацией класса Doku_Handler_Block, однако рекомендуется предварительно тщательно ознакомиться с его устройством.

Заголовки

Текущие заголовки могут находиться на той же строке, что и предшествующий текст. Это вытекает из эффекта, рассмотренного выше в вопросе «Захват строк», и требует некоторой предварительной обработки для устранения. Например:

До заголовка есть
Некоторый текст == Заголовок ==
После заголовка

Если бы поведение было бы таким же, как в оригинальном парсере «Докувики», преобразование было бы таким:

До заголовка есть Некоторый текст == Заголовок == После заголовка

Но в результате будет:

До заголовка есть Некоторый текст

Заголовок

После заголовка

Конфликт блоков и списков

Существует проблема: если до списка находится пустая строка с двумя пробелами, всё это вместе будет интерпретироваться как блок:

* list item
* list item 2

Что ещё необходимо сделать

Вот некоторые вопросы, которые ещё предстоит решить…

Больше состояний для закрывающих инструкций

Для преобразования в иные форматы, нежели XHTML, может оказаться полезным добавление отождествления уровня для закрывающих инструкций списка, и т. д.

Почему бы просто не «преобразовать» в XML и затем применить к нему некоторые парсеры XSLT/XML?

Подрежимы для таблиц, списков, цитат

Анализатор с множественными режимами для предотвращения случаев вложенности состояний друг в друга.

Обсуждение

Спасибо за перевод!

¹⁾

Lexer относится к классу Doku_Lexer и содержится в файле inc/parser/lexer.php.

²⁾

Сканирование — чтение строки PHP от начала до конца.

³⁾

Термин «токен» в этом документе относится к совпадению регулярного выраждения, полученного лексическим анализатором, и соответствующему вызову метода обработчиком.

⁴⁾

Handler относится к классу Doku_Handler и содержится в файле inc/parser/handler.php.

⁵⁾

Последовательность инструкций содержится в массиве $calls, который является атрибутом обработчика. Предназначен для использования с call_user_func_array.

⁶⁾

Parser относится к классу Doku_Parser и содержится в файле inc/parser/parser.php.

⁷⁾

Renderer ( от «to render» в значении превращать, преобразовывать) относится к абстрактному (implemented) классу Doku_Renderer - см. inc/parser/renderer.php и inc/parser/xhtml.php.

⁸⁾

Прим. переводчика: возможно, речь идёт о т.н. незахватывающем поиске, подробнее см. литературу по регулярным выражениям, например, Джеффри Фридла «Регулярные выражения: библиотека программиста. Второе издание.» — СПб.: Питер, 2003, или документацию по PHP — ru.php.net/manual/en/ref.pcre.php.

⁹⁾

Термины «состояние» и «режим» используются отчасти как взаимозаменяемые, когда здесь говориться об анализаторе

¹⁰⁾

Смысл «плохо форматируемый» не применим к парсеру «Докувики» — он разработан так, чтобы предотвращать случаи, когда пользователь забывает добавить закрывающий тэг некоторой разметки, полностью игнорируя эту разметку.

smileys.conf

anonymous@undisclosed.example.com (Anonymous) — Tue, 14 Jan 2025 09:45:51 +0000

smileys.conf

Используется для замены текстовых макросов графическим представлением. Также может использоваться для размещения других изображений smileys внутри текстового потока.

Текст заменяется, если он найден в исходном коде вики-страницы, другой синтаксис не требуется.

# Настроенные здесь смайлики будут заменены на
# настроенные изображения в каталоге смайликов

8-)         icon_cool.gif
8-O         icon_eek.gif
8-o         icon_eek.gif
:-(         icon_sad.gif
:-)         icon_smile.gif
=)          icon_smile2.gif
:-/         icon_doubt.gif
:-\         icon_doubt2.gif
:-?         icon_confused.gif
:-D         icon_biggrin.gif
:-P         icon_razz.gif
:-o         icon_surprised.gif
:-O         icon_surprised.gif
:-x         icon_silenced.gif
:-X         icon_silenced.gif
:-|         icon_neutral.gif
;-)         icon_wink.gif
m(          facepalm.gif
^_^         icon_fun.gif
:?:         icon_question.gif
:!:         icon_exclaim.gif
LOL         icon_lol.gif
FIXME       fixme.gif
DELETEME    delete.gif

Или находится в репозитории git: conf/smileys.conf

Администраторы Вики должны разместить свои смайлики conf/smileys.local.conf, см. также Настройка смайликов.

syntax_plugins

anonymous@undisclosed.example.com (Anonymous) — Thu, 09 Jan 2025 19:44:11 +0000

Синтаксические плагины

Синтаксические плагины — это плагины расширения синтаксиса «ДокуВики». Чтобы понять, что необходимо для регистрации нового синтаксиса в «ДокуВики», вы должны прочитать, как работает парсер.

Краткий обзор

Для синтаксического плагина example требуется объявить имя класса как syntax_plugin_<example>, который расширяет класс DokuWiki_Syntax_Plugin, определённый в файле lib/plugins/syntax.php. Класс необходимо сохранить в файле с названием lib/plugins/example/syntax.php. Для более подробной информации можно обратиться к статье о структуре файлов плагина.

Класс должен содержать как минимум следующие функции:

~~getInfo() — возвращает хэш с информацией о плагине: автор, электропочта, дата, название, описание, ссылки.~~
Теперь вместо неё прилагается отдельный файл plugin.info.txt
getType() — должен возвращать тип синтаксиса (см. ниже).
getSort() — возвращает число, по которому определяется, в каком порядке должны добавляться состояния, см. также parser, order of adding modes и getSort list.
connectTo($mode) — эта функция наследуется от класса Doku_Parser_Mode, определённого в inc/parser/parser.php. Это место, где регистрируется регулярные выражения, необходимые для опознания вашего синтаксиса.
handle($match, $state, $pos, Doku_Handler $handler) — функция для подготовки совпавшего синтаксиса для использования рендером.
render($mode, Doku_Renderer $renderer, $data) — функция для отображения контента.

Следующие дополнительные методы могут быть переопределены при необходимости:

getPType() — определяет, как данный синтаксис размещается относительно параграфов¹⁾. Возвращает:
- normal — (значение по умолчанию, используется, если метод не переопределяется) Плагин может использоваться внутри параграфов,
- block — Открытые параграфы должны быть закрыты до вывода плагина или
- stack — Специальный случай. Плагин обёртывает другие параграфы
getAllowedTypes() (значение по умолчанию: array()) Должен вернуть массив типов состояний, которые могут быть включены в собственную разметку плагина.
accepts($mode) — Эта функция говорит парсеру, допускает ли плагин синтаксическое состояние $mode в своей разметке. Поведение по умолчанию заключается в проверке наличия $mode в массиве состояний, хранящемся в унаследованном свойстве allowedModes.

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

Унаследованные свойства

allowedModes — начальное значение: пустой массив, унаследованный от класса Doku_Parser_Mode, определённого в inc/parser/parser.php. Содержит список других синтаксических состояний, появление которых допустимо внутри собственного синтаксического состояния плагина (т. е. состояния, которые относятся к любым другим элементам разметки «ДокуВики», которые могут быть включены внутрь собственной разметки плагина). Обычно он автоматически заполняется функцией accepts(), используя результаты getAllowedTypes().

Синтаксические типы

«ДокуВики» использует различные синтаксические типы для того, чтобы определить, какие синтаксические конструкции могут быть вставлены внутрь другой. Например, вы можете вставить текстовое форматирование внутрь таблицы.

Для того, чтобы интегрировать свой плагин в эту систему, нужно указать, какой тип он имеет и какие типы могут вставляться в него. В настоящий момент доступны следующие типы:

Тип	Используется в…	Описание
container	listblock, table, quote, hr	Контейнеры — это сложные состояния, которые могут содержать много других состояний, но они не должны использоваться в таблицах и списках (состояние `hr` нарушает общий принцип), поэтому они отнесены к этому типу.
baseonly	header	Некоторые состояния допустимы только внутри базового состояния.
formatting	strong, emphasis, underline, monospace, subscript, superscript, deleted, footnote	Состояния для изменения стиля текста (сноски (footnote) также можно рассматривать как стиль).
substition²⁾	acronym, smiley, wordblock, entity, camelcaselink, internallink, media, externallink, linebreak, emaillink, windowssharelink, filelink, notoc, nocache, multiplyentity, quotes, rss	Состояния, в которых токен просто меняется на что-то; не могут содержать в себе другие состояния.
protected	preformatted, code, file, php, html	Состояния, имеющие начальный и конечный токены, но внутри которых не допустимы никакие другие состояния.
disabled	unformatted	Внутри этого состояния вики-разметка не отрабатывается, переносы строки и пробелы не сохраняются.
paragraphs	eol	Используется для отметки границ параграфов.

Для описания того, что каждый из типов значит и какие другие классы форматирования зарегистрированы в них, читайте комментарии в файле inc/parser/parser.php.

Руководство: разбор синтаксического плагина

Цель данного руководства — разобрать концепции, касающиеся синтаксических плагинов «ДокуВики» и пройти шаги, связанные с написанием своего собственного плагина.

Для тех, кто с особым нетерпением жаждет начать: возьмите копию плагина syntax plugin skeleton. Это своего рода костяк — плагин, который выводит «Hello World!», когда встречает токен «<TEST>» в статье вики. Начните наращивать на него «мясо».

Краткая выжимка

состояния — modes

Каждый отдельный элемент синтаксиса «ДокуВики», включая и ваш собственный плагин, имеет своё собственное состояние.
Похожие состояния группируются в типы состояний.
«allowedTypes» каждого состояния определяет, какие другие синтаксические конструкции «ДокуВики» опознаются внутри собственной синтаксической конструкции этого состояния. Все состояния из «allowedTypes» допустимы.
«Тип» состояния даёт понять другим состояниям, могут ли они допустить использование данного состояния внутри своего синтаксиса.

handle

Метод handle() вызывается, когда парсер решит, что столкнулся в содержимом статьи вики с куском, относящимся к синтаксису вашего состояния.
Параметр $state говорит, какой тип шаблона из приписанных к вашему состоянию сработал. Если это просто обычный текст, то параметр state будет установлен в DOKU_LEXER_UNMATCHED.
Производите как можно больше обработки и принятия решений именно тут, оставляя как можно меньше на обработку методу render(), потому что выдача метода handle кэшируется. This also means that you shouldn't do any stuff here that mustn't be cached.

render

Метод render() выполняет инструкции отображения, которые применимы к синтаксическому состоянию плагина (и которые были созданы методом handle() плагина.
Добавляйте содержание к выходному документу с помощью $renderer->doc .= 'content';
Убедитесь, что любая выдача вашего плагина безопасна (run raw wiki data through an entity conversion function).
Совершайте как можно меньше операций по обработке и принятию решений здесь, это всё следует делать в методе handle().

Нет никакой гарантии, что метод render() будет вызван в то же время, что и метод handle(). Инструкции, произведённые хэндлером, кэшируются и могут использоваться рендером в более позднее время. Единственный надёжный способ передать данные от handle() к render() — это использовать возвращаемый методом handle() массив, который передаётся методу render() в качестве параметра $data.

Ключевые концепции

Состояния

Состояния (более точно синтаксические состояния) — это основа, на которой базируется парсер «ДокуВики». Каждый отдельный элемент разметки «ДокуВики» имеет своё синтаксическое состояние. Например, существует состояние strong для работы со strong, состояние superscript для работы с ^superscript, состояние table для работы таблицами и многие другие.

Когда парсер сталкивается с разметкой, он попадает в соответствующее этой разметке синтаксическое состояние. Свойства и методы конкретного синтаксического состояния управляют тем, как ведёт себя парсер, пока он в этом состоянии, включая:

какие другие состояния могут произойти;
какие инструкции подготовить для рендера.

Ваш плагин добавит своё синтаксическое состояние к парсеру — это автоматически производится «ДокуВики», когда впервые загружает плагин, назначаемое имя — plugin_+ имя директории плагина (которое является также именем класса плагина без префикса «syntax_»). Затем, когда парсер сталкивается с разметкой, используемой вашим плагином, он (парсер) войдёт в это синтаксическое состояние. Пока он находится в этом состоянии, ваш плагин управляет тем, что может делать парсер.

Типы состояний

Для упрощения синтаксические состояния, которые ведут себя одинаковым образом, были сгруппированы в несколько типов состояний — полный список может быть найден в разделе «Синтаксические плагины».

Каждый тип состояний соотносится с ключом в массиве $PARSER_MODES. Элемент этого массива, соответствующий каждому типу состояний, сам является массивом, который содержит все синтаксические состояния, относящиеся к этому типу. Например, в «чистой» «ДокуВики» без установленных плагинов элемент массива $PARSER_MODES['formatting'] содержит: strong, emphasis, underline, superscript, subscript, monospace, deleted и footnote.

Когда плагин загружается в парсер, то через getType() он запрашивается о типе состояния, к которому относится. Затем синтаксические состояния, относящиеся к плагину, добавляются в соответствующий массив $PARSER_MODES.

Указанный вашим плагином тип состояний определяет, где в статье «ДокуВики» парсер будет опознавать разметку вашего плагин. Другие синтаксические состояния «ДокуВики» (также, как и плагины) не будут знать о вашем плагине, но они знают о различных типах состояний.

Если они допускают конкретный тип состояний, он допускают все состояния этого типа, включая любые плагины, которые заявили этот тип состояний.

Выберите тип состояний для своего плагина, сравнивая поведение своего плагина с поведением стандартных состояний «ДокуВики». Выберите тип, к которому относятся наиболее похожие состояния.

Допустимые состояния

Есть другие состояния, которые могут возникнуть внутри разметки вашего собственного состояния.

Каждое синтаксическое состояние имеет собственный массив допустимых состояний, который говорит парсеру, какие именно другие синтаксические состояния будут опознаваться во время обработки состояния. То есть, если вы хотите, чтобы ваш плагин мог оказаться внутри разметки «**strong**», тогда состояние strong должен включить состояние вашего плагина в свой массив «allowedModes». И если вы хотите позволить разметке strong включаться внутрь разметки вашего плагина, то ваш плагин должен содержать 'strong' в своём массиве «allowModes».

Ваш плагин собирает в массив «allowedModes» другие синтаксические состояния посредством типа состояний, объявляемого методом getType().

Ваш плагин сообщает парсеру, какие другие синтаксические состояния он допускает, декларируя (объявляя) их через метод getAllowedTypes().

PType

PType определяет, как парсеру работать с HTML-элементами <p>, когда он имеет дело с вашим синтаксическим состоянием.

Обычно в тот момент, когда парсер сталкивается с некоторой разметкой, имеется открытый HTML-тэг параграфа. Парсеру необходимо знать, должен ли он закрыть этот тэг перед входом в ваше синтаксическое состояние и затем открыть другой параграф на выходе (PType='block' или PType='stack') или парсер должен оставить параграф в покое (PType='normal').

PType также определяет будет ли параграф создаваться внутри вашего синтаксического состояния. И если будет - то как.

Если PType='normal', то параграф не будет создаваться вовсе.

Если PType='block', то парсер закроет параграф перед входом в ваше синтаксическое состояние, и откроет новый параграф после выходы из вашего синтаксического состояния. Внутри вашего синтаксического состояния создание параграфов должно быть запрещено (см. "Допустимые состояния"), иначе открытый параграф закроется как обычно (как только встретятся два подряд или более newlines), и откроется новый. В результате, например, открывающий TAG <DIV> может оказаться внутри одного параграфа, а закрывающий </DIV> внутри другого. Или ещё что-то.

Если PType='stack', то парсер:

закроет параграф перед входом в ваше синтаксическое состояние;
откроет параграф после входа в ваше синтаксическое состояние;
если внутри вашего синтаксического состояния разрешёно создавать параграфы (см. "Допустимые состояния"), то параграфы внутри вашего синтаксического состояния будут создаваться как обычно (как только встретятся два подряд или более newlines). Если не разрешено, то параграф так и останется открытым до выхода из вашего синтаксического состояния;
перед выходом из вашего синтаксического состояния парсер закроет параграф (в этом месте он должен быть открыт, не зависимо от того, разрешено ли создавать параграфы внутри или нет);
после выходы из вашего синтаксического состояния парсер откроет новый параграф.

Для тех, кто знает CSS, возвращение PType='block' означает, что html, произведённый вашим плагином, будет похож на display:block, а возвращение PType='normal' означает html, похожий на display:inline.

Пример

Предполагается, что вы хорошо знакомы со стандартным шаблоном syntax plugin ENTRY ⇒ UNMATCHED ⇒ EXIT. В зависимости от значения PType <p> и </p> будут расставляться автоматически рендером в разных точках снаружи и внутри текста плагина. Поэтому вашему плагину не нужно заботиться об этих тэгах.

wikisyntax	PType=normal	PType=block	PType=stack
foo <plugin>text</plugin> bar	<p>foo ENTRY("<plugin>") UNMATCHED("text") EXIT("</plugin>") </p> <p>bar</p>	<p>foo</p> ENTRY("<plugin>") UNMATCHED("text") EXIT("</plugin>") <p>bar</p>	<p>foo</p> ENTRY("<plugin>") <p> UNMATCHED("text") </p> EXIT("</plugin>") <p>bar</p>

wikisyntax

PType=normal

PType=block

PType=stack

foo
<plugin>text</plugin>

bar

<p>foo
ENTRY("<plugin>")
UNMATCHED("text")
EXIT("</plugin>")
</p>
<p>bar</p>

<p>foo</p>
ENTRY("<plugin>")
UNMATCHED("text")
EXIT("</plugin>")
<p>bar</p>

<p>foo</p>
ENTRY("<plugin>")
<p>
UNMATCHED("text")
</p>
EXIT("</plugin>")
<p>bar</p>

Порядковый номер

Этот номер используется лексером³⁾ для управления порядком, в котором он проверяет шаблоны синтаксических состояний на «сырых» (исходных) данных вики. Это важно только в том случае, если один и тот же участок данных попадает в шаблоны, относящиеся к двум или более состояниям. После проверки будет выбран шаблон, относящийся к состоянию с наименьшим порядковым номером.

Вы можете использовать это свойство для написания плагина, который заменяет или расширяет «родной» хендлер «ДокуВики» для той же синтаксической конструкции. Примером является плагин «Code».

Подробности о существующих порядковых номерах доступны для обоих parser (sort list).

Шаблоны

Парсер использует PHP-функции «preg»⁴⁾. Детальное объяснения регулярных выражений и их синтаксиса выходит за пределы этого руководства. Существует много хороших источников в интернете.

Полный синтаксис «preg» не доступен для использования в конструировании шаблонов синтаксических плагинов. Ниже приведён список известных различий:

Шаблоны не окружаются разделителями.
Для использования вертикальной черты «|» при множественных альтернативах, сделайте их non-captured-группами, т. е. «(?:cat|dog)».
Будьте очень осторожны с «заглядыванием назад». Парсер только пытается сравнить шаблон со следующим куском «ещё не проверенных» данных. Если вам нужно заглянуть в символы, которые уже участвовали в предыдущем сравнении с шаблоном, то этих символов там на самом деле не будет.
Флаги опций могут быть включены только как встроенные опции, т. е. (?i), (?-i).

Парсер предоставляет плагину четыре функции для регистрации необходимых шаблонов. Каждая функция относится к шаблонам с разными смыслами.

специальные шаблоны — addSpecialPattern() — это шаблоны, которые используются, когда один шаблон — это всё, что нужно. В терминах парсера эти шаблоны представляют и вход в синтаксическое состояние плагина, и выход из этого синтаксического состояния, всё в одно сравнение. Обычно они используются в плагинах substition.
входные шаблоны — addEntryPattern() — шаблон, указывающий на начало данных, которые должны быть обработаны плагином. Обычно эти шаблоны должны включать в себя заглядывание вперёд для проверки существования выходного шаблона. Любой плагин, который регистрирует входной шаблон, также должен зарегистрировать выходной шаблон.
выходные шаблоны — addExitPattern() — шаблон, указывающий на конец данных, которые должны быть обработаны плагином. Этот совпадение с этим шаблоном может произойти, только если было найдено совпадение с входным шаблоном⁵⁾.
внутренние шаблоны — addPattern() — представляют специальный синтаксис, применимый к плагину, который может встретиться между входным и выходным шаблонами. Обычно это нужно только для достаточно сложных структур, например, таблиц и списков.

Один плагин может добавить несколько шаблонов в парсер, включая более чем один шаблон одного типа.

Советы

Используйте «нежадные» идентификаторы, т. е. +? или *? вместо + или *.
Будьте осторожны с использованием нескольких выходных шаблонов. Скорее всего сработает выход из состояния по первому встреченному выходному шаблону, даже если это будет не тот шаблон, который «увидел при заглядывании вперёд» входной шаблон. Необходимость нескольких выходных шаблонов может означать, что на самом деле вам нужны несколько плагинов.
В ранних версиях «ДокуВики» лексер имел баг, не дававший использовать угловые скобки «<» или «>» в «заглядывающих вперёд» шаблонах. Этот баг был исправлен и угловые скобки теперь допустимы. Некоторые плагины всё ещё содержат шестнадцатеричные обозначения для угловых скобкок («\x3C», «\x3E») — такой приём позволял обойти баг.

Метод handle()

Это часть вашего плагина, которая должна совершать всю работу. До того как «ДокуВики» выведет статью вики, он создаёт список инструкций для рендера. Метод handle() плагина создаёт инструкции отображения для собственного синтаксического состояния. В некий более поздний момент они будут интерпретированы методом render() плагина. Список инструкций кэшируется и может быть использован много раз, разумно максимально увеличить объём работы, совершаемой один раз этой функцией и максимально уменьшить объём работы, совершаемый много раз функцией render().

Параметр $match — текст, который совпадает с шаблоном, или, в случае DOKU_LEXER_UNMATCHED, непрерывный кусок обычного текста, который не совпал с каким-либо шаблоном.

Параметр $state — тип шаблона, из-за которого запустился вызов handle().

DOKU_LEXER_ENTER — шаблон установлен функцией addEntryPattern();
DOKU_LEXER_MATCHED — шаблон установлен функцией addPattern();
DOKU_LEXER_EXIT — шаблон установлен функцией addExitPattern();
DOKU_LEXER_SPECIAL — шаблон установлен функцией addSpecialPattern();
DOKU_LEXER_UNMATCHED — обычный текст, встреченный внутри синтаксического состояния плагина, который не совпал ни с одним шаблоном.

Параметр $pos — позиция первого символа найденного текста.

Параметр &$handler — ссылка на объект Doku_Handler.

Метод render()

Часть плагина, которая производит вывод окончательной веб-страницы или какой-либо другой поддерживаемый формат. Именно здесь плагин добавляет собственный вывод к уже созданным другими частями рендерера путём склейки со свойством doc рендера. Т. е.:

$renderer->doc .= "некий вывод плагина...";

В любых сырых данных вики, которые передаются render(), все спецсимволы должны быть преобразованы в элементы HTML. Вы можете использовать PHP-функции htmlspecialchars(), htmlentities() или собственный метод xmlEntities() рендера. Т. е.:

$renderer->doc .= $renderer->_xmlEntities($text);

Параметр $mode — имя формата состояния финального вывода произведённого рендером. В настоящее время «ДокуВики» поддерживает только один формат вывода — XHTML ⁶⁾.

Новые состояния могут быть представлены в плагинах рендера. Плагины должны производить вывод только для тех форматов, которые они поддерживают, это значит, что эта функция должна быть структурирована…

if ($mode == 'xhtml') {  // supported mode
  // code to generate XHTML output from instruction $data
}

Параметр $data — массив, содержащий инструкции, предварительно подготовленные собственным методом handle() плагина. Эта функция должна интерпретировать инструкции и выдавать соответствующий вывод.

Безопасность

Сырые данные вики, которые достигли вашего плагина, больше никогда не должны обрабатываться. Никакой дальнейшей обработки не производится над выводом после того, как он покидает плагин. Как минимум, плагин должен убедиться, что в выводе все спецсимволы HTML заменены на HTML-последовательности. Также к извлечённым и используемым внутри данным вики нужно относится с вниманием. См. также статью «Безопасность».

Локализация

Смотрите статьи «Локализация» и «Структура файлов плагина».

Конфигурация

Смотрите статью «Конфигурация».

Использование CSS и JavaScript

Смотрите статью «Структура файлов плагина».

Добавление кнопок к панели инструментов

Для того, чтобы облегчить жизнь пользователям вики, которые установили ваш плагин, следует добавить кнопку в панель инструментов редактора.

См. статьи:

Написание своего собственного плагина

Ну хорошо, вы решили расширить синтаксис «ДокуВики» своим собственным плагином. Вам придётся разработать, каким будет ваша синтаксическая конструкция и как она будет отображаться в браузере пользователя. Теперь вам необходимо написать сам плагин.

Примите решение, как назвать плагин. Возможно вы захотите проверить список доступных плагинов, чтобы убедиться, что такое имя уже не используется.
В своей собственной установке «ДокуВики» создайте собственную поддиректорию в директории lib/plugins/. Эта директория должна называться также, как ваш плагин.
Создайте в новой директории файл syntax.php. В качестве отправной точки, можете использовать скелет плагина. Скопируйте его в свою директорию.
Отредактируйте этот файл под свои нужды:
- измените название класса, чтобы он был вида syntax_plugin_<название вашего плагина>⁷⁾;
- измените метод getInfo(), чтобы он выдавал информацию о вашем плагине;
- измените метод getType(), чтобы он выдавал тип состояний, к которому относится ваш плагин;
- добавьте метод getAllowedTypes() для сообщения всех типов состояний, которые ваш плагин может включать внутрь своей собственной синтаксической конструкции. Если ваш плагин не желает позволять какому-либо состоянию включаться в себя, он может быть выкинут;
- измените метод getPType(), чтобы он выдавал PType, который относится к вашему плагин. Если это 'normal', вы можете просто убрать этот метод;
- измените метод getSort(), чтобы он выдавал уникальный номер, проверьте его в списке плагинов;
- измените метод connectTo(), чтобы зарегистрировать шаблон для опознавания вашего синтакиса;
- добавьте метод postConnect(), если ваш синтаксис имеет второй шаблон, для того, чтобы указать, когда парсер должен покинуть ваше синтаксическое состояние.
Ну вот, простая часть работы сделана, теперь у вас есть плагин, которой скажет «Hello World!», когда встретит шаблон вашего синтаксиса. Самое время проверить его и убедиться, что шаблон работает как надо — посетите свою вики и создайте статью с синтаксической страницей своего плагина, сохраните её и убедитесь, что «Hello World!» действительно показывается.
Напишите свои собственные методы handle() и render():
- если у вас есть входной и выходной шаблоны, не забудьте обработать не совпавшие с шаблоном данные;
- относитесь к сырым данным вики с подозрением (вниманием) и убедитесь, что все спецсимволы прошли конвертор последовательностей.
Протестируйте и добавьте плагин на страницу плагинов «ДокуВики».

Пример 1-й плагина — Now

Когда синтаксическая конструкция этого плагина [NOW] встречается в статье вики, текущая дата и время отображается в формате RFC2822.

Типом является 'substition'. Мы подставляем временую метку вместо токена [NOW], аналогично смайлам и акронимами. Они также относятся к типу состояний 'substition'.
Заполнять «allowedTypes» не требуется, т. к. никакие другие синтаксические конструкции не могут появиться в конструкции [NOW]. Т. о. нам не нужен метод getAllowedTypes().
PType — normal — это значение по умолчанию, поэтому нам не нужно определять метод getPType().
Нет необходимости во входном и выходном шаблонами, только специальный шаблон, чтобы найти [NOW]. Единственная вещь, с которой нужно быть осторожным, это то, что символы «[» и «]» имеют специальное значение в регулярных выражениях, поэтому нам нужно «выключить» (escape) их, создав шаблон '\[NOW\]'.
В нашем случае метод handler() не должен ничего делать. Нам не нужно заботиться о специальных состояниях или дополнительных параметрах в нашем синтаксисе. Мы просто вернём пустой массив в качестве инструкций для рендера.
Всё, что нужно методу render() — добавить штамп времени к текущей статье вики — $renderer->doc .= date('r');

И вот наш плагин завершён!

syntax.php

<?php
/**
 * Plugin Now: Inserts a timestamp.
 * 
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Christopher Smith <chris@jalakai.co.uk>
 */
 
// must be run within DokuWiki
if(!defined('DOKU_INC')) die();
 
if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
require_once(DOKU_PLUGIN.'syntax.php');
 
/**
 * All DokuWiki plugins to extend the parser/rendering mechanism
 * need to inherit from this class
 */
class syntax_plugin_now extends DokuWiki_Syntax_Plugin {
 
    function getInfo(){
      return array(
        'author' => 'me',
        'email'  => 'me@someplace.com',
        'date'   => '2005-07-28',
        'name'   => 'Now Plugin',
        'desc'   => 'Include the current date and time',
        'url'    => 'http://www.dokuwiki.org/plugin:tutorial',
      );
    }
 
    function getType() { return 'substition'; }
    function getSort() { return 32; }
    function connectTo($mode) { 
        $this->Lexer->addSpecialPattern('\[NOW\]',$mode,'plugin_now'); 
    }
    function handle($match, $state, $pos, &$handler) { 
        return array($match, $state, $pos); 
    }
    function render($mode, &$renderer, $data) {
 
      if($mode == 'xhtml'){
          $renderer->doc .= date('r');
          return true;
      }
      return false;
    }
}
?>

Замечание: из-за способа, которым «ДокуВики» кэширует страницы, этот плагин будет отображать дату/время для момента, когда был создан кэш страницы. Вам нужно добавить на страницу макрос ~~NOCACHE~~,чтобы отображалось правильное время каждый раз, когда запрашивается страница.

Пример 2-й плагина — Color

Когда встретится синтаксическая конструкция плагина <color somecolour/somebackgroundcolour> встречается в статье вики, цвет текста сменяется на «somecolour», а цвет фона — на «somebackgroundcolour»; и оба остаются такими, пока не встретится </color>.

То, что мы делаем, подобно тому, что делает состояние strong, его тип — 'formatting', поэтому мы тоже должны использовать этот тип.
«allowedTypes» должны быть inline состояния - substition, formatting и disabled.
PType — normal — это значение по умолчанию, поэтому нам снова не нужен метод getPType().
Нам нужны входные и выходные шаблоны. Входной шаблон должен проверять, что есть и выходной шаблон, т. е. '<color.*>(?=.*?</color>)'. Выходной шаблон аналогично </color>.
Метод handle() должен иметь дело с тремя состояниями: совпадающими с входным и выходным шаблонами и «несовпадающим» для промежуточного текста.
- Состояние DOKU_LEXER_ENTER требует некоторой обработки для извлечения значений цветов текста и фона, они войдут в инструкцию для нашего рендера.
- Состояние DOKU_LEXER_UNMATCHED не требует какой-либо обработки, но нам придётся передать «несовпадающий» текст (в параметре $match) методу render(), поэтому он войдёт в инструкцию для нашего рендера.
- Состояние DOKU_LEXER_EXIT не требует какой-либо обработки и не имеет никаких особых данных, мы просто должны сделать выходную инструкцию для render().
Методу render() необходимо иметь дело с теми же тремя сотояниями, что и handle().
- DOKU_LEXER_ENTER — отрыть тэг span с указанием стиля, использующего значения цветов текста и фона.
- DOKU_LEXER_UNMATCHED — добавить «несовпавший» текст к выходному документу.
- DOKU_LEXER_EXIT — закрыть тэг span.

Опять же, всё достаточно очевидно. И вот, что мы имеем:

syntax.php

<?php
/**
 * Plugin Color: Sets new colors for text and background.
 * 
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Christopher Smith <chris@jalakai.co.uk>
 */
 
// must be run within Dokuwiki
if(!defined('DOKU_INC')) die();
 
if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
require_once(DOKU_PLUGIN.'syntax.php');
 
/**
 * All DokuWiki plugins to extend the parser/rendering mechanism
 * need to inherit from this class
 */
class syntax_plugin_color extends DokuWiki_Syntax_Plugin {
 
    /**
     * return some info
     */
    function getInfo(){
        return array(
            'author' => 'Christopher Smith',
            'email'  => 'chris@jalakai.co.uk',
            'date'   => '2008-02-06',
            'name'   => 'Color Plugin',
            'desc'   => 'Changes text colour and background',
            'url'    => 'http://www.dokuwiki.org/plugin:tutorial',
        );
    }
 
    function getType(){ return 'formatting'; }
    function getAllowedTypes() { return array('formatting', 'substition', 'disabled'); }   
    function getSort(){ return 158; }
    function connectTo($mode) { $this->Lexer->addEntryPattern('<color.*?>(?=.*?</color>)',$mode,'plugin_color'); }
    function postConnect() { $this->Lexer->addExitPattern('</color>','plugin_color'); }
 
 
    /**
     * Handle the match
     */
    function handle($match, $state, $pos, &$handler){
        switch ($state) {
          case DOKU_LEXER_ENTER :
                list($color, $background) = preg_split("/\//u", substr($match, 6, -1), 2);
                if ($color = $this->_isValid($color)) $color = "color:$color;";
                if ($background = $this->_isValid($background)) $background = "background-color:$background;";
                return array($state, array($color, $background));
 
          case DOKU_LEXER_UNMATCHED :  return array($state, $match);
          case DOKU_LEXER_EXIT :       return array($state, '');
        }
        return array();
    }
 
    /**
     * Create output
     */
    function render($mode, &$renderer, $data) {
        if($mode == 'xhtml'){
            list($state,$match) = $data;
            switch ($state) {
              case DOKU_LEXER_ENTER :      
                list($color, $background) = $match;
                $renderer->doc .= "<span style='$color $background'>"; 
                break;
 
              case DOKU_LEXER_UNMATCHED :  $renderer->doc .= $renderer->_xmlEntities($match); break;
              case DOKU_LEXER_EXIT :       $renderer->doc .= "</span>"; break;
            }
            return true;
        }
        return false;
    }
 
    // validate color value $c
    // this is cut price validation - only to ensure the basic format is correct and there is nothing harmful
    // three basic formats  "colorname", "#fff[fff]", "rgb(255[%],255[%],255[%])"
    function _isValid($c) {
        $c = trim($c);
 
        $pattern = "/^\s*(
            ([a-zA-z]+)|                                #colorname - not verified
            (\#([0-9a-fA-F]{3}|[0-9a-fA-F]{6}))|        #colorvalue
            (rgb\(([0-9]{1,3}%?,){2}[0-9]{1,3}%?\))     #rgb triplet
            )\s*$/x";
 
        if (preg_match($pattern, $c)) return trim($c);
 
        return "";
    }
}
?>

Замечание: никаких проверок на корректность названий цветов или значения RGB не производилось.

Дополнения и Файлы

Ссылка на оригинал статьи

¹⁾

См. Doku_Handler_Block

²⁾

Да, это неправильное написание, но мы не хотели бы его менять, чтобы избежать нарушения существующих плагинов. Иногда опечатки становятся стандартами, возьмите к примеру HTTP-заголовок «referer»

³⁾

Lexer — часть парсера, анализируящая «сырую» (исходную) статью вики.

⁴⁾

Совместимые с Perl регулярные выражения. Ссылка: www.php.net/manual/en/ref.pcre.php.

⁵⁾

Криво переведено с англ.

⁶⁾

Существует ещё специальное состояние metadata, которое ничего не выводит, только собирает метаданные для страницы. Используйте его для вставки значений в массив метаданных.

⁷⁾

Название не может содержать символов подчерка и должно совпадать с названием класса

dokuwiki_on_a_stick

anonymous@undisclosed.example.com (Anonymous) — Sat, 08 Feb 2025 13:54:00 +0000

«Докувики» на флешке

„Докувики“ на флешке — это установочный пакет Докувики, содержащий в себе урезанный веб-сервер Apache. Таким образом, можно запускать «Докувики» с флешки на любом компьютере с Windows без необходимости установки на компьютер.

Получение

Для создания «„Докувики“ на флешке» нужно на странице download.dokuwiki.org скачать последнюю версию программы, предварительно отметив флажок MicroApache (Windows) в разделе Include Webserver.

Затем распаковать полученный архив и переместить папку DokuWikiStick на USB-накопитель.

Использование

По двойному щелчку на файле run.cmd в папке DokuWikiStick запустится веб-сервер MicroApache и в браузере откроется ваша вики. При первом запуске запустится Инсталлятор «Докувики», в котором можно настроить основные параметры. В дальнейшем, run.cmd будет запускать стартовую вики-страничку — http://localhost:8800/

После первого запуска и настройки, при последующих запусках этому адресу загружается index.php. Можно обойти настройкой Apache в файле «D:\DokuWikiStick\server\conf\httpd.conf» изменить строку 35 - DirectoryIndex index.html ~~index.php~~ doku.php

В случае, если команда stop в run.cmd не работает, попробуйте использовать следующую команду:

taskkill /f /im mapache.exe

Команда «убьёт» экземпляры mapache.exe на вашем компьютере, а также выйдет из командной строки Windows.

Обновление

Вы можете обновлять «„Докувики“ на флешке» до свежей версии так же как и обычную версию «Докувики» — скачать новый пакет и записать его поверху существующих файлов. (См. Обновление «Докувики»).

Еще проще — установить плагин обновления.

Также по теме

Использование «„Докувики“ на флешке» в DropBox (англ.)

Предыдущие версии

Эти версии не рекомендуется использовать, размещены на всякий случай.

«Докувики» на флешке 2010-11-07a «Муравьед» (включает в себя с последними MicroApache 2.0.63, PHP 5.2.9, GD2 и базу данных SQLite)
«Докувики» на флешке 2010-11-07 «Муравьед» (включает в себя с последними MicroApache 2.0.63, PHP 5.2.9, GD2 и базу данных SQLite)

Дополнения и Файлы

permissions

anonymous@undisclosed.example.com (Anonymous) — Wed, 14 Aug 2024 22:53:03 +0000

Настройка прав доступа к файлам

DokuWiki хранит данные о правах доступа в простых текстовых файлах, так что для этих файлов необходимо настроить права доступа. Если их настроить неправильно, это может стать угрозой безопасности.

DokuWiki работает под управлением PHP, поэтому PHP должен иметь достаточно прав, чтобы перезаписывать эти файлы. Так как PHP обычно запускается под управлением веб-сервера, доступ к файлам на запись должен иметь веб-сервер.

Как правило, DokuWiki хранит файлы, к которым нужен доступ на запись, в каталоге data. Для работы инсталлятора, а также для последующей конфигурации, права на запись также должны быть установлены для каталога conf.

Microsoft IIS (Internet Information Services)

Смотри инструкцию по установке IIS.

When installing Dokuwiki under Windows XP and the XAMPP-distribution of Apache (in a directory separate from root) I get error messages like «U:\Projekte\DokuWiki\dokuwiki-rc2007-05-24/data/attic is not writable by DokuWiki. You need to fix the permission settings of this directory!» when calling install.php. To fix this I only needed to create the directories mentioned by hand. ferdinand

Unix

Эта статья поможет вам разобраться с правами доступа, если вы устанавливаете DokuWiki на Linux, MacOS X или другую юниксоподобную систему. Арендуемый веб-сервер с большой вероятностью является юниксоподобным.

Ключевые моменты системы прав доступа

Статья не ставит себе цель подробно описать систему прав доступа UNIX'ов - информацию об этом можно найти, например, в Википедии. Вот ключевые моменты:

Права доступа к файлу зависят от пользователя, который создал файл, и его группы, а также от того, кто пытается получить доступ.
Отдельно задаются права для чтения, записи и выполнения файла.
Каждый процесс в системе обладает правами доступа определённого пользователя.
Веб-сервер - это процесс, так что предыдущий пункт к нему применим.
PHP обычно выполняется как часть веб-сервера.
DokuWiki запускается с правами доступа PHP.
DokuWiki необходимы права на чтение, запись и выполнение для каталогов, в которых нужно создавать файлы.
DokuWiki необходимы права на чтение и запись для файлов, которые нужно перезаписывать во время работы.
DokuWiki необходимы права на чтение для файлов, которые перезаписывать не нужно.

Чтобы узнать пользователя и группу, с правами которого выполняется PHP, можно выполнить следующий скрипт:

<?php
 
if(function_exists('posix_geteuid')){
    // use posix to get current uid and gid
    $uid   = posix_geteuid();
    $usr   = posix_getpwuid($uid);
    $user  = $usr['name'];
    $gid   = posix_getegid();
    $grp   = posix_getgrgid($gid);
    $group = $grp['name'];
}else{
    // try to create a file and read it's ids
    $tmp = tempnam ('/tmp', 'check');
    $uid = fileowner($tmp);
    $gid = filegroup($tmp);
 
    // try to run ls on it
    $out = `ls -l $tmp`;
    $lst = explode(' ',$out);
    $user  = $lst[2];
    $group = $lst[3];
    unlink($tmp);
}
 
echo "Your PHP process seems to run with the UID $uid ($user) and the GID $gid ($group)\n"; ?>

Какие выставлять права доступа?

Итак, какие же для упомянутых выше каталогов нужны права доступа? Общий совет состоит в том, чтобы они были как можно более ограниченными, но общего правила, какими они должны быть в вашей системе, не существует.

Обладая правами root'а (суперпользователя), вы можете менять владельцев файлов и каталогов. Это значит, что вы можете сменить владельца файлов DokuWiki на пользователя, с правами которого запускается веб-сервер (например, web-server, www-data или nobody) и установить права доступа только для владельца. Например, 0600 для файлов и 0700 для каталогов.

Если вы обычный пользователь, но состоите в группе веб-сервера, то вы можете сделать эту группу основной для файлов DokuWiki, и после этого установить для этой группы права на запись этих файлов. Например, 0660 для файлов и 0770 каталогов.

Если вы абсолютно доверяете всем, кто имеет доступ к файловой системе сервера, вы можете дать доступ на запись всем пользователям. Например, 0666 для файлов и 0777 для каталогов.

Если вы используете общий сервер, настоятельно рекомендуется связаться с администратором или тех-поддержкой и спросить совета. Отправьте им эту статью, и вам помогут принять правильное решение.

Обратите внимание: когда вы выберете параметры прав доступа, не забудьте сменить настройки fmode и dmode, чтобы новые файлы создавались с корректными параметрами.

Как менять права доступа?

Чтобы изменить права доступа, в командной строке сервера используйте chmod. Чтобы изменить владельца файлов и каталогов, используйте chown. Чтобы изменить основную группу файлов и каталогов, используйте chgrp. (Имейте в виду, что chown и chgrp могут быть запрещены или работать не так, как ожидается, если вы используете общий сервер.)

Если вы используете FTP, обратитесь к документации своей программы для работы с FTP. Большинство FTP-клиентов, которые поддерживают графический интерфейс, имеют панель управления правами доступа (чаще всего в неё можно попасть из меню по клику на файле правой кнопкой мышки).

Мнение одного пользователя Dokuwiki

add simple explanation here

OK I'll fix this for you. :) I should preface this by stating that although I have not installed docuwiki yet. I have evaluated some 300+ CMS/Fourm/Wiki's, and have been administering some 50+ servers since 1975. That said; in an effort to help prevent individuals from compromising your system. You should not provide any more permissions/abilities than is absolutely necessary to your web space file system. What does this mean/require? Quite simply; only provide enough permissions on the directory/file space to enable your web application(s) to work. EXAMPLE:

On a ««NIX»» system this is simply accomplished by setting Ownership/Read/Write permissions to the Directories/Files as so:

cd /path/to/docuwiki

chown -R www:www .

DONE! :) see that was pretty easy, wasn't it? More details please. OK We just gave ownership of the docuwiki system to the Owner and Group the web server belongs to:

User: www, Group: www

This is the Owner/Group that many NIX based OS's run their web servers as (Apache). This Owner/Group can also be nobody/nobody, or apache/apache. You'll need to find this information out for yourself. Next we need to set what TYPE of permissions the web server has over the docuwiki file system. This can be of: Read, Write, Execute (4, 6, 7 respectively). The last bit (execute) is the one that you should NEVER provide unless ABSOLUTELY necessary. For directories, the «X» bit is almost always required HOWEVER the files that live in those directories ALMOST NEVER require the Executable bit (7) to be enabled. That said, let's move on. As a rule changing into a directory and setting the file permissions goes as follows:

cd /complete/path/to/docuwiki

chmod 0444 ./*

DONE! :) We just gave ReadOnly permissions to All the files in the docuwiki folder. That was easy, wasn't it. You will need to determine IN ADVANCE what directories need which perms and which files need what perms. But to summarize:

chown = Change Owner/Group

chmod = Change/Modify permissions

always lead off with a 0 (zero) when chmodding

4 = read

2 = write

1 = execute

The other numbers have different meanings. But in most cases when setting up web space, those numbers will not be used/needed. What I've written here should get anyone well on their way to setting up/understanding how to set up a reasonably secure web space/site.

Best wishes and safe admining. :)

Если что-то пошло не так

В определённых ситуациях Вы можете обнаружить, что не можете удалять или редактировать файлы, созданные DokuWiki. Посмотрите fixperms.php для возможного решения проблемы.

Как запретить редактирование определённых страниц?

Ответ в разделе FAQ
Есть два способа:

Использовать списки контроля доступа (рекомендуется)
Запретить веб-серверу изменять определенный файл, например ¹⁾
```
chmod 644 file.txt
```
Убедитетесь, что вы понимаете? что такое настройка прав доступа к файлам и их важность (см. статью Безопасность)

¹⁾

применимо только в *nix-системах, предполагается, что вебсервер не является владельцем файла

include

anonymous@undisclosed.example.com (Anonymous) — Mon, 26 Aug 2024 05:49:48 +0000

Include Plugin

Совместим с «Докувики»

2024-02-06 "Kaos" да
2023-04-04 "Jack Jackrum" да
2022-07-31 "Igor" да
2020-07-29 "Hogfather" да

Include another wiki page into the current one

Последнее обновление:: 2023-09-22
Предоставляет: Syntax, Helper
Репозиторий: исходный код
Конфликтует с: mediasyntax, photogallery

Похож на wst

Теги: embed, include

Нужен для blog

- Dokufreaks (previous authors: Michael Hamann, Gina Häußge, Michael Klier, Esther Brunner)

The 2018-11-29 release fixes a security issue where ACLs were ignored for pages in namespace includes with DokuWiki version Greebo. If you rely on ACL checks in namespace includes or allow edits from users who must not see all pages, please upgrade ASAP!

This is a handy plugin with which you can include another wiki page into the current one. Just including certain sections of a page or even whole namespaces is supported, too.

Installation

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

If you need support for older version of DokuWiki you can try the 2009-11-27 version of the include plugin, but please note that this old version has known bugs. If you need support for older versions of DokuWiki in the current include plugin version please open a feature request in the issue tracker.

Examples

{{page>wiki:syntax#Tables}} will include the section about tables of the syntax page.

{{namespace>project_foo}} will include all pages in the project_foo namespace.

{{page>blog:mypage&tags&comments}} will include the page blog:mypage and show the tags from the tag plugin and the number of comments from the discussion plugin. Both plugins need to be installed for this example.

{{tagtopic>testtag}} will include all pages with the tag testtag, the tag plugin needs to be installed for this example.

Syntax

The plugin offers four syntaxes, {{page>...}} , {{section>...}} , {{namespace>...}} and {{tagtopic>...}}.

Section is aimed more at including sections, page at including whole pages and namespace at including whole namespaces. Tagtopic includes all pages with a tagtopic tag.

{{page>[id]&[flags]}}
{{section>[id]#[section]&[flags]}}
{{namespace>[namespace]#[section]&[flags]}}
{{tagtopic>[tag]&[flags]}}

[id]	page ID of the page to include; some macros are possible; shortcuts are resolved (`:`, `.`, `..`)	required
[section]	limits the included page to a specific section and its subsections	optional; default is the whole page , this can be used with namespace (if matches)
[tag]	include pages with tag topic tag, requires tag	required
[flags]	flags delimited by `&`, see flags	optional

Configuration and Flags

The plugin can be configured in the DokuWiki configuration manager available in the admin menu. These settings also affect the blog plugin which uses the include plugin to generate the blog page. For most settings there are flags that allow to override the setting. Some features are only available as flag.

Configuration option	Flags	Description
`noheader`	`noheader`/ (`show`)`header`	Don't display the header of the inserted section
`firstseconly`	`firstsec`(`tion`)`only`/ `fullpage`	Display only the first section of the included page
`readmore`	`readmore`/`noreadmore`	Show «read more» link in case of firstsection only
`showtaglogos`	-	Show/hide an image for the first tag (if the page has tags)
`showfooter`	`footer`/`nofooter`	Show/hide page footer below the included page
`showlink`	`link`/`nolink`	Makes the first headline of a included page/section a link to the included page/section
`showpermalink`	`permalink`/ `nopermalink`	Show/hide a permalink to the included page in the page footer
`showdate`	`date`/`nodate`	Show/hide creation date of the page in the page footer
`showmdate`	`mdate`/`nomdate`	Show/hide modification date of the page in the page footer
`showuser`	`user`/`nouser`	Show/hide user name of the page creator in the page footer
`showcomments`	`comments`/`nocomments`	Show/hide number of comments in the page footer (requires the discussion plugin)
`showlinkbacks`	`linkbacks`/`nolinkbacks`	Show/hide number of linkbacks in the page footer (requires the linkback or backlinks plugin)
`showtags`	`tags`/`notags`	Show/hide tags in the page footer (requires the tag plugin)
`showeditbtn`	`editbtn` or `editbutton`/`noeditbtn` or `noeditbutton`	Show/hide edit buttons (section edit buttons, edit button below the included page)
`doredirect`	`redirect`/`noredirect`	Redirect back to original page after an edit
`usernamespace`	-	Namespace for user pages (see `showuser` configuration) (default `user`)
`doindent`	`indent`/`noindent`	Indent included pages relative to the section of the page they get included in
`linkonly`	`linkonly`/`nolinkonly` or `include_content`	Display only a link instead of the whole page content
`title`	`title`/`notitle`	Show the title instead of the page id
`pageexists`	`pageexists`/ `nopageexists`	Only list page ids of existing pages (see `existlink`)
-	`existlink`	Display a link and do so only if page page-id exists (combination of `linkonly` and `pageexists`)
`parlink`	`parlink`/`noparlink`	(Don't) put the link into a paragraph environment (for inline lists)
`order`	`order=OPTION`	Ordering criteria for namespace includes, possible options: page ID (`id`), title (`title`), date created (`created`), date modified (`modified`), indexmenu sort order (`indexmenu`), custom sort order using the `{{include_n>[number]}}` on the pages that are included similar to the indexmenu tags (`custom`).
`rsort`	`rsort`/`sort`	Reverse the sort order in namespace includes.
`depth`	`depth=DEPTH`	The maximum depth of subnamespaces of which pages are included in namespace includes, default is `1` for only the specified namespace, `0` is for unlimited depth.
-	`inline`	Don't close/open sections when including a page. This flag should be used when the include syntax is used inside other syntax elements like lists or tables or inside other plugin syntax.
-	`beforeeach=ENTITY`/ `aftereach=ENTITY`	Display an entity before/after each included page. The entity is printed outside the section/include environment, this is mainly for adding custom HTML code (when the text isn't recognized as entity it is directly displayed but escaped so you can't directly use HTML code here).
`safeindex`	-	Don't index metadata of included pages that are non-public. This can cause problems with other plugins that use the metadata index and can be safely disabled in wikis where the permissions of the included pages match the permissions of the parent pages.
-	`exclude=/REGEX/`	Regular expression to exclude certain pages, will match on full page ID. E.g. to exclude `ns:page_name` use `/ns:page_name/` as value. Use a regex tester to debug complicated patterns.

Examples:

{{page>concept&firstseconly&footer}}
{{page>mypage&noindent}}
{{namespace>myns&order=modified}}
{{namespace>myns&exclude=/myns:subns:.+|myns:page/}}

Macros

Simple macros are possible to serve a page on a per user or per date base. These are:

@USER@	username
@NAME@	full name of user
@GROUP@	first group the user belongs to
@YEAR@	4-digit year
@MONTH@	2-digit month
@WEEK@	2-digit ISO week number
@DAY@	2-digit day
@DATE<expr>@	use a calculated date instead of today in date macros

<expr> in @DATE<expr>@ can be one of:

PYEAR	previous year
NYEAR	next year
PMONTH	previous month
NMONTH	next month
PWEEK	previous week
NWEEK	next week
YESTERDAY	yesterday's date
TOMORROW	tomorrow's date

Examples:

{{page>@MONTH@:@DAY@:birthdays}}

includes the page birthdays in namespace <month>:<day>: eg. 10:15: birthdays for the 15th of october.

{{page>@USER@:message}}

includes the page message from the namespace <user> of the logged in user

{{page>foo@DATENWEEK@@YEAR@:@WEEK@}}

includes the page <weekno> from the namespace foo<year> with next week's date e.g. foo2012:01 for the 27th of december 2011

Demo

There is currently no demo site available.

Use of the plugin is shown in this video here: https://www.youtube.com/watch?v=6RO8TSZBedU&t=8m47s Video not available (2021-03-20)

Development

Change Log

Merge pull request #413 from dokuwiki-translate/lang_update_1335_1780… (2026/06/03 22:33)
Translation update (sk) (2026/06/03 19:35)
Version upped (2025/07/23 02:04)
fix tag for minimum php version (2025/07/22 22:38)
Version upped (2025/07/05 02:04)
Merge pull request #363 from dokufreaks/tests (2025/07/04 20:49)
replace strftime use with dformat (2025/07/04 18:20)
use newer DokuWiki test workflow (2025/07/04 18:15)

Bugs / Feature Requests

Please report bugs or feature requests at the Bug tracker.

Known Bugs and Issues

There are currently no known bugs and issues for which no workarounds exist (see FAQ).

FAQ

The include plugin breaks the wrap and folded (and similar) plugins when used inside them

This can be solved by using the inline flag of the include plugin. This mode strips all section from the included page and should solve issues with invalid HTML and thus no longer working wrap and folded plugins. This also solves problems with invalid HTML code when the include plugin is used inside tables or other syntax environments. When the page contains headers this might look strange depending on the template.

Addendum

If you are using the Wrap Plugin on both the page you are using the {{section>target&inline}} from and the page target, you need to make sure any pair of WRAP tags on target are either entirely within the included section or entirely outside of the section. For instance, including the FOO section into another page might break the other page:

<WRAP right 35%>
==== FOO ====

Content goes here

</WRAP>

==== BAR ====

FOO contains the </WRAP> end-tag, but not a corresponding start-tag. Thus, if the use of include is within a WRAPed block, that WRAP block will be ended early.

The simplest solution is to never use WRAP on both pages, only on included pages or only on pages that include others – however, that's not very realistic or useful. The other (somewhat brittle) solution is to make the section on target end before the WRAP close tag. You can do this by inserting a dokuwiki section header (at the same level) before the close tag, but after the section's content. However, I've not been able to determine if this is an intended behavior of dokuwiki, or if this is undocumented behavior and therefore subject to change at any time.

So, to make the above example work correctly, it should look like this:

<WRAP right 35%>
==== BAZ ====

Content goes here

==== ====
</WRAP>

==== QUX ====

Now {{section>whatever#BAZ}} will work fine.

Is it possible to include the same page twice?

Yes, this is possible since the 2011-01-01 version and hasn't been possible before. But you can't include the same page again inside a page in order to avoid endless recursion (and things like page1 > page2 > page1 doesn't work, too).

Does the include plugin respect ACLs of the included pages?

The include plugin tries its best to respect ACLs and it should work under normal circumstances. Whenever the view permissions of included pages change the cache is purged and the included pages are adapted according to the current permissions. Due to limitations in the caching system this might fail if a page is accessed very frequently with changing permissions. If this is an issue for you you can disable caching of the affected pages using the ~~NOCACHE~~ syntax. As always there is no guarantee that everything works as expected, please test if everything works and report a bug if you should notice anything unexpected.

As of version 2012-11-24, there is a new security feature called safeindex that is turned on by default, it's purpose is to prevent the indexer from indexing metadata of included pages that aren't public. That way links that are in protected pages won't be visible as link of a public page in the backlinks list.

Why does the include plugin first close the previous section and opens it again afterwards?

This is done because if there are headers in the included page they will close the current section. As the include plugin has its own container div this would produce strange results and possibly invalid HTML. You can use the inline flag in order to avoid this (but then also all sections of the included page are removed).

Has the include plugin feature XYZ/when will you implement XYZ?

The include plugin has many feature and is very flexible and I'm willing to add more features if they fit in the general purpose of the include plugin. However there is no guarantee that I will implement a certain feature at a certain time, this depends completely on my available time and my mood. You can add your wishes to the issue tracker.

How to avoid including of whole page content if section does not exist?

If using the flag firstsectiononly in addition, could be one solve. At least in regard of avoiding very large content to be displayed. If adding a header at the source page and using tools like the hiddenheader it might solve things at the source page, but in it's case seems to conflict and break certain include flag-tasks.

Discussion

Please don't report any bugs or feature requests here but instead use the bug tracker!

If you miss a comment you've created please have a look at the FAQ section and the issue tracker, I might have moved them there, if you can't find a bug report anymore that bug should be solved, please try the current version and report it again if it still doesn't work.

Discussions in DW-forum

plugin:include / Hide current page contents once user logs in
include plugin: development in direction to use it as a kind database tool, feature inspirations.

User comments

footer.php:

// author
if ($flags['user']) {
    $author   = $meta['creator'];
    if ($author) {
        $userpage = cleanID($this->getConf('usernamespace').':'.$author);

replaced to include the real user name in the link:

// author
if ($flags['user']) {
    $author   = $meta['creator'];
    $login = $meta["last_change"]['user'];
    if ($author) {
        $userpage = cleanID($this->getConf('usernamespace').':'.$login);

User Namespace

Hi, I'm using userpagecreate plugin's to create user's namespace instead of user's page. Then, to link correctly the include's page with his last member who edit it, i rewrite the previous lines like this :

        if ($flags['user']) {
            $login = $meta['last_change']['user'];
            $author = $auth->getUserData($login);
            $author = $author['name'];
            if ($author && $login) {
                if (strstr($this->getConf('usernamespace'), '@USER@')) {
                    $userpage = cleanID(str_replace('@USER@', $login, $this->getConf('usernamespace')));
                } else {
                    $userpage = cleanID($this->getConf('usernamespace').':'.$login);
                }
                resolve_pageid(getNS($ID), $userpage, $exists);
                $class = ($exists ? 'wikilink1' : 'wikilink2');
                $link = array(
                        'url'    => wl($userpage),
                        'title'  => $userpage,
                        'name'   => hsc($author),
                        'target' => $conf['target']['wiki'],
                        'class'  => $class.' url fn',
                        'pre'    => '<span class="vcard author">',
                        'suf'    => '</span>',
                        );
                $xhtml[]    = $renderer->_formatLink($link);
            }
       }

and change my conf into :

$conf['plugin']['include']['usernamespace'] = 'user:@USER@:start';

standard configuration still works.

$conf['plugin']['include']['usernamespace'] = 'user:';

If the @USER@ wildcard is using, replace it by the login name, otherwise, use the standard include's plugin rule.

— garlik 2011/10/24 14:10

— garlik 2011/11/07 11:32 - Summmary : Update the code. will display the right modif author.

showlink vs link flag

When including a page, the flag to make the first heading a link is link, not showlink. This confused me at first because I assumed the flags would have the same names as the configuration options. Example (displays the first section of a product page, with the page heading as a link):

{{page>products:sample&firstseconly&link}}

Controlling header size in included pages

By default, the headers in included pages start one level lower than the last header in the current page. For example, if the section before the include is a level-three header, then a level-6 header in the included page will become a wimply little level-2.

If you want higher-level headers, you can trick the plugin by putting an empty header above the include. In the following example, a level-6 header in the included page will show up as level-5:

=== Some Section ===
Stuff

====== ======
{{page>somepage}}

- Zioth

Including a paragraph or excerpt from a page

See the Hidden Header plugin. -Zioth

2012-01-25 "Angua"

Just tested with the current version and it works for me. — renux 2012/02/10 12:44

Include from same page?

Using it on my knowledge wiki and it works well. However, I'd like to be able to include a section from the current page - for use with the ItemTable Plugin (along with something to hide the inline text of course. — Julian Knight 2012-03-23

Does it still work? Can't make it on my wiki page.

— Piotr 2017-10-04

Align Feature

It'll be great to be able to align included pages. Because a lot of people are using this feature for infobox purposes and some would love to be able to control the alignment of the

{{page>people:obama}}

using the core syntax by adding spaces before of after the syntax.

— James 2014-05-13 20:38

Exclude Feature

It would be nice, if there would be an «exclude» option. When we use the namespace feature, we don't want certain pages in the included in the resulting page: for example exclude «sidebar» or «start».

— Manuel 2014-10-30 02:42

I would appreciate that feature too.

— Florian 2015-07-18 18:43

Same here, the possibility of the exclusion of listed namespaces would be much appreciated.

— Tommy 2016-2-19 21:18

I totally agree.

—- Chris 2016-2-21 09:12

blog plugin supports Exclude Feature

— HsinTang 2016-07-26

I created a PR for an exclude option! Testing or adding tests would be appreciated.

— sleeping 2020-04-11 07:57

The exclude flag has been merged!

— sleeping 2020-04-16 19:28

Empty Section

We are using the plugin a lot for technical documentation. If we include a named section (#title), and that section doesn't exist, the plugin includes the whole page. This really annoying. Would it be possible to change the behavior so that if a section doesn't exist it doesn't include anything (the same as when a page doesn't exist), please?

— Simon 2015-02-02 14:50

Just thought of asking about this issue. Is there any possibility to avoid that? — Samana Johann 2018-08-20 19:45

No Other data

I love this plugin but I have a question. How do I completely remove all other data included, such as user, mdate, etc.? If I do them as individual flags I still see the grey bar under the included content. There must be a flag that just excludes all the content, right? Am I just missing it somehow?

Thanks!

— Max 2017.03.21

Hi there, I think you are looking for

{{page>ID&nouser&nodate&nofooter}}

Namespace lists using &linkonly and &beforeeach/&aftereach

I've been trying to format a list of pages generated using namespace> with &linkonly - ideally as a simple unordered list. I'm adding this paragraph to help others searching for help because it took me several hours to find out that it is not possible and this is a known issue logged as a feature request.

— vt306 2017.03.29

Thanks to Michael Hamann for the advice. The pagequery plugin is the solution for this.

— vt306 2017.04.06

Option to pass revision of main page to includes pages

We are currently using DokuWiki for technical documentation. Within DokuWiki we use the 'date_at' function (https://www.dokuwiki.org/date_at) to go back to an old revision to see which version of the page a customer recieved. It would be very usefull if the included pages would honour the revision of the main page. To clarify: if the main page is shown at a specific revision, the included pages should also be shown at the last revision before the date of the main page. Would something like that be possible to incorporate?

Thanks in advance! Ruud

Translations

If it is of use, a paticular Translation of the Plugin's info page into German can be taken from here. — Samana Johann 2018-08-20 12:11

Display search results on a page?

Hi, I was wondering if it is possible to display the search result of a term or phrase on a page?

- OYMYO

Options/arguments

I think it would be cool if this plugin supported options/arguments like in MediaWiki.

Something like this:

page1.txt

Test by {{{1}}}

page2.txt

{{page>:page1|Me}}

And page2 would be parsed into:

Test by Me

— hasha2982 2020-08-19 17:12

Sorry, didn't know about the Templater Plugin — hasha2982 2020-08-19 17:25

* https://www.dokuwiki.org/plugin:include?do=

dokufreaks-plugin-include-2023-09-22-3-ga6cfd52.tar.gz

getting_involved

anonymous@undisclosed.example.com (Anonymous) — Fri, 18 Aug 2023 22:43:49 +0000

Getting Involved

Welcome to the DokuWiki community.

This page is intended to help you find places where you can contribute to DokuWiki and get a warm fuzzy feeling for doing something wonderful. Some things you can do on your own, while others are better suited to team work.

The mailing list is a good place to get assistance and find other people doing things you would like to contribute to. DokuWiki developers can also be found in the IRC channel.

Kun Yong

this dokuwiki is best

Documentation

The user manual is always in need of wiki gardening. Even if you only have used DokuWiki for a short time there is much to do.

Correct spelling mistakes
Translate pages to your local language
Make and add screenshots of features or plugins where appropriate
There are some documentation pages which mention that certain features are develonly (use the backlinks feature to find them). If these remarks are less recent than the most recent release, they are most probably no longer relevant. Check that and remove them and rewrite the affected paragraphs.
On some pages (especially plugins) there are comments. Most of them should be removed and merged into the documentation part of the pages.
Make sure recent development changes are documented and if not, document them or remind the developers who did the changes to document them.
Search for FIXME, try to fix them

Plugins & Templates

There are a lot of plugins which aren't marked as compatible with the current release of DokuWiki. Some are working perfectly, some are simply broken. Test the plugins and check if they work and if there are users complaining about problems. If the plugin works with the current release, mark it is compatible, otherwise open a bug report in the plugin's issue tracker or send the author an email when there is no issue tracker. If there is no response within some weeks, contact the mailing list or consider adopting the plugin.
There are a lot of plugins on the dokufreaks GitHub account which were originally developed by Esther Brunner, Michael Klier and Gina Häußge who are no longer actively developing these plugins. Some of them are very simple and just work, others could need a lot more love than those who are currently looking after them can give. If you like any of them, feel free to join the effort of maintaining and improving them.
There are some very old plugins that are no longer actively developed. Some of them are very simple and just work, others could need more love. You can contact the author for more information about the state of the plugin and then contribute to it or adopt it.

Spread The Word

Help building the community. Promote DokuWiki and invite other people to get involved.

Give away the DokuWiki Leaflet to interested people in your neighborhood
Add items to blogroll & press reviews
Write about your own site on DokuWiki installations
Blog about DokuWiki
Answer questions on the forum
Share your experience on Open Hub, AlternativeTo, Siftery or Twitter

Development

We are always looking for more developers who help to fix bugs, clean up the code or implement new features. A large part of the development discussion happens in Github Issues, but also don't forget to subscribe to the mailing list.

Start with reading the getting started chapter of the development manual
Watch out for occasional bug hunting weekends
Look at the currently open pull requests on GitHub — this is where the next changes are discussed and developed
Try to work on one of the tasks with the good first issue label in the bug tracker. Feel free to ask for further information or help.
Work on one of the ideas for new features
Don't be shy, talk to us—we don't bite

Graphic Designers

Our goal is not only to create great software but also to have it look nice. For that we need Photoshop/Gimp/Inkscape wizards with a keen eye for design. We often have requirements for custom icons or need help with making an interface work visually and usability wise. Larger tasks like completely redesigning a template are rare, but happen once in a while.

Introduce yourself to the mailinglist so we are aware that we can rely on your help
Check the Design category in our bug tracker

syntax

anonymous@undisclosed.example.com (Anonymous) — Mon, 15 May 2023 17:13:12 +0000

Formatting Syntax

Basic Text Formatting

DokuWiki supports bold, italic, underlined and monospaced texts. Of course you can combine all these.

DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.
Of course you can **__//''combine''//__** all these.

You can use _subscript and ^superscript, too.

You can use <sub>subscript</sub> and <sup>superscript</sup>, too.

You can mark something as ~~deleted~~ as well.

You can mark something as <del>deleted</del> as well.

Paragraphs are created from blank lines. If you want to force a newline without a paragraph, you can use two backslashes followed by a whitespace or the end of line.

This is some text with some linebreaks
Note that the two backslashes are only recognized at the end of a line
or followed by
a whitespace \\this happens without it.

This is some text with some linebreaks\\ Note that the
two backslashes are only recognized at the end of a line\\
or followed by\\ a whitespace \\this happens without it.

You should use forced newlines only if really needed.

Links

DokuWiki supports multiple ways of creating links.

External

DokuWiki supports multiple ways of creating links. External links are recognized
automagically: http://www.google.com or simply www.google.com - You can set
link text as well: [[http://www.google.com|This Link points to google]]. Email
addresses like this one: <andi@splitbrain.org> are recognized, too.

Internal

Internal links are created by using square brackets. You can either just give a pagename or use an additional link text.

Internal links are created by using square brackets. You can either just give
a [[pagename]] or use an additional [[pagename|link text]].

Wiki pagenames are converted to lowercase automatically, special characters are not allowed.

You can use namespaces by using a colon in the pagename.

You can use [[some:namespaces]] by using a colon in the pagename.

For details about namespaces see namespaces.

Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to this Section.

This links to [[syntax#internal|this Section]].

Notes:

Links to existing pages are shown in a different style from nonexisting ones.
DokuWiki does not use CamelCase to automatically create links by default, but this behavior can be enabled in the config file. Hint: If DokuWiki is a link, then it's enabled.
When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much.

Interwiki

DokuWiki supports Interwiki links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis: Wiki.

DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis.
For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]].

Windows Shares

Windows shares like this are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate Intranet.

Windows Shares like [[\\server\share|this]] are recognized, too.

Notes:

For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the «local zone»).
For Mozilla and Firefox it can be enabled through different workaround mentioned in the Mozilla Knowledge Base. However, there will still be a JavaScript warning about trying to open a Windows Share. To remove this warning (for all users), put the following line in conf/lang/en/lang.php (more details at localization):
conf/lang/en/lang.php
```
<?php
/**
 * Customization of the english language file
 * Copy only the strings that needs to be modified
 */
$lang['js']['nosmblinks'] = '';
```

Image Links

You can also use an image to link to another internal or external page by combining the syntax for links and images (see below) like this:

[[http://php.net|{{wiki:dokuwiki-128.png}}]]

Please note: The image formatting is the only formatting syntax accepted in link names.

The whole image and link syntax is supported (including image resizing, internal and external images and URLs and interwiki links).

Footnotes

You can add footnotes ¹⁾ by using double parentheses.

You can add footnotes ((This is a footnote)) by using double parentheses.

Sectioning

Headline Level 3

Headline Level 4

Headline Level 5

==== Headline Level 3 ====
=== Headline Level 4 ===
== Headline Level 5 ==

By using four or more dashes, you can make a horizontal line:

Media Files

You can include external and internal images, videos and audio files with curly brackets. Optionally you can specify the size of them.

Real size:

Resize to given width:

Resize to given width and height²⁾:

Resized external image:

Real size:                        {{wiki:dokuwiki-128.png}}
Resize to given width:            {{wiki:dokuwiki-128.png?50}}
Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}}
Resized external image:           {{https://secure.php.net/images/php.gif?200x50}}

By using left or right whitespaces you can choose the alignment.

{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}

Of course, you can add a title (displayed as a tooltip by most browsers), too.

{{ wiki:dokuwiki-128.png |This is the caption}}

For linking an image to another page see Image Links above.

Supported Media Formats

DokuWiki can embed the following media formats directly.

Image	`gif`, `jpg`, `png`
Video	`webm`, `ogv`, `mp4`
Audio	`ogg`, `mp3`, `wav`
Flash	`swf`

If you specify a filename that is not a supported media format, then it will be displayed as a link instead.

By adding ?linkonly you provide a link to the media without displaying it inline

{{wiki:dokuwiki-128.png?linkonly}}

dokuwiki-128.png This is just a link to the image.

Fallback Formats

Unfortunately not all browsers understand all video and audio formats. To mitigate the problem, you can upload your file in different formats for maximum browser compatibility.

For example consider this embedded mp4 video:

{{video.mp4|A funny video}}

When you upload a video.webm and video.ogv next to the referenced video.mp4, DokuWiki will automatically add them as alternatives so that one of the three files is understood by your browser.

Lists

Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a * for unordered lists or a - for ordered ones.

This is a list
The second item
- You may have different levels
Another item

The same list but ordered
Another item
1. Just use indention for deeper levels
That's it

  * This is a list
  * The second item
    * You may have different levels
  * Another item

  - The same list but ordered
  - Another item
    - Just use indention for deeper levels
  - That's it

Also take a look at the FAQ on list items.

Text Conversions

DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML.

The text to image conversion is mainly done for smileys. And the text to HTML conversion is used for typography replacements, but can be configured to use other HTML as well.

Text to Image Conversions

DokuWiki converts commonly used emoticons to their graphical equivalents. Those Smileys and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki:

8-)
8-O
:-(
:-)
=)
:-/
:-\
:-?
:-D
:-P :-P
:-O :-O
:-X :-X
:-| :-|
;-) ;-)
^_^ ^_^
m( m(
:?:
:!:
LOL
FIXME
DELETEME

Text to HTML Conversions

Typography: DokuWiki can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."

The same can be done to produce any kind of HTML, it just needs to be added to the pattern file.

There are three exceptions which do not come from that pattern file: multiplication entity (640×480), 'single' and «double quotes». They can be turned off through a config option.

Quoting

Some times you want to mark some text to show it's a reply or comment. You can use the following syntax:

I think we should do it

> No we shouldn't

>> Well, I say we should

> Really?

>> Yes!

>>> Then lets do it!

I think we should do it

No we shouldn't

Well, I say we should

Really?

Yes!

Then lets do it!

Tables

DokuWiki supports a simple syntax to create tables.

Heading 1	Heading 2	Heading 3
Row 1 Col 1	Row 1 Col 2	Row 1 Col 3
Row 2 Col 1	some colspan (note the double pipe)
Row 3 Col 1	Row 3 Col 2	Row 3 Col 3

Table rows have to start and end with a | for normal rows or a ^ for headers.

^ Heading 1      ^ Heading 2       ^ Heading 3          ^
| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
| Row 2 Col 1    | some colspan (note the double pipe) ||
| Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        |

To connect cells horizontally, just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators!

Vertical tableheaders are possible, too.

	Heading 1	Heading 2
Heading 3	Row 1 Col 2	Row 1 Col 3
Heading 4	no colspan this time
Heading 5	Row 2 Col 2	Row 2 Col 3

As you can see, it's the cell separator before a cell which decides about the formatting:

|              ^ Heading 1            ^ Heading 2          ^
^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        |
^ Heading 4    | no colspan this time |                    |
^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |

You can have rowspans (vertically connected cells) by adding ::: into the cells below the one to which they should connect.

Heading 1	Heading 2	Heading 3
Row 1 Col 1	this cell spans vertically	Row 1 Col 3
Row 2 Col 1		Row 2 Col 3
Row 3 Col 1		Row 2 Col 3

Apart from the rowspan syntax those cells should not contain anything else.

^ Heading 1      ^ Heading 2                  ^ Heading 3          ^
| Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        |
| Row 2 Col 1    | :::                        | Row 2 Col 3        |
| Row 3 Col 1    | :::                        | Row 2 Col 3        |

Table with alignment
right	center	left
left	right	center
xxxxxxxxxxxx	xxxxxxxxxxxx	xxxxxxxxxxxx

This is how it looks in the source:

^           Table with alignment           ^^^
|         right|    center    |left          |
|left          |         right|    center    |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Note: Vertical alignment is not supported.

No Formatting

If you need to display text exactly like it is typed (without any formatting), enclose the area either with <nowiki> tags or even simpler, with double percent signs %%.

This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. The same is true for //__this__ text// with a smiley ;-).

<nowiki>
This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.
</nowiki>
The same is true for %%//__this__ text// with a smiley ;-)%%.

Code Blocks

You can include code blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags <code> or <file>.

This is text is indented by two spaces.

This is preformatted code all spaces are preserved: like              <-this

This is pretty much the same, but you could use it to show that you quoted a file.

Those blocks were created by this source:

  This is text is indented by two spaces.

<code>
This is preformatted code all spaces are preserved: like              <-this
</code>

<file>
This is pretty much the same, but you could use it to show that you quoted a file.
</file>

Syntax Highlighting

/**
 * The HelloWorldApp class implements an application that
 * simply displays "Hello World!" to the standard output.
 */
class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!"); //Display the string.
    }
}

There are additional advanced options available for syntax highlighting, such as highlighting lines or adding line numbers.

Downloadable Code Blocks

When you use the <code> or <file> syntax as above, you might want to make the shown code available for download as well. You can do this by specifying a file name after language code like this:

<file php myexample.php>
<?php echo "hello world!"; ?>
</file>

myexample.php

<?php echo "hello world!"; ?>

If you don't want any highlighting but want a downloadable file, specify a dash (-) as the language code: <code - myfile.foo>.

RSS/ATOM Feed Aggregation

Parameter	Description
any number	will be used as maximum number items to show, defaults to 8
reverse	display the last items in the feed first
author	show item authors names
date	show item dates
description	show the item description. All HTML tags will be stripped
nosort	do not sort the items in the feed
n[dhm]	refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours).

By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the reverse parameter, or display the feed as is with nosort.

Example:

{{rss>http://slashdot.org/index.rss 5 author date 1h }}

The US Military Quietly Turned GPS Into a Global 'Numbers Station,' Evidence Suggests — BeauHD (2026/06/06 02:00)
Google Will Pay SpaceX $920 Million Per Month For Compute — BeauHD (2026/06/06 01:00)
Bitcoin Falls To $60,000 As Zcash Bug Rocks Crypto — BeauHD (2026/06/06 00:00)
340 Local News Outlets Now Blocking the Internet Archive — BeauHD (2026/06/05 23:00)
GOV.UK Goes Dutch On Payments As It Dumps Stripe — BeauHD (2026/06/05 22:00)

Control Macros

Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:

Macro	Description
~~NOTOC~~	If this macro is found on the page, no table of contents will be created
~~NOCACHE~~	DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the <php> syntax above is used), adding this macro will force DokuWiki to rerender a page on every call

Syntax Plugins

Auto-Tooltip 2026-01-15 — Eli Fenton
Syntax and helper plugins for tooltips, including automatically generated tips based on page abstract.
Cells background color plugin 2013-10-09 — dr4Ke
Sets background of a cell with a specific color
Code Prettifier 2023-09-16 — Satoshi Sahara
syntax highlighting of source code snippets in wiki page using Javascript code prettifier
dbquery plugin 2025-07-24 — Andreas Gohr
Display query results from a database
description plugin 2025-05-16 — Mark C. Prins, Ikuo Obataya, Matthias Schulte
Add a specified string to a description meta header
Diagrams plugin 2025-10-15 — Innovakom + CosmoCode
Embed diagrams.net editor (formerly draw.io)
Diagram plugin 2021-02-21 — Nikita Melnichenko
Constructs diagrams
discussion plugin 2021-12-31 — Michael Hamann, Gerrit Uitslag, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner, Matthias Schulte
Provides discussion funtionality for wiki pages
DokuTeaser Plugin 2016-01-16 — Andreas Gohr
A plugin for internal use on dokuwiki.org only
fontawesome plugin 2013-10-10 — Mikhail Medvedev
Embed Font Awesome icons
Gallery Plugin 2024-04-30 — Andreas Gohr
Creates a gallery of images from a namespace or RSS/ATOM feed
HTML Details Tag Plugin 2021-03-18 — Sascha Klawohn
Use the HTML <details> and <summary> tag for toggling information
htmlmetatags plugin 2024-03-04 — Heiko Heinz
Set html and open graph meta tags.
htmlok plugin 2023-05-10 — saggi, glen
Allows embed HTML and PHP
Icons Plugin 2024-10-30 — Giuseppe Di Terlizzi
Embed icons in Dokuwiki
Info Plugin 2020-06-04 — Andreas Gohr
Displays information about various DokuWiki internals
Meta plugin 2024-08-07 — Michael Hamann
Set Metadata for the current page. (previous authors: Esther Brunner, Gina Häußge, Michael Klier)
Note Plugin 2024-04-15 — Anael Mobilia
Add Note/Important/Tip/Warning Capability (DIV+CSS box)
Pagelist Plugin 2023-08-27 — Matthias Schulte, Michael Hamann, Michael Klier, Gina Haeussge
Lists pages in a nice formatted way
PHP Wikify 2020-06-05 — Trailjeep
Allows one the possibility of having output of PHP scripts parsed
Repository plugin 2024-02-09 — Andreas Gohr/Håkan Sandell
Helps organizing the plugin and template repository
rating plugin 2016-01-13 — Andreas Gohr
Allows rating a page
Stars2 Plugin 2025-02-07 — Zahno Silvan
Embedding Rating Stars
DokuWiki statdisplay plugin 2022-12-12 — Andreas Gohr
Displays log statistics about your DokuWiki
StepByStep plugin 2023-09-25 — saggi
Displays step-by-step tutorials, spoilers, or more information about a topic
tablelayout plugin 2022-03-28 — Michael Große
Set the width of table columns and set which lines to fix
Tag Plugin 2023-10-17 — Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
tag wiki pages
Translation Plugin 2025-05-20 — Andreas Gohr
Supports the easy setup of a multi-language wiki.
Typography plugin 2020-07-31 — Satoshi Sahara
Enable typesetting capabilities with CSS font properties such as font face, size, weight, and color of text
Wrap Plugin 2023-08-13 — Anika Henke
Universal plugin which combines functionalities of many other plugins. Wrap wiki text inside containers (divs or spans) and give them a class (choose from a variety of preset classes), a width and/or a language with its associated text direction.
PHPXref Plugin 2024-04-30 — Andreas Gohr
Makes linking to a PHPXref generated API doc easy.

¹⁾

This is a footnote

²⁾

when the aspect ratio of the given width and height doesn't match that of the image, it will be cropped to the new ratio before resizing

administration

anonymous@undisclosed.example.com (Anonymous) — Wed, 14 Aug 2024 22:53:01 +0000

Настройка прав доступа к папкам и файлам

dokuwiki_permissions.sh

#!/bin/bash
 
root_path=/opt/dokuwiki/
 
chown -R www-data:www-data $root_path
find $root_path -type d -exec chmod -v 770 {} \;
find $root_path -type f -exec chmod -v 660 {} \;

Настройка HTTP сервера

1. Нужно создать файл:

/opt/dokuwiki/conf/apache.conf

AliasMatch ^/dokuwiki/sites/[^/]+$      /opt/dokuwiki/
AliasMatch ^/dokuwiki/sites/[^/]+/(.*)$ /opt/dokuwiki/$1
Alias	/dokuwiki	/opt/dokuwiki/
 
<Directory /opt/dokuwiki/>
	Options +FollowSymLinks
	AllowOverride All
	order allow,deny
	Allow from all
	<IfModule mod_rewrite.c>
		# Uncomment to implement server-side URL rewriting
		# (cf. <http://www.dokuwiki.org/config:userewrite>).
		# Do *not* mix that with multisite!
		#RewriteEngine on
		#RewriteBase /dokuwiki
		#RewriteRule ^lib                      - [L]
		#RewriteRule ^doku.php                 - [L]
		#RewriteRule ^feed.php                 - [L]
		#RewriteRule ^_media/(.*)              lib/exe/fetch.php?media=$1  [QSA,L]
		#RewriteRule ^_detail/(.*)             lib/exe/detail.php?media=$1 [QSA,L]
		#RewriteRule ^_export/([^/]+)/(.*)     doku.php?do=export_$1&id=$2 [QSA,L]
		#RewriteRule ^$                        doku.php  [L]
		#RewriteRule (.*)                      doku.php?id=$1  [QSA,L]
	</IfModule>
</Directory>
 
<Directory /opt/dokuwiki/bin>
	Deny from all
</Directory>
 
<Directory /opt/dokuwiki/data>
	Deny from all
</Directory>
 
<VirtualHost *:80>
	DocumentRoot /opt/dokuwiki/
	ServerName wiki.domain.ru
</VirtualHost>

2. Выполнить следующие действия:

dokuwiki_install.sh

#!/bin/bash
 
# Создаем символическую ссылку
ln -s /opt/dokuwiki/conf/apache.conf /etc/apache2/sites-available/dokuwiki.conf
# Разрешаем сайт
a2ensite dokuwiki
# Перезапуск 
service apache2 reload

Настройка

Начальная настройка: http://wiki/dokuwiki/install.php?l=ru

Назначение папок и файлов

Назначение папок

Папка с настройками	conf/
Основные настройки	conf/local.php
Папка с данными	data/
Старые версии страниц	data/attic/
Страницы	data/pages/
Кэш (html)	data/cache/
Индексы	data/index/
Блокировки	data/locks/
Файлы	data/media/
Старые версии файлов	data/media_attic/
Временные файлы	data/tmp/

LDAP

Авторизация через LDAP

Установка:

apt-get install php5-ldap

Пример для сервера OpenLDAP:

local.php

# Имя группы администраторов
$conf['superuser'] = '@dokuwiki-admin';
 
# LDAP
$conf['openregister']= 0;
$conf['authtype']    = 'ldap';
$conf['auth']['ldap']['version']  = 3;
$conf['auth']['ldap']['server']   = 'Сервер_LDAP';
$conf['auth']['ldap']['port']     = 389;
$conf['auth']['ldap']['binddn']   = 'cn=admin,dc=domain';
$conf['auth']['ldap']['bindpw']   = 'ПАРОЛЬ';
$conf['auth']['ldap']['usertree'] = 'cn=%{user},ou=users,dc=domain';
$conf['auth']['ldap']['userfilter']  = '(&(cn=%{user})(objectClass=posixAccount))';
$conf['auth']['ldap']['grouptree']   = 'ou=groups,dc=domain';
$conf['auth']['ldap']['groupfilter'] = '(|(memberUid=%{user})(gidNumber=%{gid}))';
# $conf['auth']['ldap']['debug']      = 1;

https://www.dokuwiki.org/wiki:auth:ldap

PHP

Настройка PHPsoftware:development:ps_pycharm:php:php_setting

Преобразование URL средствами веб-сервера Для того, чтобы привести URL к «красивому» виду можно включить Преобразование URL средствами веб-сервера, более подробно описано по адресу: URL-преобразование

Добавить модуль в Apache

a2enmod rewrite
service apache2 restart

Разрешить преобразование:

dokuwiki/local.php

$conf['userewrite'] = '1';

Включить правила:

В файле dokuwiki/htaccess нужно убрать символ комментария с следующих строк:

dokuwiki/htaccess

RewriteEngine on
 
# Путь dokuwiki на веб сервере
RewriteBase /dokuwiki
 
RewriteCond %{HTTPS} !=on
RewriteRule ^lib/exe/xmlrpc.php$      https://%{SERVER_NAME}%{REQUEST_URI} [L,R=301]
RewriteRule ^_media/(.*)              lib/exe/fetch.php?media=$1  [QSA,L]
RewriteRule ^_detail/(.*)             lib/exe/detail.php?media=$1  [QSA,L]
RewriteRule ^_export/([^/]+)/(.*)     doku.php?do=export_$1&id=$2  [QSA,L]
RewriteRule ^$                        doku.php  [L]
RewriteCond %{REQUEST_FILENAME}       !-f
RewriteCond %{REQUEST_FILENAME}       !-d
RewriteRule (.*)                      doku.php?id=$1  [QSA,L]
RewriteRule ^index.php$               doku.php

После этого URL будут выглядеть примерно так:

http://dokuwiki/start:1

При этом старые URL, например:

http://dokuwiki/doku.php?id=start:1

тоже будут работать.

Резервное копирование

Список папок:

/opt/dokuwiki/dokuwiki

Исключение:

/opt/dokuwiki/data/cache
/opt/dokuwiki/data/locks
/opt/dokuwiki/data/tmp

Дополнительно можно использовать расширение BackupTool for DokuWiki

Восстановление

При восстановлении данных из резервной копии необходимо создать папки:

mkdir /opt/dokuwiki/data/locks
mkdir /opt/dokuwiki/data/tmp

Шаблоны

Внешняя ссылка

Расширения

Writer2DokuWiki

Преобразование синтаксиса форматирования LibreOffice в формат DocuWiki: Расширение Writer2DokuWiki

Установка

В меню Сервис\Управление расширениями…\Добавить, открыть Writer2DokuWiki.oxt, перезапустить LibreOffice

Выполнение

Выбрать меню Сервис\Дополнения\Writer2DokuWiki

Проблема в версии 0.0.20140505.a+dfsg-4+deb8u1

Проблема возникает при попытке загрузить файл.

Пакет: dokuwiki_0.0.20140505.a+dfsg-4+deb8u1_all.deb
DokuWiki: 2014-05-05a «Ponder Stibbons»

Решение проблемы: нужно применить заплатку: ajax.diff

cd /usr/share/dokuwiki/lib/exe patch ajax.php<ajax.diff

Ошибки расширений после перехода на PHP7

В общем случае нужна замена аргументов функций.

Образец:

Заменяем

function register(&$c)

на

function register(Doku_Event_Handler $c)

Declaration should be compatible with... | Andreas Gohr on Patreon

Error Messages for plugins after update to PHP7 - DokuWiki User Forum

CSS

В этом разделе описаны изменения таблиц стилей CSS.

https://www.dokuwiki.org/devel:css

userstyle.css

В файл conf/userstyle.css для примера внесены следующие изменения:

Выравнивание по ширине и «красная строка» для основного текста
Исправление после изменений «для основного текста» для расширения WRAP
Таблицы: вертикальное выравнивание по середине ячейки

Заголовок 1	Заголовок 2
Заголовок 1	Заголовок 2/2
Строка 1	Строка 2
Строка 1/2	Строка 2

Отключение фона из блоков CODE Расширение Hidden

conf/userstyle.css

/* Выравнивание текста */
/* Основной тест */
p {
text-align: justify;
/* text-indent: 1.5em; */
}
/* Списки */
li {
text-align: justify;
/* text-indent: 0em; */
}
/* Содержание */
#dw__toc li{
text-align: left;
}
 
/* Plugin WRAP */
.wrap_leftalign p{
    text-align: left;
}
.wrap_centeralign p{
    text-align: center;
}
.wrap_rightalign p{
    text-align: right;
}
.wrap_justify p{
    text-align: justify;
}
 
/* Таблицы */
td, th {
    vertical-align: middle;
}
 
/* CODE */
pre, code, samp, kbd {
    line-height: 15px;
    background-color: transparent;
    box-shadow: none;
}
 
/* Редактор */
.dokuwiki textarea.edit {
    font-family: monospace;
    font-size: 150%
}
 
/* Строка поиска */
form.search input {
    padding-left: 0.5em;
}

Логотип

lib/tpl/dokuwiki/images
- apple-touch-icon.png
- favicon.ico
- logo.png
data/media
- logo.png

Ссылки

Ссылка на источник статьи

development

anonymous@undisclosed.example.com (Anonymous) — Sat, 01 Feb 2025 06:55:21 +0000

Разработка «Докувики»

Вы можете внести свой вклад в «Докувики» и присоединиться к её развитию.

Степень вашего вклада, конечно же, зависит только от вас (прежде всего вы должны потакать себе). Если вам нужны идеи, чего не хватает в «Докувики», прежде всего вам следует заглянуть на баг-трекер¹⁾ или страницы идей. Возможно вам захочется обновить плагин или шаблон. Начните с главы «С чего начать».

Работать вместе - веселее. Сообщество DokuWiki организовано в команды и нуждается в специалистах с различными навыками. Вы свободно можете присоединиться к любой из них или просто поучаствовать в обсуждениях разработок на почтовых рассылках или irc-каналах. Также, регулярно проводятся IRC-встречи, викенды по отлову багов, на которых.. эх, исправляются ошибки, иногда разработчики собираются в IRL²⁾ на DokuWiki хакфестах (сборы хацкеров).

DokuWiki была наставнической организацией на событии «Google Summer of Code» в 2011. Если вы заинтересованы в участии развития DokuWiki посредством такого рода инициатив, пожалуйста, свяжитесь с нами.

С чего начать

Гит — получение кода и работа с «Гитом»³⁾
1. Работа с Git-хабом. Pull запросы
Стиль написания кода
Установка редактора
1. VIM
2. IntelliJ Idea (или PHPStorm)
Безопасность
Тестирование юнитов (частей кода)
Патчи
Отладка

Техническая документация

Обзор, рассказывается о том, как отрабатываются запросы страниц
1. Взаимодействие
2. Структура каталогов (директорий)
3. Блокировка статей
4. Окружение — глобальные переменные и константы
5. Режимы действий
6. Парсер
7. Хранение метаданных
8. Полнотекстовый индекс
Плагины
Шаблоны (темы)
Конфигурирование
Локализация
Каскадные таблицы стилей (CSS)
JavaScript
Предварительная загрузка
Внутренние библиотеки
XML-RPC
custom webservices
Масштабируемость
Дополнительные ресурсы
1. development api reference⁴⁾
2. Ежедневные сборки
3. «Докувики» на «Гитхабе» — интерфейс для просмотра исходного кода и патчей.
4. Зал славы — все авторы «Докувики»
5. Принятие разработки плагина или шаблона на себя

Организация командной разработки

Процесс формирования релиза и описание его сборки

Идеи и предложения

Планирование внешнего Аудита безопасности для DokuWiki
Идеи и концепты которые могут быть реализованы (новыми) DokuWiki разработчиками
Планы радикальных изменений в шаблонах
DokuWiki оптимизация кода
Ферма - идеи для советы:ферма
Некоторые заметки по уменьшению расхода памяти
Разработка темы масштабирования, предложения по масштабированию
Разработка темы таг-строки для dokuwiki.org
https://www.dokuwiki.org/wiki:development
https://codesearch.dokuwiki.org/
https://xref.dokuwiki.org/reference/dokuwiki/nav.html?index.html

¹⁾

bugs (англ.) — ошибки в коде

²⁾

in real life (англ.) - в реальной жизни

³⁾

Система управления версиями (англ. VCS) для разработки «Докувики».

⁴⁾

Ежедневные сборки.

security

anonymous@undisclosed.example.com (Anonymous) — Fri, 03 Jan 2025 14:48:19 +0000

Правила безопасности для авторов плагинов

Создание плагинов для DokuWiki очень просто даже для начинающих программистов PHP. Чтобы убедиться, что ваш плагин не ставит под угрозу безопасность всей вики, на которой он установлен, вам следует следовать рекомендациям, изложенным на этой странице.

Улучшение этой страницы всегда приветствуется. Она находится в очень сыром состоянии и должна быть расширена более подробной информацией, ссылками и примерами.

Краткое содержание

Список наиболее распространенных проблем безопасности и способы их избежания можно найти на этой странице. Краткое резюме:

Межсайтовый скриптинг (XSS) — вставляет вредоносный код на веб-сайт для манипулирования сайтом в браузере пользователя.
Подделка межсайтовых запросов (CSRF) — уловки, позволяющие вам совершать неосознанные вредоносные действия на вашем сайте.
Удаленное включение кода – включает код на сервере, который там выполняется.
Утечка информации – отображается слишком много информации
SQL-инъекция – можно выполнить нежелательные запросы к вашим данным

Также добавлено примечание о необходимости сообщать о проблемах безопасности .

Межсайтовый скриптинг (XSS)

Это, вероятно, самая распространенная уязвимость, встречающаяся в плагинах DokuWiki.

Cross Site Scripting относится к атаке, при которой вредоносный код JavaScript внедряется на веб-сайт. Это может использоваться для перенаправления невинных пользователей на вредоносные веб-сайты или для кражи аутентификационных cookie-файлов.

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

Выход из режима экранирования

Как минимум, плагин должен гарантировать, что все выходные необработанные данные будут содержать все специальные символы HTML , преобразованные в сущности HTML с помощью функции htmlspecialchars(). DokuWiki предоставляет удобный ярлык hsc() для этой функции. Значения URL-адресов следует экранировать с помощью rawurlencode().

Кроме того, следует с подозрением относиться к любым данным вики, извлеченным и используемым внутри компании (например, именам пользователей).

Проверка входных данных

Всегда проверяйте все ваши входные данные. Используйте белые списки, фильтры, преобразования в точный тип данных, который вы имеете в виду, например, из числа, введенного как смешанное значение php, в целое число и т. д., чтобы убедиться, что у вас есть только разрешенные вами данные.

Также ознакомьтесь с нашей главой об обработке переменных запросов, таких как _GET, _POST или _SERVER.

Смотрите также:

Типичные примеры уязвимостей

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

Синтаксис Тела

Многие простые плагины синтаксиса принимают часть введенных пользователем данных и форматируют их в виде пользовательского HTML .

Пример: Вот плагин сокращенного синтаксиса, позволяющий выделить заданный ввод жирным шрифтом.

class syntax_plugin_bold extends DokuWiki_Syntax_Plugin {
    // общие функции плагина опущены
 
    public function connectTo($mode) {
        $this->Lexer->addSpecialPattern('!!!.*?!!!', $mode, 'plugin_bold');
    }
 
    public function handle($match, $state, $pos, Doku_Handler $handler){
        return [substring($match, 3, -3)];
    }
 
    public function render($format, Doku_Renderer $renderer, $data) {
        if($format != 'xhtml') return false;
        $renderer->doc .= '<b>' . $data[0] . '</b>';  // без экранирования
    }
}

Как вы можете видеть, необработанные входные данные, захваченные в шаблоне лексера, просто передаются в метод рендеринга, где экранирование вообще не выполняется. Злонамеренные пользователи могут вводить любой код JavaScript и HTML , который они хотят.

Решение простое: правильный побег.

class syntax_plugin_bold extends DokuWiki_Syntax_Plugin {
    // общие функции плагина опущены
 
    public function connectTo($mode) {
        $this->Lexer->addSpecialPattern('!!!.*?!!!', $mode, 'plugin_bold');
    }
 
    public function handle($match, $state, $pos, Doku_Handler $handler){
        return [substring($match, 3, -3)];
    }
 
    public function render($format, Doku_Renderer $renderer, $data) {
        if($format != 'xhtml') return false;
        $renderer->doc .= '<b>' . htmlspecialchars($data[0]) . '</b>'; //экранирование 
    }
}

Формы

Когда ваш плагин предоставляет форму, очень часто требуется проверить вводимые данные и повторно отобразить форму с полученными данными пользователя в случае возникновения ошибки проверки.

Пример: ниже показана форма, уязвимая для атаки XSS, поскольку она не экранирует правильно введенные пользователем данные:

<form action="" method="post">
    <input type="text" name="q" value="<?php echo $_REQUEST['q']?>" /> 
    <input type="submit" />                     //без экранирования
</form>

Предоставление данных "><script>alert('bang')</script> в качестве входных данных пользователя приведет к эксплуатации уязвимости.

Для исправления формы используйте функцию htmlspecialchars() или функцию DokuWiki shortcut hsc():

<form action="" method="post">
    <input type="text" name="q" value="<?php echo hsc($_REQUEST['q'])?>" />
    <input type="submit" />                                      //экранирование
</form>

В целом рекомендуется не создавать формы вручную, а использовать библиотеку форм DokuWiki .

Классы и другие атрибуты

Часто плагины принимают несколько параметров и опций, которые используются для изменения выходных данных плагина.

Представьте себе плагин, принимающий следующие входные данные для отображения окна сообщения:

<msg warning>Do not believe anything!</msg>

В методе рендеринга этого синтаксиса может быть такой код:

$renderer->doc .= '<div class="msg_' . $class . '">'  //$class может быть чем угодно 
                       . htmlspecialchars($message)
                . '</div>';

Как вы видите, само сообщение правильно экранировано, но класс — нет. Вместо экранирования может быть разумнее использовать белый список разрешенных классов с резервным вариантом по умолчанию::

$allowed = ['notice', 'info', 'warning', 'error'];   // белый список 
if(!in_array($class, $allowed){                         
    $class = 'notice'; // неизвестный ввод, вернуться к разумному значению по умолчанию
}
$renderer->doc .= '<div class="msg_' . $class . '">'
                       . htmlspecialchars($message)
                . '</div>';

входные URL-адреса

Когда плагин принимает URL-адреса в качестве входных данных, необходимо убедиться, что пользователи не смогут передать javascript:// псевдо-протокол.

Вот пример того, как может выглядеть очень простая проверка, позволяющая убедиться, что используются только URL-адреса http и https.

// пустой URL при несоответствии протокола 
if(!preg_match('/^https?:\/\//i', $url)) {
    $url = '';
}

Подделка межсайтовых запросов (CSRF)

Эта уязвимость часто появляется в плагинах из-за отсутствия понимания этой проблемы, ее часто путают с XSS.

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

Добавление токена безопасности

DokuWiki предлагает функции, которые помогут вам бороться с атаками CSRF. getSecurityToken() создаст токен, который следует использовать для защиты любого аутентифицированного действия. Он должен быть включен в ссылки или формы, запускающие это действие. Все формы, созданные с помощью библиотеки форм будут иметь автоматически добавленные токены безопасности, для форм, созданных вручную, можно использовать функцию formSecurityToken().

Вы как автор плагина несете ответственность за фактическую проверку токена перед выполнением авторизованных действий с использованием функции checkSecurityToken().

Типичный пример уязвимости

Ниже приведен простейший пример для начала. У вас может быть более сложный плагин для защиты, вот простой пример на основе формы.

Представьте, что вы хотите узнать что-то, на что можно ответить «Да» или «Нет», у вас получится форма такого типа:

<form action="" method="GET">
    <input type="radio" name="yn" value="Yes" />
    <input type="radio" name="yn" value="No" />
    <input type="submit" value="Answer" />
</form>

Затем вы обрабатываете эту форму следующим образом:

global $INPUT;
 
if($INPUT->get->has('yn')){
    do_something_with_yn($INPUT->get->str('yn'));
}

Итак, пользователь подключен, чтобы ответить на этот вопрос, но он пока не знает ответа. Давайте уделим время размышлениям и просмотрим веб-страницы… Теперь пользователь посещает вредоносный веб-сайт, который знает или нет, что пользователь может быть подключен к вашему DokuWiki. На этом веб-сайте разработчик включил этот HTML- тег изображения:

<img src="http://your.dokuwi.ki/formpage?yn=Yes" />

Что тогда будет делать браузер пользователя?

Браузер обработает это изображение как любое другое и отправит запрос на этот URL . Ваш плагин увидит, что $_GET['yn'] установлено, и вызовет do_something_with_yn() функцию.

Это один из примеров CSRF. Теперь, как исправить эту дыру в безопасности?

Предотвращение CSRF-атак

Помните вашу форму выше? Давайте добавим в нее ввод:

<form action="" method="GET">
    <input type="hidden" name="sectok" value="<?php getSecurityToken(); ?>" />
    <input type="radio" name="yn" value="Yes" />
    <input type="radio" name="yn" value="No" />
    <input type="submit" value="Answer" />
</form>

Видите первый ввод? Да? Хорошо. Теперь вам нужно проверить токен безопасности при получении формы, перед ее обработкой:

global $INPUT;
 
if($INPUT->get->has('yn') && checkSecurityToken()) {
    do_something_with_yn($INPUT->get->str('yn'));
}

Поскольку вредоносный веб-сайт никогда не найдет значение скрытого ввода «sectok», ваша форма больше не уязвима для CSRF.

Примечание: Если токен безопасности недействителен, checkSecurityToken() функция отображает сообщение, информирующее пользователя.

Удаленное включение кода

Эта атака позволяет злоумышленнику внедрить код (PHP) в ваше приложение. Это может произойти при включении файлов или использовании небезопасных функций операций, таких как eval() или system().

Всегда фильтруйте любые входные данные, которые будут использоваться для загрузки файлов или которые передаются в качестве аргумента внешним командам.

Утечка информации

Эта атака может привести к раскрытию файлов, которые обычно должны быть защищены ACL DokuWiki , или может раскрыть файлы на сервере (например, /etc/passwd).

Всегда фильтруйте любые входные данные, которые будут использоваться для загрузки файлов или которые передаются в качестве аргумента внешним командам.

Всегда используйте функции проверки ACL DokuWiki при доступе к данным страницы.

SQL-инъекция

Эта атака редко актуальна в DokuWiki, поскольку база данных не используется. Однако, если ваш плагин обращается к базе данных, всегда экранируйте все значения перед их использованием в операторах SQL.

Дополнительная информация:

SQL-инъекция

Сообщение о проблемах безопасности

Если у вас возникли проблемы с плагином, сообщите об этом автору плагина по электронной почте, при желании указав Andi or the список рассылки on CC.

Дополнительно к данным на странице плагина securityissue следует добавить поле с кратким описанием проблемы . Это создаст красное предупреждающее поле и исключит плагин из основного списка плагинов.

После устранения проблемы и выпуска новой версии это поле следует снова удалить.

advanced

anonymous@undisclosed.example.com (Anonymous) — Wed, 15 Jan 2025 18:55:23 +0000

Расширенные настройки фермы и советы

Большую часть старой документации фермы, которая не охвачена новой документацией фермы, следует добавить сюда.

В следующих разделах предполагается установка, аналогичная той, что описана на фермах.

CLI tools

CLI-инструменты инструменты командной строки вам нужно только задать имя животного в animal переменной окружения. Например, если вы хотите выполнить bin/indexer.php для животного «foo» вы можете использовать animal=foo bin/indexer.php.

Установка значений по умолчанию и ограничение опций

Вы можете добавить дополнительные файлы конфигурации для значений по умолчанию, которые должны использоваться в животных, и для ограничения определенных параметров конфигурации. Если вы добавите следующий код в конец inc/preload.php, основной файл конфигурации фермера будет использоваться как файл по умолчанию для всех животных, а защищенный файл фермера будет использоваться как последний защищенный файл для всех животных, что означает, что животные не смогут изменять эти параметры. Это может быть использовано для отключения определенных параметров, таких как phpok если вы не доверяете администратору животных.

$config_cascade['main']['default'][] = DOKU_INC.'conf/local.php';
$config_cascade['main']['protected'][] = DOKU_INC.'conf/local.protected.php';

Обратите внимание, что эти изменения также влияют на фермера, если к нему есть доступ. Это сломает менеджер конфигурации в фермере, поскольку он предполагает, что все измененные значения являются значениями по умолчанию, и удалит их из конфигурации.

Аналогичные изменения можно использовать для каскада плагинов, чтобы определить набор плагинов, которые включены по умолчанию, или набор плагинов, которые должны или не должны быть включены.

Конечно, вы также можете полностью изменить каскад конфигурации, каскад конфигурации по умолчанию, который используется в фермах, вы можете найти в конце inc/farm.php.

Отключение доступа к фермеру

Если вы хотите отключить доступ к фермеру, вы можете добавить что-то вроде

if (DOKU_FARM == false) { nice_die('Access to the farmer denied'); }

в конце inc/preload.php (после включения farm.php).

Централизованное управление пользователями

Если некоторые или все ваши животные должны иметь общих пользователей, вы можете сделать это не только с помощью той же внешней аутентификации, но и с помощью управления пользователями DokuWiki по умолчанию, указав путь к списку пользователей в том же месте в конце inc/preload.php:

$config_cascade['plainauth.users'] = array(
    'default'   => '/your/path/to/conf/users.auth.php',
);

Если вы хотите сделать это только для некоторых животных, вы, конечно, можете просто добавить условие, основанное на значении DOKU_CONF.

Гибкие настройки на основе .htaccess

На самом деле настройки на основе .htaccess могут быть намного более гибкими, чем настройки, описанные на фермах. Для этих расширенных настроек ваш каталог фермы может и даже должен быть вне корня документов (каталога, доступного из Интернета). Если ваш каталог фермы находится внутри корня документов, вам нужно убедиться, что вы должным образом защищаете каждый каталог данных (например, используя .htaccess, как это делается в обычной настройке DokuWiki), так как в этих расширенных настройках они могут не быть автоматически защищены (зависит от используемых вами условий перезаписи).

Чтобы сделать животных доступными, как в стандартной настройке, вы можете создать второй каталог фермы внутри корня документа с файлом .htaccess и без каталогов животных. Вы также можете добавить RewriteCond операторы, как в примере ниже, чтобы предотвратить циклы перенаправления. Тогда ваши животные могут быть в корневом каталоге домена, т. е. вы можете иметь example.com/animal1/ для животного animal1 и example.com/dokuwiki/ для фермера.

.htaccess

RewriteEngine On
 
# Prevent rewrite loops by making sure that the farmer directory won't be matched
# If you need to enable access to other directories either add them here or try something like
# RewriteCond %{REQUEST_FILENAME}       !-f
# RewriteCond %{REQUEST_FILENAME}       !-d
# but then also the files of your animals (if they should be in this directory) will be accessible
# so make sure you have properly protected them
 
RewriteCond %{REQUEST_URI} !^/?dokuwiki/
RewriteRule ^/?([^/]+)/(.*)  /dokuwiki/$2?animal=$1 [QSA]
RewriteCond %{REQUEST_URI} !^/?dokuwiki$
# RewriteCond %{REQUEST_FILENAME}       !-f # allow files in the root directory (like some index file)
RewriteRule ^/?([^/]+)$      /dokuwiki/?animal=$1 [QSA]
Options +FollowSymLinks

Более одного домена

Если вы можете использовать символические ссылки вы можете легко связать каталог в корневом каталоге документов каждого домена с фермером и указать этот каталог в правилах перезаписи.

Пользовательские пути

Если вы не хотите, чтобы все животные были в одном каталоге, вы можете просто создать файл .htaccess для каждого животного. В этом файле .htaccess вы можете указать имя животного.

.htaccess

RewriteEngine On
 
# Prevent rewrite loops by making sure that the farmer directory won't be matched
# If you need to enable access to other directories either add them here or try something like
# RewriteCond %{REQUEST_FILENAME}       !-f
# RewriteCond %{REQUEST_FILENAME}       !-d
# but then also the files of your animal (if they should be in this directory) will be accessible
# so make sure you have properly protected them
RewriteCond %{REQUEST_URI} !^/?dokuwiki/
RewriteRule ^/?(.*) /dokuwiki/$1?animal=ANIMAL [QSA]
RewriteRule ^/?$ /dokuwiki/?animal=ANIMAL [QSA]
 
Options +FollowSymLinks

Операторы RewriteCond предотвращают циклы перенаправления, когда ваш каталог фермера находится внутри каталога животных. Таким образом, вы также можете поместить животное в корневой каталог домена.

Запуск фермы за обратным прокси-сервером

Это происходит, когда вы настраиваете свою ферму на внутреннем сервере (например http://11.22.33.44) и представляете свои вики-ресурсы миру через фронтенд-сервер Apache (например, http://www.example.com).

Сначала настройте ферму на сервере в соответствии со стандартной документацией.

В моем случае я решил поместить все файлы DokuWiki в одно место, чтобы отделить их от других сайтов, работающих на внутреннем сервере:

/var/www/wikis/ – Корень моей установки DokuWiki.

Итак, моя ферма имеет следующую конфигурацию:

/var/www/wikis/dokuwiki– движок DokuWiki, он должен быть доступен из Интернета
/var/www/wikis/farm– каталог ферм DokuWiki, содержащий всех животных
/var/www/wikis/farm/bear– моя первая вики о медведях

На внутреннем сервере моя вики о медведях (после полной настройки) будет доступна по следующему адресу http://11.22.33.44/wikis/farm/bear

Однако на сервере frontend я хочу представить свою вики по следующему адресу (обратите внимание, что я решил убрать «s» из «wikis» в этом URL ): http://www.example.com/wiki/bear

Используя тип настройки .htaccess, я настроил его /var/www/wikis/farm/.htaccess с помощью следующего кода:

.htaccess

RewriteEngine On
 
RewriteRule ^/?([^/]+)/(.*)  /wikis/dokuwiki/$2?animal=$1 [QSA]
RewriteRule ^/?([^/]+)$      /wikis/dokuwiki/?animal=$1 [QSA]
Options +FollowSymLinks

Затем /var/www/wikis/farm/bear/confя редактирую local.protected.php следующим образом (примечание: здесь используется адрес интерфейса):

local.protected.php

<?php
/**
 * These settings are "protected" and cannot be overwritten
 * by the configuration manager, but need to be edited manually.
 */
 
$conf['savedir'] = DOKU_CONF.'../data';
$conf['updatecheck'] = 0;
// if you're using the .htaccess base setup, set this to your animal's base directory:
$conf['basedir'] = '/wiki/bear/';

Поэтому я использую Apache's mod_proxy и настраиваю конфигурацию в httpd.conf на сервере front-end:

httpd.conf

    <Location /wiki>
      ProxyPass http://11.22.33.44/wikis/farm
      ProxyPassReverse http://11.22.33.44/wikis/farm
    </Location>

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

Это работает очень хорошо, пока вы не выполните определенные действия (например, вход в систему, выход из системы, сохранение изменений и т. д.). Поскольку движок DokuWiki выполняет перенаправление в этих точках, браузеру конечного пользователя отправляется заголовок HTTP 302, содержащий следующее:

Location: http://11.22.33.44/wiki/bear/doku.php?id=blahblahblah

Конечно, на внутреннем сервере по этому адресу нет страницы, и в результате в браузере пользователя появляется сообщение об ошибке HTTP 404 «Страница не найдена».

Средство — использовать Apache's mod_headers. Мы изменяем наш блок кода в httpd.conf следующим образом:

httpd.conf

    <Location /wiki>
      ProxyPass http://11.22.33.44/wikis/farm
      ProxyPassReverse http://11.22.33.44/wikis/farm
      Header edit Location ^http://11.22.33.44 http://www.example.com
    </Location>

The 'Location' response header is now re-written to the correct address and everything works fine.

iis

anonymous@undisclosed.example.com (Anonymous) — Wed, 14 Aug 2024 22:43:55 +0000

DokuWiki с IIS

Это для тех, кто хочет использовать DokuWiki на компьютере с Windows и веб-сервером IIS (Windows 2000, Windows XP или Windows Server 2003, 2008)

IIS6 и предыдущие

Установить PHP

Новая DL-ссылка для PHP под IIS (автоматическая установка): Ссылка IIS-Aid не работает/Скачать невозможно
Если вы хотите выполнить автономную установку и хотите использовать fast-cgi, установите дополнение перед установкой php: IIS-FastCGI

(Просто установите и оставьте настройку «загрузить и установить FastCGI», и он автоматически обнаружит fast-cgi в вашей системе)

Используйте установку Windows с веб-сайта PHP. Посетите сайт PHP для инсталляторов или полных пакетов. PHP не полностью совместим с основными выпусками, по состоянию на Q1/2021 выберите новейший выпуск 7.x. Если у вас есть сомнения, обратитесь к системным requirements требованиям. PHP может работать как CGI-приложение или как расширение ISAPI. В качестве альтернативы посетите сайт Microsoft IIS для автоматической настройки PHP.
Если вы используете расширение кэширования Windows для PHP, вам необходимо отключить функцию кэширования файлов расширения, установив wincache.fcenabled значение 0 в php.ini.

Настроить IIS

Извлеките архив DokuWiki
Переименуйте dokuwiki-YYYY-MM-DD каталог в dokuwiki (или как вам нравится) и переместите его в:
- ЛУЧШАЯ Практика — поместить его куда-нибудь, кроме вашего «системного» диска, «D:\dokuwiki». Это необходимо для безопасности и снижения вероятности состояния «диск заполнен» на этом диске.
- Где-то ниже documentroot вашего нового веб-сервера, например c:\inetpub\wwwroot\dokuwiki
- Защитите все каталоги, как описано в шаге 2 главной страницы установки .
Настройте IIS (выполните одно из следующих действий):
- Виртуальный каталог на существующем веб-сайте, например, « www.YourSite.com/wiki »: поэтому обязательно настройте сопоставление виртуального каталога с wiki-code-location
- Новый веб-сайт, например «wiki.YourSite.com»: добавьте новый website-Config в IIS и установите Root-Directory в wiki-code-location
Перейдите в dokuwiki/ каталог и проверьте свойства папки data/. Убедитесь, что учетная запись гостя Интернета (IUSR_имя_компьютера ) или соответствующая учетная запись веб-сервера (или группа веб-сервера, например IIS_WPG) имеет разрешения на запись на уровне папки data/.
Установщик wiki теперь должен быть доступен по адресу http://localhost/dokuwiki/install.php

ПРИМЕЧАНИЯ

Если вы хотите записать /conf/local.php (а это нужно сделать во время процесса установки!), убедитесь, что гостевая учетная запись Интернета (IUSR_имя_компьютера ) или соответствующая группа веб-сервера (например, IIS_WPG) имеют права «Запись» для этого conf/local.php файла.
Если вы хотите запустить новую DokuWiki, убедитесь, что гостевая учетная запись Интернета (IUSR_имя_компьютера ) или соответствующая группа веб-сервера (например, IIS_WPG) имеют права «Запись» для файла conf/local.php.

IIS7/10

Установить PHP

Используйте установку Windows с веб-сайта PHP. Посетите сайт PHP для получения установщиков или полных пакетов. PHP не полностью совместим между основными выпусками, по состоянию на Q1/2021 выберите новейший выпуск 7.x. Если у вас есть сомнения, обратитесь к системным требованиям . Существует 2 установщика: «потокобезопасный» и «непотокобезопасный». Рекомендуется использовать непотокобезопасную сборку PHP с IIS 7 FastCGI. Непотокобезопасная сборка PHP обеспечивает значительный прирост производительности по сравнению со стандартной сборкой, не выполняя никаких проверок потокобезопасности, которые не нужны, поскольку FastCGI обеспечивает однопоточную среду выполнения.
PHP может работать как CGI-приложение или как расширение ISAPI. Эти инструкции предназначены для Fast-CGI, так как он быстрее и стабильнее ISAPI. Даже Microsoft рекомендует устанавливать с помощью Fast-CGI, хотя они и изобрели ISAPI. См. How To

Настроить IIS

Извлеките архив DokuWiki
Переименуйте dokuwiki-YYYY-MM-DD каталог в dokuwiki (или как вам нравится) и переместите его в:
- ЛУЧШИЙ способ — разместить его где-нибудь, кроме системного диска (например D:\dokuwiki). Это необходимо для безопасности и снижения вероятности переполнения диска на этом диске.
- Однако вы также можете поместить его где-нибудь ниже корневого каталога документов вашего нового веб-сервера, (например c:\inetpub\wwwroot\dokuwiki)
Защитите все каталоги, как описано в шаге 2 главной страницы установки .
- Вам придется предоставить учетной записи IUSR разрешения на чтение и выполнение на веб-сайте, поскольку по умолчанию они отсутствуют.
  - В диспетчере IIS щелкните левой кнопкой мыши имя сайта.
  - Нажмите «Изменить разрешения» на панели «Действия» ИЛИ щелкните правой кнопкой мыши и выберите «Изменить разрешения» в контекстном меню.
  - Нажмите вкладку «Безопасность».
  - Нажмите кнопку «Изменить».
  - Нажмите кнопку «Добавить».
  - Нажмите кнопку «Расположения» и выберите имя локального сервера.
  - Теперь введите IUSR и нажмите «ОК», а затем еще раз «ОК».
Настройте IIS (выполните одно из следующих действий):
- Виртуальный каталог на существующем веб-сайте, например, « www.YourSite.com/wiki »: поэтому обязательно настройте сопоставление виртуального каталога с wiki-code-location
- Новый веб-сайт, например «wiki.YourSite.com»: добавьте новый website-Config в IIS и установите Root-Directory в wiki-code-location
Перейдите в dokuwiki/ каталог и проверьте свойства папки data/. Убедитесь, что учетная запись гостя Интернета (IUSR), соответствующая учетная запись веб-сервера или группа серверов (IIS_IUSRS) имеет разрешения на запись на уровне папки data/. Инструкции см. выше.
Перейдите в dokuwiki/каталог и убедитесь, что учетная запись гостя Интернета (IUSR), соответствующая учетная запись веб-сервера или группа серверов (IIS_IUSRS) имеет разрешения на запись на уровне папки conf/. Инструкции см. выше.

conf/
lib/plugins ( если вы этого не сделаете, вы увидите предупреждающее сообщение в менеджере расширений )

Установщик вики теперь должен быть доступен. В зависимости от того, как вы его установили, вы можете найти его по адресу http://localhost/dokuwiki/install.php ИЛИ http://(название сайта вики) /install.php
Перейдите в dokuwiki/ каталог и удалите файл install.php.

Переписать

Включите перезапись URL-адресов и вставьте соответствующий набор правил:

<rewrite>
<rules>
 
<rule name="rule 1C" stopProcessing="true">
	<match url="^_media/(.*)" />
	<action type="Rewrite" url="/lib/exe/fetch.php?media={R:1}" appendQueryString="true" />
</rule>
<rule name="rule 2C" stopProcessing="true">
	<match url="^_detail/(.*)" />
	<action type="Rewrite" url="/lib/exe/detail.php?media={R:1}" appendQueryString="true" />
</rule>
<rule name="rule 3C" stopProcessing="true">
	<match url="^_export/([^/]+)/(.*)" />
	<action type="Rewrite" url="/doku.php?do=export_{R:1}&amp;id={R:2}" appendQueryString="true" />
</rule>
<rule name="rule 4C" stopProcessing="true">
	<match url="^$" />
	<action type="Rewrite" url="/doku.php" />
          <conditions>
            <add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
            <add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
           </conditions>
</rule>
<rule name="rule 5C" stopProcessing="true">
	<match url="(.*)" />
	<action type="Rewrite" url="/doku.php?id={R:1}" appendQueryString="true" />
          <conditions>
            <add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
            <add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
          </conditions>
</rule>
<rule name="rule 6C">
	<match url="^index.php$" />
	<action type="Rewrite" url="/doku.php" />
</rule>
</rules>
</rewrite>

Если вы используете Azure Web App, просто поместите эти строки под тегами <system.webServer> в файле web.config (расположенном в wwwroot вашего приложения).

IIS 7.0 или выше

IIS 7.0 и выше можно расширить с помощью модуля URL Rewrite 2.0, доступного от Microsoft для x86 и x64.

Сохраните правила Apache выше в файле .htaccess, удалив строку «RewriteBase /dokuwiki». Это не потребуется, так как мы будем добавлять правила непосредственно в корень вики.

В диспетчере IIS выберите папку Wiki, а в разделе IIS выберите « URL Rewrite» (если диспетчер был открыт перед установкой, потребуется обновление).

На панели действий справа выберите «Импортировать правила».

Для вашего файла конфигурации выберите файл .htaccess и импортируйте его. Это должно дать вам 6 преобразованных правил.

Наконец, нажмите «Применить» на панели «Действия» справа.

Настройте свою Wiki на использование правил .htaccess для перезаписи, и теперь вы должны увидеть, как ваши URL-адреса будут перезаписаны.

nginx

anonymous@undisclosed.example.com (Anonymous) — Thu, 08 Aug 2024 23:58:03 +0000

nginx

Эту страницу нужно немного подчистить. Желательно, чтобы это сделал опытный пользователь nginx. В вики nginx

есть рецепт , а ниже — несколько примеров. В идеале их следует объединить в одну связную установку. Следует добавить пояснение по различным установкам с использованием (F) CGI и FPM. Установку необходимых компонентов для разных операционных систем следует перенести в отдельный раздел — в любом случае конфигурация не должна зависеть от особенностей ОС .

DokuWiki с nginx на Ubuntu

Вам необходимо установить nginx и php-fpm. Если у вас текущая версия, то это будет как минимум php7.0.

Конфигурация nginx ниже основана в основном на образце конфигурации на этом сайте, обновленном для работы с текущими версиями (протестировано с 16.04 LTS). С конфигурацией кэширования изображений с этого сайта

При первоначальной настройке вы не сможете запуститься, пока не закомментируете deny в файле install.php. Это полная конфигурация, которую мы используем, вы можете просто скопировать и вставить, а также изменить имена по своему вкусу. Пожалуйста, учтите, что это работает как vhost. Вам, скорее всего, нужно будет поместить его в /etc/nginx/sites-enabled по умолчанию (или куда-то еще, если вы изменили конфигурацию).

Обратите внимание, что это https, поэтому вам понадобится сертификат или самоподписанный сертификат для настройки таким образом. Конфигурация для сертификата https типична, как показано ниже (чтобы получить хорошую оценку безопасности):

# файл с сертификатом + промежуточные данные 
ssl_certificate /etc/ssl/certs/example_com_pack.crt;
ssl_certificate_key /etc/ssl/private/example_com.key;
ssl_session_timeout 5m;
ssl_ciphers "HIGH:!aNULL:!MD5 or HIGH:!aNULL:!MD5:!3DES";
# Используйте 2048-битные параметры ключа Diffie-Hellman RSA 
# (в противном случае Nginx использует по умолчанию 1024-битные параметры, что снижает надежность шифрования # при использовании PFS) 
# Сгенерировано OpenSSL с помощью следующей команды: 
# openssl dhparam -outform pem -out /etc/nginx/ssl/dhparam2048.pem 2048 
ssl_dhparam /etc/ssl/private/dhparam2048.pem;

server {
    listen               80;
    listen                   [::]:80;
    server_name          wiki.domain.example;
    return 301 https://$server_name$request_uri;
}
 
server {
    listen [::]:443 ssl;
    listen 443 ssl;
 
    server_name wiki.domain.example;
 
     # Максимальный размер загружаемого файла составляет 4 МБ — при необходимости измените его соответствующим образом 
    client_max_body_size 4M;
    client_body_buffer_size 128k;
 
    root /dokuwiki;
    index doku.php;
 
    #Не забудьте закомментировать следующее при установке и раскомментировать после завершения. 
    location ~ /(conf/|bin/|inc/|vendor/|install.php) { deny all; }
 
    #Поддержка расположения  X-Accel-Redirect ~ ^/data/ {  internal  ;  }
    location ~ ^/data/ { internal ; }
 
    location ~ ^/lib.*\.(js|css|gif|png|ico|jpg|jpeg)$ {
        expires 365d;
    }
 
    location / { try_files $uri $uri/ @dokuwiki; }
 
    location @dokuwiki {
        # перезаписывает "doku.php/" из URL-адресов, если вы установили настройку userrewrite в .htaccess на странице конфигурации dokuwiki 
        rewrite ^/_media/(.*) /lib/exe/fetch.php?media=$1 last;
        rewrite ^/_detail/(.*) /lib/exe/detail.php?media=$1 last;
        rewrite ^/_export/([^/]+)/(.*) /doku.php?do=export_$1&id=$2 last;
        rewrite ^/(.*) /doku.php?id=$1&$args last;
    }
 
    location ~ \.php$ {
        try_files $uri $uri/ /doku.php;
        include fastcgi_params;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        fastcgi_param REDIRECT_STATUS 200;
        fastcgi_pass unix:/var/run/php/php7.0-fpm.sock;
        # fastcgi_pass unix:/var/run/php5-fpm.sock; #старая версия php 
    }
}

После размещения этого файла необходимо перезапустить nginx и php-fpm.

  service php7.0-fpm reload && service nginx reload
  # service php5-fpm reload && service nginx reload # for the older php5 version

Если вы получаете ошибку шлюза 502, это обычно означает, что возникла проблема с конфигурацией сокета phpfpm (обычно неправильный путь к сокету). Пожалуйста, ознакомьтесь с документацией по phpfpm и nginx.

DokuWiki с nginx на Windows

Dokuwiki был извлечен в E:\www\dokuwiki.

Это пример записи dokuwiki в nginx.conf, работающем на Windows:

location ~ ^/dokuwiki/.*\.php {
    root           E:/www;	         
    fastcgi_pass   127.0.0.1:9000;
    fastcgi_param  SCRIPT_FILENAME    E:/www$fastcgi_script_name;
    fastcgi_param  QUERY_STRING       $query_string;
    include        fastcgi_params;
}
# обслуживаем статические файлы 
location ~ ^/dokuwiki/lib/  {
    root         E:/www;		
    expires 30d;
}
 
location ~ ^/dokuwiki/conf/ { deny all; }
location ~ ^/dokuwiki/data/ { deny all; }
location ~ /\.ht            { deny all; }

FastCGI и nginx были запущены с помощью этого пакетного файла:

ECHO Starting PHP FastCGI...
RunHiddenConsole.exe E:\appl\php-5.2.9-2-Win32\php-cgi.exe -b 127.0.0.1:9000
ECHO Starting nginx...
cd /d D:\nginx-0.8.39 && start nginx.exe

Или вы можете попробовать Start-Nginx, если вы предпочитаете обычный графический интерфейс Windows.

Конфигурация Linux для Debian 8

У вас уже должны быть установлены nginx и php5-fpm.

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

Вы просто копируете и вставляете то, что работает для вас.

Эта конфигурация сайта не имеет SSL и использует перезапись URL

в этом примере dokuwiki находится в корне домена с именем exempl.net

Как root:

создайте новый файл сайта nginx:

nano /etc/nginx/sites-available/exempl.net

Вы вставляете код ниже, конечно же, меняете путь к вашей doku wiki и меняете server_name:

server {
      listen 80;
      root /var/www/exempl.net;
      server_name exempl.net;
      index index.php index.html doku.php;
      location ~ ^/(data|conf|bin|inc) {
              return 404;
      }
      location ~ ^/lib.*\.(gif|png|ico|jpg)$ {
              expires 31d;
      }
      location / {
              try_files $uri $uri/ @dokuwiki;
      }
      location @dokuwiki {
              rewrite ^/_media/(.*) /lib/exe/fetch.php?media=$1 last;
              rewrite ^/_detail/(.*) /lib/exe/detail.php?media=$1 last;
              rewrite ^/_export/([^/]+)/(.*) /doku.php?do=export_$1&id=$2 last;
              rewrite ^/tag/(.*) /doku.php?id=tag:$1&do=showtag&tag=tag:$1 last;
              rewrite ^/(.*) /doku.php?id=$1&$args last;
      }
 
	 # здесь вы вставляете свое местоположение ~ \.php$
	 # вот мой комментарий
     # местоположение ~ \.php$ {
     # включить /etc/nginx/fastcgi_params;
     # fastcgi_param ИМЯ_ФАЙЛА_СКРИПТА $document_root$fastcgi_script_name;
     # fastcgi_pass unix:/var/run/php5-fpm.sock;
     # }
 }

и включите его и перезапустите ngnix:

ln -s /etc/nginx/sites-available/exempl.net /etc/nginx/sites-enabled/
 
service nginx restart

Переписать

См. документацию nginx. В следующем примере корневой каталог нашего сервера — /var/www, и мы извлекаем dokuwiki в /var/www/wiki.

server {
    listen 80;
    server_name example.com www.example.com;
 
    #максимальный размер загружаемого файла составляет 4 МБ — при необходимости измените его соответствующим образом
    client_max_body_size 4M;
    client_body_buffer_size 128k;
 
    root /var/www/wiki;
    index doku.php;
 
    location / { try_files $uri $uri/ @dokuwiki; }
 
    location @dokuwiki {
        rewrite ^/_media/(.*) /lib/exe/fetch.php?media=$1 last;
        rewrite ^/_detail/(.*) /lib/exe/detail.php?media=$1 last;
        rewrite ^/_export/([^/]+)/(.*) /doku.php?do=export_$1&id=$2 last;
        rewrite ^/(.*) /doku.php?id=$1&$args last;
    }
 
    location ~ \.php$ {
        if (!-f $request_filename) { return 404; }
        include fastcgi_params;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        fastcgi_param REDIRECT_STATUS 200;
        fastcgi_pass 127.0.0.1:9000;
    }
}

Примечания

Если используется https, переменная HTTPS-сервера должна быть установлена, чтобы разрешить правильное связывание в dokuwiki. Это можно сделать в разделе сервера с помощью:

fastcgi_param HTTPS on;

Ключевое last слово правил перезаписи перед настройкой местоположения гарантирует, что переписывание происходит только один раз. Вам следует заменить все /dokuwiki/, указанные выше, на ваш каталог вики относительно корневого каталога веб-сервера.

Если вы копируете и вставляете эти конфигурации, обязательно добавьте местоположения для защиты некоторых каталогов, как описано на странице «Безопасность».

ubuntu

anonymous@undisclosed.example.com (Anonymous) — Sat, 22 Feb 2025 13:20:05 +0000

Установка DokuWiki под Ubuntu

Обратите внимание, что в репозитории Ubuntu все еще находится версия DokuWiki от 2018-04-22. Эта версия не рекомендуется. Пожалуйста, установите последнюю версию DokuWiki. В инструкции ниже используется версия, загруженная напрямую с dokuwiki.org.

Ubuntu 18.04 + Nginx

Ubuntu 14.04, and 16.04?

Это инструкции по установке одного DokuWiki в Ubuntu 14.04. Другие версии установки обсуждаются ниже. Если вы хотите установить DokuWiki Farm, следуйте этим инструкциям, а затем посетите страницу Farm Page.

Обратите внимание, что в репозиториях Ubuntu есть пакет dokuwiki. Если вы хотите его использовать, перейдите на страницу установки Debian. В этой статье описывается установка DokuWiki из tarball. (Пакеты Ubuntu и Debian следуют соглашениям о каталогах Debian, поэтому при использовании пакета Ubuntu/Debian требуются другие шаги).

Для Ubuntu 16.04 вам нужно будет использовать libapache2-mod-php 7.0 и обязательно установить php7.0-xml, php7.0 с помощью apt-get

При обновлении с Ubuntu 14.04 LTS до Ubuntu 16.04 LTS мне пришлось добавить следующее:

apt-get установить php7.0
apt-get install php-mbstring tt
apt-get install php7.0-xml

Это решило все проблемы с восстановлением DokuWiki до нормального состояния, существовавшего до обновлений.

Установка Ubuntu Server 14.04 Пошаговые инструкции со скриншотами
Обновление и модернизация Ubuntu.
```
sudo apt-get update && sudo apt-get upgrade
```

Установите Apache2 и PHP.

sudo apt-get install apache2 libapache2-mod-php php-xml

Включить модуль Apache Rewrite.
```
sudo a2enmod rewrite
```

Загрузите и распакуйте последнюю стабильную версию.

cd /var/www
sudo wget https://download.dokuwiki.org/src/dokuwiki/dokuwiki-stable.tgz
sudo tar xvf dokuwiki-stable.tgz
sudo mv dokuwiki-*/ dokuwiki

Изменить разрешения.

sudo chown -R www-data:www-data /var/www/dokuwiki

Измените корневой каталог документов в Apache так, чтобы он указывал на /var/www/dokuwiki
```
sudo nano /etc/apache2/sites-enabled/000*.conf
```
Заменить
DocumentRoot /var/www/html
на
DocumentRoot /var/www/dokuwiki
1. Если вы хотите разместить сервер DokuWiki на локальном хосте для целей тестирования, НЕ изменяйте содержимое /etc/apache2/sites-enabled/000*.conf, вместо этого создайте новый файл
  /etc/apache2/sites-available
  с
```
sudo touch apache2-dokuwiki.conf
```
  следующего содержания:
```
<VirtualHost 127.0.0.1>
        DocumentRoot /var/www/dokuwiki
 	ServerName localhost
</VirtualHost>
```
2. включите новый проект, поместив его в /etc/apache2/sites-enabled с помощью
```
sudo a2ensite apache2-dokuwiki
```
3. и затем перезагрузите службу apache2
```
sudo service apache2 reload
```
Измените настройку AllowOverrides в Apache2, чтобы использовать файлы .htaccess в целях безопасности.
```
sudo nano /etc/apache2/apache2.conf
```
1. Для каталога /var/www/ замените
  AllowOverride None
  на
  AllowOverride All
Перезапустите службу Apache2.
```
sudo service apache2 restart
```
Посетите страницу http://IP-address-of-your-server/install.php для первоначальной настройки DokuWiki.
1. Если вы решили разместить DokuWiki на локальном хосте для целей тестирования из пунктов 7a-c, посетите 127.0.0.1/install.php
После завершения установки удалите файл install.php.
```
sudo rm /var/www/dokuwiki/install.php
```
Необходимо для отправки электронной почты (например, регистрация пользователя): установить программу sendmail, например postfix
```
sudo apt-get install postfix
```
и настроить соответствующим образом
Наслаждайтесь собственным сервером DokuWiki.

Дополнительная информация по установке

Дополнительную информацию об установке и настройке DokuWiki в Ubuntu см. в разделе debian_ubuntu_extras.

Конфигурация Apache для запуска DokuWiki в ~/public_html

Это работает с Ubuntu 11.04 natty:

Установите apache2 и модуль php5:

sudo apt-get install apache2 libapache2-mod-php5

Включите модули userdir и rewrite:
```
sudo a2enmod userdir
sudo a2enmod rewrite
```
Чтобы сделать свою .htaccess работу, отредактируйте /etc/apache2/mods-enabled/userdir.conf и измените AllowOverride директиву на All¹⁾
По умолчанию php отключен для пользовательских каталогов. Чтобы включить его, закомментируйте строки согласно инструкции в /etc/apache2/mods-enabled/php5.conf
Перезапустите Apache с помощью
```
sudo service apache2 restart
```

Ubuntu Server 14.04 и lighttpd

Установите lighttpd и php.

sudo apt-get install lighttpd 
sudo apt-get install php5-cgi

Загрузите dokuwiki и поместите в каталог www. Измените имя файла соответствующим образом, так как ваш загруженный файл размещен и назван.
```
tar xvfz dokuwiki.tgz 
ls -l
sudo cp -r dokuwiki/ /var/www/
sudo chown -R www-data:www-data /var/www/dokuwiki
```

Настройте lighttpd для php.

sudo lighttpd-enable-mod fastcgi-php
sudo /etc/init.d/lighttpd force-reload

Вот и все. Наслаждайтесь собственным сервером DokuWiki. (Проверьте, работает ли он на вашем http://localhost/dokuwiki)

Установка DokuWiki с помощью apt-get

apt list dokuwiki

Проверьте дату. Если она больше пары месяцев, то я настоятельно рекомендую остановиться и попробовать описанные выше методы установки.

dokuwiki/eoan,now 0.0.20180422.a-2 all [residual-config]

Если вы настаиваете на использовании вышеуказанного пакета, то приведенные ниже шаги помогут вам запустить установку в эксплуатацию.

Примечание:

По состоянию на 2 января 2020 г. пакет датирован 22 апреля 2018 г. , что существенно устарело.
Я обеспокоен тем, что:
1. Дополнительные элементы из /var/lib/dokuwiki/ могут потребоваться в /usr/share/dokuwiki
2. Дополнительные элементы из /etc/dokuwiki/ могут потребоваться в /usr/share/dokuwiki
Изначально есть несколько предупреждений PHP, которые иногда появляются при первом изучении вики, однако они, похоже, исчезают и не возвращаются (часто). Эти проблемы задокументированы на веб-сайте DokuWiki и, как утверждается, исправлены, вероятно, проблемы исчезнут после обновления установочного пакета DokuWiki.

Предположим, что вы уже установили Apache и PHP (см. выше) и они работают правильно.

Для следующих команд потребуется префикс sudo или su (непослушный).

sudo apt install dokuwiki

Папки интереса

/etc/dokuwiki/
/usr/share/dokuwiki/
/var/lib/dokuwiki/

Пакет apt имеет ряд проблем, которые вам придется решить:

chown www-data:www-data /usr/share/dokuwiki
chown www-data:www-data /usr/share/dokuwiki/* -R
chown www-data:www-data /var/lib/dokuwiki
chown www-data:www-data /var/lib/dokuwiki/* -R
ln -s /var/lib/dokuwiki/data /usr/share/dokuwiki/data
ln -s /etc/dokuwiki/license.php /usr/share/dokuwiki/conf/license.php

Создать виртуальный каталог для Apache

nano /etc/apache2/sites-available/dokuwiki.conf

Alias /dokuwiki /usr/share/dokuwiki
<Directory /usr/share/dokuwiki>
        Options +FollowSymLinks
        AllowOverride All
        DirectoryIndex index.php
        Order allow,deny
        Allow from all
</Directory>
AliasMatch ^/dokuwiki/sites/[^/]+$      /usr/share/dokuwiki/
AliasMatch ^/dokuwiki/sites/[^/]+/(.*)$ /usr/share/dokuwiki/$1

Сообщите Apache о необходимости включить виртуальную папку (Примечание: для отключения используйте a2dissite).

a2ensite dokuwiki
systemctl reload apache2

Откройте веб-браузер и настройте DokuWiki (если у вас PHP 7.x, вы, скорее всего, получите предупреждения).

http://mysite.dyndns.org/dokuwiki/install.php

¹⁾

: кто-то, кто лучше меня разбирается в Apache, вероятно, может предложить «более безопасную» настройку для AllowOverride

blog

anonymous@undisclosed.example.com (Anonymous) — Tue, 20 Jan 2026 19:18:51 +0000

Blog Plugin

Совместим с «Докувики»

2024-02-06 "Kaos" да
2023-04-04 "Jack Jackrum" да
2022-07-31 "Igor" да
2020-07-29 "Hogfather" да

Используйте DokuWiki в качестве инструмента для ведения блога.

Последнее обновление:: 2023-10-24
Предоставляет: Syntax, Helper, Action
Репозиторий: исходный код
Требует: include, pagelist

Похож на blogtng, miniblog

Теги: blog, news

Нужен для feed

- Dokufreaks (previous author: Michael Hamann, Gina Häußge, Michael Klier, Esther Brunner)

Описание

Плагин «Блог» упрощает создание блогов в вашей вики. Компонент «Блог» отображает последние записи (страницы) из пространства имен в обратном хронологическом порядке. В этой новой версии в качестве ключа сортировки используется дата создания — это больше не дата последнего существенного изменения, как в предыдущих версиях. Компонент «Архив» отображает все записи, созданные в течение указанного месяца.

Монтаж

Используйте менеджер плагинов для установки или…

скачать zip-файл
распаковать его в<dokuwiki>/lib/plugins/
войдите как администратор и измените плагин в менеджере конфигурации

Installation

Download	plugin-blog.tgz
BundleHub	Configure your own DokuWiki blogsuite install package, consisting of all mandatory plugins plus any optional features you want to include: BlogSuite BundleHub The Bundle Hub is currently out of date and not updated any more, please install the plugins individually Site seems to be down for sime time, here is the archived version if you want to see possible optional plugins & features.
Tips	If you intend to use this plugin be sure to take a look at the blogging tips page

Syntax

Blog

{{blog>[namespace]?[number]&[flags]}}

[namespace]	namespace for the blog; subspaces will be searched as well; `*` is the whole wiki, `.` is the same namespace as the page lies in	optional; default is the blog namespace set in the configuration
[number]	number of entries to show per page	optional; default is 5
[flags]	flags are delimited by `&`
	all Include plugin flags are supported	optional
	Form placement: `topform`/`bottomform`/`noform`	optional, default is `topform`
	Custom new-entry form title: `newentrytitle=Custom title`	optional, can also be set as a configuration option
	Hide paging controls: `nopagingcontrols`	optional

This includes a specified number of most recent blog entries from the given namespace into the current page. Below the entries a link to the page (permalink), the author, the creation date and the number of comments are shown. Link, author, date and comments info can be hidden. At the end of the blog a link to older entries lets you navigate in the history of the blog. At the very end, if you have enough rights to create new pages, a form for new blog entries is displayed.

Note that when the page with the blog syntax is in the specified namespace, content my be shown twice. At some point, the loop will be detected and stopped. You should therefore make sure that either the page with the listing is in a different namespace or use the excluded_pages-option to explicitly exclude the blog page from the blog listing.

[namespace]	the namespace for which you want an archive list; `*` is the whole wiki, `.` is the same namespace as the page lies in	optional; default is the namespace specified in the configuration
[month]	the month for the archive list in YYYY-MM format; `*` for all pages	required
[flags]	pagelist flags delimited by `&`, see flags	optional
[username]	username of an author	optional

Configuration and Settings

The blog plugin can be configured using the DokuWiki configuration manager available in the admin menu.

`namespace`	The default namespace which is used if no namespace was given in the syntax
`formposition`	You can choose to display the new entry form either above or below the blog entries
`newentrytitle`	Set a custom title for all new entry forms. This can also be set on individual blog forms.
`dateprefix`	A date prefix that automatically gets added to pages created with the new entry form. You can use the options from the strftime PHP function; namespace separators work as well, e.g. `%Y:%m%d`
`sortkey`	Defines how the blog entries are sorted. Available options are creation date, modification date, page name, page ID and page title (first headline)
`sortorder`	Sort the blog entries ascending/descending
`excluded_pages`	Exclude certain pages from the blog listing. Requires a regular expression. Use for example `!(^\|:)start$!` in order to exclude start pages from all blog listings. To exclude both start and rightsidebar directly below :blog use `!(^\|:)blog:(start\|rightsidebar)$!`
`showhistogram`	Display a histogram in normal archive mode (not for autoarchive)
`max_months`	Maximum number of months to show in the histogram
`histogram_height`	Height of the histogram (in pixels)

Changes

2013-10-20: Translation updates, fix cache handling for empty blog listings
2013-03-27: Better cache handling for the archive syntax
- the syntax that lists everything till now correctly updates the cache now whenever a page is changed or a comment or linkback is added.
- the cache is not used anymore when it contains an archive listing with a page that the current user can't access. The excluded pages won't be included again automatically unless the cache expires for other reasons, the ~~NOCACHE~~ macro can be used if this is needed.

Development

Change Log

Merge pull request #126 from dokuwiki-translate/lang_update_848_17143… (2024/05/01 18:45)
translation update (2024/04/29 09:20)
Version upped (2023/10/25 00:50)
Merge pull request #121 from fiwswe/fix_issue_120 (2023/10/24 20:51)
Rename constructor (2023/10/24 13:10)
Merge pull request #118 from dokuwiki-translate/lang_update_564_16764… (2023/02/16 22:25)
translation update (2023/02/15 03:35)
Merge pull request #117 from dokuwiki-translate/lang_update_551_16745… (2023/01/24 23:45)

Bugs / Feature Requests

Please report bugs or feature requests at the Bug tracker.

FAQ

Please also have a look at the blogging tips page!

My dates are shown wrong. What can I do?

Make sure you run the latest version of all required plugins and DokuWiki.

Is it possible to change the way the date is displayed?

Yes, the plugin uses the dformat option to format the date.

How can I alter the date of a blog post?

You can use the meta plugin to manually set the creation date (and modification date) in the page source, then select the modification date in the blog plugins order setting. An alternative solution would be to alter the timestamps of the created files.

Is it possible to show table of contents?

The table of contents is shown automatically (depending on the settings in DokuWiki itself) from version 2013-02-07 on.

The header is always a link to the page even though it's disabled in the include plugin settings

The blog plugin assumes that in the context of a blog the header should be a link. However from version 2013-02-26 on it is possible to disable this behavior by using the nolink-flag, the blog plugin now only sets a default without overriding the nolink flag.

Is it possible to show just the first lines of each post with a 'Read more' link to view the full post?

I think I solved myself. In the blog mark, use the following flags

{{blog>?5&firstseconly&readmore}}

This will work if you add an H2 header (in the full post) where you want to make appear the 'Read more' link. If you don't need or want an H2 header in your post, you can add a empty H2 header, just as a delimiter for the text you want to show in the Blog's headlines

the excluded_pages does not work

In the blog mark ,use the following flags

{{blog>*?5&!(^|:)index$!}}
or
{{blog>*?5&excluded_pages=!(^|:)index$!}}

all above flags does not work, the index pages in sub namespace is still included .

This is global configuration, you should configure it in Configuration Manager. — Siyuan Liu 2023-08-17

Discussion

Please report bugs or feature requests at the Bug tracker.

Is it possible to make a blog in one namespace be in ascending order, and a blog in a different namespace to be in descending order?

Обновление

Для обновления удалите исходную папку lib/plugins/displaywikipage и установите новую версию, как указано выше.

Файл для загрузки

plugin-blog-master.zip

Лицензия

Author: Dokufreaks (previous authors: Michael Hamann, Gina Häußge, Michael Klier, Esther Brunner)
License: GNU GPL v2

Это не обязательно, но, пожалуйста, рассмотрите возможность ссылки на эту страницу с вашего сайта, если вам нравится этот продукт.

httpslogin

anonymous@undisclosed.example.com (Anonymous) — Fri, 09 Aug 2024 01:01:18 +0000

Принудительный вход через HTTPS

Плагины

forcessllogin

См. https://www.dokuwiki.org/plugin:forcessllogin, похоже, не отражает доступ SSL в URL , т.е. страница «Докувики», доступ к которой запрещен, не будет открыта по протоколу https, что затрудняет отладку и обеспечение безопасного входа в систему.

Апачи

Используя mod_rewrite Apache, можно принудительно использовать HTTPS для входа в DokuWiki, тем самым предотвращая передачу паролей в открытом виде.

Вам также может понадобиться, чтобы все запросы (а не только вход) использовали HTTPS. Для этого создайте файл .htaccess в корневом каталоге DokuWiki и вставьте следующий код.

.htaccess

RewriteCond %{HTTPS} !on
RewriteRule (.*) https://%{HTTP_HOST}/$1 [R,L]

Если вы хотите принудительно задать только какой-то определенный URL , сначала прочтите статью о перезаписи URL.

Перенаправление на защищенное соединение, которое ограничено определенным набором страниц (например, страницы входа), требует их распознавания на основе URL . Некоторые страницы (например, страницы «доступ запрещен», которые могут быть включены только в более новых версиях, например, 2014-05-05 «Ponder Stibbons» <ref> https://www.dokuwiki.org/plugin:ondeniedlogin </ref>) не включают такую метку и не могут быть отделены от остальных URL (к которым может потребоваться доступ без защищенного соединения для экономии ресурсов сервера).

Остальная часть параграфа обрабатывает только запросы с ?do=login запросом GET, который не охватывает по крайней мере страницы «доступ запрещен»! Необходимо исследование правила перенаправления для всех запросов аутентификации по HTTP. Смотрите обсуждение для решения.

Далее предполагается, что вы уже настроили поддержку HTTPS для своей вики, сделав ее доступной по HTTP и HTTPS по одному и тому же адресу. По соображениям производительности только вход в систему и обновления профиля должны быть принудительно переведены на HTTPS, в то время как все «нормальные» действия вики будут продолжать работать по HTTP.

Поскольку вам необходимо настроить куки через HTTPS для работы на HTTP, вам необходимо сначала отключить опцию securecookie . Затем приступайте к настройке перенаправления в вашем .htaccess:

# Переключиться на безопасный режим при входе в систему, профиле и действиях администратора 
RewriteEngine On
RewriteCond %{HTTPS} !on
RewriteCond %{QUERY_STRING} do=(log|profile|admin)
RewriteRule ^(.*) https://%{HTTP_HOST}/$1 [R,QSA,L,NE]
 
# Изменить обратно на небезопасный режим при показе действия 
RewriteCond %{HTTPS} on
RewriteCond %{QUERY_STRING} !do=(log|profile|admin)
RewriteCond %{REQUEST_METHOD} GET
RewriteRule ^(.*) http://%{HTTP_HOST}/$1 [R,QSA,L]

Возможно, вы захотите изменить ${HTTP_HOST} его на ${SERVER_NAME}, где имя сервера совпадает с именем хоста в вашем SSL-сертификате.

Примечания:

выше переключает обратно на не-SSL только на действии show. Это означает, что переключение может не произойти немедленно после входа, но гарантирует отсутствие предупреждений о «смешанном контенте» во время операции SSL.
если у вас есть другие правила переписывания, например, те, которые используются при общем переписывании, поместите эти правила перед остальными.
Если каталог установки DokuWiki не является корневым каталогом (например, http://example.com/wiki/) , вам необходимо добавить этот дополнительный путь к строкам 5 и 11 приведенного выше фрагмента, что будет выглядеть примерно так:RewriteRule ^(.*) http://%{HTTP_HOST}/wiki/$1 [R,QSA,L]

защищенный cookie

Обратите внимание: вам необходимо отключить « securecookie », conf/dokuwiki.php чтобы приведенный выше код работал. В противном случае ваши входы не будут успешно регистрироваться. Это происходит потому, что при включенном securecookie сеансовый cookie, созданный во время входа HTTPS, не может быть отправлен по HTTP, и сеанс теряется.

nginx

Такая настройка также возможна в nginx, но с небольшой доработкой fastcgi_params.

Во-первых, вам нужно иметь отдельные экземпляры сервера, для http и https каждый, чтобы поддерживать чистоту (и rewrite не запутаться и не попасть в ловушку redir loops). Это может выглядеть так. Каждый экземпляр имеет свое собственное правило перезаписи для переключения с http на https.

# Протестировано с nginx 0.8.5
# В http-контексте вашей конфигурации nginx
map $scheme $php_https { default off; https on; }
 
    server {
	server_name wiki.host.org
	root /path/to/dokuwiki;
	index doku.php;
	listen 80;
	#Enforce https for logins, admin
	if ($args ~* do=(log|admin|profile)) {
		rewrite ^ https://$host$request_uri? redirect;
	}
	include dokuwiki.conf;
    }
 
    server {
	server_name wiki.host.org;
	root /path/to/dokuwiki;
	index doku.php;
	listen 443 ssl;
	keepalive_requests    10;
	keepalive_timeout     60 60;
	ssl_certificate      /etc/ssl/certs/ssl-cert-snakeoil.pem;
	ssl_certificate_key  /etc/ssl/private/ssl-cert-snakeoil.key;
	#switch back to plain http for normal view
 
	if ($args ~* (do=show|^$)){
		rewrite ^ http://$host$request_uri? redirect;
	}
	include dokuwiki.conf;
    }

В dokuwiki.conf (тот же путь, что и у вашего nginx.conf) вы можете использовать фрагмент из вики nginx, но вам нужно добавить

fastcgi_param HTTPS $php_https;

в ваш fastcgi_params. Этот параметр и map директива в начале обязательны, поскольку Dokuwiki проверяет $_SERVER['HTTPS'] для работы.

Как и в случае с Apache, вам необходимо отключить Securecookie в вашем conf/dokuwiki.php.

HTTPS на основе PHP

Ниже полезно, если вы хотите принудительно использовать https-соединение ВСЕГДА (не только для входа) и не хотите полагаться на Apache или NGINX htaccess или другие специфичные для сервера директивы. Поместите следующие строки в начало файла шаблона в '…lib/tpl/template-name/main.php'

<?php
if ($_SERVER[HTTPS]!="on") {
  //$strURIName=$_SERVER['SERVER_NAME'] . getenv("REQUEST_URI"); 
  // Функция 'getenv' не работает, если ваш API сервера - ASAPI (IIS). 
  // Поэтому постарайтесь использовать не getenv('REMOTE_ADDR'), а $_SERVER["REMOTE_ADDR"].
  $strURIName= $_SERVER['SERVER_NAME'] . $_SERVER['REQUEST_URI'];
  header ("Location: https://$strURIName");
  // Если это не работает для вас и вам нужно устранить неполадки в вашем PHP-коде, 
  // раскомментируйте ниже, чтобы узнать о ваших конкретных переменных сервера 
  /*
  echo "<b>_SERVER Variables from $_SERVER</b><br><br>";
  reset($_SERVER);
  while (list ($key, $val) = each ($_SERVER)) {
  print $key . " = " . $val . "<br>";
  }
  */
}
?>

Спасибо. Это спасло мой день!

Обсуждение

parallelregex.php

anonymous@undisclosed.example.com (Anonymous) — Thu, 16 Jan 2025 16:43:27 +0000

ParallelRegex.php

<?php
/**
 * Lexer adapted from Simple Test: http://sourceforge.net/projects/simpletest/
 * For an intro to the Lexer see:
 * https://web.archive.org/web/20120125041816/http://www.phppatterns.com/docs/develop/simple_test_lexer_notes
 *
 * @author Marcus Baker http://www.lastcraft.com
 */
 
namespace dokuwiki\Parsing\Lexer;
 
/**
 * Compounded regular expression.
 *
 * Any of the contained patterns could match and when one does it's label is returned.
 */
class ParallelRegex
{
    /** @var string[] patterns to match */
    protected $patterns;
    /** @var string[] labels for above patterns */
    protected $labels;
    /** @var string the compound regex matching all patterns */
    protected $regex;
    /** @var bool case sensitive matching? */
    protected $case;
 
    /**
     * Constructor. Starts with no patterns.
     *
     * @param boolean $case    True for case sensitive, false
     *                         for insensitive.
     */
    public function __construct($case)
    {
        $this->case = $case;
        $this->patterns = array();
        $this->labels = array();
        $this->regex = null;
    }
 
    /**
     * Adds a pattern with an optional label.
     *
     * @param mixed       $pattern Perl style regex. Must be UTF-8
     *                             encoded. If its a string, the (, )
     *                             lose their meaning unless they
     *                             form part of a lookahead or
     *                             lookbehind assertation.
     * @param bool|string $label   Label of regex to be returned
     *                             on a match. Label must be ASCII
     */
    public function addPattern($pattern, $label = true)
    {
        $count = count($this->patterns);
        $this->patterns[$count] = $pattern;
        $this->labels[$count] = $label;
        $this->regex = null;
    }
 
    /**
     * Attempts to match all patterns at once against a string.
     *
     * @param string $subject      String to match against.
     * @param string $match        First matched portion of
     *                             subject.
     * @return bool|string         False if no match found, label if label exists, true if not
     */
    public function apply($subject, &$match)
    {
        if (count($this->patterns) == 0) {
            return false;
        }
        if (! preg_match($this->getCompoundedRegex(), $subject, $matches)) {
            $match = "";
            return false;
        }
 
        $match = $matches[0];
        $size = count($matches);
        // FIXME this could be made faster by storing the labels as keys in a hashmap
        for ($i = 1; $i < $size; $i++) {
            if ($matches[$i] && isset($this->labels[$i - 1])) {
                return $this->labels[$i - 1];
            }
        }
        return true;
    }
 
    /**
     * Attempts to split the string against all patterns at once
     *
     * @param string $subject      String to match against.
     * @param array $split         The split result: array containing, pre-match, match & post-match strings
     * @return boolean             True on success.
     *
     * @author Christopher Smith <chris@jalakai.co.uk>
     */
    public function split($subject, &$split)
    {
        if (count($this->patterns) == 0) {
            return false;
        }
 
        if (! preg_match($this->getCompoundedRegex(), $subject, $matches)) {
            if (function_exists('preg_last_error')) {
                $err = preg_last_error();
                switch ($err) {
                    case PREG_BACKTRACK_LIMIT_ERROR:
                        msg('A PCRE backtrack error occured. Try to increase the pcre.backtrack_limit in php.ini', -1);
                        break;
                    case PREG_RECURSION_LIMIT_ERROR:
                        msg('A PCRE recursion error occured. Try to increase the pcre.recursion_limit in php.ini', -1);
                        break;
                    case PREG_BAD_UTF8_ERROR:
                        msg('A PCRE UTF-8 error occured. This might be caused by a faulty plugin', -1);
                        break;
                    case PREG_INTERNAL_ERROR:
                        msg('A PCRE internal error occured. This might be caused by a faulty plugin', -1);
                        break;
                }
            }
 
            $split = array($subject, "", "");
            return false;
        }
 
        $idx = count($matches)-2;
        list($pre, $post) = preg_split($this->patterns[$idx].$this->getPerlMatchingFlags(), $subject, 2);
        $split = array($pre, $matches[0], $post);
 
        return isset($this->labels[$idx]) ? $this->labels[$idx] : true;
    }
 
    /**
     * Compounds the patterns into a single
     * regular expression separated with the
     * "or" operator. Caches the regex.
     * Will automatically escape (, ) and / tokens.
     *
     * @return null|string
     */
    protected function getCompoundedRegex()
    {
        if ($this->regex == null) {
            $cnt = count($this->patterns);
            for ($i = 0; $i < $cnt; $i++) {
                /*
                 * decompose the input pattern into "(", "(?", ")",
                 * "[...]", "[]..]", "[^]..]", "[...[:...:]..]", "\x"...
                 * elements.
                 */
                preg_match_all('/\\\\.|' .
                               '\(\?|' .
                               '[()]|' .
                               '\[\^?\]?(?:\\\\.|\[:[^]]*:\]|[^]\\\\])*\]|' .
                               '[^[()\\\\]+/', $this->patterns[$i], $elts);
 
                $pattern = "";
                $level = 0;
 
                foreach ($elts[0] as $elt) {
                    /*
                     * for "(", ")" remember the nesting level, add "\"
                     * only to the non-"(?" ones.
                     */
 
                    switch ($elt) {
                        case '(':
                            $pattern .= '\(';
                            break;
                        case ')':
                            if ($level > 0)
                                $level--; /* closing (? */
                            else $pattern .= '\\';
                            $pattern .= ')';
                            break;
                        case '(?':
                            $level++;
                            $pattern .= '(?';
                            break;
                        default:
                            if (substr($elt, 0, 1) == '\\')
                                $pattern .= $elt;
                            else $pattern .= str_replace('/', '\/', $elt);
                    }
                }
                $this->patterns[$i] = "($pattern)";
            }
            $this->regex = "/" . implode("|", $this->patterns) . "/" . $this->getPerlMatchingFlags();
        }
        return $this->regex;
    }
 
    /**
     * Accessor for perl regex mode flags to use.
     * @return string       Perl regex flags.
     */
    protected function getPerlMatchingFlags()
    {
        return ($this->case ? "msS" : "msSi");
    }
}

totranslate

anonymous@undisclosed.example.com (Anonymous) — Thu, 26 Sep 2013 21:30:05 +0000

Diese Seite wurde noch nicht vollständig übersetzt. Bitte helfen Sie bei der Übersetzung.
(diesen Absatz entfernen, wenn die Übersetzung abgeschlossen wurde)

totranslate

anonymous@undisclosed.example.com (Anonymous) — Sat, 12 Oct 2013 21:30:05 +0000

이 문서는 아직 완전히 번역되지 않았습니다. 번역을 완료하는 데 도와주세요.
(번역을 마치면 이 단락을 지우세요)