Manual

This chapter describes the structure of the pages in this manual.

The pages are created using the static side generator HUGO in combination with the relearn theme. Some of the icons are taken from fontawesome.

It will be possible to open the pages of this manual by pressing F1 within the application.

The page layout of this online manual automatically adapts to the resolution of your viewing device. If the screen width is smaller than usual, the menu on the left will be hidden. It can then be accessed by clicking on the menu icon, which consists of three horizontal lines. Some icons in the top bar may also be grouped behind an icon with three vertical dots.

Topmost line on all pages

Clicking this icon displays a list of the sections on the current manual page
Breadcrumbs: Show the current position within the manual hierarchy, with the option to navigate to superior chapters
Switch to a print-optimised version of the current page
Navigate to previous and next chapters in the manual

Search: Enter text in this field for a full-text search of the entire manual
Home: Return to the start page of the manual
Manual: The current chapter, this page

Best practice: Chapters providing best practice instructions for the software
Workflows: Instructions for workflows within the Diversity Workbench
Modules: This section contains the chapters for the Diversity Workbench modules
- Introduction: A general introduction to the module
- Download: Current and previous software versions, along with notes on changes ↓10
  - Installation: How to install the software
- Login: How to access the databases ↓20
- Menu: The main menu of the module ↓30
- Tutorial: A step-by-step guide for using the module ↓40
- Query: How to search for data ↓50
- Editing: How to edit the data ↓60
  - Data in Tables
  - Projects
  - Withholding data
  - Relation to DWB-Modules
  - …
- Import & Export: Import and export of data ↓70
  - Importing data
    - Wizard for importing data from text files
    - …
  - Exporting data
    - Backup of the database
    - CSV backup of the database
    - Wizard for exporting selected data
    - …
  - Archive: Creating an archive for a project
  - Replication: Synchronzing data between databases
- FAQ: Frequently asked questions, including video turorials ↓80
- General: General aspects of the software ↓90
  - Feedback: Feedback for the software
  - Customizing: Customizing the software
  - Maintenance: Maintenance of the data
  - …
- Internals: Software internals like the design of the database ↓100
  - Database: Structure of the database
  - Version: Version of the software and the database
  - License: License of the software
  - Update: Update of the software and the database
  - Errorlog: Errorlog of the software
  - Settings: Settings for the software
  - …
Special software: Special software related e.g. to special interest groups
Development: Previews for upcoming projects