Tips and tricks for using this site
This page is a collection of tips and tricks for the usage of the Nerve 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.
Nerve Documentation assumes Windows is used as an operating system on the workstation. Specific instructions or comments for Linux and Mac workstations will be added in the future.
Note
The page is built with MkDocs and the Material for MkDocs theme. Thanks to all the contributors of these projects.
Features and page navigation
The table below presents an overview of functionality features that the Nerve documentation website offers as well as some tips on usage and navigation.
| Element | Description |
|---|---|
| Page Structure | Each guide can be accessed by selecting its tab at the top of the page, leading to the introduction page of the guide. The left table of contents displays the titles of pages contained in a guide while the right table of contents shows the headings of the current page. Located at the bottom is an easy navigation menu that allows turning to the next or previous page in the guide. Right below are miscellaneous links. Selecting the Nerve logo in the top-left leads back to the landing page. |
| Search bar | Use the search bar in the upper-right to look for terms in the Nerve Documentation. While entering a search query, the search bar will display the search results in real-time. Select the matching search result to go to a chapter. The searched word is highlighted on the visited page. |
| Screenshots | All screenshots are selectable. Selecting a screenshot maximizes it in an overlay in the current window. Close the overlay by pressing Escape or selecting the cross symbol in the upper-right corner. |
| Back to top | Scrolling back up on any page makes a button labeled Back to top appear in the central content area. Selecting the button automatically scrolls back up to the top, placing the page in its initial state. |
| Links | All links open in new tabs when selected with the left mouse button. |
| Copy to clipboard | Code blocks can be copied to the clipboard by selecting the copy symbol in the upper-right corner of the code block. |
| Mobile version | The Nerve documentation page can be viewed on mobile devices as well. The design is configured to display correctly in mobile browsers. |
Style guide
The formatting of the text has significance. Below is an overview of the formatting options used to convey certain information more clearly.
| Element | Description | Example |
|---|---|---|
| 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) > 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 the workload. |
| User input Code File paths File names IP addresses |
Information like user input, file names or IP addresses is presented in inline code. |
The default path is /home/admin/ on the Nerve Device. |
| Placeholder | Instructions containing information that can be replaced by the user are identified by angled brackets. | Name the ZIP file by replacing <userproject> with a name of choice. |
| 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. |
Orange notes Blue notes |