struct Plugin

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 ¹⁾
• global data can be used as data source for lookup dropdowns
• serial data is a collection of data structures belonging to certain pages
• 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.

External requirements: This plugin requires the following additional components that must be installed separately:

• SQLite Plugin

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

Please refer to the following pages to learn how to use the plugin:

• Schema Editing
  • Configuration
  • Types
  • Import/Export
    • CSV Import
    • CSV Export
  • Delete
  • Rename
• Page Data Assignments
• Editing Global Data
• Editing Serial Data
• Aggregation
  • Aggregation Types
    • Table
    • List
    • Value
  • Aggregation Control
    • Filter Control
    • Cloud Control
  • Filters
  • Inline Editing
  • CSV Export
• Permissions
• Developer Support
• remote API
• Struct Integration into other Plugins
• Plugins to extend Struct
• Database internals

Here a complete overview of all sub-pages to struct plugin.

• Samples

• Version upped (2024-04-09 23:51)
• fix filter mechanism (2024-04-09 08:30)
• Version upped (2024-02-16 23:51)
• Fix #708 (2024-02-16 12:26)
• Version upped (2024-02-14 23:51)
• remove auto-comment.yml (2024-02-14 16:27)
• Merge pull request #705 from cosmocode/lazy-search (2024-02-14 10:31)
• Remove obsolete code (2024-02-13 18:38)

Please report bugs and issues at https://github.com/cosmocode/dokuwiki-plugin-struct/issues