Documentation
This page is relevant for ✅Studio ✅Player
General
Information can be provided for each 3D system (project). This can be a task description or a technical description.
The document can be displayed in the default browser via the Info button:

Here's how you can provide information:
- Create a folder named doc in your project folder.
- In this folder, create the files doc_de.md (German language) and doc_en.md (English language) and write your information in Markdown format. Add any image files and other files you want to link to in this folder.
Using the Markdown format, you can create high-quality documentation with simple formatting instructions, including images and tables.
Inserting Tags into the Description
The table of inputs and outputs can be automatically inserted using the placeholder {Symbols}.
This string is replaced with the table of all inputs and outputs when the Markdown file is parsed.
What is Markdown?
Markdown is an easy-to-understand markup language that allows you to format texts simply. It enables you to represent headings, lists, links, images, and other elements with simple characters, without needing complex commands. Markdown files usually have the extension .md and are frequently used for documentation.
How does it work?
When the Info button is pressed, the Markdown file is read and converted into HTML code. The default browser is opened and displays the HTML file.
Example of a Project Description or Task
The image for the task was saved in this example in the pics folder within the docs folder.
# Task Pallet Lift Table
{50%}
## Description
A **pallet** slides down a **ramp** onto the conveyor belt of a lift table. The lift table moves up, and the pallet is transported from the lift table's conveyor belt to the conveyor belt of the deposit table.
**Automatic Mode**
The process is started via the push-button **S1**. This switches on the conveyor belt **7M2** of the lift table. As soon as a pallet is detected by sensor **3S2**, the conveyor belt switches off. The lift table then moves upwards via the drive **7M1**. Once the lift table has reached the upper end position, the conveyor belt of the lift table and the conveyor belt of the deposit table (**7M3**) are switched on. Once the pallet reaches the sensor **3S1** of the deposit table, both conveyor belts are switched off. In the next step, the lift table moves down. Once the lift table has reached its lower end position, the cycle is complete. A new cycle can only be started again after the pallet at the deposit table has been removed using the "Remove pallet" button.
It should be noted that both end-position sensors **3S3** and **3S4** are designed as normally closed contacts.
## Task
1. Export the variable list for your programming environment via the station settings (wrench icon).
2. Write the control program for the above process.
## I/O Assignment
{Symbols}Quick Guides to Markdown
Headings
Syntax Example:
# Heading Level 1
## Heading Level 2
### Heading Level 3Bold & Italic
Syntax Example:
**Bold text** and *italic text*
__Also bold__ and _also italic_Result: Bold text and italic text Also bold and also italic
Lists
Syntax Example (unordered):
- Item A
- Item B
- Sub-item B1Result:
- Item A
- Item B
- Sub-item B1
Syntax Example (ordered):
1. First
2. SecondResult:
- First
- Second
Links
Syntax Example:
[MHJ-Software](https://www.mhj-online.de "MHJ-Software Homepage")Result:
Images
Syntax Example:
Result:
Additional possibility (not generally available in Markdown): You can append the string {50%} to scale the image to 50% of the current window width.
Left or right alignment is also possible: {50%, right}, {50%, left}
Code Blocks
Syntax Example (fenced code):
Use this string at the beginning and end of the block to create code blocks: ```
Result: Lines in a gray box:
Console.WriteLine("Hello, World!");Blockquotes
Syntax Example:
> This is a quote.Result:
This is a quote.
Tables
Syntax Example:
| Name | Age |
|---------|------:|
| Alice | 30 |
| Bob | 25 |Result:
| Name | Age |
|---|---|
| Alice | 30 |
| Bob | 25 |
Admonitions - Notes
Syntax Example:
!!! info "Any text as a heading"
Here is some text. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Result:
Here is some text.Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.