Usage and Typographic Conventions#
This page is a collection of tips and tricks for the usage of the Nerve Blue documentation.
It contains both hints for page navigation and feature usage of the website as well as an overview of the style guide explaining the meaning behind formatting choices.
Features and Page Navigation#
The table below presents an overview of functionality features that the Nerve Blue documentation website offers as well as some tips on usage and navigation.
|Page Structure||Each guide can be accessed by clicking on its tab at the top of the page, leading to the introduction page of the guide. The left table of contents displays the chapters of the guide while the right table of contents shows the contents of a chapter. Located at the bottom is an easy navigation menu that allows you to turn to the next or previous page in the guide. Right below are links to licenses and a legal disclaimer. Clicking the Nerve logo in the top-left leads back to the landing page.|
|PDF Download||A PDF version of the entire documentation can be downloaded on every chapter page. Click the download symbol to the right of the chapter header to download the combined PDF.|
|Search bar||Use the search bar in the upper-right to look for terms in the Nerve Blue Documentation. While you are entering a search query, the search bar will display the search results in real-time. Click the matching search result to go to the chapter you would like to open.|
|Screenshots||All screenshots are clickable. Clicking a screenshot maximizes it in an overlay in the current window. Close the overlay by pressing Escape or clicking the cross symbol in the upper-right corner. A download symbol is also available in the overlay.|
|Back to top||After scrolling down, a button labeled "Back to top" appears in the lower-right corner. Clicking the button automatically scrolls back up to the top, placing the page in its initial state.|
|Links||All links open in new tabs when clicked with the left mouse button.|
|Copy to clipboard||Code blocks can be copied to the clipboard by clicking the copy symbol in the upper-right corner of the code block.|
|Changelog||On the left side of the landing page you can find a link to the changelog. The changelog is a page that informs you about the updates and changes to the Nerve Blue documentation. Click Changelog in the left table of contents to reach the changelog. Please note that updates to the Nerve Blue product are documented under Release Notes.|
|Mobile version||The Nerve Blue documentation page can be viewed on mobile devices as well. The design is configured to display correctly in mobile browsers.|
The formatting of the text has significance. Below is an overview of the formatting options used to convey certain information more clearly.
|Instructions||Step by step guides are always presented in numbered lists.||Example instructions|
|GUI elements||User interface elements mentioned in the documentation are always highlighted with bold text.||All nodes that are registered in the Management System are placed in the Unassigned element by default.|
|Tree view elements||Tree view elements are emphasized with bold text and an angled bracket in between subsequent elements.||Expand Device (Nerve_MFN_100) > PLC Logic > Application in the tree view on the left.|
|Optional information||Optional information is presented in italics, usually preceded by Optional:||Optional: Enter a description for your workload.|
|Information like user input, file names or IP addresses is presented in
|Placeholder||Instructions containing information that can be replaced by the user are identified by angled brackets||You can freely name the ZIP file here by replacing
|Notes||If noteworthy additional information is presented, it is found in light blue note boxes.
Critical information that could cause severe system errors or block the user from progressing is presented in orange note boxes.