Skip to content

Repository used to generate the JSON-LD and HTML catalogs for FOOPS!

License

Notifications You must be signed in to change notification settings

oeg-upm/foops_documentation_scripts

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

foops_documentation_scripts

Repository used to generate the JSON-LD and HTML catalogs for FOOPS!

In order for the script to work correctly, the following paths have been configured: path_ttls = 'https://github.com/oeg-upm/fair_ontologies/tree/main/doc/test/' path_ttls_metric = 'https://github.com/oeg-upm/fair_ontologies/tree/main/doc/metric/' path_mustache = 'https://github.com/oeg-upm/fair_ontologies/tree/main/doc/test/template.html'. path_mustache_metrics = 'https://github.com/oeg-upm/fair_ontologies/tree/main/doc/metrics/template_metrics.html'

If the TTL files or the template change location, these paths will need to be updated.

The process iterates recursively within the root, and if it finds a TTL file, it creates an equivalent file with the same name but with HTML and JSON-LD extensions.

The Mustache template is necessary to create the HTML file, and if any design modifications to the HTML are deemed necessary, they should be made in that template.

The script requires the rdflib and pystache libraries for proper operation. Both are included in the Bin folder.

The main page created from ttl_catalogue.py goes through all test folders and retrieves information to create a catalog item whenever it finds a ttl file in the folder.

It requires specifying the path where the test and metric folders are located and where the template is hosted, from which the catalog will be created to show the list of tests and metrics availables.

path_ttls = 'https://github.com/oeg-upm/fair_ontologies/tree/main/doc/test/' path_ttls_metric = 'https://github.com/oeg-upm/fair_ontologies/tree/main/doc/metric/' path_mustache = 'https://github.com/oeg-upm/fair_ontologies/tree/main/doc/template_catalog.html'.

About

Repository used to generate the JSON-LD and HTML catalogs for FOOPS!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages