Skip to content

Latest commit

 

History

History
266 lines (178 loc) · 14.3 KB

USERMANUAL.md

File metadata and controls

266 lines (178 loc) · 14.3 KB

Netzgrafik-Editor User Documentation

Table Of Contents

Additional information can be found under the provided links.

Introduction

This document provides an overview of its key features and instructions on how to interact with the editor effectively.

Key Features

  1. Interactive Drawing Interface: The user can define nodes, trains with their routes and attributes to create a comprehensive Netzgrafik. The editor offers an user-friendly drag-and-drop interface that allows to easily draw the entire Netzgrafik. When a node is repositioned (moved), the edge paths of all train segments at the node are redrawn using a heuristic to minimize the number of overlapping edges. This ensures that the network graph is always clear and easy to read. Additionally, connections between trains can be drawn using drag-and-drop. This intuitive feature simplifies the creation and customization of the network layout.

  2. Graphic timetable (Streckengrafik): All lines (trainruns) defined in the Netzgrafik can be transferred into a graphical timetable representation (Streckengrafik). In addition to displaying the timetable graphically, this graphical timetable provides a new track occupancy estimation at the nodes and between the nodes (lines). It estimates the required minimum infrastructure, such as the number of tracks. This enhances the capability for clear and quick analytics directly through the graphical timetable.

  3. Advanced Analytics: Increasing demands are being placed on advanced analytical abilities. Analyzing journey routes through the logistics network is crucial. A first version has been implemented that allows users to analyze the logistics network based on the timetable representation. It provides insights into connection coordination, transfer times and journey times.

  4. Collaboration and Sharing: The Netzgrafik-Editor provides collaboration features, enabling multiple users to work on the same Netzgrafik simultaneously. Users can share their work with others, track changes, and collaborate seamlessly. Exporting and sharing the designed Netzgrafik is also a useful function that improves further processing with third parties.


Project/Variant

The container in which the planning work takes place is a project. Projects have a name and can be described. User authorisations for writing and reading are assigned at project level. Variants can be created within the projects, each of which contains a Netzgrafik (network graphic). Variants can be compared within a project. For more details and to create your first Netzgrafik have a look into create a new project.

Advanced editing short-cuts

Users can perform advanced editing operation short-cuts such as copy (ctrl+c), paste (ctrl+v), duplicate (ctrl+d), delete ('delete') and undo (ctrl+z) in multiple steps - either using the standard (ctrl+z) key command or with help of the version history. These editing functions make it easier to manage and edit complex network structures.

User don't need to explicitly save the latest changes. The system save it automatically. There is therefore no shortcut for saving changes.

Short-cuts

Keyboard description
'delete' Delete nodes, comments, and selected trainruns.
ctrl+d / 'insert' Duplicate nodes, comments, and selected trainruns (if multiple nodes are selected, trains including nodes will be duplicated).
'insert' Add new nodes under the mouse on the drawing area.
'escape' Select trainruns / In multi-node move mode, all selected nodes will be unselected.
shift + left mouse button pressed and move (or alternatively with the right mouse button pressed and move) Multi-select nodes and notes for subsequent moving or delete all selected elements by using "Delete".
ctrl+z Undo - Reverse the previous action.
ctrl+c Copy the currently visible trainruns. The copied content remains in the browser's memory/cache and can be pasted into different variants (even after closing the browser, the data remains saved).
ctrl+v Paste the copied trainruns.
ctrl+a Select all.

Duplicate

To duplicate one or many elements - use shift + left mouse button pressed to select several elements and press (ctrl+d).

If more than one node is selected, all train sections that are connected to two selected nodes are also duplicated. If further notes are selected, the notes are duplicated in the same way as the nodes.

If in the menu the Knoten-Positionierungswerkzeug is activated, you can multi-select nodes and notes by clicking. If you use shift + right mouse press

Duplicate trainrun

To duplicate a train in the project, follow these steps:

  • Select the train: Use the left mouse click to select the train that you want to duplicate.

  • Duplicate the train: Once the train is selected, press (ctrl+d) on your keyboard to duplicate it. This action will create an identical copy of the selected train.

    There are alternative editing path to process duplication: Use the copy-past idea: Select the train und press (ctrl+c) then (ctrl+v)

  • Edit the train name: Click on the train name with the left mouse button, and a dialog window will open, allowing you to edit the train's details. Make the necessary changes to the train name or any other relevant information.

2024-1-25-Duplicate_Trainrun_ctr_d.webm

Optional: Edit the train in the Perlenkette

Duplicate nodes

To duplicate a node, ensure there is no trainrun selected. Move with the mouse pointer over the node to duplicate and press (ctrl+d).

Duplicate notes

To duplicate a note, ensure there is no trainrun selected. Move with the mouse pointer over the note to duplicate and press (ctrl+d).

Delete

To delete one or many elements - use shift + left mouse button pressed to select several elements and press 'delete'.

Delete trainrun

To delete a train in the project, follow these steps:

  • Select the train: Use the left mouse click to select the train that you want to delete.

  • Delete the train: Once the train is selected, press 'delete' on your keyboard to delete it. This action will create an identical copy of the selected train.

    There are alternative editing path to process duplication: Use the copy-past idea: Select the train und press (ctrl+c) then (ctrl+v).

Delete nodes

To delete a node, ensure there is no trainrun selected. Move with the mouse pointer over the node to delete and press 'delete'. Deleting a node causes all train sections connected to the node to be deleted.

Delete notes

To delete a note, ensure there is no trainrun selected. Move with the mouse pointer over the note to delete and press 'delete'.


Nodes

The nodes represent the specific locations, such as stations or stops, where a trainrun can have different actions or events associated with it. These nodes serve as key points in the trainrun's route, determining where it stops, passes through, or starts and ends (see data model).

For mor details have a look into create and modifiy nodes.

Trainruns

A trainrun consists out of one ore more trainrun sections. The trainrun section represents a specific segment or portion of a trainrun that connects two nodes. It encapsulates all the relevant information related to that particular section, including temporal details like departure and arrival times. Additionally, it also stores the journey time, which indicates the duration it takes for the train to run to move from one node to another.

A trainrun has references to behaviour-related abstractions such as category (e.g. a regional train, an intercity train or a goods train), frequency (e.g. 1/4h, 1/2h or every hourand) time category (e.g. peak times or off-peak times or occasional), which define the behaviour of a trainrun (see data model).

For mor details have a look into create and modifiy trainrun.


Connections

Editing_Connections

For mor details have a look into create and modifiy connections.


Filters

For mor details have a look into create and modifiy filters.


Graphic timetable (Streckengrafik)

Overview_Streckengrafik_Screenshot_001

For mor details have a look into graphic timetable.


Perlenkette

The Perlenkette allows you to view and edit the entire trainrun from a vertical perspective. It is displayed on the right-hand side. In the upper part of the Perlenkette, the train information is displayed. It can also be expanded to get more information. It also allows to edit the train name, category or frequency.

Between the title and the train route display, there is a sorted list of all the passed nodes. These nodes are displayed as buttons, which enable quick synchronization with the Netzgrafik. If you click on a node button, the viewpoint (center) will automatically be readjusted. Similarly, clicking on a train section will center that section in the Netzgrafik, allowing for easy navigation and visualization.

Show Perlenkette

To access it, select a train first. Then, by clicking on the train again, the Perlenkette will open on the right side, displaying the train's route as a vertical chain of nodes and trainrunsections.

2024-1-25_DeleteConnections-Perlenkette-Show_Connections.webm

Change the time locks

The time can be locked so that no propagtion (automated update) will be done. Just click on the lock icon and the lock state switchs: On to off or vice-versa.

Toggle all show all locks / or only closed (default)

In the Perlenkette view, you can click on the eye icon in the bottom left corner to display all locks. By default, only the locks that are closed are shown. This is visually visible with the disabled eye icon. When you click on the icon then the disable eye icon switchs to the visible eye icon - or vive-versa. Visble eye means all locks are visible.


Conclusion

By following the instructions in this document, users can effectively create and facilitate the creation of comprehensive and visually appealing network representations.


Links