Initial commit

.github/workflows/build-docs.yml

@@ -0,0 +1,59 @@
+name: Documentation Ontologies
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+env:
+  PYLODE_COMMIT: f60b2087e706967480ad5080770f8a66444cc81d
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.2.2"
+
+      - name: Install Ruby Gems
+        run: bundle install
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Install pyLODE v2 with vocpub
+        run: pip install pylode==2.13.2 html5
+
+      - name: Create Ontology Documentation 🔧
+        run: |
+          mkdir docs
+          ./ci_scripts/run.sh
+
+      - name: Deploy - make static files available in GH pages for pylode build
+        uses: JamesIves/github-pages-deploy-action@releases/v4
+        with:
+          BRANCH: gh-pages
+          FOLDER: docs/
+
+      - name: Install pyLODE with supermodel functionality
+        run: pip install git+https://github.com/RDFLib/pyLODE@${{ env.PYLODE_COMMIT }}
+
+      - name: Create pylode-generated CSDM documentation
+        run: |
+          mkdir -p docs/docs docs/docs/icsm-profile docs/docs/nz-profile docs/docs/wa-profile docs/docs/vic-profile
+          pylode -p supermodel -o docs/docs/index.html csdm_model/csdm.ttl
+          pylode -p supermodel -o docs/docs/icsm-profile/index.html https://icsm-au.github.io/3d-csdm-profiles/profiles/icsm-common.ttl
+          pylode -p supermodel -o docs/docs/nz-profile/index.html https://icsm-au.github.io/3d-csdm-profiles/profiles/nz-profile.ttl
+          pylode -p supermodel -o docs/docs/wa-profile/index.html https://icsm-au.github.io/3d-csdm-profiles/profiles/wa-profile.ttl
+          pylode -p supermodel -o docs/docs/vic-profile/index.html https://icsm-au.github.io/3d-csdm-profiles/profiles/vic-profile.ttl
+
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@releases/v4
+        with:
+          BRANCH: gh-pages
+          FOLDER: docs/

.gitignore

@@ -0,0 +1,5 @@
+csdm_model.zip
+docs/
+venv/
+csdm_model/build-local/
+.idea/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "3d-csdm-schema"]
+	path = 3d-csdm-schema
+	url = https://github.com/icsm-au/3d-csdm-schema.git

Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# gem "rails"
+
+gem "asciidoctor", "~> 2.0"

Gemfile.lock

@@ -0,0 +1,13 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    asciidoctor (2.0.20)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  asciidoctor (~> 2.0)
+
+BUNDLED WITH
+   2.4.10

README.adoc

@@ -0,0 +1,42 @@
+= 3d-csdm
+
+A repository to manage the development and release of the 3D Cadastral Survey Data Model (3D CSDM).
+
+The 2022 publication of this model and initial requirements are documented at https://icsm-au.github.io/3d-csdm-design/2022/spec.html
+
+The 2023 next-generation model documentation is in development but available online at:
+
+* https://icsm-au.github.io/3d-csdm/
+
+
+== Model Repositories
+
+* This repository
+** master data for the model, includes the encoding specification as a submodule
+* https://github.com/icsm-au/3d-csdm-schema
+** the CSDM encoding specification in the form of an OGC API "building block"
+
+
+== Related resources
+
+* Documentation co-design at https://github.com/icsm-au/3d-csdm-schema
+* https://github.com/icsm-au/3d-csdm-req Requirements model for extended documentation and design process support
+* https://github.com/icsm-au/3d-csdm-doc Document knowledge base
+
+
+== License & Rights
+
+This model and all repository contents are © Australian Government (Intergovernmental Committee on Surveying and Mapping), 2023.
+
+The contents of this repository are licensed for reuse with the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 License] and a copy of the deed is stored in the LICENSE file in this repository.
+
+
+== Contact
+
+For all usage and legal issues, please contact the https://www.icsm.gov.au[Intergovernmental Committee on Surveying and Mapping (ICSM)].
+
+For technical matters during the development phase of this model, please contact:
+
+*Robert Atkinson* +
+_3D CSDM Consortium Modelling Lead_ +
+rob.atkinson@surroundaustralia.com

Taskfile.yml

@@ -0,0 +1,20 @@
+# https://taskfile.dev
+
+version: "3"
+
+tasks:
+  dev:
+    cmds:
+      - venv/bin/watchfiles ./ci_scripts/run.sh index.html
+
+  dev:mockup:profile:
+    cmds:
+      - venv/bin/watchfiles 'asciidoctor -o docs/profiles-demo.html mockups/profiles/index.adoc' mockups/profiles
+
+  web:
+    cmds:
+      - venv/bin/python -m http.server -d docs/ 8001
+
+  dev:pylode:
+    cmds:
+      - python -m http.server -d csdm_model/

ci_scripts/run.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+echo "Creating docs directory"
+mkdir -p docs
+mkdir -p docs/mockups
+mkdir -p docs/shapes
+
+echo "Copying static files"
+cp csdm_model/static/vocab-management.html docs/vocab-management.html
+cp csdm_model/static/vocab-attributions.html docs/vocab-attributions.html
+cp csdm_model/static/vocab-impspecs.html docs/vocab-impspecs.html
+cp csdm_model/*.ttl docs/
+cp csdm_model/shapes/*.ttl docs/shapes
+
+echo "Running asciidoctor"
+asciidoctor -o docs/index.html csdm_model/static/index.adoc
+asciidoctor -o docs/mockups/profiles.html mockups/profiles/index.adoc
+
+echo "Running pyLODE on components"
+pylode -p vocpub -i csdm_model/attributions.ttl -o docs/vocab-attributions.html
+pylode -i csdm_model/commonpatterns.ttl -o docs/commonpatterns.html
+pylode -i csdm_model/container.ttl -o docs/container.html
+pylode -i csdm_model/geometryprim.ttl -o docs/geometryprim.html
+pylode -p vocpub csdm_model/impspecs.ttl -o docs/vocab-impspecs.html
+pylode -i csdm_model/parcels.ttl -o docs/parcels.html
+pylode -i csdm_model/surveyfeats.ttl -o docs/surveyfeats.html
+pylode -i csdm_model/surveyobs.ttl -o docs/surveyobs.html
+pylode -i csdm_model/surveyprov.ttl -o docs/surveyprov.html

csdm_model/.project

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>csdm_model</name>
+	<comment>3D Cadastre Survey Data Model Knowledge Graph. This graph will depend on generic document and Use Case models, and multiple componentised resuable "componentised document" data sources.</comment>
+	<projects>
+	</projects>
+	<buildSpec>
+	</buildSpec>
+	<natures>
+	</natures>
+</projectDescription>