DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:struct

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:struct [2017-08-22 13:51] – [Usage] SFITCSplugin:struct [2024-04-09 23:51] (current) – version upped andi
Line 3: Line 3:
 ---- plugin ---- ---- plugin ----
 description: A new structured data plugin description: A new structured data plugin
-author     : Michael Große and Andreas Gohr+author     : Anna Dabrowska, Michael GroßeAndreas Gohr
 email      : dokuwiki@cosmocode.de  email      : dokuwiki@cosmocode.de 
-type       : syntax, admin, action +type       : syntax, admin, action, remote 
-lastupdate : 2017-07-11 +lastupdate : 2024-04-09 
-compatible : 2016-06-26a, !Detritus, !Hrun, !Ponder Stibbons, !Binky+compatible : !Frusterick Manners, !Greebo, !Hogfather, !Igor, Jack Jackrum, Kaos
 depends    : sqlite depends    : sqlite
-conflicts fastwiki, discussion+conflicts  : discussion, ckgedit
 similar    : data, strata similar    : data, strata
-tags       : !experimental, database, sqlite, data+tags       : database, sqlite, data
  
 downloadurl: https://github.com/cosmocode/dokuwiki-plugin-struct/zipball/master downloadurl: https://github.com/cosmocode/dokuwiki-plugin-struct/zipball/master
Line 23: Line 23:
 ===== Why “struct” instead of “data”? ===== ===== 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. +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: So why another plugin? The data plugin proved to be very useful and versatile but had a few shortcomings:
Line 32: Line 32:
   * there was no validation for the data entered   * 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:+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//   * structured data is classified in //schemas//
Line 44: Line 44:
   * the structured data is no longer part of the page syntax   * 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 [[plugin:struct:inlineedit|inline editing]]   * data is only edited via a dedicated form within the standard editor or through [[plugin:struct:inlineedit|inline editing]]
-  * it is possible to create //lookup// schemas where data is not attached to any page +  * it is possible to create //global// data not attached to any page ((referred to as //lookup// in previous versions of struct)) 
-  * lookup schemas can be used as data source for [[plugin:struct:type_lookup|lookup dropdowns]]+  * global data can be used as data source for [[plugin:struct:type_lookup|lookup dropdowns]] 
 +  * //serial// data is a collection of data structures belonging to certain pages
   * all crucial code is covered by automated tests   * 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. This allows for central management of wanted structured data while keeping the functionality of the data plugin.
  
 +[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ https://www.cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]
  
 ===== Installation ===== ===== Installation =====
- 
-[[http://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ http://cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]] 
  
 :!: **External requirements:** This plugin requires the following additional components that must be installed separately: :!: **External requirements:** This plugin requires the following additional components that must be installed separately:
Line 59: Line 59:
   * [[plugin:sqlite|SQLite Plugin]]   * [[plugin:sqlite|SQLite Plugin]]
  
-:!: Please also note that this plugin requires **PHP 5.6 or higher**. +Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
- +
- +
-Install the plugin using the [[plugin:extension|Extension Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.+
  
 ===== Usage ===== ===== Usage =====
Line 76: Line 73:
     * [[plugin:struct:delete|Delete]]     * [[plugin:struct:delete|Delete]]
     * [[plugin:struct:rename|Rename]]     * [[plugin:struct:rename|Rename]]
-  * [[plugin:struct:assignments|Assignments]] +  * [[plugin:struct:assignments|Page Data Assignments]] 
-  * [[plugin:struct:lookupedit|Editing Lookups]]+  * [[plugin:struct:globaledit|Editing Global Data]] 
 +  * [[plugin:struct:serialedit|Editing Serial Data]]
   * [[plugin:struct:aggregation|Aggregation]]   * [[plugin:struct:aggregation|Aggregation]]
 +    * Aggregation Types
 +      * [[plugin:struct:aggregation:table|Table]]
 +      * [[plugin:struct:aggregation:list|List]]
 +      * [[plugin:struct:aggregation:value|Value]]
 +    * Aggregation Control
 +      * [[plugin:struct:aggregation:filter|Filter Control]]
 +      * [[plugin:struct:cloud|Cloud Control]]
     * [[plugin:struct:filters|Filters]]     * [[plugin:struct:filters|Filters]]
     * [[plugin:struct:inlineedit|Inline Editing]]     * [[plugin:struct:inlineedit|Inline Editing]]
     * [[plugin:struct:csvexport|CSV Export]]     * [[plugin:struct:csvexport|CSV Export]]
   * [[plugin:struct:permissions|Permissions]]   * [[plugin:struct:permissions|Permissions]]
-  * [[plugin:struct:cloud|Control-Cloud]] 
-  * [[plugin:struct:bureaucracy|Bureaucracy Support]] 
   * [[plugin:struct:devel|Developer Support]]   * [[plugin:struct:devel|Developer Support]]
   * [[plugin:struct:remote_api|remote API]]   * [[plugin:struct:remote_api|remote API]]
 +  * [[plugin:struct:integrations|Struct Integration into other Plugins]]
 +  * [[plugin:struct:plugins|Plugins to extend Struct]]
 +  * [[plugin:struct:dbinternals|Database internals]]
 +
 +Here a complete overview of [[.struct:aggregation?do=index|all sub-pages]] to struct plugin.
 +
 +===== Samples =====
 +
 +  * [[plugin:struct:Samples]]
  
-Alternatively - [[https://scottferguson.com.au/uploads/files/struct%20Plugin.pdf|the entire documentation in a single PDF]] 
 ===== Development ===== ===== Development =====
  
 === Change Log === === Change Log ===
  
-[[https://travis-ci.org/cosmocode/dokuwiki-plugin-struct|{{  https://travis-ci.org/cosmocode/dokuwiki-plugin-struct.png?nocache|Build Status}}]]+[[https://github.com/cosmocode/dokuwiki-plugin-struct/commits/master.atom|{{https://raw.githubusercontent.com/legacy-icons/famfamfam-silk/master/dist/png/feed.png?16x16&recache |Subscribe to 'struct Plugin Change Log' by RSS}}]]
  
 {{rss>https://github.com/cosmocode/dokuwiki-plugin-struct/commits/master.atom date}} {{rss>https://github.com/cosmocode/dokuwiki-plugin-struct/commits/master.atom date}}
Line 99: Line 110:
 === Known Bugs and Issues === === Known Bugs and Issues ===
  
-Please report bugs and issues athttps://github.com/cosmocode/dokuwiki-plugin-struct/issues+Please report bugs and issues at https://github.com/cosmocode/dokuwiki-plugin-struct/issues
  
plugin/struct.txt · Last modified: 2024-04-09 23:51 by andi

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki