Last edited 6 days ago
by Anna Lionetti

ShareDoc:PublicDocumentation: Difference between revisions

mNo edit summary
No edit summary
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:Public Documentation}}
{{DISPLAYTITLE:Public Documentation}}


== Main technological components ==
== [https://wiki.share-vde.org/wiki/ShareDoc:PublicDocumentation/Main_technological_components Main technological components] ==
*Summary of the components of the [https://wiki.share-vde.org/w/images/5/54/share_components_EN.pdf LOD Platform], <span style="color: #000000" data-ve-attributes="{&quot;style&quot;:&quot;color: #000000&quot;}">the technology underlying the [https://wiki.share-vde.org/wiki/ShareFamily:Main_Page Share Family] system</span>
This section serves as a gateway to a comprehensive breakdown of key technological components that form the backbone of the LOD Platform. the technology that powers the Share Family system. This section provides an overview of crucial components and concepts integral to understanding the inner workings of our platform.
*<span style="color: #000000">Extensive</span> <span style="color: #000000">descri</span><span style="color: #000000">ption of</span> <span style="color: #000000">the [https://wiki.share-vde.org/w/images/a/ae/LOD_Platform_2021-02_ENG.pdf LOD Platform]</span>
*[https://wiki.share-vde.org/w/images/7/79/Comparison_IFLA-LRM_BIBFRAME_SVDE.pdf Share-VDE entity model]
*[https://wiki.share-vde.org/w/images/e/e8/J.Cricket_entity_editor_presentation.pdf JCricket workflows]
*[https://wiki.share-vde.org/w/images/c/c7/Share_Family_data_flow.pdf Share-VDE and Share Family data flow]
*[https://wiki.share-vde.org/w/images/b/b3/Share-VDE_perspective_on_Cluster_Knowledge_Base_and_Provenance.pdf Share-VDE perspective on Cluster Knowledge Base and Provenance]
*[https://wiki.share-vde.org/w/images/b/bc/SVDE_tech_stack_-_Back_end_%26_Front_end.pdf Share-VDE technological stack]
== User guides ==
* [https://wiki.share-vde.org/wiki/ShareDoc:LOD-PlatformUXguide LOD Platform UX guide]: user guide for the LOD Platform entity discovery web interface (aka “discovery portal”)
* <span class="col-red">ANNA TO ADD LINK TO wiki page of End user document to present config options</span>
* [https://wiki.share-vde.org/wiki/ShareDoc:JCricketGuide JCricket UX guide]: user guide for the JCricket entity editor


== Release notes ==
== [https://wiki.share-vde.org/wiki/ShareDoc:PublicDocumentation/User_guides User guides] ==
This page gathers the release notes of the technical implementations: [https://wiki.share-vde.org/wiki/ShareDoc:ReleaseNotes ReleaseNotes]
Here you'll find user guides describing the LOD Platform and JCricket entity editor.


== Share-VDE API: Technical documentation ==
== [https://wiki.share-vde.org/wiki/ShareDoc:PublicDocumentation/Release_notes Release notes] ==
This technical documentation is valid for all tenants of the Share Family. However, in the documentation pages you will find examples showing only the namespace "svde.org". If your institution belongs to a tenant that is not svde.org, you have to run queries using the specific namespace of your tenant (e.g. natbib-lod.org, or pcc-lod.org, or kubikat-lod.org). Please remember to replace the namespace "svde.org" that appears in the examples with the namespace of your tenant (both for entity URIs and for attributes/properties URIs).
This page gathers the release notes of the technical implementations.


=== General ===
== [https://wiki.share-vde.org/wiki/ShareDoc:PublicDocumentation/APIs Share Family API: Technical documentation] ==
* [[ShareDoc:Domain Model|The Share-VDE Domain Model]]
This is a collection of Share Family API.
* [[ShareDoc:The PostMan Collection|How to import the Share-VDE API Collection]]
* [[ShareDoc:API documentation|Share-VDE API: cross-cutting concepts]]
* [[ShareDoc:Auth|Share-VDE API: Authentication]]
* [[ShareDoc:Query Languages|Share-VDE API: Query Languages]]
* [[ShareDoc:Simple Search|Share-VDE API: Simple Search]]


=== REST ===
This technical documentation is valid for all tenants of the Share Family. However, in the documentation pages you will find examples showing only the namespace "svde.org". If your institution belongs to a tenant that is not svde.org, you have to run queries using the specific namespace of your tenant (e.g. natbib-lod.org, or pcc-lod.org, or kubikat-lod.org). Please remember to replace the namespace "svde.org" that appears in the examples with the namespace of your tenant (both for entity URIs and for attributes/properties URIs).
* [[ShareDoc:RESTFul API|Share-VDE REST API]]
* [[ShareDoc:ShareVDEAndTheSemanticWeb|Share-VDE and the Semantic Web]]
* [[ShareDoc:Content Negotiation|Share-VDE REST API: Content Negotiation]]
 
=== GraphQL ===
* [[ShareDoc:GraphQL API|Share-VDE GraphQL API]]
* [[ShareDoc:Subject API|Share-VDE GraphQL API: Subjects]]

Revision as of 15:27, 6 March 2024


Main technological components

This section serves as a gateway to a comprehensive breakdown of key technological components that form the backbone of the LOD Platform. the technology that powers the Share Family system. This section provides an overview of crucial components and concepts integral to understanding the inner workings of our platform.

User guides

Here you'll find user guides describing the LOD Platform and JCricket entity editor.

Release notes

This page gathers the release notes of the technical implementations.

Share Family API: Technical documentation

This is a collection of Share Family API.

This technical documentation is valid for all tenants of the Share Family. However, in the documentation pages you will find examples showing only the namespace "svde.org". If your institution belongs to a tenant that is not svde.org, you have to run queries using the specific namespace of your tenant (e.g. natbib-lod.org, or pcc-lod.org, or kubikat-lod.org). Please remember to replace the namespace "svde.org" that appears in the examples with the namespace of your tenant (both for entity URIs and for attributes/properties URIs).