Этот плагин позволяет добавлять структурированные данные на любую страницу 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 страниц, отсортированных по объему.

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

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

This syntax will display the values of a given data name as a tag cloud. Each value will link back to the current page (unless configured otherwise by target option). The page should also contain a Data Table - this table will then be filtered for all entries matching the selected tag.

Example:

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

The above code would display a cloud of employees assigned to at least two different projects. A maximum of the 20 most busiest employees are shown.

These are the possible options for the cloud:

Additionally filters can be given as described in the datatable syntax.

Position and styling of input and output boxes can be done with simple CSS. Everything given after the syntax keyword will be assigned as additional class name to the surrounding div. Additionally are the field keys used as classes for the entry box items.

Let's assume the following «dataentry» box, as specified at the beginning of the page.

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

You now can style this box with CSS in your <dokuwiki>/conf/userstyle.css⁴⁾. Here is an example:

div.character24 {
  /* code for the container block, such as position, layout and borders, goes here */
  float: right;
  width: 33%;
}
 
div.character24 dl > dt { 
  /* this will allow you to style the definition terms */
  font-variant: small-caps;
}
 
div.character24 dl > dt + dd {
  /* this will allow you to style to the definition values */
  font-family: sans-serif;
}
 
div.character24 dl dd.name{
  /* this makes the name larger than the rest */
  font-size: 120%;
}

Type aliases are custom data types which are defined by a base type (one of the built-in types like page or no type), and optionally a prefix, postfix or a comma-separated set of valid values. Type aliases are managed on their own page in the admin menu and stored in the database. They can be used in data entries, lists and tables like the built-in types.

For example to create new datatype map which would open Google Maps:

define interwiki address map:

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

And in Admin → Data Plugin: Field Aliases (do=admin&page=data_aliases) define:

which you could use now as:

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

You can even enter a valid address, e.g. Bahnhofsstraße 5, Regensburg, Deutschland

Tag links use default the column name as target page. You can change it by a type alias. Give as Prefix the url of the page that has your datatable. Clicking on taglink will filter that table by the tagvalue.

which you could use now as:

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

Clicking on this cheese tag will refer to namespace:pagewithdatatable and filter on cheese.

If you aggregate any meeting, you´d link to combine them to a downloadable link.

iCal-Plugin

Setup for the vCard plugin is similar to iCal.

The data plugin is the first plugin to provide a custom editor for its data entries. Data entries have an own edit button. When pressing this button, the user gets an edit form where she can edit the data entries’ content or – depending on the configuration option edit_content_only – even the structure, i. e. change a field’s name, type or append and delete fields.

Custom editor: Editing structure and values

Custom editor: Editing only values by switching on config option edit_content_only

When the configuration option edit_content_only is enabled, some nice fields are used:

