From 33c49eb9870aadc60fa3a36634684f91517376a7 Mon Sep 17 00:00:00 2001 From: Bruno Willenborg Date: Mon, 2 Dec 2024 14:03:06 +0100 Subject: [PATCH] initial structure --- docs/{tags.md => CityDB tool/assets/.gitkeep} | 0 docs/CityDB tool/cql2.md | 7 ++ docs/CityDB tool/db-connection.md | 7 ++ docs/CityDB tool/export.md | 7 ++ docs/CityDB tool/general.md | 13 +++ docs/CityDB tool/import.md | 7 ++ docs/{CLI tools => CityDB tool}/intro.md | 2 +- docs/First steps/3dcitydb.md | 16 ++++ docs/First steps/citydb-tool.md | 16 ++++ docs/First steps/docker.md | 6 ++ docs/First steps/requirements.md | 10 ++ docs/First steps/setup.md | 10 ++ docs/Partners/contributors.md | 10 ++ docs/Partners/hft-stuttgart.md | 10 ++ docs/Partners/list-eco.md | 10 ++ docs/Partners/moss.md | 10 ++ docs/Partners/tum-gis.md | 10 ++ docs/Partners/vcs.md | 10 ++ docs/how-to.md | 92 ++++++++++++++++++ docs/index.md | 96 +------------------ mkdocs.yml | 10 +- 21 files changed, 260 insertions(+), 99 deletions(-) rename docs/{tags.md => CityDB tool/assets/.gitkeep} (100%) create mode 100644 docs/CityDB tool/cql2.md create mode 100644 docs/CityDB tool/db-connection.md create mode 100644 docs/CityDB tool/export.md create mode 100644 docs/CityDB tool/general.md create mode 100644 docs/CityDB tool/import.md rename docs/{CLI tools => CityDB tool}/intro.md (63%) create mode 100644 docs/First steps/3dcitydb.md create mode 100644 docs/First steps/citydb-tool.md create mode 100644 docs/First steps/requirements.md create mode 100644 docs/First steps/setup.md create mode 100644 docs/Partners/contributors.md create mode 100644 docs/Partners/hft-stuttgart.md create mode 100644 docs/Partners/list-eco.md create mode 100644 docs/Partners/moss.md create mode 100644 docs/Partners/tum-gis.md create mode 100644 docs/Partners/vcs.md create mode 100644 docs/how-to.md diff --git a/docs/tags.md b/docs/CityDB tool/assets/.gitkeep similarity index 100% rename from docs/tags.md rename to docs/CityDB tool/assets/.gitkeep diff --git a/docs/CityDB tool/cql2.md b/docs/CityDB tool/cql2.md new file mode 100644 index 0000000..a6323d7 --- /dev/null +++ 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 new file mode 100644 index 0000000..43f1232 --- /dev/null +++ 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 new file mode 100644 index 0000000..4c02b16 --- /dev/null +++ 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 new file mode 100644 index 0000000..35993b3 --- /dev/null +++ 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 new file mode 100644 index 0000000..c4656ec --- /dev/null +++ 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 b/docs/CityDB tool/intro.md similarity index 63% rename from docs/CLI tools/intro.md rename to docs/CityDB tool/intro.md index 69614ca..ec304d6 100644 --- a/docs/CLI tools/intro.md +++ b/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 new file mode 100644 index 0000000..ac97733 --- /dev/null +++ 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 new file mode 100644 index 0000000..effafc4 --- /dev/null +++ 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 index 2a23e83..74dced6 100644 --- 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 new file mode 100644 index 0000000..88c79ca --- /dev/null +++ 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 new file mode 100644 index 0000000..1c52fa2 --- /dev/null +++ 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 new file mode 100644 index 0000000..4bc3f18 --- /dev/null +++ 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 new file mode 100644 index 0000000..cb1e8ef --- /dev/null +++ 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 new file mode 100644 index 0000000..9e85d41 --- /dev/null +++ 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 new file mode 100644 index 0000000..04f2a0a --- /dev/null +++ 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 new file mode 100644 index 0000000..67f5ad8 --- /dev/null +++ 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 new file mode 100644 index 0000000..c5e2b0f --- /dev/null +++ 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 new file mode 100644 index 0000000..bd148da --- /dev/null +++ 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 index dc70c32..008dad6 100644 --- 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 diff --git a/mkdocs.yml b/mkdocs.yml index 466d7bc..bc2468a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -14,8 +14,8 @@ edit_uri: edit/main/docs theme: name: material language: en - logo: docs/assets/img/logos/3dcitydb-logo.png - favicon: docs/assets/img/logos/3dcitydb-logo.png + logo: assets/img/logos/3dcitydb-logo.png + favicon: assets/img/logos/3dcitydb-logo.png # palette: # scheme: default # primary: green @@ -54,9 +54,9 @@ plugins: - search: lang: en - glightbox - - tags: - enabled: true - tags_file: tags.md + # - tags: + # enabled: true + # tags_file: tags.md # Extra ####################################################################### extra: