Sparnatural documentation
For examples of how Sparnatural works and can be configured, have a look at the demos folder of sparnatural.eu website.
1. Features
- Reference documentation of Sparnatural widgets : all the possible ways to select a criteria value in Sparnatural. Read this to learn some of the features of Sparnatural.
2. Getting started
- Hello Sparnatural : start here to integrate Sparnatural in your own website, from the tutorial page.
3. Configuring Sparnatural
3.1 SHACL configuration
Sparnatural is configured by a configuration file expressed in SHACL. The configuration file can be edited in an Excel spreadsheet.
- How-to configure in SHACL : a detailled documentation for configuring Sparnatural in a spreadsheet. Start here to learn the different configuration options of Sparnatural.
- Reference page of SHACL configuration : the list of all SHACL constructs Sparnatural understands
3.2 deprecated OWL configuration
Historically, Sparnatural also supported configuration specified in OWL :
- How-to configure in OWL : a detailled documentation for configuring Sparnatural in an OWL spreadsheet (that is converted into a OWL configuration file). This is deprecated and now replaced by the SHACL configuration guide.
- Configure in OWL using Protégé : a reference page of all useful OWL axioms and annotations to configure Sparnatural with OWL
- Configure datasources in OWL : a reference page of all included datasources and how-to write your own datasource
3.3 Advanced configuration
- Querying date ranges - How to generate SPARQL queries that can match on resources with a begin date and a end date
- Federated query support - How to enable federated querying using SERVICE keyword in your configuration
- Query specific named graphs - How to build an endpoint URL to be restricted to one or more named graphs
- Querying multiple endpoints - How to configure Sparnatural so that it can query multiple endpoints at the same time in a transparent way
- Integration with GraphDB Lucene Connector - Special configuration to interact with a GraphDB Lucene index
4. Integrating Sparnatural in HTML / React
- HTML page and Javascript integration - The reference page to understand how the
<spar-natural
web component can be integrated in your webpage - YasGUI specific plugins - Read if you are using YasGUI in combination with Sparnatural, to understand the Sparnatural specific plugins
- Customize colors - How to customize colors of Sparnatural
Advanced integration
- React integration - Initialization of Sparnatural as a custom component within react
- Query JSON format - Documentation on the JSON structure used by Sparnatural to output and reload queries
- Using a SPARQL proxy - if your SPARQL endpoint is not CORS-enabled, or uses http while your query page uses https
- Querying a password protected SPARQL endpoint
5. Extending Sparnatural
6. FAQ
- FAQ - Frequently Asked Questions
7. Other resources
- Check out the bibliography section of the website where you can find presentation material on Sparnatural
- Check out the YouTube channel for videos of Sparnatural
- Don’t hesitate to ask questions on the Github issue tracker
- Sparna can provide some support on setting up Sparnatural, so get in touch at thomas /dot/ francart /at/ sparna /dot/ fr
8. Archives
deprecated JSON configuration
deprecated v7 Javascript integration page
- Javascript integration v7 (old) - Reference page for Javascript integration and parameters for the old version 7