• Dropdown list is shown filled with the values given in the Valid values column of type aliases.
• Datepicker for fields of type dt
• Autocompletion suggestion of existing pages for type aliases based on the page type
  (type page itself don't work)

Requirement: The datepicker and pagesuggestions needs the bureaucracy plugin, which supplies the JavaScript magic.

Page suggestions are activated by a type alias of type page. The second alias shows only pages in plugin: namespace, demonstrated in the image too.

Left: custom editor with datapicker field and a single and a multiple select field.

Right: a field with pagesuggestions.

The nice fields of data plugin used in the custom entry editor are also available for fields in the form of the Bureaucracy Plugin. These are: select of valid values, datepicker and pagesuggestions. Other types are allowed, but are a plain textbox only.

Some examples of defining form fields in the bureaucracy form, using dataplugin fields:

data_aliastextbox Tag _fixedtag 	
data_aliastextbox Multitags _fixedtags 

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

Last line uses the type alias of previous section, the first two lines are in combination with type alias:

Left image shows a datepicker in a bureaucracy form and right a single and a multiple select, these are created with a type alias which defines some valid values.

If you use the translation plugin, you might want to use the same data entries in different languages. The plugin allows for translated field names – values will not be translated. If you only want to use English field names while having them displayed in your language, you can also follow these instructions.

To create fieldname translations, create a file in conf/lang/<langcode>/data-plugin.php. The file needs to contain a PHP array named $lang with the fieldname in the array key and the translation in the value:

conf/lang/en/data-plugin.php

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

Fieldnames are to be given without their type. So it's deadline not deadline_dt.

After creating or modifiying data-plugin.php file, please update wiki configuration to refresh cache start?do=admin&page=config, otherwise modifications are not taken into account.

• more control options:
  • attribute list (similar to tag cloud but as a simple list)
  • search field – see datasearchform plugin
• better documentation, examples
  • Please provide suggestions for which pieces need more attention or where you do not understand stuff. Thanks.
• Add JavaScript support for the content_only edit form to the full-blown form as well
• more data types?
• links in aggregations and data entries don't generate backlinks
• search data in a specific namespace
• WHERE checks against date fields need SQL INTERVAL equivalent («WHERE field_dt < %now% + INTERVAL 6 MONTH» equals to «field_dt before 6 months from now»)
• compare against «this page» name (in datatable)
• history for the type alias table (changes in the table can affect the pages, but no record and no revert is available).
• More data-entry blocks at one page. Reason: the Data Plugin is designed as data-entry block per page. ⇒ Recommended alternative: Strata Plugin, which is equivalent to Data plugin, but bit more sophisticated.

Some use cases:

• This plugin may be seen in action on this wiki in the DokuWiki Installations namespace.
  • Look for the datatable in the source of DokuWiki Installations
  • and for a dataentry in some of the individual installation pages.
• Very interesting and organized wiki setup: ICKEwiki by Cosmocode integrates the Data Plugin with some other plugins such as Bureaucracy to a complete enterprise wiki tool. Follow links to the (German) Demo, which let you access the wiki as employee.
• DokuWiki usecase: list of employees – How to use Data Plugin with Bureaucracy Plugin and Wrap Plugin. A manual by lolmaus.

The data that is copied to the SQLite database should be refreshed automatically whenever the page containing the dataentry box is changed. If you deleted or renamed pages outside the wiki, the database will still contain data about now non-existing pages. These can be cleaned using the Data Plugin: Clean up database entry in the Admin menu.

However there might be some bugs making this not always 100% reliable. Refer to the open bugs section and changes to see what might be broken or what was recently fixed.

When you delete the whole database, all entry pages have to be re-rendered to repopulate the database. There is no automatic way to do so.

In case page were externally modified, or fresh database, few tricks to refresh the database are:

• to download the wiki pages, in batch, using wget, a command-line file downloader;
• to install the searchindex plugin, launch the newly added SearchIndex Manager panel in Admin menu and click the Rebuild Index button.

You can of course open the database file directly in the SQLite command line client and manipulate it through SQL queries.

The Strata Plugin is in the big lines equivalent to Data plugin. However, it has more sophisticated query syntax, less and simpler 'aliastypes' system and additional features like graph or output based at an predefined template. So for handling of more complicated data the Strata Plugin has more opportunities.

Suppose some entries contain empty fields and you want to display such entries: how do you write the filter in the query to output these?

e.g.

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

and if the query is:

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

the output does not show the above record

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

DokuWiki calls strftime on _template.txt when creating a new page. This replaces some combinations of %[a-z] (for example, %title% will become [TAB]itle%). When using placeholders in _template.txt you should use double percent signs (%%title%%). Strftime will treat those as literal percent characters.

If you still have questions, search the forum and if it hasn't been asked before ask your question there. Please leave bug reports on Github's issue tracker.

Important! These are hacks – there is no guarantee they'll always work, and they will not survive updates.

If it breaks you get to keep the pieces.

NOTE: The configuration setting for the PHP strftime function in /conf/dokuwiki.php also need to be changed (can also be changed via Admin→Configuration)

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

To change the default date format from yy-mm-dd to dd-mm-yy (e.g. for Australia)

Change this:

plugins/data/helper.php

    /**
     * Replace placeholders in sql
     */
    function _replacePlaceholdersInSQL(&$data) {
        global $USERINFO;
        // allow current user name in filter:
        $data['sql'] = str_replace('%user%', $_SERVER['REMOTE_USER'], $data['sql']);
        $data['sql'] = str_replace('%groups%', implode("','", (array) $USERINFO['grps']), $data['sql']$
        // allow current date in filter:
        $data['sql'] = str_replace('%now%', dformat(null, '%Y-%m-%d'), $data['sql']);
 
        // language filter
        $data['sql'] = $this->makeTranslationReplacement($data['sql']);
    }

to this:

plugins/data/helper.php

    /**
     * Replace placeholders in sql
     */
    function _replacePlaceholdersInSQL(&$data) {
        global $USERINFO;
        // allow current user name in filter:
        $data['sql'] = str_replace('%user%', $_SERVER['REMOTE_USER'], $data['sql']);
        $data['sql'] = str_replace('%groups%', implode("','", (array) $USERINFO['grps']), $data['sql']$
        // allow current date in filter:
        $data['sql'] = str_replace('%now%', dformat(null, '%d-%m-%Y'), $data['sql']);
 
        // language filter
        $data['sql'] = $this->makeTranslationReplacement($data['sql']);
    }

and change this:

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]);
                }

to this:

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]);
                }

and change this:

plugins/data/script.js

/**
 * Init datepicker for all date fields
 */
jQuery(function () {
    jQuery('.data_type_dt input').datepicker({
        dateFormat: "yy-mm-dd",
        changeMonth: true,
        changeYear: true
    });

to this:

plugins/data/script.js

/**
 * Init datepicker for all date fields
 */
jQuery(function () {
    jQuery('.data_type_dt input').datepicker({
        dateFormat: "dd-mm-yy",
        changeMonth: true,
        changeYear: true
    });

— SFITCS 2016-11-26 01:24

Please submit bugs and feature requests in the issue tracker on GitHub. Patches should be sent unified diff format or as git patches against the devel branch. Or even better: fork the repository at github and send a merge request.