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

Возможно, вам стоит рассмотреть возможность использования идейного преемника этого плагина struct Plugin

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

• Merge pull request #250 from dokuwiki-translate/lang_update_1176_1753… (2025/10/17 12:36)
• translation update (2025/07/22 15:25)
• Version upped (2024/02/02 01:50)
• Merge pull request #240 from annda/gh-tests (2024/02/01 11:48)
• Manual code style fixes (2024/01/31 11:39)
• Update test workflow (2024/01/30 11:30)
• Semi-automatic code style fixes (2024/01/30 11:30)
• Version upped (2023/07/20 00:50)

Обязательно обновите плагин sqlite и следуйте инструкциям по обновлению версии sqlite.

Начиная с 22 марта 2010 года, плагин данных использует вспомогательный плагин sqlite. Поэтому расположение и структура файлов базы данных изменились. Если вы хотите сохранить старую базу данных, перед обновлением плагина данных необходимо выполнить следующие действия:

1. Установите sqlite плагин
2. Переместите файл data/cache/dataplugin.sqlite в data/meta/data.sqlite
3. Выполните следующие SQL-запросы к базе данных (например, используя страницу администрирования плагина sqlite):

CREATE TABLE opts (opt,val);
CREATE UNIQUE INDEX idx_opt ON opts(opt);
INSERT INTO opts VALUES ('dbversion', 1);

1. Обновите плагин данных.

Если вы обновили плагин данных до выполнения этих шагов, data.sqlite был создан пустой файл, и вам необходимо скопировать его data/cache/dataplugin.sqlite поверх существующего data/meta/data.sqlite.

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

Эта часть используется для добавления структурированных данных на страницу. Все введенные здесь данные привязаны к странице. Поэтому вы можете использовать ее только один раз на странице ¹²⁾. Давайте начнем с примера:

---- dataentry projects ----
type            : web development
volume          : 1 Mrd    # how much do they pay?
employees       : Joe, Jane, Jim
description_wiki: **Important** project
customer_page   : customers:microsoft
deadline_dt     : 2009-08-17
server_pages    : servers:devel01, extern:microsoft
website_url     : http://www.microsoft.com
task_tags       : programming, coding, design, html
----

Как видите, блок определяется дефисами и словом dataentry. После ключевого слова можно добавить дополнительные слова dataentry. Они будут добавлены в качестве дополнительных CSS- классов в итоговый HTML- код и могут быть использованы для запроса %class% позже. Это можно использовать для стилизации отображения различных типов записей или для ограничения агрегации определенными типами страниц.

Вы можете использовать этот # символ для добавления комментариев к блоку. Они будут игнорироваться и не будут отображаться или сохраняться. Если вам нужно ввести # данные, экранируйте их обратной косой чертой ( \#). Если вам нужна обратная косая черта, экранируйте и её (\\).

Внутри блока вы видите названия столбцов и их значения. Для названий столбцов существует несколько правил:

• Используйте любое имя на ваш выбор.
• Если имя заканчивается этим s символом, вы можете добавить несколько значений, разделенных запятыми (как в строке с сотрудниками). Это удалит последний s символ из отображаемого имени столбца.
  • Суффикс s или «множественные значения» вступают в действие при использовании ~ фильтра, в отличие от *~ (см. ниже)¹³⁾
  • Если вы хотите избежать использования опции множественных значений и сохранить имя столбца без изменений, добавьте в конец имени символ подчеркивания (например: thickness_ : 1cm).
  • s Если вам нужен вариант с несколькими значениями, и вы хотите оставить название столбца без изменений, добавьте к нему второе значение …

например: name…
e.g.:
name : John → name: John
names: John, Jack → name: John, Jack
name_tag : John, Jack → name: John, Jack
name_tags: John, Jack → name: John, Jack
thickness : 1cm → thicknes: 1cm
thickness_: 1cm → thickness: 1cm
thicknesss: 1cm, 2inch → thickness: 1cm, 2inch

• При использовании типа данных добавьте параметр sдля множественных значений в самом конце (например, в server_pages строке).
• Для форматирования вывода к имени можно добавить специальные типы. Используйте нижнее подчеркивание для разделения идентификатора и типа. Доступные в настоящее время типы перечислены в таблице ниже.
  • Если тип не указан, он рассматривается как простая строка.
  • Новые типы можно создавать с помощью псевдонимов типов

В значениях можно использовать два заполнителя, полезных для создания ссылок, зависящих от локализации.

Для агрегирования структурированных данных, прикрепленных к различным страницам вашей вики, используется следующий синтаксис. Он отобразит настраиваемую таблицу с нужными вам данными. Таблицу можно сортировать и фильтровать. Также поддерживается постраничная навигация¹⁴⁾. И, как и в случае с dataentry, вы можете добавить дополнительные слова после ключевого слова datatable. Они будут добавлены в виде дополнительных CSS- классов в итоговый HTML- код. Давайте снова начнем с примера:

---- datatable ----
cols    : %pageid%, employees, deadline_dt, website_url, volume
headers : Details, Assigned Employees, Deadline, Personal website, $$$
max     : 10
filter  : type=web development
sort    : ^volume
----

Приведенная выше конфигурация отобразит таблицу со всеми проектами веб-разработки, сотрудниками, назначенными на проект, сроками выполнения и объемом работ. Таблица будет отсортирована по объему и будет отображать максимум 10 проектов.

Как и в случае с вводом данных, значения в столбцах также можно форматировать, добавляя к именам столбцов псевдоним типа. Как и в случае со столбцом deadline_dt выше. Другой пример показывает website, что при указании URL-адреса записи в столбцах помечаются, например, _url для обеспечения возможности создания ссылок в выходных данных.

Ключевое слово перед двоеточием обозначает параметр конфигурации, а значение после него — фактическую настройку. Для повышения отказоустойчивости часто допускается использование нескольких имен параметров. Вот список всех доступных параметров:

Для фильтрации возможно использование нескольких компараторов:

Вы можете использовать специальные переменные в фильтре, чтобы он сопоставлялся с текущим авторизованным пользователем или текущей датой, например. filter: username=%user%

Существует несколько переменных, которые можно использовать в качестве имен полей, например filter : %pageid%~members:*:

Класс записи данных %lastmod%:

---- datatable ----
cols    : %pageid%, %lastmod%
headers : Details, Last Update
max     : 10
filter  : type=release notes
sort    : ^%lastmod%
----

Работает datalist аналогично описанному datatable выше и принимает те же параметры. Но вместо отображения таблицы показывается неупорядоченный список. Каждая строка результата представляет собой один элемент списка, все выбранные столбцы по умолчанию соединены пробелом. Если параметр sepbyheaders не задан, header он полностью игнорируется. Пагинация не используется.

---- datalist ----
cols    : %pageid%, volume
max     : 10
filter  : type=web development
sort    : ^volume
----

Этот режим позволяет отображать список страниц, похожих на текущую страницу, поскольку они имеют общие структурированные данные. Какие столбцы используются для сравнения по сходству, необходимо указать в параметрах cols. Можно задать дополнительные фильтры и параметры сортировки. Вот пример:

---- datarelated ----
cols  : task_tags, type
title : Similar projects
max   : 5
sort  : ^volume
----

Представленная конфигурация будет искать страницы, имеющие общие значения в столбцах task_tags и type. Отображается максимум 5 страниц, отсортированных по объему.

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

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

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

Пример:

---- datacloud ----
field: employees
min: 2
limit: 20
----

Приведенный выше код отобразит цепочку сотрудников, назначенных как минимум на два разных проекта. Отобразится максимум 20 самых загруженных сотрудников.

Вот возможные варианты облачных решений:

Кроме того, фильтры можно задавать, как описано в синтаксисе таблицы данных.

Позиционирование и стилизация полей ввода и вывода могут быть выполнены с помощью простого CSS . Все, что указано после ключевого слова синтаксиса, будет присвоено в качестве дополнительного имени класса окружающему div. Кроме того, ключи полей используются в качестве классов для элементов полей ввода.

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

