Commit 7ed5b294 authored by Susanne Arndt's avatar Susanne Arndt
Browse files

Merge branch '1-set-up-ci-for-automatic-generation-of-ontology-documentation' into 'main'

Resolve "Set up CI for automatic generation of ontology documentation"

Closes #1

See merge request !1
parents 00fb0632 8b24d6eb
Pipeline #60317 canceled with stage
image: ruby:2.7
# Source: https://git.rwth-aachen.de/nfdi4ing/metadata4ing/metadata4ing/-/blob/8216d83d46790fb46921f12bc495bbf5b668fce6/.gitlab-ci.yml
# Potential upgrade: have stable ontology releases and stable GitLab pages for each of the documentation versions https://git.rwth-aachen.de/nfdi4ing/metadata4ing/metadata4ing/-/blob/fcb75e0fe58b58a3ae829f9deb5b50740ca79dd2/.gitlab-ci.yml
pages:
stage: deploy
variables:
......@@ -12,18 +14,19 @@ pages:
- echo "Creating documentation..."
- mkdir doc
- wget https://github.com/dgarijo/Widoco/releases/download/v$WIDOCO_VERSION/widoco-$WIDOCO_VERSION-jar-with-dependencies.jar -O widoco.jar
- java -jar widoco.jar -ontFile ListDB-Onto.owl -outFolder doc -webVowl -uniteSections -oops -rewriteAll -confFile config.properties
- java -jar widoco.jar -ontFile myOnto.ttl -outFolder doc -webVowl -uniteSections -oops -rewriteAll -confFile config.properties
- ls -al doc
- mv doc/ontology.rdf doc/ontology.xml
- mv doc/OOPSevaluation doc/OOPSEvaluation
- ls -al doc/OOPSEvaluation
- mv doc/index-en.html doc/index.html
- sed -i -e 's/<!-- <dt>Evaluation/<dt>Evaluation/g' -e 's/OOPS!" \/><\/a><\/dd> -->/OOPS!" \/><\/a><\/dd> /g' doc/index.html
#- echo "Adding textual inputs to the documentation HTML"
#- sed -i -f ci/replace-intro.sed doc/index.html
#- sed -i -f ci/replace-description.sed doc/index.html
#- sed -i -f ci/replace-references.sed doc/index.html
#- echo "Copying results to /public for publishing..."
- echo "Adding textual inputs to the documentation HTML"
- sed -i -f scripts/widoco/replace-abstract.sed doc/index.html
- sed -i -f scripts/widoco/replace-intro.sed doc/index.html
- sed -i -f scripts/widoco/replace-description.sed doc/index.html
- sed -i -f scripts/widoco/replace-references.sed doc/index.html
- echo "Copying results to /public for publishing..."
- rm -rf public/
- mkdir public
- cp -r doc/* public
......@@ -32,3 +35,4 @@ pages:
- public
only:
- main
# - main
# abstract = Leave empty if you provide abstract via widoco_sections
ontologyTitle = ListDB Ontology
ontologyPrefix = listdb
ontologyNamespaceURI = https://www.listdb.de/ontology
ontologyName = LIstDB Ontology
thisVersionURI = https://www.listdb.de/ontology/0.0.0
latestVersionURI =
previousVersionURI =
dateOfRelease = DD.MM.YYYY
ontologyRevisionNumber = 0.0.0
licenseURI =
licenseName = tbd
licenseIconURL =
citeAs = Publisher (YYYY): ListDB Ontology. Version 0.0.0 (DRAFT). https://www.listdb.de/ontology.
DOI =
backwardsCompatibleWith =
status = draft
publisher =
publisherURI =
publisherInstitution =
publisherInstitutionURI =
authors =
authorsURI =
authorsInstitution =
authorsInstitutionURI =
contributors =
contributorsURI =
contributorsInstitution =
contributorsInstitutionURI =
importedOntologyNames =
importedOntologyURIs =
extendedOntologyNames =
extendedOntologyURIs =
RDFXMLSerialization = ontology.xml
TurtleSerialization = ontology.ttl
N3Serialization = ontology.nt
This directory contains scripts to replace sections in a Widoco documentation generated from the ontology by customized text snippets from [widoco_sections](widoco_sections).
/This is a place holder text for the abstract. The abstract should contain a couple of sentences summarizing the ontology and its purpose./ {
r widoco_sections/Abstract.md
d
}
/This is a placeholder text for the description of your ontology. The description should include an explanation and a diagram explaining how the classes are related, examples of usage, etc./ {
r widoco_sections/3.Description.md
d
}
/This is a place holder text for the introduction. The introduction should briefly describe the ontology, its motivation, state of the art and goals./ {
r widoco_sections/1.Introduction.md
d
}
/Add your references here. It is recommended to have them as a list./ {
r widoco_sections/5.References.md
d
}
This is a place holder text for the introduction. The introduction should briefly describe the ontology, its motivation, state of the art and goals.
\ No newline at end of file
This is a placeholder text for the description of your ontology. The description should include an explanation and a diagram explaining how the classes are related, examples of usage, etc.
\ No newline at end of file
Add your references here. It is recommended to have them as a list.
\ No newline at end of file
This is a place holder text for the abstract. The abstract should contain a couple of sentences summarizing the ontology and its purpose.
\ No newline at end of file
This directory contains text snippets that will be used in a documentation generated from the ontology by Widoco.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment