initial structure

3dcitydb · Dec 2, 2024 · 33c49eb · 33c49eb
1 parent 0e5f693
commit 33c49eb
Show file tree

Hide file tree

Showing 21 changed files with 260 additions and 99 deletions.
diff --git a/docs/tags.md → docs/CityDB tool/assets/.gitkeep b/docs/tags.md → docs/CityDB tool/assets/.gitkeep
diff --git a/docs/CityDB tool/cql2.md b/docs/CityDB tool/cql2.md
@@ -0,0 +1,7 @@
+---
+title: CQL2
+subtitle: CQL2
+description:
+# icon: material/emoticon-happy
+status: wip
+---
diff --git a/docs/CityDB tool/db-connection.md b/docs/CityDB tool/db-connection.md
@@ -0,0 +1,7 @@
+---
+title: Database connection
+subtitle: How to connect a 3DCityDB
+description:
+# icon: material/emoticon-happy
+status: wip
+---
diff --git a/docs/CityDB tool/export.md b/docs/CityDB tool/export.md
@@ -0,0 +1,7 @@
+---
+title: Export
+subtitle: Export
+description:
+# icon: material/emoticon-happy
+status: wip
+---
diff --git a/docs/CityDB tool/general.md b/docs/CityDB tool/general.md
@@ -0,0 +1,13 @@
+---
+title: General
+subtitle: General
+description:
+# icon: material/emoticon-happy
+status: wip
+---
+
+## Help
+
+## Validate
+
+## Env vars
diff --git a/docs/CityDB tool/import.md b/docs/CityDB tool/import.md
@@ -0,0 +1,7 @@
+---
+title: Import
+subtitle: Import
+description:
+# icon: material/emoticon-happy
+status: wip
+---
diff --git a/docs/CLI tools/intro.md → docs/CityDB tool/intro.md b/docs/CLI tools/intro.md → docs/CityDB tool/intro.md
@@ -1,6 +1,6 @@
 ---
 title: Intro
-subtitle: Gettings started with the 3DCityDB
+subtitle:
 description:
 # icon: material/emoticon-happy
 status: wip

diff --git a/docs/First steps/3dcitydb.md b/docs/First steps/3dcitydb.md
@@ -0,0 +1,16 @@
+---
+title: 3DCityDB
+subtitle: Getting started with the 3DCityDB and Docker
+description:
+# icon: material/emoticon-happy
+status: wip
+# tags:
+#   - tag1
+#   - tag2
+---
+
+Intro content
+
+## hl2
+
+### hl3
diff --git a/docs/First steps/citydb-tool.md b/docs/First steps/citydb-tool.md
@@ -0,0 +1,16 @@
+---
+title: CityDB tools
+subtitle: Getting started with the 3DCityDB and Docker
+description:
+# icon: material/emoticon-happy
+status: wip
+# tags:
+#   - tag1
+#   - tag2
+---
+
+Intro content
+
+## hl2
+
+### hl3
diff --git a/docs/First steps/docker.md b/docs/First steps/docker.md
@@ -8,3 +8,9 @@ status: wip
 #   - tag1
 #   - tag2
 ---
+
+Intro content
+
+## hl2
+
+### hl3
diff --git a/docs/First steps/requirements.md b/docs/First steps/requirements.md
@@ -0,0 +1,10 @@
+---
+title: Requirements
+subtitle:
+description:
+# icon: material/emoticon-happy
+status: wip
+# tags:
+#   - tag1
+#   - tag2
+---
diff --git a/docs/First steps/setup.md b/docs/First steps/setup.md
@@ -0,0 +1,10 @@
+---
+title: Setup
+subtitle:
+description:
+# icon: material/emoticon-happy
+status: wip
+# tags:
+#   - tag1
+#   - tag2
+---
diff --git a/docs/Partners/contributors.md b/docs/Partners/contributors.md
@@ -0,0 +1,10 @@
+---
+title: Contributors
+subtitle:
+description:
+# icon: material/emoticon-happy
+status: wip
+# tags:
+#   - tag1
+#   - tag2
+---
diff --git a/docs/Partners/hft-stuttgart.md b/docs/Partners/hft-stuttgart.md
@@ -0,0 +1,10 @@
+---
+title: HFT Stuttgart
+subtitle:
+description:
+# icon: material/emoticon-happy
+status: wip
+# tags:
+#   - tag1
+#   - tag2
+---
diff --git a/docs/Partners/list-eco.md b/docs/Partners/list-eco.md
@@ -0,0 +1,10 @@
+---
+title: LIST Eco GmbH & Co. KG
+subtitle:
+description:
+# icon: material/emoticon-happy
+status: wip
+# tags:
+#   - tag1
+#   - tag2
+---
diff --git a/docs/Partners/moss.md b/docs/Partners/moss.md
@@ -0,0 +1,10 @@
+---
+title: M.O.S.S.
+subtitle:
+description:
+# icon: material/emoticon-happy
+status: wip
+# tags:
+#   - tag1
+#   - tag2
+---
diff --git a/docs/Partners/tum-gis.md b/docs/Partners/tum-gis.md
@@ -0,0 +1,10 @@
+---
+title: Chair of Geoinformatics, TUM
+subtitle:
+description:
+# icon: material/emoticon-happy
+status: wip
+# tags:
+#   - tag1
+#   - tag2
+---
diff --git a/docs/Partners/vcs.md b/docs/Partners/vcs.md
@@ -0,0 +1,10 @@
+---
+title: Virtual City Systems
+subtitle:
+description:
+# icon: material/emoticon-happy
+status: wip
+# tags:
+#   - tag1
+#   - tag2
+---
diff --git a/docs/how-to.md b/docs/how-to.md
@@ -0,0 +1,92 @@
+## Usage instructions
+
+In dieser Sektion findest du Hinweise, wie du effektiv mit der Prozessdokumentation arbeiten kannst.
+
+### How to search
+
+Die effizienteste Möglichkeit Dinge in der Dokumentation zu finden, ist die Suchfunktion. Nur ein Schlagwort wird in vielen Fällen schon ausreichen, um die richtige Seite zu finden.
+
+#### Keyboard shortcuts
+
+Die großartige [Suchfunktion](https://squidfunk.github.io/mkdocs-material/plugins/search/){target="_blank"} lässt sich komfortabel über die Tastatur steuern.
+Das gleich gilt für die Navigation zwischen Seiten. Für die Suchfunktion gibt zwei Modi:
+
+:   Dieser Modus ist aktiv, wenn die _Suche fokussiert_ ist. Er bietet mehrere Tasten, um die Suche über die Tastatur zugänglich und navigierbar zu machen:
+
+    * ++arrow-down++ , ++arrow-up++ : Nächstes/Vorheriges Suchergebnis auswählen
+    * ++esc++ , ++tab++ : Suchdialog schließen
+    * ++enter++ : Suchergebnis öffnen
+
+:   Dieser Modus ist aktiv, wenn _Suche nicht fokussiert ist_ und wenn es kein anderes fokussiertes Element gibt, das für Tastatureingaben empfänglich ist. Die folgenden Tasten sind gebunden:
+
+    * ++f++ , ++s++ , ++slash++ : Suchdialog öffnen
+    * ++p++ , ++comma++ : Nächste Seite
+    * ++n++ , ++period++ : Vorherige Seite
+
+[Hier](https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/?h=keyboard#keyboard-shortcuts){target="_blank"} gibt es weitere Infos zur Erstellung von eigenen Tastenkombinationen.
+
+## How to contribute
+
+- VS Code und Extensions auflisten!
+
+Diese Dokumentation wurde mit _Materials_ für _MkDocs_ erstellt.
+Der Inhalt ist in _Markdown_, einer vereinfachten Auszeichnungssprache geschrieben, deren Grundelemente in 15 min erlernt werden können.
+
+- [Markdown Referenz](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet){target="_blank"}
+- [Markdown cheatsheet printable](https://enterprise.github.com/downloads/en/markdown-cheatsheet.pdf){target="_blank"}
+- [MkDocs Materials Theme documentation](https://squidfunk.github.io/mkdocs-material/){target="_blank"}
+- [User Guide MkDocs](https://www.mkdocs.org/user-guide){target="_blank"}
+
+### Markdown examples
+
+Hier ein Beispiel:
+
+``` markdown title="Ein Beispiel Markdown dokument"
+
+# Überschrift Ebene 1
+
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
+sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
+sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
+Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+
+## Überschrift Ebene 2
+
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
+sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
+sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
+Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+
+### Überschrift Ebene 3
+
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
+sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
+sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
+Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+
+#### Überschrift Ebene 4
+
+Eine Aufzählung:
+
+- Punkt 1
+
+    - Unterpunkt 1
+    - Unterpunkt 2
+
+        - Unterunterpunkt 1
+        - ...
+
+- Punkt 2
+- ...
+
+Eine Nummerierung:
+
+1. Punkt 1
+
+    1. Unterpunkt 1
+    2. Unterpunkt 2
+
+2. Punkt 2
+3. ...
+
+```
diff --git a/docs/index.md b/docs/index.md
@@ -1,5 +1,5 @@
 ---
-title: Home
+title: Welcome
 subtitle: 3D City Database v5 documentation
 description:
 # icon: material/emoticon-happy
@@ -9,95 +9,5 @@ description:
 
 ## Content
 
-## Usage instructions
-
-In dieser Sektion findest du Hinweise, wie du effektiv mit der Prozessdokumentation arbeiten kannst.
-
-### How to search
-
-Die effizienteste Möglichkeit Dinge in der Dokumentation zu finden, ist die Suchfunktion. Nur ein Schlagwort wird in vielen Fällen schon ausreichen, um die richtige Seite zu finden.
-
-#### Keyboard shortcuts
-
-Die großartige [Suchfunktion](https://squidfunk.github.io/mkdocs-material/plugins/search/){target="_blank"} lässt sich komfortabel über die Tastatur steuern.
-Das gleich gilt für die Navigation zwischen Seiten. Für die Suchfunktion gibt zwei Modi:
-
-:   Dieser Modus ist aktiv, wenn die _Suche fokussiert_ ist. Er bietet mehrere Tasten, um die Suche über die Tastatur zugänglich und navigierbar zu machen:
-
-    * ++arrow-down++ , ++arrow-up++ : Nächstes/Vorheriges Suchergebnis auswählen
-    * ++esc++ , ++tab++ : Suchdialog schließen
-    * ++enter++ : Suchergebnis öffnen
-
-:   Dieser Modus ist aktiv, wenn _Suche nicht fokussiert ist_ und wenn es kein anderes fokussiertes Element gibt, das für Tastatureingaben empfänglich ist. Die folgenden Tasten sind gebunden:
-
-    * ++f++ , ++s++ , ++slash++ : Suchdialog öffnen
-    * ++p++ , ++comma++ : Nächste Seite
-    * ++n++ , ++period++ : Vorherige Seite
-
-[Hier](https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/?h=keyboard#keyboard-shortcuts){target="_blank"} gibt es weitere Infos zur Erstellung von eigenen Tastenkombinationen.
-
-## How to contribute
-
-- VS Code und Extensions auflisten!
-
-Diese Dokumentation wurde mit _Materials_ für _MkDocs_ erstellt.
-Der Inhalt ist in _Markdown_, einer vereinfachten Auszeichnungssprache geschrieben, deren Grundelemente in 15 min erlernt werden können.
-
-- [Markdown Referenz](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet){target="_blank"}
-- [Markdown cheatsheet printable](https://enterprise.github.com/downloads/en/markdown-cheatsheet.pdf){target="_blank"}
-- [MkDocs Materials Theme documentation](https://squidfunk.github.io/mkdocs-material/){target="_blank"}
-- [User Guide MkDocs](https://www.mkdocs.org/user-guide){target="_blank"}
-
-### Markdown examples
-
-Hier ein Beispiel:
-
-``` markdown title="Ein Beispiel Markdown dokument"
-
-# Überschrift Ebene 1
-
-Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
-sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
-sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
-Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
-
-## Überschrift Ebene 2
-
-Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
-sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
-sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
-Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
-
-### Überschrift Ebene 3
-
-Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
-sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
-sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
-Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
-
-#### Überschrift Ebene 4
-
-Eine Aufzählung:
-
-- Punkt 1
-
-    - Unterpunkt 1
-    - Unterpunkt 2
-
-        - Unterunterpunkt 1
-        - ...
-
-- Punkt 2
-- ...
-
-Eine Nummerierung:
-
-1. Punkt 1
-
-    1. Unterpunkt 1
-    2. Unterpunkt 2
-
-2. Punkt 2
-3. ...
-
-```
+- Content overview
+- Side structure