Conventions
On Screen components such as Menu items will be in Helvetica (for example File menu)
TwinCAT code will be in sans-serif Lucida (for example VAR, END_VAR) when used in the text or a paragraph, and when used in a code block.
1 2 | |
Note
Notes are added to provide additional information in order to add clarity or to bring up a point of consideration.
Info
Information is added to provide additional information that may be useful, but is not required to understand the content.
Tip
Tips are added to provide additional information that may be useful, but are not required to understand the content.
Question
Questions are added to address items that are commonly asked or to encourage the reader to think about how something will need to be considered in their project.
Success
Success items are added to provide information that is a best practice or a good way to do something. These are not the only way to do something, but they are a good starting point.
Danger
These are items that if not managed correctly can be a source of frustration and can cause problems.
Warning
Warnings point out items that are common mistakes and can cause issues if not addressed.
Example
Examples are added to provide a sample of how something is done or how it can be done. These are not the only way to do something, but they are a good starting point.
Code that you might wish to copy will have a copy button in the top right corner of the code block.
1 | |
Code that is used to show an example will not have the copy button, but can still be highlighted and copied.
1 | |
When code samples are modified, the following will be used to show differences in code by using the following format:
1 2 | |