struct Plugin
struct Plugin
Why “struct” instead of “data”?
This plugin draws heavy inspiration from the data plugin. It basically tries to solve the same problem of assigning structured data to pages and build automatic aggregations from it.
So why another plugin? The data plugin proved to be very useful and versatile but had a few shortcomings:
- each page defined its own set of structured data
- there was no central way to ensure the structured data was consistent over multiple pages
- there was no easy way to modify the structured data set for multiple pages
- there was no validation for the data entered
The bureaucracy plugin helped with some of the points but not all of them. So Struct tries to rethink the Data plugin:
- structured data is classified in schemas
- a schema holds a set of fields
- fields have a specific type
- types control how the data is displayed and validated
- types have specific configuration within the schema
- schemas are managed centrally in an admin interface
- pages are assigned schemas through namespace patterns
- changing a schema changes it for all associated pages
- the structured data is no longer part of the page syntax
- data is only edited via a dedicated form within the standard editor or through inline editing
- it is possible to create global data not attached to any page [1]
- global data can be used as data source for lookup dropdowns
- serial data is a collection of data structures belonging to a given page
- all crucial code is covered by automated tests
This allows for central management of wanted structured data while keeping the functionality of the data plugin.
Installation
:!: External requirements: This plugin requires the following additional components that must be installed separately:
:!: Please also note that this plugin requires PHP 5.6 or higher.
Search and install the plugin using the Extension Manager. Refer to plugins on how to install plugins manually.
Usage
Please refer to the following pages to learn how to use the plugin:
- Schema Editing
- Page Data Assignments
- Editing Global Data
- Editing Serial Data
- Aggregation
- Permissions
- Control-Cloud
- Developer Support
- remote API
- Struct Integration into other Plugins
- Plugins to extend Struct
Here a complete overview of all sub-pages to struct plugin.
Development
Change Log
RSS: https://github.com/cosmocode/dokuwiki-plugin-struct/commits/master.atom date
Known Bugs and Issues
Please report bugs and issues at https://github.com/cosmocode/dokuwiki-plugin-struct/issues
referred to as lookup in previous versions of struct ↩︎