---- dataentry character24 ----
name            : Jack Bauer
agency_nspage   : CTU
status_tags     : alive, active, disowned, furtive
.... more info
----

Теперь вы можете стилизовать этот блок с помощью CSS в вашем <dokuwiki>/conf/userstyle.css¹⁵⁾. Вот пример:

div .character24  { 
  /* Здесь размещается код для контейнерного блока, такой как положение, макет и границы */ 
  float :  right ; 
  width :  33% ; 
}
 
div .character24 dl > dt {  
  /* Это позволит вам стилизовать термины определения */ 
  font-variant :  small-caps ; 
}
 
div .character24 dl > dt + dd { 
  /* Это позволит вам стилизовать значения определения */ 
  font-family :  sans-serif ; 
}
 
div .character24 dl dd.name { 
  /* Это делает имя больше, чем остальное */ 
  font-size :  120% ; 
}

Псевдонимы типов — это пользовательские типы данных, определяемые базовым типом (одним из встроенных типов, например, `<type>` page или отсутствием типа) и, при необходимости, префиксом, постфиксом или набором допустимых значений, разделенных запятыми. Псевдонимы типов управляются на отдельной странице в меню администратора и хранятся в базе данных. Их можно использовать в записях данных, списках и таблицах, как и встроенные типы.

Например, чтобы создать новый тип данных map который будет открывать Google Maps:

определить карту адресов interwiki:

map     http://maps.google.com/maps?q={NAME}

А в разделе Администрирование → Плагин данных: Псевдонимы полей (do=admin&page=data_aliases) определите:

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

---- dataentry  ----
Address_map  : 51.103028,-1.780611
----

Вы даже можете ввести действительный адрес, например: Bahnhofsstraße 5, Regensburg, Deutschland

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

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

---- dataentry  ----
Address_newtag  : cheese
----

Нажатие на этот cheese тег приведет к переходу по ссылке namespace:pagewithdatatable и фильтрации по ней cheese.

Если вы объедините все встречи, вы можете создать ссылку для их скачивания.

iCal-плагин

Настройка плагина vCard аналогична настройке iCal.

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

Пользовательский редактор: редактирование структуры и значений.

Пользовательский редактор: редактирование только значений путем включения соответствующей опции в конфигурации.edit_content_only

При включении этой опции конфигурации edit_content_only используются некоторые удобные поля:

• Выпадающий список отображается заполненным значениями, указанными в Valid values столбце псевдонимов типов.
• Выбор даты для полей типа dt
• Функция автозаполнения предлагает варианты существующих страниц для псевдонимов типов на основе самого page типа ( page сам тип не работает).

Требование : Для работы средства выбора даты и подсказок страниц необходим плагин bureaucracy который обеспечивает необходимую JavaScript-инфраструктуру.

Подсказки страниц активируются с помощью псевдонима типа page. Второй псевдоним отображает только страницы в plugin: пространстве имен , что также показано на изображении.

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

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

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

data_aliastextbox Tag _fixedtag 	
data_aliastextbox Multitags _fixedtags 

data_aliastextbox "Date of happening" _dt	
data_aliastextbox "Plugin Page" _pagesuggestplugin

В последней строке используется псевдоним типа из предыдущего раздела, первые две строки объединены с псевдонимом типа:

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

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

Для создания переводов имен полей создайте файл в каталоге `/etc/fieldname/fieldname` conf/lang/<langcode>/data-plugin.php. Этот файл должен содержать PHP-массив $lang с именем `/etc/fieldname` в качестве ключа и переводом в качестве значения:

conf/lang/en/data-plugin.php

<?php
$lang['somekey']  = 'My name for the key';
$lang['otherkey'] = 'My name for the other key';

Названия полей следует указывать без указания типа. Поэтому это deadline не так deadline_dt.

После создания или изменения файла data-plugin.php, пожалуйста, обновите конфигурацию вики, чтобы обновить кэшstart?do=admin&page=config, в противном случае изменения не будут учтены.

• Дополнительные параметры управления:
  • Список атрибутов (аналогично облаку тегов, но в виде простого списка)
  • поле поиска – см. плагин datasearchform
