Merge branch 'docu_extend' into develop-3.0.0

.github/workflows/deploy.yaml

@@ -1,28 +1,59 @@
-name: HTML
+name: HTMLextend
 
 on:
  push:
  branches:
- - main
+ - docu_extend
+ workflow_dispatch:
+ inputs:
+ logLevel:
+ description: 'Log level'
+ required: true
+ default: 'debug'
+ type: choice
+ options:
+ - info
+ - warning
+ - debug
 jobs:
  deploy:
  runs-on: ubuntu-latest
  steps:
  - uses: actions/checkout@v3
- with:
- ref: main
- path: main
+ # with:
+ #  ref: main
+ #  path: main
  - name: Build HTML for main
  run: | 
  wget -O widoco.jar https://github.com/dgarijo/Widoco/releases/download/v1.4.17/java-11-widoco-1.4.17-jar-with-dependencies.jar
  mkdir public 
- java -jar widoco.jar -ontFile main/pmd_core.ttl -outFolder public -htaccess -uniteSections -includeAnnotationProperties -lang en-de -getOntologyMetadata -noPlaceHolderText -rewriteAll -webVowl
+ java -jar widoco.jar -ontFile pmd_core.ttl -outFolder public -htaccess -uniteSections -includeAnnotationProperties -lang en-de -getOntologyMetadata -rewriteAll -webVowl
+ - name: Include Additional Documentation
+ run: | 
+ dir="public"
+ echo "Adding english textual inputs to the documentation HTML"
+ gawk -i inplace -v r="$(cat documentation/en/1.Introduction.md)" '{gsub(/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)}1' $dir/index-en.html
+ gawk -i inplace -v r="$(cat documentation/en/3.Description.md)" '{gsub(/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)}1' $dir/index-en.html
+ gawk -i inplace -v r="$(cat documentation/en/5.References.md|sed 's/&/\\\\&/')" '{gsub(/Add your references here. It is recommended to have them as a list./,r)}1' $dir/index-en.html
+ gawk -i inplace -v r="<span class=\"markdown\">$(cat documentation/en/6.Acknowledgements.md)</span>" '{gsub(/(The authors would like to thank.*documentation\.)/,r)}1' $dir/index-en.html
+ echo "Adding german textual inputs to the documentation HTML"
+ gawk -i inplace -v r="$(cat documentation/de/1.Einleitung.md)" '{gsub(/Dies ist ein Platzhalter f&uuml;r die Einf&uuml;hrung. Die Einf&uuml;hrung sollte in kurzer Form die Ontologie und ihren Anwendungszweck beschreiben, sowie Informationen &uuml;ber ihren Entwicklungsstand und Kontext enthalten./,r)}1' $dir/index-de.html
+ gawk -i inplace -v r="$(cat documentation/de/3.Beschreibung.md)" '{gsub(/Dies ist ein Platzhalter f&uuml;r die Beschreibung. Die Beschreibung sollte eine Erkl&auml;rung und Graphiken enthalten, die die Beziehung der Klassen untereinander und Anwendungsbeispiele enth&auml;lt./,r)}1' $dir/index-de.html
+ gawk -i inplace -v r="$(cat documentation/de/5.References.md|sed 's/&/\\\\&/')" '{gsub(/F&uuml;gen Sie Ihre Referenzen hier ein. &uuml;blicherweise wird dies in Form einer Liste gemacht./,r)}1' $dir/index-de.html
+ gawk -i inplace -v r="<span class=\"markdown\">$(cat documentation/de/6.Danksagung.md)</span>" '{gsub(/(Die Autoren bedanken sich bei.*wird\.)/,r)}1' $dir/index-de.html
+ echo "Converting markdown sections into html sections so that they appear in the table of content in the index-en.html"
+ sed -i -E -e 's/### ([[:digit:]]\.[[:digit:]]+\.) (.*)/<\/span><h3 id="\1" class="list">\2<\/h3><span class="markdown">/g' $dir/index-en.html
+ sed -i -E -e 's/### ([[:digit:]]\.[[:digit:]]+\.) (.*)/<\/span><h3 id="\1" class="list">\2<\/h3><span class="markdown">/g' $dir/index-de.html
+ #echo "Injecting code snippet for hiding unused elements to the index-en.html"
+ #gawk -i inplace -v r="<script>$(cat documentation/hideUnusedElements.js)</script></head>" '{gsub(/(<\/head>)/,r)}1' $dir/index-en.html
+ #gawk -i inplace -v r="<script>$(cat documentation/hideUnusedElements.js)</script></head>" '{gsub(/(<\/head>)/,r)}1' $dir/index-de.html
+ echo "Set english website as default, or markdown of branch is rendered as default"
  cp public/index-en.html public/index.html
  - name: Deploy to GitHub Pages
  if: success()
  uses: crazy-max/ghaction-github-pages@v3
  with:
- target_branch: gh-pages
+ target_branch: gh-pages-dev
  build_dir: public
  env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

documentation/Authors.md

@@ -0,0 +1,6 @@
+| Name | ORCID | Affiliation (acronym) | [ROR][ROR] |
+| ---------------------- | ------------------- | ----------------------------------------------------- | ---------- |
+| Thomas Hanke | 0000-0003-1649-6832 | Fraunhofer Institute for Mechanics of Materials IWM | 04hm8eb66 |
+
+
+[ROR]: <https://ror.org/search>

documentation/de/1.Einleitung.md

@@ -0,0 +1 @@
+Hier der Einleitungstext!

documentation/de/3.Beschreibung.md

@@ -0,0 +1,22 @@
+### 3.1. Allgemeines Prozess Modell
+
+### 3.2. Processing step as central element
+
+### 3.3. Specifying in- and output
+
+### 3.4. Specifying the investigated object and property
+
+### 3.5. Specifying employed tools and methods
+
+### 3.6. Specifying parameters
+
+### 3.7. Specifying persons and projects
+
+### 3.8. Specifying complex setups and processes by using composition
+
+### 3.9. Specifying parameters by variables
+
+### 3.10. Specifying datasets
+
+### 3.11. Specifying related publications
+

documentation/de/5.Referenzen.md

@@ -0,0 +1,15 @@
+Verwendete Ontologien: 
+
+* [Dublin Core Terms](http://purl.org/dc/terms/) 
+* [Friend of a Friend](http://xmlns.com/foaf/0.1/) 
+* [Web Ontology Language](https://www.w3.org/TR/owl-overview/) 
+* [Provenance Namespace](https://www.w3.org/TR/2013/REC-prov-o-20130430/) 
+* [Quantities, Units, Dimensions and Types](http://www.qudt.org/2.1/catalog/qudt-catalog.html) 
+* [Resource Description Framework](https://www.w3.org/TR/rdf11-concepts/) 
+* [RDF Schema](https://www.w3.org/TR/rdf-schema/) 
+* [schema.org](https://schema.org/) 
+* [Simple Knowledge Organization System](https://www.w3.org/TR/skos-reference/) 
+* [Vocabulary for Annotating vocabulary descriptions](https://vocab.org/vann/) 
+* [XML Schema Definition](https://www.w3.org/TR/xmlschema11-1/) 
+* [Basic Formal Ontology](https://basic-formal-ontology.org/) 
+* [Relation Ontology](https://obofoundry.org/ontology/ro.html) 

documentation/de/6.Danksagung.md

@@ -0,0 +1,3 @@
+Die Autoren bedanken sich bei[Silvio Peroni](http://www.essepuntato.it/) für die Entwicklung von [LODE](http://www.essepuntato.it/lode), einer Umgebung zur Live-OWL-Dokumentation, die im Abschnitt Querverweise für die Darstellung verwendet wird, bei [Daniel Garijo](https://w3id.org/people/dgarijo) für die Entwicklung von [Widoco](https://github.com/dgarijo/Widoco), welches für die Templates in dieser Anwendung verwendet wird.
+
+Die Autoren bedanken sich ebenfalls bei der Bundesregierung und den Regierungen der Länder für die Förderung im Rahmen des Plattformprojects [Plattform MaterialDigital](https://www.materialdigital.de/). Gefördert durch das [Bundesministerium für Bildung und Forschung](https://www.bmbf.de/bmbf/en) (BMBF).

documentation/en/1.Introduction.md

@@ -0,0 +1 @@
+This is the introduction text!

documentation/en/3.Description.md

@@ -0,0 +1,22 @@
+### 3.1. General process model
+
+### 3.2. Processing step as central element
+
+### 3.3. Specifying in- and output
+
+### 3.4. Specifying the investigated object and property
+
+### 3.5. Specifying employed tools and methods
+
+### 3.6. Specifying parameters
+
+### 3.7. Specifying persons and projects
+
+### 3.8. Specifying complex setups and processes by using composition
+
+### 3.9. Specifying parameters by variables
+
+### 3.10. Specifying datasets
+
+### 3.11. Specifying related publications
+

documentation/en/5.References.md

@@ -0,0 +1,15 @@
+Reused Ontologies: 
+
+* [Dublin Core Terms](http://purl.org/dc/terms/) 
+* [Friend of a Friend](http://xmlns.com/foaf/0.1/) 
+* [Web Ontology Language](https://www.w3.org/TR/owl-overview/) 
+* [Provenance Namespace](https://www.w3.org/TR/2013/REC-prov-o-20130430/) 
+* [Quantities, Units, Dimensions and Types](http://www.qudt.org/2.1/catalog/qudt-catalog.html) 
+* [Resource Description Framework](https://www.w3.org/TR/rdf11-concepts/) 
+* [RDF Schema](https://www.w3.org/TR/rdf-schema/) 
+* [schema.org](https://schema.org/) 
+* [Simple Knowledge Organization System](https://www.w3.org/TR/skos-reference/) 
+* [Vocabulary for Annotating vocabulary descriptions](https://vocab.org/vann/) 
+* [XML Schema Definition](https://www.w3.org/TR/xmlschema11-1/) 
+* [Basic Formal Ontology](https://basic-formal-ontology.org/) 
+* [Relation Ontology](https://obofoundry.org/ontology/ro.html) 

documentation/en/6.Acknowledgements.md

@@ -0,0 +1,3 @@
+The authors would like to thank [Silvio Peroni](http://www.essepuntato.it/) for developing [LODE](http://www.essepuntato.it/lode), a Live OWL Documentation Environment, which is used for representing the Cross Referencing Section of this document and [Daniel Garijo](https://w3id.org/people/dgarijo) for developing [Widoco](https://github.com/dgarijo/Widoco), the program used to create the template used in this documentation.
+
+The authors would like to thank the Federal Government and the Heads of Government of the Länder for their funding and support within the framework of the [Plattform MaterialDigital](https://www.materialdigital.de/). Funded by the german [Federal Ministry of Education and Research](https://www.bmbf.de/bmbf/en) (BMBF).