Ticket #841 (closed Defect: duplicate)

Opened 5 years ago

Last modified 4 years ago

plugin development guide still refers to api pre 4.4 & misses crucial infos

Reported by: Malte Owned by: jri
Priority: Major Milestone:
Component: DeepaMehta Standard Distribution Version: 4.6.1
Keywords: Cc: Juergen, Malte, dgf
Complexity: 13 Area:
Module:

Description

In the PluginDevelomentGuide?, the main references for developers to get started, i noticed the following topics are yet undocumented (the list is incomplete):

  • importmodels line (#840)
  • "composite" is still used instead of "childs"
  • a pointer to the windows issue when "building from source" would make thing more complete (#775)
  • Paragaph "Consuming a service" is outdated since 4.4 (and services can also be consumed in a migration as of 4.5)
  • no documentation of the index_mode_uris is yet available
  • creating custom events in plugins (as of 4.2) is yet un-documented
  • the facets concept and service is yet un-documented
  • how and when to use Transactions is yet un-documented
  • what are workspaces, sharing modes and acl (assign topics, create memberships, defaults), system workspace
  • what are custom association types
  • server side exception handling/error reporting facility

Just so we all know what new developers might not yet know about dm4-plugin development when starting their plugin and just so we all can keep track of the doc work undone.

Change History

comment:1 Changed 5 years ago by Malte

  • paragraph about using a migration.properties file

comment:2 Changed 5 years ago by jri

  • Status changed from new to closed
  • Resolution set to duplicate
  • Milestone Release 4.7 deleted

See #444. I added a reference to this ticket there.

comment:3 Changed 4 years ago by Malte

I just updated the https://trac.deepamehta.de/wiki/PluginDevelopmentGuide to be not anymore extensive but compatible with 4.8.

I suggest therefore to close this ticket and move the parts on missing docs into #444. Those are:

  • documentation of index_mode_uris
  • creating custom events in plugins (as of 4.2)
  • server side exception handling/error reporting facility
  • usage of transactions
  • the facets concept and service
  • using association types and custom association types
  • workspaces, sharing modes and all their defaults

I hope this helps.
So, if one would review the changes to the existing

Note: See TracTickets for help on using tickets.