• улучшенная документация, примеры
  • Пожалуйста, укажите, какие фрагменты требуют большего внимания или что вам непонятно. Спасибо.
• Добавьте поддержку JavaScript для формы редактирования content_only в полнофункциональную форму.
• Больше типов данных?
• Ссылки в агрегированных данных и в самих записях не создают обратных ссылок.
• поиск данных в определенном пространстве имен
• Для проверок типа WHERE по полям даты требуется эквивалент SQL INTERVAL («WHERE field_dt < %now% + INTERVAL 6 MONTH» равно «field_dt before 6 months from now»).
• сравнить с названием «этой страницы» (в таблице данных)
• История изменений в таблице псевдонимов типов (изменения в таблице могут повлиять на страницы, но запись и отмена изменений недоступны).
• Больше блоков ввода данных на одной странице. Причина: плагин Data разработан таким образом, что на каждой странице размещается отдельный блок ввода данных. ⇒ Рекомендуемая альтернатива: Strata Plugin, который эквивалентен плагину Data, но немного более функционален.

Некоторые варианты использования:

• С работой этого плагина можно ознакомиться на этой вики в пространстве имен DokuWiki Installations.
  • Найдите это datatable в исходном коде DokuWiki Installations
  • а также dataentry на некоторых страницах, посвященных установке.
• Очень интересная и хорошо организованная вики-система: ICKEwiki от Cosmocode интегрирует плагин данных с другими плагинами, такими как Bureaucracy, создавая полноценный корпоративный вики-инструмент. Перейдите по ссылкам на демо-версию (на немецком языке), которая позволяет получить доступ к вики как сотрудник.
• Пример использования DokuWiki: список сотрудников – Как использовать плагин Data с плагинами Bureaucracy и Wrap Руководство от lolmaus.

Данные, копируемые в базу данных SQLite, должны автоматически обновляться при каждом изменении страницы, содержащей поле ввода данных. Если вы удаляли или переименовывали страницы вне вики, база данных по-прежнему будет содержать данные о страницах, которые теперь не существуют. Их можно очистить с помощью Data Plugin: Clean up database соответствующего пункта в меню «Администрирование».

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

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

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

• для пакетной загрузки страниц вики с помощью wget, программы для загрузки файлов из командной строки;
• Чтобы установить плагин searchindex откройте новую SearchIndex Manager панель в меню «Администрирование» и нажмите Rebuild Index кнопку.

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

Плагин Strata по своим функциональным возможностям является аналогом плагина Data. Однако он обладает более сложным синтаксисом запросов, упрощенной системой псевдонимов и дополнительными функциями, такими как построение графиков или вывод данных на основе предопределенного шаблона. Таким образом, для обработки более сложных данных плагин Strata предоставляет больше возможностей.

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

например

---- dataentry projects ----
type            : web development
volume          : 1 Mrd    # how much do they pay?
employees       : Joe, Jane, Jim
description_wiki: **Important** project
customer_page   : 
----

и если запрос выглядит так:

---- datatable ----
cols    : %pageid%
headers : Details
filter  : customer_page=
----

В выходных данных указанная выше запись не отображается.

---- datatable ----
cols    : %pageid%
headers : Details
filter  : %class% = projects
----

DokuWiki вызывает функцию strftime _template.txt при создании новой страницы. Это заменяет некоторые комбинации %[az] (например, %title% станет [TAB]itle%). При использовании заполнителей _template.txt следует использовать двойные знаки процента (%%title%%). Функция strftime будет рассматривать их как обычные символы процента.

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

Важно! Это лишь уловки — нет гарантии, что они всегда будут работать, и они не сохранятся после обновлений.

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

ПРИМЕЧАНИЕ: /conf/dokuwiki.php Также необходимо изменить параметр конфигурации функции PHP strftime (это можно сделать через Администрирование → Конфигурация ).

$conf['dformat']     = '%d/%m/%Y %H:%M';

Чтобы изменить формат даты по умолчанию с yy-mm-dd на dd-mm-yy (например, для Австралии)

Измените это:

plugins/data/helper.php

    /** 
     * Заменяет заполнители в SQL 
     */ 
    function _replacePlaceholdersInSQL ( & $data )  { 
        global  $USERINFO ; 
        // разрешить имя текущего пользователя в фильтре: 
        $data [ 'sql' ]  =  str_replace ( '%user%' ,  $_SERVER [ 'REMOTE_USER' ] ,  $data [ 'sql' ] ) ; 
        $data [ 'sql' ]  =  str_replace ( '%groups%' ,  implode ( "','" ,  ( array )  $USERINFO [ 'grps' ] ) ,  $data [ 'sql' ] $
         // разрешить текущую дату в фильтре: 
        $data [ 'sql' ]  =  str_replace ( '%now%' , dformat ( null ,  '%Y-%m-%d' ) ,  $data [ 'sql' ] ) ; 
 
        // языковой фильтр 
        $data [ 'sql' ]  =  $this- > makeTranslationReplacement ( $data [ 'sql' ] ) ; 
    }

к этому:

plugins/data/helper.php

    /** 
     * Заменяет заполнители в SQL 
     */ 
    function _replacePlaceholdersInSQL ( & $data )  { 
        global  $USERINFO ; 
        // разрешить имя текущего пользователя в фильтре: 
        $data [ 'sql' ]  =  str_replace ( '%user%' ,  $_SERVER [ 'REMOTE_USER' ] ,  $data [ 'sql' ] ) ; 
        $data [ 'sql' ]  =  str_replace ( '%groups%' ,  implode ( "','" ,  ( array )  $USERINFO [ 'grps' ] ) ,  $data [ 'sql' ] $
         // разрешить текущую дату в фильтре: 
        $data [ 'sql' ]  =  str_replace ( '%now%' , dformat ( null ,  '%d-%m-%Y' ) ,  $data [ 'sql' ] ) ; 
 
        // языковой фильтр 
        $data [ 'sql' ]  =  $this- > makeTranslationReplacement ( $data [ 'sql' ] ) ; 
    }

и измените это:

plugins/data/helper.php

switch ( $type )  { 
            case  'dt' : 
                if ( preg_match ( '/^(\d\d\d\d)-(\d\d?)-(\d\d?)$/' ,  $value ,  $m ) )  { 
                    return  sprintf ( '%d-%02d-%02d' ,  $m [ 1 ] ,  $m [ 2 ] ,  $m [ 3 ] ) ; 
                }

к этому:

plugins/data/helper.php

switch ( $type )  { 
            case  'dt' : 
                if ( preg_match ( '/^(\d\d?)-(\d\d?)-(\d\d\d\d)$/' ,  $value ,  $m ) )  { 
                    return  sprintf ( '%02d-%02d-%d' ,  $m [ 1 ] ,  $m [ 2 ] ,  $m [ 3 ] ) ; 
                }

и измените это:

plugins/data/script.js

/** 
 * Инициализация средства выбора даты для всех полей даты 
 */ 
jQuery ( function  ( )  { 
    jQuery ( '.data_type_dt input' ) . datepicker ( { 
        dateFormat :  "yy-mm-dd" , 
        changeMonth :  true , 
        changeYear :  true 
    } ) ;

к этому:

plugins/data/script.js

/** 
 * Инициализация средства выбора даты для всех полей даты 
 */ 
jQuery ( function  ( )  { 
    jQuery ( '.data_type_dt input' ) . datepicker ( { 
        dateFormat :  "dd-mm-yy" , 
        changeMonth :  true , 
        changeYear :  true 
    } ) ;

— SFITCS 2016-11-26 01:24

Пожалуйста, сообщайте об ошибках и предлагайте новые функции в системе отслеживания ошибок на GitHub. Патчи следует отправлять в формате унифицированного сравнения изменений (unified diff format) или в виде git-патчей для ветки devel. Или еще лучше: создайте форк репозитория на GitHub и отправьте запрос на слияние (merge request).

• Ссылка на оригинальную статью
• Скачать plugin data