Fisheye: Tag 764eac20c00785d8ada89d292ef1348514b8a0f4 refers to a dead (removed) revision in file `doc/manual/chapters/ds_installation.tex'. Fisheye: No comparison available. Pass `N' to diff? Fisheye: Tag 764eac20c00785d8ada89d292ef1348514b8a0f4 refers to a dead (removed) revision in file `doc/manual/chapters/ds_overview.tex'. Fisheye: No comparison available. Pass `N' to diff? Index: doc/manual/chapters/rt_general.tex =================================================================== diff -u --- doc/manual/chapters/rt_general.tex (revision 0) +++ doc/manual/chapters/rt_general.tex (revision 764eac20c00785d8ada89d292ef1348514b8a0f4) @@ -0,0 +1,281 @@ +\svnid{$Id: rt_general.tex 41593 2015-08-30 15:39:28Z rodriqu_dd $} + +\chapter{Projecten, schermen en schermindeling} +\label{ch:general} + +In dit hoofdstuk wordt een overzicht gegeven van de algemene functionaliteit van Ringtoets. Na een korte introductie wordt in dit hoofdstuk allereerst aandacht besteed aan de projectstructuur die door RT wordt gebruikt. Vervolgens worden de hoofdfuncties van de gebruikersinterface uitgelegd voor alle type beschikbare vensters. Als laatste wordt aandacht besteed aan de mogelijkheden tot importeren en exporteren van data en resultaten. + +\section{Project structuur} + \label{sec:RT_Project_Structure} +RT werkt met een projectstructuur die weergegeven wordt in het \textbf{Project} toolvenster (zie paragraaf \ref{sec:RT_Project_Explorer}). Data en modellen kunnen aan het project worden toegevoegd op de volgende manieren: + +\begin{enumerate} + \item Klik op \textbf{New Folder}, \textbf{New Item} of \textbf{New Model} in de \textbf{Home} tab bovenaan het scherm, zoals weergegeven in figuur \ref{fig:rt_Add_Object}. + \item Rechtsklik in het \textbf{Project} toolvenster op de gewenste locatie en klik dan op \textbf{New Item...} of \textbf{New Folder}, zoals weergegeven in figuur \ref{fig:rt_Add_Object_Project_Explorer}. +\end{enumerate} + +\begin{figure}[H] + \centering + \includegraphics[width=1.0\textwidth]{figures/chapter_general/Home_Ribbon_Add_New_Model.png} + \caption{Voorbeeld van de Home tab met daarin onder het kopje Add de mogelijkheid tot het toevoegen van een object aan het project.} + \label{fig:rt_Add_Object} +\end{figure} +\begin{figure}[H] + \centering + \includegraphics{figures/chapter_general/rt_Add_Object_Project_Explorer.png} + \caption{Voorbeeld van het context menu dat naar voren komt bij rechts klikken op het project. Door op Add te klikken krijgt de gebruiker de mogelijkheid objecten aan het project toe te voegen.} + \label{fig:rt_Add_Object_Project_Explorer} +\end{figure} + +De objecten in een RT project zijn doorgaans afgeleid van een van de drie soorten zoals hieronder weergegeven (en nader omschreven): +\begin{itemize} +\item \textbf{Item} - Geeft data weer van een willekeurig type +\item \textbf{Model} - Geeft een model weer +\item \textbf{Folder} - Geeft een folder weer vergelijkbaar met een directory in het windows besturingssysteem +\end{itemize} + +\subsection{Item} +Een item kan willekeurige informatie bevatten. RT kent drie type items die altijd aanwezig zijn: +\begin{itemize} +\item Map (World) - Voegt een lege kaart toe aan het project +\item Text Document - Voegt een leeg tekst document toe aan het project +\item Web link - Voegt een weblink toe aan het project +\end{itemize} +Naast een item is er doorgaans ook een (document) venster beschikbaar om de inhoud van het item te bekijken en zo mogelijk aan te passen. In dat geval is het venster te openen door dubbel te klikken op het desbetreffende item in het \textbf{Project} toolvenster of via een klik met de rechter muisknop op het item in het project toolvenster en dan op \textit{Open}. + +\subsection{Model} +Een model is een rekenkern met bijbehorende invoer en uitvoer. Standaard heeft een model in DeltaShell dus ook een folder \textit{Input} en een folder \textit{Output}. In de input en output folders is er plaats voor items die de invoer en uitvoer beschrijven. Het laten rekenen van een model kan op verschillende manieren: +\begin{itemize} +\item Rechtsklik op het model in het \textbf{Project} toolvenster en dan klik op \textbf{Run Model} +\item Klik op \includegraphics{figures/chapter_general/Run_Arrow.png} (run) of \includegraphics{figures/chapter_general/RunAll_Arrow.png} (run All) in de \textbf{Home} tab van de ribbon (zie ook paragraaf \ref{sec:RT_Toolbar}) +\item Selecteer een model en druk op F9, of druk op Ctrl+F9 om alle modellen in het project te laten rekenen +\end{itemize} + +\subsection{Folder} +Een Folder in een RT project is vergelijkbaar met een map, folder of directory in het windows bestandssysteem. Een map kan worden gebruikt om gegevens (items en modellen) te ordenen en groeperen. Folders worden ook gebruikt in Modellen om input items en output items te groeperen. + +\section{Interface onderdelen} + \label{sec:DS:InterfaceOnderdelen} +Figuur \ref{fig:1_RT_Welcome_Page} geeft een overzicht van de interface, waarbij zoveel mogelijk schermen zichtbaar zijn gemaakt. Deze paragraaf bespreekt de aangegeven onderdelen. De gebruikersinterface is georganiseerd in een set van tool- en documentvensters. Deze kunnen naar wens worden gerangschikt en gepositioneerd in de interface. Daarnaast heeft de interface een quick access toolbar (1 in de figur) en ribbon (2 in de figuur) om het project, de data of de weergave te kunnen sturen of bewerken. Deze paragraaf geeft allereerst aandacht aan de mogelijkheden die de gebruiker heeft om het gebruik van de interface zo goed mogelijk aan te laten sluiten bij zijn eigen wensen. Daarna zullen alle toolvensters en document vensters kort worden toegelicht. Nummers in de beschrijving refereren naar de nummers in figuur \ref{fig:1_rt_Welcome_Page_Welcome_Page}. + +\subsection*{Toolvensters} +Toolvensters geven de eigenschappen van het huidig geselecteerde item weer. In RT zijn de volgende toolvensters beschikbaar: +\begin{itemize} +\item Project (3) +\item Map (4) +\item Chart (5) +\item Properties (6) +\item Messages (7) +\item Time Navigator (8) +\end{itemize} + +\subsection*{Document vensters} +Document vensters worden gebruikt voor het visualiseren en het bewerken van specifieke gegevenstypen. Ze worden geopend in het hoofdvenster (9) dat centraal staat na het opstarten van RT. Voorbeelden van document vensters zijn: +\begin{itemize} +\item Map(s) +\item Editors +\item Visualizers +\end{itemize} + +\begin{figure}[H] + \centering + \includegraphics[width=\textwidth]{figures/chapter_general/rt_Welcome.png} + \caption{De RT interface} + \label{fig:1_RT_Welcome_Page} +\end{figure} + +\subsection{Hoofdvenster} +Het hoofdscherm is de plek waar alle documentvensters die door de gebruiker zijn geopend (bijvoorbeeld kaarten en editors) bekeken en bewerkt kunnen worden. Het venster beschikt over een tabstructuur vergelijkbaar met tabs in een Excel document. De gebruiker kan door middel van de pijltjes rechtsboven door de tabs navigeren. Docking en het verplaatsen van vensters (zie paragraaf \ref{sec:RT_Docking}) maakt het mogelijk om op een overzichtelijke manier verschillende document vensters naast elkaar te gebruiken. + +\subsection{Docking en aanpassen van vensters} +\label{sec:RT_Docking} +De grafische gebruikersinterface kan eenvoudig aangepast worden aan persoonlijke voorkeuren door docking van vensters. Dit is mogelijk door een venster met de linker muisknop te slepen en los te laten links, rechts, boven of onder door middel van een hulpwijzer (zie figuur \ref{fig:3_Docking}). Dit kan gedaan worden met alle geopende tabs, maar ook met toolvensters. Er kan ook worden gekozen om een venster los van het hoofdscherm weer te geven (Floating). Wanneer een venster geopend is bevinden zich rechtsboven twee symbolen (zie ook figuur \ref{fig:3_Pin_UnPin}), waarmee: +\begin{itemize} +\item het venster op het scherm vastgezet kan worden of naar een tab verplaatst kan worden (de punaise) +\item het venster van het scherm verwijderd wordt en via de menubalk weer opgeroepen kan worden (het kruisje) +\end{itemize} + +Ook de grootte van de vensters is geheel naar eigen wens aan te passen door met de muis op de lichtgekleurde grens tussen twee vensters te gaan staan en vervolgens met de linker muisknop ingedrukt de grootte van een venster aan te passen. + +\begin{figure}[H] + \centering + \includegraphics[width=\textwidth]{figures/chapter_general/rt_Docking_explained.png} + \caption{Voorbeeld van de hulpwijzer voor docking van een toolvenster} + \label{fig:3_Docking} +\end{figure} + +\begin{figure}[H] + \centering + \includegraphics[width=\textwidth]{figures/chapter_general/rt_Pin_UnPin_Explained.png} + \caption{Uitleg van de mogelijkheden voor het vastzetten, verbergen of vergroten/verkleinen van een venster} + \label{fig:3_Pin_UnPin} +\end{figure} + +\subsection{Ribbon} + \label{sec:RT_Toolbar} +Aan de bovenkant van de interface bevindt zich een zogenaamed ribbon bar (nummer 2 in figuur \ref{fig:1_RT_Welcome_Page}). In de ribbon bieden knoppen functionaliteit aan voor bijvoorbeeld het gebruik in een document venster (zoals een kaart), of voor het doen van bewerkingen in het project (snelfuncties). De ribbon bar heeft verschillende tabs: + +\begin{itemize} + \item[Home] Dit is een algemene tab waar veel handige knoppen beschikbaar zijn die kunnen worden gebruikt bij het werken met een project (figuur \ref{fig:rt_Ribbon_Home}) + \item[View] Deze tab biedt de mogelijkheid om toolvensters weer zichtbaar te maken indien ze bijvoorbeeld door een klik op het kruisje zijn weggehaald (figuur \ref{fig:rt_Ribbon_View}) + \item[Chart] De Chart tab geeft de mogelijkheid tot het exporteren of aanpassen van de lettergrootte wanneer een grafiek zichtbaar is in een van de documentvensters (figuur \ref{fig:rt_Ribbon_Chart}) + \item[Map] Met behulp van deze tab kan een kaart worden aangepast aan de wensen van de gebruiker wanneer deze zichtbaar is in een van de documentvensters (figuur \ref{fig:RT_Ribbon_Map}) +\end{itemize} + +\begin{figure}[H] + \centering + \includegraphics[width=1.0\textwidth]{figures/chapter_general/rt_Home.png} + \caption{Overzicht van de beschikbare functies in de Home ribbon tab} + \label{fig:rt_Ribbon_Home} +\end{figure} + +\begin{figure}[H] + \centering + \includegraphics[width=1.0\textwidth]{figures/chapter_general/rt_View.png} + \caption{Overzicht van de beschikbare functies in de View ribbon tab} + \label{fig:rt_Ribbon_View} +\end{figure} + +\begin{figure}[H] + \centering + \includegraphics[width=1.0\textwidth]{figures/chapter_general/rt_Chart.png} + \caption{Overzicht van de beschikbare functies in de Chart ribbon tab} + \label{fig:rt_Ribbon_Chart} +\end{figure} + +\begin{figure}[H] + \centering + \includegraphics[width=1.0\textwidth]{figures/chapter_general/RT_Map.png} + \caption{Overzicht van de beschikbare functies in de Map ribbon tab} + \label{fig:RT_Ribbon_Map} +\end{figure} + +\subsection{Project} + \label{sec:RT_Project_Explorer} +Het \textbf{Project} toolvenster is het belangrijkste venster voor de navigatie door projectgegevens. In dit toolvenster zijn alle project componenten te zien in een boomstructuur (zie figuur \ref{fig:RT_Project_Explorer}). Binnen het venster kan het project geordend worden door het toevoegen van Folders (zie paragraaf \ref{sec:RT_Project_Structure}) en het slepen van items, of het gebruik van cut (Ctrl+X) en paste (Ctrl+V). Het project toolvenster kan worden verborgen of verwijderd, door gebruik te maken van de punaise of het kruisje rechts bovenaan (zie ook paragraaf \ref{sec:RT_Docking}). Na verwijdering kan het venster worden opgehaald door een muisklik op het de \textbf{Project} button in de \textbf{View} ribbon tab (zie ook figuur \ref{fig:RT_Ribbon_View}). Door te klikken op het pictogram linksboven in het project toolvenster wordt het actieve item in het hoofdvenster gelokaliseerd in de boomstructuur van het Project toolvenster. + +\begin{figure}[H] + \centering + \includegraphics{figures/chapter_general/Project_Explorer_RTData.png} + \caption{Voorbeeld van het Project toolvenster met een veel voorkomende RT project structuur} + \label{fig:RT_Project_Explorer} +\end{figure} + +Er bestaan verschillende mogelijkheden om de project structuur te bekijken of bewerken: +\begin{itemize} +\item linker muisklik om te selecteren +\item rechter muisklik geeft een menu met beschikbare acties +\item dubbelklik om document venster te tonen, afhankelijk van het item of model waarop geklikt is +\end{itemize} + +\subsection{Map} + \label{sec:RT_MapView} +RT biedt de mogelijkheid om een GIS kaart te bewerken. + +% TODO: Describe all buttons in the Map ribbon + +Het is mogelijk om een standaard achtergrondkaart in te stellen die wordt gebruikt overal waar een kaartlaag wordt getoond (zie paragraaf \ref{sec:RT_Map_Contents}). Dit kan de gebruiker doen door een nieuwe kaart toe te voegen aan het project (of een bestaande kaart op te zoeken in het \textbf{Project} toolvenster) en via het rechter muis menu (context menu) te kiezen voor "`Use as default background layer"'. Vervolgens wordt de kaart in het toolvenster dik gedrukt en wordt deze als achtergrondkaart toegevoegd overal waar een kaart wordt weergegeven. Het is ook mogelijk een standaard achtergrondkaart aan te maken via de setup wizard voor een RT workspace. + +\begin{figure}[H] + \centering + \includegraphics[width=0.85\textwidth]{figures/chapter_general/Map_With_MapContents.png} + \caption{Voorbeeld van een kaart met resultaten van het Coastal Development Model} + \label{fig:RT_Map} +\end{figure} + +\subsection{Map toolvenster} + \label{sec:RT_Map_Contents} +Indien een kaart (Map) actief is in het document venster (figuur \ref{fig:RT_Map}), kunnen de kaartlagen worden beheerd in het toolvenster \textbf{Map} (figuur \ref{fig:Map_Contents}). + +Met de vier pictogrammen linksboven in het map toolvenster kunnen nieuwe lagen worden toegevoegd of verwijderd op basis van bijvoorbeeld shapefiles (.shp) of TIFF bestanden (.tiff) met georeference. Daarnaast is het mogelijk om een laag op de kaart te exporteren naar een shapefile. Met de knoppen rechtsboven kan het venster worden verwijderd of verborgen. Het venster kan worden opgehaald door te klikken op menu item \textbf{Map} in de \textbf{View} ribbon (zie ook figuur \ref{fig:RT_Ribbon_View}). + +Elke laag kan (on)zichtbaar gemaakt worden door het te selecteren of deselecteren. Dit kan gedaan worden voor een laag als geheel, maar ook voor sublagen binnen een laag (indien deze sublagen bevat). Door te dubbelklikken op een laag, wordt de laag properties editor geopend met daarin symbolen, maten, kleuren, etc. Deze eigenschappen kunnen naar voorkeur worden aangepast. + +\begin{figure}[h!] + \centering + \includegraphics{figures/chapter_general/Map_Contents.png} + \caption{Voorbeeld van het Map toolvenster waarin verschillende kaartlagen worden getoond. In dit geval gaat het om de kaartlagen van het resultaat van een Momentary coastline model.} + \label{fig:Map_Contents} +\end{figure} + +Door op een laag rechts te klikken wordt een menu geopend dat de mogelijkheden weergeeft voor die laag (figuur \ref{fig:MapLayer_Context_Menu}). Hieronder vallen bijvoorbeeld: +\begin{itemize} +\item \textbf{Properties} - bewerk de styling van de laag. Hiermee kunnen de kleur(schaal) en weergave van de features op deze laag worden aangepast. Tevens is dit de plaats om labels aan of uit te zetten. +\item \textbf{Zoom to Extend} - zet het zoom niveau van de kaart dusdanig dat alle informatie van deze laag precies in het beeld past +\item \textbf{Show in legend} - laat deze laag in de legenda van de kaart zien +\item \textbf{Hide all layers but this one} - laat alleen deze laag op de kaart zien en zet de anderen uit +\end{itemize} + +\begin{figure}[h!] + \centering + \includegraphics{figures/chapter_general/rt_MapLayer_Context_Menu.png} + \caption{menu met mogelijkheden na het rechts klikken op een kaartlaag} + \label{fig:MapLayer_Context_Menu} +\end{figure} + +\subsection{Chart toolvenster} + \label{RT_Chart_Contents} +Indien een document venster een grafiek bevat laat het \textbf{Chart} toolvenster (figuur \ref{fig:3_Chart_Contents}) de afzonderlijk getekende lijnen en punten met hun eigenschappen zien. Door op een item in het toolvenster te klikken (selecteren) wordt in het \textbf{Properties} toolvenster de eigenschappen getoond. Deze kunnen worden bewerkt, zodat bijvoorbeeld het bereik van de assen kan worden veranderd, of kleuren en namen kunnen worden aangepast. Hierdoor is het mogelijk om de figuren met vaste assen te exporteren. Ook kunnen bepaalde lijnen of punten tijdelijk aan of uitgezet worden. In de huidige versie van RT is deze functie helaas nog niet voor de transect editor beschikbaar. + +\begin{figure}[H] + \centering + \includegraphics{figures/chapter_general/Chart_Contents.png} + \caption{Voorbeeld weergave van het Chart toolvenster} + \label{fig:3_Chart_Contents} +\end{figure} + +\subsection{Properties} +Wanneer een element in de interface is geselecteerd (bijvoorbeeld in het project toolvenster of bijvoorbeeld op een kaart, resultaat grafiek of in het chart tool venster) worden de eigenschappen van dit element weergegeven in het properties toolvenster. Naast het geven van een overzicht van de eigenschappen van een geselecteerd element, wordt het properties venster ook gebruikt voor het bewerken van de getoonde eigenschappen. + +\subsection{Time Navigator} + \label{sec:TimeSeriesNavigator} +De time navigator wordt gebruikt om te navigeren door tijd(stappen) van een tijdsafhankelijke variabele. Elk scherm dat tijdsafhankelijke informatie toont heeft zijn eigen time navigator. Hiermee is er de mogelijkheid om te navigeren door de tijd. Deze tijdnavigatie kan twee vormen aannemen: +\begin{itemize} +\item Enkele tijdsindicatie. In dit geval heeft de tijdnavigatie balk een verticale lijn die de positie in de tijd aangeeft. In dit geval wordt slechts een tijdstip weergegeven en wel het tijdstip links van de genoemde lijn (zie figuur \ref{fig:TimeSeriesNavigator}). +\item Tijd range (figuur \ref{fig:TimeSeriesNavigator_Range}). In dit geval heeft de navigatie balk een rechthoek die begin en eind tijdstip aangeeft. In dit geval worden alle gegevens tussen het begin en eind tijdstip weergegeven. +\end{itemize} + +\begin{figure}[H] + \centering + \includegraphics[width=\textwidth]{figures/chapter_general/TimeSeriesNavigator.png} + \caption{Time Navigator met enkele tijdsindicatie} + \label{fig:TimeSeriesNavigator} +\end{figure} +\begin{figure}[H] + \centering + \includegraphics[width=\textwidth]{figures/chapter_general/TimeSeriesNavigator_Range.png} + \caption{Time Navigator met tijdrange weergave} + \label{fig:TimeSeriesNavigator_Range} +\end{figure} + +\subsection{Messages} + \label{sec:RT_Messages} +Het message venster is een logging venster. Berichten verstuurd uit modellen of verschillende delen van het systeem worden hier chronologisch getoond. Afhankelijk van de inhoud van het bericht worden deze weergegeven met een icoon (zie voor een verklaring van de iconen tabel \ref{table:message_icons}). Indien het venster wordt gesloten en weer geopend (zie paragraaf \ref{sec:RT_Docking}) worden alleen nieuwe berichten getoond. Oudere berichten worden op twee plaatsen opgeslagen: +\begin{enumerate} +\item Een run rapport wordt getoond in de output folder van het Project toolvenster voor elke modelberekening. Dit run rapport bevat alle berichten die zich voordoen tijdens de berekening. +\item Daarnaast word een applicatie log bijgehouden voor elke sessie (van opstarten tot afsluiten) van RT in de project database. In deze log-file worden alle berichten opgeslagen die zich tijdens de sessie voordoen. De applicatie log kan ten alle tijden worden opgevraagd door in de \textbf{Home} ribbon op de knop \textbf{Show Log} te klikken. +\end{enumerate} + +\begin{table}[H] +\caption{Bericht types} +\centering +\begin{tabular}{| c | l |} +\hline +\STRUT{\bf Icoon} & {\bf Bericht type}\\ [1ex] +\hline +\rule{0in}{4ex} \includegraphics{figures/chapter_general/Message_Icon_Info.png} & Informatie \\ +\hline +\rule{0in}{4ex} +\includegraphics{figures/chapter_general/Message_Icon_Warning.png} & Waarschuwing \\ +\hline +\rule{0in}{4ex} +\includegraphics{figures/chapter_general/Message_Icon_Error.png} & Error \\ +\hline +\end{tabular} +\label{table:message_icons} +\end{table} + +\section {Import \ Export} +Indien voor een item in het \textbf{Project} toolvenster een zogenaamde exporter of importer is gedefinieerd, is het in RT mogelijk om gegevens te exporteren of importeren via het menu onder de rechter muisknop. Kies hiervoor \textbf{Export...} of \textbf{Import...}. Indien een plugin of het framework zelf een exporter of importer voor het geklikte item is aangeboden kan deze worden gebuikt. In sommige gevallen zijn er meerdere manieren om items te exporteren (bijvoorbeeld berekeningsresultaten kunnen als figuur worden ge"exporteerd, maar ook naar het csv format dat in Excel leesbaar is). + +RT definieert voor alle berekeningsresultaten een exporter die de resultaten wegschrijft als csv file. Dit format is eenvoudig in Microsoft Excel in te lezen. Let er op dat als scheidingsteken voor de verschillende cellen een "';"' wordt gebruikt en dat in alle gevallen een "'."' de scheiding tussen gehele getallen en de decimalen aangeeft. Zie ook paragraaf \ref{sec:General_Export_Output}. \ No newline at end of file Index: doc/manual/chapters/rt_guide.tex =================================================================== diff -u --- doc/manual/chapters/rt_guide.tex (revision 0) +++ doc/manual/chapters/rt_guide.tex (revision 764eac20c00785d8ada89d292ef1348514b8a0f4) @@ -0,0 +1,26 @@ +\svnid{$Id: rt_guide.tex 1 2015-08-30 15:39:28Z rodriqu_dd $} + +\chapter{Introductie\label{chap:guide}} + +\section{Inleiding} +Deze handleiding betreft de Ringtoets applicatie (RT). + +\section{Overzicht} +Om de toegankelijkheid van deze handleiding te bevorderen, wordt er een overzicht van alle onderdelen ge\"{i}ntroduceerd. + +\Autoref{chap:rt_overview}: \nameref{chap:rt_overview}, gives a brief introduction to all GUI-components, which are shared between fail mechanisms based on the framework. + +\section{Versie informatie} +Productinformatie is op te vragen via Menu | Info. Via de Support organisatie kan het versienummer +vergeleken worden met de vigerende versie. De productinformatie heeft de support +organisatie ook nodig om te controleren welke modules er in de gebruikte Ringtoets versie +zijn geïnstalleerd en u van de juiste ondersteuning te voorzien. De productinformatie geeft +tevens toegang tot de gebruiksvoorwaarden (disclaimer) van het product. + +\section{Typographical conventions} +Throughout this manual, the following conventions help you to distinguish between different +elements of text. +\input{common/typographical_conventions} + +\section{Changes with respect to previous versions} +This is the first edition. \ No newline at end of file Index: doc/manual/chapters/rt_installation.tex =================================================================== diff -u --- doc/manual/chapters/rt_installation.tex (revision 0) +++ doc/manual/chapters/rt_installation.tex (revision 764eac20c00785d8ada89d292ef1348514b8a0f4) @@ -0,0 +1,91 @@ +\svnid{$Id: rt_guide.tex 1 2015-08-30 15:39:28Z rodriqu_dd $} + +\chapter{Installatie\label{chap:install}} + +\section{Inleiding} +Deze sectie beschrijft de installatie procedure van de applicatie Ringtoets. Hiervoor is in ieder geval het installatie bestand (Ringtoets Setup*.msi) nodig. Daarnaast worden er enkele eisen aan het besturingssysteem gesteld (zie \Autoref{sec:sysrequirements}). + +\section{Systeemeisen} +\label{sec:sysrequirements} +Voor een goed functioneren van RT is het wenselijk (of in sommige gevallen nodig) om een computer te hebben die minimaal voldoet aan de volgende eisen: +\begin{itemize} + \item Microsoft Windows 7 hoger + \item Microsoft .NET Framework versie 4.0 of hoger + \item Minimaal een Intel Pentium III/800 MHz processor (of vergelijkbaar) + \item Minimaal 256(???) MB RAM (1 GB RAM aanbevolen) + \item Minimale beeldscherm resolutie van 1024x768 pixels +\end{itemize} + + + + +\section{RT installeren en opstarten} +\label{sec:rtinstall} +De installatie procedure wordt opgestart door op de snelkoppeling dubbel te klikken. Op bijna elke stap kan de procedure voortgezet worden door te drukken op \textit{Volgende}. De eerdere stap van de procedure kan bereikt worden door te klikken op \textit{Vorige}. Door op \textit{Annuleren} te klikken, kan de installatie onderbroken worden. + +Er zijn drie type installaties: +\begin{itemize} + \item \textbf{Standaard}: de meest gebruikte onderdelen van het programma worden ge\"installeerd. Het programma wordt ge\"installeerd in de map + + \dir{C:\textbackslash Program Files (x86)\textbackslash Deltares\textbackslash Wettelijk Toets Instrumentarium (\color[rgb]{0.75,0.75,0.75}versienummer\color[rgb]{0,0,0})}. + + Dit is de aanbevolen optie voor de meeste gebruikers. + \item \textbf{Aangepast}: de te installeren onderdelen en de map waarin het programma zal ge\"installeerd worden, kunnen geselecteerd worden. Door deze optie te kiezen, kan het ook gecontroleerd worden hoe veel ruimte de installatie in beslag zal nemen, en hoe veel ruimte beschikbaar is in de beschikbare volumes. + \item \textbf{Volledig}: alle onderdelen van het programma worden ge\"installeerd. Het programma wordt ge\"installeerd in de map + + \dir{C:\textbackslash Program Files (x86)\textbackslash Deltares\textbackslash Wettelijk Toets Instrumentarium (\color[rgb]{0.75,0.75,0.75}versienummer\color[rgb]{0,0,0})}. +\end{itemize} + +Op het moment dat de de installatietype gekozen is, wordt deze daadwerkelijk uitgevoerd door op \textit{Installeren} te klikken. De voortgang van de installatie wordt aangegeven totdat hij klaar is. Op dat moment wordt de installatie procedure volledig afgerond door op \textit{Voltooien} te klikken. + + +Als het installatiebestand opgestart wordt nadat het programma ge\"installeerd is, kan de installatie aangepast worden. De mogelijke aanpassingen zijn: +\begin{itemize} + \item \textbf{Wijzigen}: hiermee kan men opnieuw aangegeven worden welke onderdelen van het programma ge\"installeerd zullen zijn. + \item \textbf{Herstellen}: deze optie herstelt de ontbrekende of beschadigde bestanden, snelkoppelingen en registervermeldingen van de huidige installatie. + \item \textbf{Verwijderen}: de installatie van het Wettelijk Toets Instrumentarium wordt volledig verwijderd van de computer door deze optie te kiezen. +\end{itemize} + +Na installatie (\Autoref{sec:rtinstall}) kan Ringtoets worden opgestart via het startmenu (onder de map Deltares) of door op het bijbehorende icoontje (\Fref{fig:fig2.1}) op het bureaublad dubbel te klikken. + + +\begin{figure} [H] + \centering + \includegraphics{figures/chapter_installation/rt_desktop_icon} + \caption{Ringtoets snelkoppelingsicoon op het bureaublad.} + \label{fig:fig2.1} +\end{figure} + +Er wordt ook een snelkoppeling aangemaakt in het startmenu van Windows. Deze is te vinden in Startmenu $\,\to\,$ Alle programma's $\,\to\,$ Deltares $\,\to\,$ Ringtoets $\,\to\,$ Ringtoets: + + +\begin{figure} [H] + \centering + \includegraphics{figures/chapter_installation/rtInAllPrograms} + \caption{Ringtoets in de startmenustructuur van Windows \color[rgb]{1,0,0} \textbf{Needs to be updated!!!}\color[rgb]{0,0,0}.} + \label{fig:fig2.2} +\end{figure} + + +Kort nadat het programma ge\"instaleersd is, is deze snelkoppeling direct te vinden onder het startmenu: + + +\begin{figure} [H] + \centering + \includegraphics{figures/chapter_installation/rtDirectlyinStartMenu} + \caption{Ringtoets direct in het startmenu van Windows \color[rgb]{1,0,0} \textbf{Needs to be updated!!!}\color[rgb]{0,0,0}.} + \label{fig:fig2.3} +\end{figure} + + + + + + + + + + + + + Index: doc/manual/chapters/rt_overview.tex =================================================================== diff -u --- doc/manual/chapters/rt_overview.tex (revision 0) +++ doc/manual/chapters/rt_overview.tex (revision 764eac20c00785d8ada89d292ef1348514b8a0f4) @@ -0,0 +1,258 @@ +\svnid{$Id: rt_overview.tex 1 2015-10-01 14:54:12Z rodriqu_dd $} + +\chapter{General overview of the GUI} +\label{chap:rt_overview} + +This chapter introduces all GUI-components, which are shared between applications based on the framework. +% +\section{Windows} +\label{sec:windows} +As DeltaShell is an integrated modelling suite, the application is project-based. Within a project several models may be run and combined. + +The main user interface is organized in a set of tool and document windows. An example is given in \Fref{fig:fig3.1}. The tool windows show properties of the current project, whereas document windows are used to visualize or edit a specific data type. Tool windows can be docked where you prefer --- even at a second display. Document windows are, when placed within the framework, always in the central area but may also be docked stand-alone (on a second display, for example). Examples of tool windows are: +% +\begin{itemize} + \item \window{Project} + \item \window{Map} + \item \window{Properties} + \item \window{Chart} + \item \window{Messages} +\end{itemize} +% +Examples of document windows are: +% +\begin{itemize} + \item Map(s) + \item Editor(s) +\end{itemize} +% +\begin{figure} [H] + \centering + \includegraphics[width=\textwidth]{figures/chapter_overview/overview_ds} + \caption{Overview of the graphical user interface, example for a SOBEK3 model.} + \label{fig:fig3.1} +\end{figure} +% +In this chapter all tool windows, menus, dockable views, context menus, and ribbons and toolbars will be described. Map functionality and the spatial editor are treated in separate chapters. The specific editors for the different models are described in the user manuals belonging to those model plug-ins. + +\subsection{Project} +\label{subsec:project} +The \window{Project} window is the main navigation window for the project data, showing the total workspace in a tree view (\Fref{fig:fig2.2}). In the \window{Project} all project components are shown. +% +All project items with sub-levels can be collapsed by a mouse-click on the `$-$' sign in the tree view. Project data can be sorted by adding new folders to the project tree view and moving models or movable items to designated folders. +% +By clicking on the top left icon in \Fref{fig:fig2.2} the active item in the central Map is located in the tree view. +% +\begin{figure} [H] + \centering + \includegraphics[width=0.5\textwidth]{figures/chapter_overview/view_project_window.png} + \caption{The project tree window.} + \label{fig:fig2.2} +\end{figure} +% +Several possibilities exist to work with the tree view: +% +\begin{itemize} + \item Left mouse-click to select + \item Right mouse-click gives a context menu with available actions + \item Double-click to show a map or editor in the main (central) window, depending on the parameter +\end{itemize} +% +\subsection{Main (central) window} +\label{subsec:Main} +The main window (\Fref{fig:fig2.3}) is by default always placed in the middle of the screen. It can also be docked separately, for example on a second display. It is used to present a map for all geo-referenced modeldata, the editors for other data, and results in charts. The editors for other data are model-specific and therefore described in the manuals for the various model plug-ins. + +All items with a geo-reference will be presented on the central map, for example: network, computational grid and output data as layers, comparable to a geographical information system (GIS). Working with these layers is described in \Cref{ssec:Map layers}. +% +\begin{figure} [H] + \centering + \includegraphics[width=\textwidth]{figures/chapter_overview/example_map.png} + \caption{The central map view.} + \label{fig:fig2.3} +\end{figure} +When working in the central map, for example on a network, it is possible to add, adjust or delete network components, which is described thoroughly in the dflow manual. + +Results in charts windows (\Fref{fig:chartwindow}) are presented by combining a table view and a '$xy$'-plot. The user can visualize separate data points by selecting rows in the table view. The data that is presented in the chart window may also be exported to a *.csv file by clicking the \button{Csv export} button. +% +\begin{figure} [H] + \centering + \includegraphics[width=\textwidth]{figures/chapter_overview/example_chart_window.png} + \caption{The chart window view.} + \label{fig:chartwindow} +\end{figure} + +\subsection{Map} +\label{subsec:Map} +The \window{Map} window (\Fref{fig:fig2.4}) manages the active map. In this window layers within the active map can be shown, hidden or adjusted. +% +With the four icons in the top left of the window new \ext{shp}- or \ext{wms}-layers can be added, removed or exported. With the icons in the top right of the window, the window can be removed or hidden. The window can be retrieved by clicking on \button{Map} in \menu{View} ribbon. +% +\begin{figure} [H] + \centering + \includegraphics[width=0.5\textwidth]{figures/chapter_overview/view_map_window.png} + \caption{The map window.} + \label{fig:fig2.4} +\end{figure} + +\subsection{Data} +\label{subsec:data} +The \window{Data} window (\Fref{fig:datawindow}) can be used to inspect the contents of available data items, when selected in the project window. +% +\begin{figure} [H] + \centering + \includegraphics[width=0.5\textwidth]{figures/chapter_overview/view_data_window.png} + \caption{The data window.} + \label{fig:datawindow} +\end{figure} + +\subsection{Chart} +\label{subsec:chart} +The \window{Chart} window (\Fref{fig:chartwindow}) can be used to stack/unstack chart series of the same type or to convert chart series to a certain type (area, line, point, or bar series), Furthermore, series can be selected or deselected within this window. + +\begin{figure} [H] + \centering + \includegraphics[width=0.5\textwidth]{figures/chapter_overview/view_chart_window.png} + \caption{Example of the chart window.} + \label{fig:chartwindow} +\end{figure} +% +\subsection{Properties} +\label{subsec:properties} +% +The \window{Properties} window shows properties for an active selection of the graphical user interface. When a model object is selected in the \window{Region} window it shows the properties of this object. Accordingly, the \window{Properties} window of an item selected in the \window{Project} shows data related to the selected item, for example the simulation time of a \dir{flow model} or a list with output parameters when clicking on the \dir{output} entry. \Fref{fig:fig2.6} shows an example for the properties of a flow model. + +In the \window{Properties Window} data can also be edited. If the property grid is insufficient to display the information, for example in case of time series, an additional editor can be opened. +% +\begin{figure} [H] + \centering + \includegraphics[width=0.5\textwidth]{figures/chapter_overview/view_properties_window.png} + \caption{Example of a property grid in the properties window of a flow model.} + \label{fig:fig2.6} +\end{figure} +% +\subsection{Messages} +\label{subsec:messages} +% +The \window{Messages} window (\Fref{fig:messageswindow}) is a logging window. Messages sent from models or different parts of the system are shown here. When a message is too large to fit within the \window{Messages} the user can open a single message (\Fref{fig:messagedetailwindow}) separately by right-mouse-clicking the message and selecting the 'Show details' option. +% +\begin{figure} [H] + \centering + \includegraphics[width=\textwidth]{figures/chapter_overview/view_messages_window.png} + \caption{The messages window.} + \label{fig:messageswindow} +\end{figure} +% +\begin{figure} [H] + \centering + \includegraphics[width=0.5\textwidth]{figures/chapter_overview/view_messagedetails_window.png} + \caption{The message detail window.} + \label{fig:messagedetailwindow} +\end{figure} + +Within the \window{Messages} window the user may select the verbosity of the shown messages, ranging from 'Info messages' to 'Warning messages' to 'Error messages'. It is also possible to clear all messages by clicking \includegraphics[height=5mm]{figures/chapter_overview/icon_clear_all_messages}. + +Furthermore, a run report is shown in the output in the \window{Project} for each model simulation. This run report contains all the messages (from DeltaShell and the model plug-ins) that occur during a simulation. + +Finally, an application log is kept for each session of DeltaShell in the project database. In this log-file, which can be accessed through the \menu{File/Help} or \menu{Home} menus, all messages are stored. + +% include section: Dockable views, which is also used in other separate User manuals +\input{chapters/section_dockableviews} + +\section{Context menus} +\label{sec:contextmenus} +Depending on the active window, different context menus are present when right-mouse-clicking on items within this window. This section will treat these context menus per active window. +% +\subsection{Project} +\label{subsec:project} +Within the \window{Project} window, a variety of levels and/or items with different context menus are present. These will be described here. +\subsubsection{Project level} +\label{subsubsec:projectlevel} +The context menu of the project level within the project explorer is shown in \Fref{fig:contextmenuproject}. It contains the following choices: +% +\begin{figure} [H] + \centering + \includegraphics[width=0.5\textwidth]{figures/chapter_overview/context_menu_project.png} + \caption{The context menu on the project level within the project explorer.} + \label{fig:contextmenuproject} +\end{figure} +\begin{itemize} + \item \button{Add} $\Rightarrow$ Option to add models and/or items to project (depending on installed model plug-ins) + \item \button{Import \dots} $\Rightarrow$ Opens selection window for a variety of available importers (if present) + \item \button{Export \dots} $\Rightarrow$ Opens selection window for a variety of available exporters (if present) + \item \button{Cut} $\Rightarrow$ Cuts current project for pasting elsewhere + \item \button{Copy} $\Rightarrow$ Copies current project for pasting elsewhere + \item \button{Paste} $\Rightarrow$ Pastes current project available on the clipboard + \item \button{Rename} $\Rightarrow$ Rename the current project + \item \button{Run All Models} $\Rightarrow$ Runs all models available in the project + \item \button{Stop All Models} $\Rightarrow$ Stops running of all models currently running within the project + \item \button{Clear All Models Output} $\Rightarrow$ Clears all model output of models available within the project + \item \button{Expand All \dots} $\Rightarrow$ Expands all project items + \item \button{Collapse All \dots} $\Rightarrow$ Collapses all project items + \item \button{Properties} $\Rightarrow$ Switches to \window{Properties} window of active project +\end{itemize} +\subsubsection{Other level still to come} +\label{subsubsec:otherLevel1} +The context menu of \ldots +% +\subsubsection{Other items} +\label{subsubsec:otheritems} +For the other items in the project explorer the following holds: +\begin{itemize} + \item Folder items have the same context menu as the project level context menu depicted in \Fref{fig:contextmenuproject}. + \item All other project items have context menus similar to the context menu on the region level as shown in \Fref{fig:contextmenuregion} +\end{itemize} + +\subsection{Main (Central Map window)} +\label{subsec:centralmap} +The \window{Main} or \window{Central Map} window may consist of multiple tabs \ldots + +\subsubsection{Table editor} +\label{subsubsec:tableeditor} +The context menu of the table editors within the \window{Main} window as shown in \Fref{fig:contextmenutable} contains the following choices: +% +\begin{figure} [H] + \centering + \includegraphics[width=0.4\textwidth]{figures/chapter_overview/context_menu_table.png} + \caption{The context menu of the table editor.} + \label{fig:contextmenutable} +\end{figure} +\begin{itemize} + \item \button{Copy} + \item \button{Paste} + \item \button{Delete} +\end{itemize} +\subsubsection{Charts} +\label{subsubsec:charts} +The context menu of the charts within the \window{Main} window as shown in \Fref{fig:contextmenuchart} contains the following choice: +% +\begin{figure} [H] + \centering + \includegraphics[width=0.8\textwidth]{figures/chapter_overview/context_menu_chart.png} + \caption{The context menu of the chart view.} + \label{fig:contextmenuchart} +\end{figure} +\begin{itemize} + \item \button{Export as Image \dots} +\end{itemize} +\subsection{Map} +\label{subsec:map} +The context menus for the \window{Map} window are described in \Cref{chapter:map}. +% +\subsection{Messages} +\label{subsec:messages2} +The context menu for the \window{Messages} window as shown in \Fref{fig:contextmenumessages} contains the following choices: +% +\begin{figure} [H] + \centering + \includegraphics[width=\textwidth]{figures/chapter_overview/context_menu_messages.png} + \caption{The context menu for the \window{Messages} window.} + \label{fig:contextmenumessages} +\end{figure} +\begin{itemize} + \item \button{Copy} + \item \button{Show details} $\Rightarrow$ Open separate window with detailed message information + \item \button{Clear all} +\end{itemize} + +% include section: Ribbons and toolbars, which is also used in other separate User manuals +\input{chapters/section_ribbons} \ No newline at end of file Index: doc/manual/chapters/rt_piping.tex =================================================================== diff -u --- doc/manual/chapters/rt_piping.tex (revision 0) +++ doc/manual/chapters/rt_piping.tex (revision 764eac20c00785d8ada89d292ef1348514b8a0f4) @@ -0,0 +1,109 @@ +\svnid{$Id: rt_guide.tex 1 2015-08-30 15:39:28Z rodriqu_dd $} + +\chapter{Piping\label{chap:piping}} + +\section{Inleiding} +Dit hoofdstuk beschrijft de procedure om een piping berekening op te zetten en uit te voeren. + +\section{Toevoegen van een piping faalmechanisme} +\label{sec:addpiping} +Om een piping berekening uit te voeren, moet er allereerst een RT project aangemaakt zijn in het algemeen project. Een RT project wordt toegevoegd in het \textbf{Project} toolvenster. Door op het project met de rechter muisknop te klikken, en dan door voor de opties \textit{New} en vervolgens \textit{Item} te kiezen. + +\begin{figure} [H] + \centering + \includegraphics{figures/chapter_piping/addNewProject} + \caption{Nieuw item toevoegen.} + \label{fig:fig5.1} +\end{figure} + +In de dialoog die dan te zien is, moet er gekozen worden voor een RT project: + +\begin{figure} [H] + \centering + \includegraphics{figures/chapter_piping/selectRTProject} + \caption{Nieuw toe te voegen item is RT project.} + \label{fig:fig5.2} +\end{figure} + +Door gebruik te maken van het contextmenu van het RT project, kan er uiteindelijk een piping faalmechanisme toegevoegd worden. + +\begin{figure} [H] + \centering + \includegraphics{figures/chapter_piping/addPipingMechanismToProject} + \caption{Toevoeging van faalmechanisme Piping aan RT project.} + \label{fig:fig5.3} +\end{figure} + + +\section{Opbouw van het faalmechanisme} + +\begin{figure} [H] + \centering + %\includegraphics{figures/chapter_piping/OpbouwFaalmechanisme} + \caption{Opbouw van het faalmechanisme} + \label{fig:fig5.4} +\end{figure} + +Het faalmechanisme kent 3 onderdelen: +\begin{enumerate} +\item \textbf{Ondergrondprofielen}. Door gebruik te maken van het contextmenu kan een .soil database met de stochastische schematisatie van de +ondergrond (SOS database) worden ge\"{i}mporteerd. +\item \textbf{Dwarsdoorsneden}. Door gebruik te maken van het contextmenu kan een .soil database met de stochastische schematisatie van de +ondergrond (SOS database) worden ge\"{i}mporteerd. +\item \textbf{Piping}. In het \textbf{Properties} venster kunnen de piping varaiabelen worden aangepast: +\begin{figure} [H] + \centering + %\includegraphics{figures/chapter_piping/PipingProperties} + \caption{Aan te passen piping variabelen} + \label{fig:fig5.5} +\end{figure} + \begin{itemize} + \item \textbf{Naam}: Naam van de berekening, door de gebruiker te wijzigen + \item \textbf{Volumiek gewicht van water}: Het volumegewicht $\gamma$ \textsubscript{water} is ca. 10 kN/m\textsuperscript{3} + \item \textbf{Modelfactor opbarsten}: Rekenwaarde van de modelonzekerheid + \item \textbf{Toetspeil}: Het door HydraRing berekende toetspeil voor dit dijkvak + \item \textbf{Stijghoogte bij uittredepunt}: + \item \textbf{Dempingsfactor bij uittredepunt}: Stochast; Relateert respons van stijghoogte bij binnenteen aan buitenwaterstand + \item \textbf{Freatische waterstand bij uittredepunt}: Stochast; + \item \textbf{Stijghoogte in achterland}: + \item \textbf{Kritiek verhang m.b.t. heave}: Stochast; + \item \textbf{Totale deklaagdikte bij uittredepunt}: Stohast; Dikte van de laag boven de aquifer tot aan maaiveld of onderkant sloot + \item \textbf{Modelfactor piping toegepast op Sellmeijermodel}: Rekenwaarde van de modelonzekerheid + \item \textbf{Reductiefactor Sellmeijer}: + \item \textbf{Kwelweglengte}: De horizontale afstand tussen intrede- en uittredepunt die het kwelwater in de aquifer aflegt + \item \textbf{Volumiek gewicht van de zandkorrels onder water}: Stochast; Het (ondergedompelde) volumegewicht van de korrels in de zandlaag. + \item \textbf{Co\"{e}ffici\"{e}nt van White}: Sleepkrachtfactor volgens White + \item \textbf{70\%-fraktiel van de korreldiameter in de bovenste zandlaag}: Stochast; Zeefmaat waar 70 gewichtsprocent van de korrels doorheen gaat. Hier de korreldiameter van het bovenste gedeelte van de aquifer, zonder de fijne fractie (<63$\mu$ meter) + \item \textbf{Doorlatendheid aquifer}: Stochast; Darcy-snelheid waarmee water door de eerste zandlaag stroomt + \item \textbf{Kinematische viscositeit van water bij 10\textsuperscript{$\circ$} Celsius}: + \item \textbf{Valversnelling}: Versnelling van de zwaartekracht [m/s\textsuperscript{2}] $\approx$ 9.81 + \item \textbf{Dikte watervoerend pakket}: Stochast; De dikte van de zandlaag die als aquifer is benoemd + \item \textbf{Referentiewaarde voor 70\%-fraktiel in Sellmeijer regel}: Gemiddelde d70 van de in kleine schaalproeven toegepaste zandsoorten waarop de formule van Sellmeijer is gefit = 0.000208 meter + \item \textbf{Rolweerstandshoek}: Hoek in het krachtenevenwicht die aangeeft hoeveel de korrels weerstand beiden tegen rollen; ook beddingshoek genoemd + \begin{figure} [H] + \centering + %\includegraphics{figures/chapter_piping/PipingSurfacelines} + \caption{Keuzemenu dwarsdoorsneden} + \label{fig:fig5.6} +\end{figure} + \item \textbf{Dwarsdoorsnede}: Keuzemenu om de dwarsdoorsnede die voor de pipingsom wordt gebruikt te selecteren die zijn opgehaald in het \textbf{Project} venster + \item \textbf{Ondergrondprofiel}: Keuzemenu om het ondergrondprofiel die voor de pipingsom wordt gebruikt te selecteren die zijn opgehaald in het \textbf{Project} venster + \end{itemize} + +\end{enumerate} + + + + + + + + +Als alle invoergegevens voor een piping faalmechanisme berekening klaar zijn, kan deze uitgevoerd worden door op Berekenen te klikken in het contextmenu. + +Als de berekening niet uitgevoerd kan worden, dan komt er een bericht terecht in het berichtpanel met verdere informatie over de reden dat het fout is gegaan. Als de berekening wel uitgevoerd is, is het resultaat toegevoegd (of ge\"{u}pdatet) in het projectpanel. + + + + + Index: doc/manual/chapters/section_ribbons.tex =================================================================== diff -u -r8400da3ec38a51c99add5df59dbc067c70b24653 -r764eac20c00785d8ada89d292ef1348514b8a0f4 --- doc/manual/chapters/section_ribbons.tex (.../section_ribbons.tex) (revision 8400da3ec38a51c99add5df59dbc067c70b24653) +++ doc/manual/chapters/section_ribbons.tex (.../section_ribbons.tex) (revision 764eac20c00785d8ada89d292ef1348514b8a0f4) @@ -8,15 +8,15 @@ %------------------------------------------------------------------------------- \subsection{Ribbons (hot keys)}\label{subsec:gettingstarted_ribons} -WTI Ringtoets makes use of ribbons, just like Microsoft Office. You can use these ribbons for most of the operations. +RT Ringtoets makes use of ribbons, just like Microsoft Office. You can use these ribbons for most of the operations. With the ribbons comes hot key functionality, providing shortcuts to perform operations. If you press ``ALT'', you will see the letters and numbers to access the ribbons and the ribbon contents (i.e.\ operations). For example, ``ALT'' + ``H'' will lead you to the ``Home''-ribbon (\Fref{fig:ribbonhotkey}). \textbf{\Note Implementation of the hot key functionality is still work in progress.} \begin{figure}[H] \centering - \includegraphics{figures/chapter_overview/ds_ribbon_hotkey.png} + \includegraphics{figures/chapter_overview/rt_ribbon_hotkey.png} \caption{Perform operations using the hot keys} \label{fig:ribbonhotkey} \end{figure} @@ -34,7 +34,7 @@ % \begin{figure} [H] \centering - \includegraphics[width=\textwidth]{figures/chapter_overview/ds_options.png} + \includegraphics[width=\textwidth]{figures/chapter_overview/rt_options.png} \caption{The options dialog.} \label{fig:dsoptions} \end{figure} Index: doc/manual/common/typographical_conventions.tex =================================================================== diff -u -r84a2fdb7cdf2f1d1eb254bdced7f04c6ce51f3dd -r764eac20c00785d8ada89d292ef1348514b8a0f4 --- doc/manual/common/typographical_conventions.tex (.../typographical_conventions.tex) (revision 84a2fdb7cdf2f1d1eb254bdced7f04c6ce51f3dd) +++ doc/manual/common/typographical_conventions.tex (.../typographical_conventions.tex) (revision 764eac20c00785d8ada89d292ef1348514b8a0f4) @@ -19,7 +19,7 @@ \ginput{27 08 1999} \STRUT & Data to be typed by you into the input fields are displayed between double quotes.\newline Selections of menu items, option boxes etc.\ are described as such: for instance `select \menu{Save} and go to the next window'. \\ [1ex] \hline -\command{wti-menu} \STRUT & +\command{rt-menu} \STRUT & Commands to be typed by you are given in the font Courier New, 10 points. \\ [1ex] \hline \includegraphics[height=4mm]{figures/common/action_arrow.pdf} \STRUT & Fisheye: Tag 764eac20c00785d8ada89d292ef1348514b8a0f4 refers to a dead (removed) revision in file `doc/manual/ds_um.aux'. Fisheye: No comparison available. Pass `N' to diff? Fisheye: Tag 764eac20c00785d8ada89d292ef1348514b8a0f4 refers to a dead (removed) revision in file `doc/manual/ds_um.bbl'. Fisheye: No comparison available. Pass `N' to diff? Fisheye: Tag 764eac20c00785d8ada89d292ef1348514b8a0f4 refers to a dead (removed) revision in file `doc/manual/ds_um.blg'. Fisheye: No comparison available. Pass `N' to diff? Fisheye: Tag 764eac20c00785d8ada89d292ef1348514b8a0f4 refers to a dead (removed) revision in file `doc/manual/ds_um.ilg'. Fisheye: No comparison available. Pass `N' to diff? Fisheye: Tag 764eac20c00785d8ada89d292ef1348514b8a0f4 refers to a dead (removed) revision in file `doc/manual/ds_um.lof'. Fisheye: No comparison available. Pass `N' to diff? Fisheye: Tag 764eac20c00785d8ada89d292ef1348514b8a0f4 refers to a dead (removed) revision in file `doc/manual/ds_um.log'. Fisheye: No comparison available. Pass `N' to diff? Fisheye: Tag 764eac20c00785d8ada89d292ef1348514b8a0f4 refers to a dead (removed) revision in file `doc/manual/ds_um.lot'. Fisheye: No comparison available. Pass `N' to diff? Fisheye: Tag 764eac20c00785d8ada89d292ef1348514b8a0f4 refers to a dead (removed) revision in file `doc/manual/ds_um.nlo'. Fisheye: No comparison available. Pass `N' to diff? Fisheye: Tag 764eac20c00785d8ada89d292ef1348514b8a0f4 refers to a dead (removed) revision in file `doc/manual/ds_um.nls'. Fisheye: No comparison available. Pass `N' to diff? Index: doc/manual/ds_um.pdf =================================================================== diff -u -ra3c869f5e6ea258f8c1dc3d0d0c63783f5451235 -r764eac20c00785d8ada89d292ef1348514b8a0f4 Binary files differ Fisheye: Tag 764eac20c00785d8ada89d292ef1348514b8a0f4 refers to a dead (removed) revision in file `doc/manual/ds_um.tcp'. Fisheye: No comparison available. Pass `N' to diff? Fisheye: Tag 764eac20c00785d8ada89d292ef1348514b8a0f4 refers to a dead (removed) revision in file `doc/manual/ds_um.tex'. Fisheye: No comparison available. Pass `N' to diff? Fisheye: Tag 764eac20c00785d8ada89d292ef1348514b8a0f4 refers to a dead (removed) revision in file `doc/manual/ds_um.toc'. Fisheye: No comparison available. Pass `N' to diff? Fisheye: Tag 764eac20c00785d8ada89d292ef1348514b8a0f4 refers to a dead (removed) revision in file `doc/manual/ds_um.tps'. Fisheye: No comparison available. Pass `N' to diff? Index: doc/manual/figures/Chapter_installation/rt_desktop_icon.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/Chapter_overview/rt_options.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/Chapter_overview/rt_ribbon_hotkey.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_background/ArchitectureMindMap.pdf =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_background/ArchitectureMindMap.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_background/ArchitectureMindMap.svg =================================================================== diff -u --- doc/manual/figures/chapter_background/ArchitectureMindMap.svg (revision 0) +++ doc/manual/figures/chapter_background/ArchitectureMindMap.svg (revision 764eac20c00785d8ada89d292ef1348514b8a0f4) @@ -0,0 +1,4488 @@ + + + +image/svg+xmlDelta Shell + \ No newline at end of file Index: doc/manual/figures/chapter_background/DeltaShellStoryMap.imx =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_background/DeltaShellStoryMap.pdf =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_background/DeltaShellStoryMap.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_background/DeltaShellStoryMap.svg =================================================================== diff -u --- doc/manual/figures/chapter_background/DeltaShellStoryMap.svg (revision 0) +++ doc/manual/figures/chapter_background/DeltaShellStoryMap.svg (revision 764eac20c00785d8ada89d292ef1348514b8a0f4) @@ -0,0 +1,7092 @@ + + + +image/svg+xmlDelta ShellStory Map + \ No newline at end of file Index: doc/manual/figures/chapter_background/DeltaShell_layers.PNG =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_background/OverallArchitecture.pdf =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_background/OverallArchitecture.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_general/Project_Explorer_RTData.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_general/rt_Add_Object_Project_Explorer.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_general/rt_Chart.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_general/rt_Docking_explained.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_general/rt_Home.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_general/rt_Map.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_general/rt_MapLayer_Context_Menu.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_general/rt_Pin_UnPin_Explained.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_general/rt_View.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_general/rt_Welcome.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_installation/installer_icon.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_installation/rtDirectlyinStartMenu.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_installation/rtInAllPrograms.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_installation/rt_desktop_icon.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/Thumbs.db =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/context_menu_central_map.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/context_menu_central_region.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/context_menu_chart.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/context_menu_editable_items.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/context_menu_hydro_object_level.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/context_menu_im.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/context_menu_messages.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/context_menu_model.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/context_menu_project.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/context_menu_region.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/context_menu_region_level.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/context_menu_sub_levels.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/context_menu_table.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/delta_shell.ppt =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/delta_shell_structure.pdf =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/delta_shell_structure.pptx =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/example_autohide.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/example_case_management.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/example_chart_window.PNG =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/example_docking.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/example_docking_UndoRedo_1.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/example_docking_UndoRedo_2.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/example_integrated_model.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/example_map.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/icon_clear_all_messages.PNG =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/icon_undo_redo.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/multiple_models_project_explorer.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/overview_ds.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/quick_access_toolbar.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/ribbon_file.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/ribbon_home.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/ribbon_map.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/ribbon_map_minimised.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/ribbon_tools.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/ribbon_view.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/rt_options.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/rt_ribbon_hotkey.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/time_navigator.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/view_chart_window.PNG =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/view_data_window.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/view_map_window.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/view_messagedetails_window.PNG =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/view_messages_window.PNG =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/view_project_window.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/view_properties_window.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/view_region_window.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/view_toolbox_window.PNG =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_overview/view_undo-redo_window.png =================================================================== diff -u Binary files differ Index: doc/manual/figures/chapter_piping/selectRTProject.png =================================================================== diff -u Binary files differ Index: doc/manual/rt_um.pdf =================================================================== diff -u Binary files differ Index: doc/manual/rt_um.tcp =================================================================== diff -u --- doc/manual/rt_um.tcp (revision 0) +++ doc/manual/rt_um.tcp (revision 764eac20c00785d8ada89d292ef1348514b8a0f4) @@ -0,0 +1,12 @@ +[FormatInfo] +Type=TeXnicCenterProjectInformation +Version=4 + +[ProjectInfo] +MainFile=rt_um.tex +UseBibTeX=1 +UseMakeIndex=0 +ActiveProfile=LaTeX ⇨ PDF +ProjectLanguage=nl +ProjectDialect=NL + Index: doc/manual/rt_um.tex =================================================================== diff -u --- doc/manual/rt_um.tex (revision 0) +++ doc/manual/rt_um.tex (revision 764eac20c00785d8ada89d292ef1348514b8a0f4) @@ -0,0 +1,115 @@ +\documentclass[dutch]{deltares_manual_style} + +\svnid{$Id: rt_um.tex 1 2015-10-01 12:00:00Z rodriqu_dd $} + +\usepackage{booktabs} +\usepackage {color} +\definecolor {gray} {rgb} { 0.4, 0.4, 0.4 } +\definecolor {darkblue} {rgb} { 0.0, 0.0, 0.6 } +\definecolor {cyan} {rgb} { 0.0, 0.6, 0.6 } +\definecolor {orange} {rgb} { 1.0, 0.5, 0.0 } +\definecolor {brown} {rgb} { 0.6, 0.3, 0} +\usepackage {listings} + +\lstdefinelanguage {XML} { + escapechar=\%, + identifierstyle=\color{brown}, + stringstyle=\color{blue}, + morestring=[b]", + morecomment=[s]{}, + morecomment=[s][\color{green}]{}, + keywordstyle=\color{red}, + morekeywords={ + designation, + icaoCode, + ilsFreq, + ilsID, + name, + partition, + pathname, + range, + schemaLocation, + state, + tora, + towerFreq, + trueBRG, + type, + units, + value, + version, + xmlns, + xsi + } % list your attributes here + } + +\lstset { + language=XML, + basicstyle=\ttfamily\footnotesize, + columns=fullflexible, + showstringspaces=false, + commentstyle=\color{gray}\upshape + } + +\graphicspath{{../common/}} + +\newcommand{\menuarrow}{$\rightarrow$\xspace} +%\newcommand{\deltashell}{\textrm{Delta Shell}\xspace} % for headings where \, is not allowed + +\newenvironment{litemize}{\begin{itemize}\raggedleft}{\end{itemize}} +\newcolumntype{L}{>{\raggedright\arraybackslash}X} +\newcolumntype{C}{>{\centering\arraybackslash}X} +\newcolumntype{R}{>{\raggedleft\arraybackslash}X} +%------------------------------------------------------------------------------ +\hypersetup +{ + pdfauthor = {Deltares}, + pdftitle = {Ringtoets (RT) Handleiding}, + pdfkeywords = {Deltares User Manual}, + pdfcreator = {LaTeX hyperref}, + pdfproducer = {ps2pdf} +} +%------------------------------------------------------------------------------ +% +\renewcommand\BackgroundPicChapter{ + \put(0,0){ + \parbox[b][\paperheight]{\paperwidth}{% + \vspace{4\baselineskip} + \hspace{220mm} + \includegraphics[width=15mm]{cover/chapter-ribbon.jpg}% + \vfill + } + } +} + +%------------------------------------------------------------------------------ +% +\begin{document} + +\pagestyle{empty} +\includepdf[pages=1,offset=72 -70]{cover/default-cover-pages.pdf} % links-rechts past precies +\cleardoublepage + +\title{Ringtoets} +\subtitle{} +\manualtype{Gebruikershandleiding} +\version{1.0} +\date{1 november 2015} +\manualtitle + +\input{chapters/rt_guide} +\input{chapters/rt_installation} +\input{chapters/rt_general} +\input{chapters/rt_overview} +\input{chapters/rt_piping} + + +%\appendix +%\input{chapters/An_example_of_appendix} + +\cleardoublepage +% +\newpage +\pagestyle{empty} +\mbox{} +\includepdf[pages=2,offset=-72 -70]{cover/default-cover-pages.pdf} % links-rechts past precies +\end{document} \ No newline at end of file Index: doc/manual/wti_um.pdf =================================================================== diff -u -r25c79044eac099aa61ae5e7fa0230f29739822a9 -r764eac20c00785d8ada89d292ef1348514b8a0f4 Binary files differ