Merge pull request #7 from a3an4ogd/mijn-documentatie-bijdrage

Onboarding HOME en 3D-Viewer
Netherlands3D · Dec 9, 2024 · 3e7ab65 · 3e7ab65
2 parents 0010c9a + 5163e89
commit 3e7ab65
Show file tree

Hide file tree

Showing 26 changed files with 226 additions and 0 deletions.
diff --git a/docs/docs/imgs/onboarding/3d-viewer.interface.png b/docs/docs/imgs/onboarding/3d-viewer.interface.png
diff --git a/docs/docs/imgs/onboarding/3d-viewer.main.png b/docs/docs/imgs/onboarding/3d-viewer.main.png
diff --git a/docs/docs/imgs/onboarding/3d-viewer.menu.linksboven.png b/docs/docs/imgs/onboarding/3d-viewer.menu.linksboven.png
diff --git a/docs/docs/imgs/onboarding/3d-viewer.menu.linksonder.png b/docs/docs/imgs/onboarding/3d-viewer.menu.linksonder.png
diff --git a/docs/docs/imgs/onboarding/3d-viewer.menu.rechtsboven.png b/docs/docs/imgs/onboarding/3d-viewer.menu.rechtsboven.png
diff --git a/docs/docs/imgs/onboarding/3d-viewer.menu.rechtsonder.png b/docs/docs/imgs/onboarding/3d-viewer.menu.rechtsonder.png
diff --git a/docs/docs/imgs/onboarding/3d-viewer.png b/docs/docs/imgs/onboarding/3d-viewer.png
diff --git a/docs/docs/imgs/onboarding/3d-viewer.positie.png b/docs/docs/imgs/onboarding/3d-viewer.positie.png
diff --git a/docs/docs/imgs/onboarding/3d-viewer.project.openen.png b/docs/docs/imgs/onboarding/3d-viewer.project.openen.png
diff --git a/docs/docs/imgs/onboarding/3d-viewer.project.opslaan.png b/docs/docs/imgs/onboarding/3d-viewer.project.opslaan.png
diff --git a/docs/docs/imgs/onboarding/3d-viewer.rechtsonder.minimap.png b/docs/docs/imgs/onboarding/3d-viewer.rechtsonder.minimap.png
diff --git a/docs/docs/imgs/onboarding/3d-viewer.rechtsonder.noordpijl.png b/docs/docs/imgs/onboarding/3d-viewer.rechtsonder.noordpijl.png
diff --git a/docs/docs/imgs/onboarding/3d-viewer.rechtsonder.perspectief.png b/docs/docs/imgs/onboarding/3d-viewer.rechtsonder.perspectief.png
diff --git a/docs/docs/imgs/onboarding/_not/Animation.01.gif b/docs/docs/imgs/onboarding/_not/Animation.01.gif
diff --git a/docs/docs/imgs/onboarding/_not/animated.gif b/docs/docs/imgs/onboarding/_not/animated.gif
diff --git a/docs/docs/imgs/onboarding/content.png b/docs/docs/imgs/onboarding/content.png
diff --git a/docs/docs/imgs/onboarding/footer.png b/docs/docs/imgs/onboarding/footer.png
diff --git a/docs/docs/imgs/onboarding/functionaliteiten.png b/docs/docs/imgs/onboarding/functionaliteiten.png
diff --git a/docs/docs/imgs/onboarding/headliner.png b/docs/docs/imgs/onboarding/headliner.png
diff --git a/docs/docs/imgs/onboarding/hoofdmenubalk.png b/docs/docs/imgs/onboarding/hoofdmenubalk.png
diff --git a/docs/docs/imgs/onboarding/instellingen.main.png b/docs/docs/imgs/onboarding/instellingen.main.png
diff --git a/docs/docs/imgs/onboarding/instellingen.sub.png b/docs/docs/imgs/onboarding/instellingen.sub.png
diff --git a/docs/docs/imgs/onboarding/schermmodus.icon.png b/docs/docs/imgs/onboarding/schermmodus.icon.png
diff --git a/docs/docs/imgs/onboarding/schermmodus.png b/docs/docs/imgs/onboarding/schermmodus.png
diff --git a/docs/docs/onboarding/3D-viewer.md b/docs/docs/onboarding/3D-viewer.md
@@ -0,0 +1,170 @@
+# 3D-viewer
+Versie:	0.03  
+Auteur:	Adrian Voogd   
+Datum:	22 november 2024  
+
+**Functie:**	Hoofdfunctionaliteit
+
+## Inleiding
+
+* De 3D-viewer is de hoofdfunctionaliteit van Netherlands3D.eu. De interface biedt toegang tot de verschillende functionaliteiten. De 3D-viewer wordt geactiveerd na het klikken op Bekijk de viewer op de homepage in de Headline.
+* Dit hoofdstuk beschrijft de belangrijkste functionaliteiten van de 3D-viewer en de instellingen.   
+
+## Overzicht van functionaliteiten
+
+* De 3D-viewer is de hoofdfunctionaliteit van Netherlands3D.eu. Met behulp van verschillende functionaliteiten worden databronnen gekoppeld en in real-time interactief gevisualiseerd.
+
+## Gedetailleerde beschrijving van de functionaliteiten
+
+### **Instellingen**
+
+![Building Blocks](../imgs/onboarding/3d-viewer.png)
+3D-Viewer startscherm
+
+Na het opstarten van de 3D viewer is het instellingen menu actief. Het instellingenmenu is onderverdeeld in drie functies;    
+
+
+#### **1. Locatie bepalen**
+![Building Blocks](../imgs/onboarding/instellingen.main.png)
+Locatie bepalen - submenu
+
+Met deze functie wordt de locatie ingevoerd. Dit kan op drie manieren;   
+1. Door met de muis op een locatie in de map te klikken.   
+2. Door het invoeren van een plaats-, straatnaam en/of postcode.   
+3. Door bij X, Y een coördinaat* in te voeren.     
+
+(*) Het coördinatenstelsel is gebaseerd RD-coördinatenstelsel. 
+
+#### **2. Functionaliteiten**
+![Building Blocks](../imgs/onboarding/functionaliteiten.png)
+Functionaliteiten - submenu
+
+Met het submenu Functionaliteiten krijgt de gebruiker toegang tot het aan-/uitzetten van de standaard datalagen en (menu)functionaliteiten die in de basis versie van Netherlands3d.eu wordt aangeboden.   
+
+Door het aanklikken van het selectievinkje wordt de laag of functionaliteit aan of uitgezet.    
+
+In het hoofdstuk Bijlagen van dit document staat een overzicht van de datalagen en bijbehorende (gekoppelde) functionaliteiten.
+
+#### **3. Instellingen (submenu)**
+![Building Blocks](../imgs/onboarding/instellingen.sub.png)
+Instellingen - submenu
+
+**(beeld)Kwaliteit**   
+In dit menu kan de performance van de 3D viewer worden geoptimaliseerd en afgestemd op de capaciteit van het gebruikte computersysteem. Door te kiezen voor Hoog, Middel of Laag, kan de (beeld)kwaliteit worden aangepast van resp. Hoge, Middelmatige of lage kwaliteit. De optie laag biedt de snelste performance maar heeft het minste detailniveau. 
+
+**Limiteer scroll gevoeligheid **  
+In sommige gevallen reageert de 3D-viewer niet optimaal op de muisbewegingen va de gebruiker. Door de optie Limiteer scroll gevoeligheid aan te vinken kan dit worden verbeterd. 
+
+Met x (rechtsboven) wordt het instellingenmenu afgesloten en toont de 3D-viewer het [default] startpunt; het centrum van Amersfoort.
+
+### **3D-viewer**
+
+![Building Blocks](../imgs/onboarding/3d-viewer.main.png)
+3D-Viewer hoofdscherm
+
+#### **1. Interface**  
+<!-- -->
+De interface is onderverdeeld in het 3D-scherm met daaromheen de knoppen van de interface;  
+1. Hoofdmenu – linksboven,  
+2. Project openen/project opslaan - linksonder,  
+3. Bovenbalk – rechtsboven,  
+4. Onderbalk - rechtsonder.
+
+![Building Blocks](../imgs/onboarding/3d-viewer.interface.png)
+3D-Viewer interface
+&nbsp;
+
+**Menu 1. Hoofdmenu (linksboven)**  
+![Building Blocks](../imgs/onboarding/3d-viewer.menu.linksboven.png){ style="height:230px;width:50px" }
+
+Het hoofdmenu (linksboven) bevat de volgende functies (van boven naar onder);  
+- Bag informatie,   
+- Ondergrond doorzicht,   
+- Lagen,   
+- Zonnestand,   
+- Gebied downloaden.  
+&nbsp;
+
+**Menu 2. Project openen/project opslaan (linksonder)**  
+![Building Blocks](../imgs/onboarding/3d-viewer.menu.linksonder.png){ style="height:100px;width:50px" }
+
+Het Project opslaan/openen-menu bevindt zich in de linker onder hoek en bevat de volgende functies;  
+- Project openen,   
+- Project opslaan.  
+
+Met **Project opslaan** worden alle nieuwe instellingen, locatie, lagen etc. van de viewer opgeslagen. Met de knop **Project opslaan** wordt een venster geopend met aanvullende uitleg en de knop Bestand opslaan.
+
+![Building Blocks](../imgs/onboarding/3d-viewer.project.opslaan.png){ width="350px" }
+
+Met de knop **Bestand opslaan** worden de instellingen automatisch in een .nl3d bestand gedownload in de C:\Users\Gebruikersnaam\Downloads. 
+
+Met de knop **Project openen** wordt een venster geopend met aanvullende uitleg en de knop **Bestand openen**. Hiermee wordt de verkenner/finder (?) geopend en kan een eerder gemaakt .nl3d-bestand worden geopend. Hierna zijn de in-het-.nl3d-bestand-opgeslagen instellingen, datalagen, locatie etc. weer actief. 
+
+![Building Blocks](../imgs/onboarding/3d-viewer.project.openen.png){ width="350px" }
+
+&nbsp;
+
+**Menu 3. Bovenbalk(rechtsboven)**  
+![Building Blocks](../imgs/onboarding/3d-viewer.menu.rechtsboven.png){ width="150" }
+
+De bovenbalk bevat de volgende functies (van links naar rechts);   
+
+**Schermafbeelding maken**   
+Door op de knop Schermafbeelding maken te klikken wordt automatisch een afdruk van de 3D viewer als .png-bestand gedownload. Je kunt de afbeelding bekijken door naar C:\Users\Gebruikersnaam\Downloads te gaan.
+
+**Instellingen**  
+Zie [Instellingen](http://127.0.0.1:8000/docs/onboarding/3D-viewer/#instellingen)
+
+**Informatie**  
+Met de knop Informatie wordt de Homepage in een apart browser-venster geopend.
+
+&nbsp;
+
+**Menu 4. Navigeren(rechtsonder)**  
+![Building Blocks](../imgs/onboarding/3d-viewer.menu.rechtsonder.png){ width="360px" }
+
+Het menu bevat de volgende functies:   
+
+![Building Blocks](../imgs/onboarding/3d-viewer.rechtsonder.noordpijl.png){ align=left width="50px" }
+**Weergave naar noorden draaien**   
+Met de knop  wordt de kijkrichting automatisch naar het noorden gericht.   
+&nbsp;
+
+![Building Blocks](../imgs/onboarding/3d-viewer.rechtsonder.perspectief.png){ align=left width="50px" } 
+**Wissel tussen orthografisch/perspectief**   
+ Met de knop  wordt de kijkrichting automatisch gewijzigd in loodrecht naar beneden en zonder perspectief. Na het opnieuw indrukken wordt het beeld (terug) veranderd in de oorspronkelijke toestand. 
+&nbsp;
+
+![Building Blocks](../imgs/onboarding/3d-viewer.rechtsonder.minimap.png){ align=left width="260px" }  
+**Mini-map**   
+De minimap is de kleine versie van de map bij instellingen zie 2. Instellingen 
+Door met de muis over de minimap te bewegen wordt deze groter.  
+Door op een locatie in de minimap te klikken wordt in de 3D viewer bijbehorende locatie weergegeven. 
+
+Met de knoppen +/- kan worden in-/uitgezoomd.
+
+&nbsp;
+
+**Positie indicatie**   
+In de blauwe onderbalk van de viewer staan (rechts) de coördinaten van de positie van de viewer. 
+![Building Blocks](../imgs/onboarding/3d-viewer.positie.png){ width="360px" }  
+
+
+
+&nbsp;
+
+#### **2. 3D-viewer scherm** 
+Het scherm toont de locatie die in het instellingenmenu is ingevoerd of – als er geen invoer is gedaan - de default-locatie (centrum Amersfoort). Het beeld is in perspectief, onder een lichte hoek en vanaf een hoogte van 300 meter.
+
+**Bediening van het scherm**  
+Met behulp van de muis al dan niet in combinatie met muisknoppen en/of toetsenbordknoppen kan men door de 3D wereld in de viewer navigeren.  
+Dit kan op verschillende manieren; 
+
+[Scroll/Zoom] Door met het muiswiel te draaien kan de kijker naar voren of naar achteren bewegen in de kijkrichting. 
+
+[Panning] Door met de muis én de ingedrukte linkermuisknop over het scherm omhoog of omlaag of naar links of naar rechts te bewegen, kan de kijker zich resp. omhoog of omlaag of resp. naar links of naar rechts in de 3D wereld verplaatsen. 
+
+[Orbit 1] Door met de muis en de ingedrukte middelste muisknop over het scherm te bewegen, kan de kijker om het kijkpunt heen draaien. 
+Alternatief; Dit kan ook met de linkermuisknop in combinatie met de alt-toets. 
+
+[Orbit 2] Door met de muis en de ingedrukte linkermuisknop in combinatie met de ctrl-toets over het scherm te bewegen, kan de kijker de kijkhoek
diff --git a/docs/docs/onboarding/home.md b/docs/docs/onboarding/home.md
@@ -0,0 +1,56 @@
+# Home
+Versie:	0.02  
+Auteur:	Adrian Voogd   
+Datum:	22 november 2024  
+
+**Functie:**	Startpagina
+
+## Inleiding
+
+* De homepage is het portaal naar de verschillende hoofdstukken en functionaliteiten op Netherlands.eu. De hoofdstukken bevatten vooral informatie over Netherlands 3D en is onderverdeeld in de doelgroepen Organisaties (gebruikers) en Ontwikkelaars. 
+* Dit hoofdstuk beschrijft de belangrijkste functionaliteiten van de homepage en de gebruikersinterface.   
+
+## Overzicht van functionaliteiten
+
+* De homepage van Netherlands3d.eu biedt toegang tot de verschillende hoofdstukken en functionaliteiten. 
+
+## Gedetailleerde beschrijving van de functionaliteiten
+
+### **Hoofdmenubalk**
+
+![Building Blocks](../imgs/onboarding/hoofdmenubalk.png)
+
+* **Voor organisaties**   
+Dit hoofdstuk is onder ontwikkeling en bevat straks een uitgebreide bron van informatie. Het doel is om organisaties te ondersteunen met gidsen, best practices en antwoorden op veel gestelde vragen die essentieel zijn voor het gebruik van het Netherlands3D platform. 
+
+* **Voor ontwikkelaars**   
+Dit hoofdstuk bevat technische documentatie. Deze documentatie is bedoeld voor ontwikkelaars die willen begrijpen hoe het platform werkt, de architectuur willen verkennen en nieuwe modules of functionaliteiten willen bijdragen.
+
+* **Schermmodus**![Building Blocks](../imgs/onboarding/schermmodus.icon.png){ width="30" }   
+Door op dit icoon te klikken kan de interface kan de modus veranderd worden in * Dark; lichte tekst op een donkere achtergrond of * Light; donkere tekst op een lichte achtergrond. In de Dark modus gebruikt het systeem minder energie en hoeft het systeem in het geval van een laptop minder snel te worden opgeladen.
+
+![Building Blocks](../imgs/onboarding/schermmodus.png)
+Dark/Light modus
+
+* **Zoeken (invulvenster)**   
+Deze zoekfunctie biedt de mogelijkheid om naar trefwoorden te zoeken in Netherlands3D.eu. Bij gevonden zoektermen wordt een lijst met (klikbare) resultaten in de context (hoofdstuk en alinea) waar in het gevonden wordt getoond.
+
+
+###  **Headline**
+
+![Building Blocks](../imgs/onboarding/headliner.png)
+
+* **Bekijk de viewer**   
+Met de knop **Bekijk de viewer** in de headline wordt de 3D viewer functionaliteit (zie 3D viewer functionaliteit voor de beschrijving) gestart en verdwijnt de homepage. Met de knop **Wat is het?** wordt de tekst ’Wat is Netherlands3D?’ onder het overlay scherm naar boven gehaald.
+
+###  **Content**
+
+![Building Blocks](../imgs/onboarding/content.png)
+
+De content beschrijft wat Netherlands3D.eu is.
+
+### **Footer** 
+
+![Building Blocks](../imgs/onboarding/footer.png)
+
+Deze laag bevat de logo's van de bij Netherlds3D.eu betrokken provincies en de mogelijkheid om door de hoofdstukken van het hoofdmenu in de hoofdbalk te bladeren.