gCubeSystem
/
gcube-cms-suite
14
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

updated README

This commit is contained in:
Francesco Mangiacrapa 2024-06-28 12:17:39 +02:00
parent b5f9184195
commit ef2d2d45dc
2 changed files with 31 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -9,8 +9,8 @@ gCube CMS Suite is a distributed full stack application for publication manageme
Rationale :
Publication involves lots of common features as well as custom behaviour and formats. The service implements the basic common logic, delegating to installed plugin both cutom and configurable functions ranging from validation, data manifestazion, indexing and lifecycle management.
Lifecycle management is itself an extension allowing for both common and complex ad-hoc workflows.
High modularity of plugins allows for the composition of ad hoc use cases with maximized re-usability.
**Lifecycle management** is itself an extension allowing for both common and complex ad-hoc workflows.
High modularity of **plugins** allows for the composition of ad hoc use cases with maximized re-usability.
The suite comes with a set of pre-built plugins and GUIs that communities can easily extend and / or reuse.
@ -18,10 +18,34 @@ The suite comes with a set of pre-built plugins and GUIs that communities can ea
[<img src="https://gcube.wiki.gcube-system.org/images_gcube/c/ce/Geoportal_General_Architecture.jpg">](https://geoportal.cloud.d4science.org/geoportal-service/docs/architecture.html)
## Use Case
##### D4GNA: component diagram
##### The D4GNA
["Dataset per il Geoportale Nazionale per l’Archeologia"](https://gna.d4science.org)
Component diagram:
<img src="https://gcube.wiki.gcube-system.org/images_gcube/2/2e/Geoportal-Service_Workflow_and_Interactions_with_Engines.png" style="max-width:800px;" alt="D4GNA context: engines involved">
## Lifecycle Managements
Document Lifecycle Managements in action:
##### Single Step (no moderation)
<img src="https://gcube.wiki.gcube-system.org/images_gcube/8/8c/SingleStep_LC.png" style="max-width:600px;" alt="Default Single Step lifecycle">
##### 3 Phases (content moderation)
<img src="https://gcube.wiki.gcube-system.org/images_gcube/d/d8/Default3Phases_LC.png" style="max-width:750px;" alt="Default 3 Phases lifecycle">
## Plugins
Plugins in action:
* [Lifecycle Manager](/src/branch/master/default-lc-managers)
* [Spatial Data Infrastructure "SDI"](src/branch/master/sdi-plugins)
* [Notifications](/src/branch/master/notifications-plugins)
* [Catalogue Binding](/src/branch/event_manager/catalogue-binding-plugin)
## Documentation
* [Dedicated Wiki](https://geoportal.d4science.org/geoportal-service/docs/index.html#) - powered by [Sphynx](https://www.sphinx-doc.org/en/master/)
* [Service Interactive API](https://geoportal.d4science.org/geoportal-service/api-docs/index.html) - powered by [Enunciate](http://enunciate.webcohesion.com/)

5
catalogue-binding-plugin/README.md
View File

@ -39,7 +39,8 @@ The "Catalogue Binding Plugin" requires a handler registered in the UCD so defin
}
],
"freemarker_template_host": "{FREEMARKER_TEMPLATE_HOST}",
"freemarker_template_path": "{PATH_TO_FREEMARKER_TEMPLATE_NAME.ftl}"
"freemarker_template_path": "{PATH_TO_FREEMARKER_TEMPLATE_NAME.ftl}",
"enabled": {true|false}
}
}
```
@ -58,6 +59,8 @@ the "when" part.. `"when": [{...}]`, is optional:
the `{FREEMARKER_TEMPLATE_HOST}` is the host where the FREEMARKER_TEMPLATE.ftl is located and the `{FREEMARKER_TEMPLATE_NAME.ftl}` is the (complete) path to the FREEMARKER_TEMPLATE.ftl file.
The template pointed by `{FREEMARKER_TEMPLATE_HOST}/{PATH_TO_FREEMARKER_TEMPLATE_NAME.ftl}` URL is applied to transform a Geoportal project to Catalogue Item object.
`enabled` : set to `ŧrue` to activate the plugin `false` otherwise.
NB. The configuration must contain the "when" part with `{TARGET_PHASE}` and `{LAST_INVOKED_STEP}` if the `{EVENT_X}` is `LIFECYCLE_STEP_PERFORMED`
## Change log