[manual] text and icon improvements

Dieser Commit ist enthalten in:
Reinder Feenstra 2025-11-23 16:04:00 +01:00
Ursprung 1f75962841
Commit d22a2605b4
9 geänderte Dateien mit 34 neuen und 33 gelöschten Zeilen

Datei anzeigen

@ -716,7 +716,7 @@ void ScreenShotDialog::start()
[this]() [this]()
{ {
static constexpr std::array<const char*, 2> schemes{"light", "dark"}; static constexpr std::array<const char*, 2> schemes{"light", "dark"};
static constexpr std::array<const char*, 22> icons{ static constexpr std::array<const char*, 23> icons{
"circle/add", "circle/add",
"add", "add",
"board", "board",
@ -736,6 +736,7 @@ void ScreenShotDialog::start()
"power_on", "power_on",
"remove", "remove",
"resize_tile", "resize_tile",
"run",
"swap", "swap",
"train", "train",
"up", "up",

Binäre Datei nicht angezeigt.

Vorher

Breite:  |  Höhe:  |  Größe: 14 KiB

Datei anzeigen

@ -30,32 +30,34 @@ In the wizard, choose your **digital system / command station** from the list of
Depending on your selection, Traintastic will ask additional questions, such as: Depending on your selection, Traintastic will ask additional questions, such as:
- **How it is connected**: serial, USB, or network (Ethernet or Wi-Fi). - **How it is connected**: serial, USB, or network (Ethernet or Wi-Fi).
*Tip: Wi-Fi is supported but not recommended for stability reasons.*
- **Device or port**: for example a COM port (Windows), `/dev/ttyUSB0` (Linux), or an IP address. - **Device or port**: for example a COM port (Windows), `/dev/ttyUSB0` (Linux), or an IP address.
!!! tip "Using WiFi"
Wi-Fi is supported but not recommended for stability reasons.
When you finish the wizard: When you finish the wizard:
- The new interface will appear in the *Interfaces* list. - The new interface will appear in the *Interfaces* list.
- A **status icon** will show in the status bar (right side of the window). - A **status icon** will show in the status bar (right side of the window).
- ![Gray](../assets/images/icons/dark/interface_state.offline.png) - Offline - ![Gray](../assets/images/icons/dark/interface_state.offline.png) Offline
- ![Purple](../assets/images/icons/dark/interface_state.initializing.png) - Initializing - ![Purple](../assets/images/icons/dark/interface_state.initializing.png) Initializing
- ![Green](../assets/images/icons/dark/interface_state.online.png) - Online/connected - ![Green](../assets/images/icons/dark/interface_state.online.png) Online/connected
- ![Red](../assets/images/icons/dark/interface_state.error.png) - Error - ![Red](../assets/images/icons/dark/interface_state.error.png) — Error occured
If you add multiple interfaces, each has its own status icon. If you add multiple interfaces, each has its own status icon.
## Step 4: Connect and test ## Step 4: Connect and test
1. Press the ![connect](../assets/images/icons/light/offline.png#only-light)![connect](../assets/images/icons/dark/offline.png#only-dark) button (double arrow icon, top left on the toolbar) 1. Press the ![connect](../assets/images/icons/light/offline.png#only-light)![connect](../assets/images/icons/dark/offline.png#only-dark) button
or use the menu: **World → Connection → Connect**. or use the menu: **World → Connection → Connect**.
2. The status icon will change: 2. The status icon will change:
- Purple while initializing (up to a few seconds). - ![Purple](../assets/images/icons/dark/interface_state.initializing.png) — while initializing (up to a few seconds).
- Green if the connection succeeds. - ![Green](../assets/images/icons/dark/interface_state.online.png) — if the connection succeeds.
- Red if an error occurs. - ![Red](../assets/images/icons/dark/interface_state.error.png) — if an error occurs.
If an error occurs: If an error occurs:
- Open the **server log** (hotkey ++F12++ or **View → Server log**) to see details. - Open the **server log** (hotkey ++f12++ or **View → Server log**) to see details.
- See [Common interface connection errors](../troubleshooting/interface-connection-errors.md) for steps to resolve typical issues. - See [Common interface connection errors](../troubleshooting/interface-connection-errors.md) for steps to resolve typical issues.
- If youre unsure whether your system is supported, check the [Supported hardware appendix](../appendix/supported-hardware.md). - If youre unsure whether your system is supported, check the [Supported hardware appendix](../appendix/supported-hardware.md).
@ -64,7 +66,7 @@ When the connection succeeds:
Toggle the track power using the Toggle the track power using the
![power off](../assets/images/icons/light/power_off.png#only-light)![power off](../assets/images/icons/dark/power_off.png#only-dark) / ![power off](../assets/images/icons/light/power_off.png#only-light)![power off](../assets/images/icons/dark/power_off.png#only-dark) /
![power on](../assets/images/icons/light/power_on.png#only-light)![power on](../assets/images/icons/dark/power_on.png#only-dark) ![power on](../assets/images/icons/light/power_on.png#only-light)![power on](../assets/images/icons/dark/power_on.png#only-dark)
button (left of *Connect* button). button.
If the command station responds, your connection is working! If the command station responds, your connection is working!
--- ---

Datei anzeigen

@ -8,8 +8,8 @@ You can create multiple boards, for example one for the **main layout** and anot
1. Make sure you are in **edit mode** (![pencil](../../assets/images/icons/light/edit.png#only-light)![pencil](../../assets/images/icons/dark/edit.png#only-dark) button in the top right). 1. Make sure you are in **edit mode** (![pencil](../../assets/images/icons/light/edit.png#only-light)![pencil](../../assets/images/icons/dark/edit.png#only-dark) button in the top right).
2. Open the board list: 2. Open the board list:
- From the main menu: **Objects → Boards** - From the main menu: **Objects → Boards**
- Or click the **Board icon** on the toolbar (next to the Train icon). - Or click the ![board](../../assets/images/icons/light/board.png#only-light)![board](../../assets/images/icons/dark/board.png#only-dark) button on the toolbar.
![Empty board list](../../assets/images/getting-started/board-list-empty.png) ![Empty board list](../../assets/images/getting-started/board-list-empty.png)
@ -27,8 +27,8 @@ You can now start drawing.
1. Select a **tile** from the toolbar (straight, curve, turnout, etc.). 1. Select a **tile** from the toolbar (straight, curve, turnout, etc.).
2. Click on the board where you want to place it. 2. Click on the board where you want to place it.
3. To **rotate** a tile (before placing it): 3. To **rotate** a tile (before placing it):
- **Right-click** rotate clockwise - **Right-click** rotate clockwise
- **Shift + Right-click** rotate counter-clockwise - ++shift++ + **Right-click** rotate counter-clockwise
## Step 4: Move tiles ## Step 4: Move tiles

Datei anzeigen

@ -9,15 +9,13 @@ Once configured, Traintastic can switch the turnout directly and automatically u
- On the toolbar, select the ![mouse pointer](../../assets/images/icons/light/mouse.png#only-light)![mouse pointer](../../assets/images/icons/dark/mouse.png#only-dark) tool. - On the toolbar, select the ![mouse pointer](../../assets/images/icons/light/mouse.png#only-light)![mouse pointer](../../assets/images/icons/dark/mouse.png#only-dark) tool.
- Click on a **turnout tile** on your board — the turnout properties dialog opens. \ - Click on a **turnout tile** on your board — the turnout properties dialog opens. \
![Turnout general tab](../../assets/images/getting-started/turnout-general.png) ![Turnout general tab](../../assets/images/getting-started/turnout-general.png)
- On the **General** tab: - Enter the turnout basics:
- Enter a **name** (e.g. “Turnout 1” or “Yard Switch”). - Enter a **name** (e.g. “Turnout 1” or “Yard Switch”).
- The **ID** field identifies the turnout internally and can be left unchanged (mainly used for scripting). - The **ID** field identifies the turnout internally and can be left unchanged (mainly used for scripting).
- Switch to the **Output** tab. \ - On the **Output** tab configure how the turnout is controlled:
![Turnout output tab](../../assets/images/getting-started/turnout-output-mapping.png) - **Interface** — The command station or interface that controls this turnout.
- Configure how the turnout is controlled: - **Channel** — Usually set to *Accessory*.
- **Interface** – The command station or interface that controls this turnout. - **Address** — The digital address for the turnout on your command station.
- **Channel** – Usually set to *Accessory*.
- **Address** – The digital address for the turnout output on your command station.
- If the turnout has multiple addresses (e.g. **3-way**, **single slip**, or **double slip**), click ![plus](../../assets/images/icons/light/add.png#only-light)![plus](../../assets/images/icons/dark/add.png#only-dark) to add the additional addresses. - If the turnout has multiple addresses (e.g. **3-way**, **single slip**, or **double slip**), click ![plus](../../assets/images/icons/light/add.png#only-light)![plus](../../assets/images/icons/dark/add.png#only-dark) to add the additional addresses.
- The **Output mapping** defines how Traintastic translates turnout states (e.g. *straight* / *left* / *right*) to output commands. - The **Output mapping** defines how Traintastic translates turnout states (e.g. *straight* / *left* / *right*) to output commands.
For most standard turnouts, the default mapping is correct. For most standard turnouts, the default mapping is correct.
@ -29,10 +27,10 @@ When finished, close the dialog.
- Click the turnout in the schematic to change its position. - Click the turnout in the schematic to change its position.
- The turnout should move on your physical layout. - The turnout should move on your physical layout.
!!! tip !!! tip "Opposite movement?"
If the turnout moves in the opposite direction on your layout compared to what Traintastic shows, switch back to **edit mode** and open the turnout properties again. If the turnout moves in the opposite direction on your layout compared to what Traintastic shows, switch back to **edit mode** and open the turnout properties again.
On the **Output** tab, you can **swap the direction mapping** — this tells Traintastic which output corresponds to which turnout position. On the **Output** tab, you can **swap the direction mapping** — this tells Traintastic which output corresponds to which turnout position.
For standard turnouts that use a single address, you can do this quickly using the pink **⇄** button. For standard turnouts that use a single address, you can do this quickly using the ![swap](../../assets/images/icons/dark/swap.png) button.
--- ---

Datei anzeigen

@ -33,8 +33,8 @@ The dialog has three tabs:
2. Click the ![plus](../assets/images/icons/light/add.png#only-light)![plus](../assets/images/icons/dark/add.png#only-dark) button and choose **Locomotive**. \ 2. Click the ![plus](../assets/images/icons/light/add.png#only-light)![plus](../assets/images/icons/dark/add.png#only-dark) button and choose **Locomotive**. \
![Locomotive general tab](../assets/images/getting-started/locomotive-general.png) ![Locomotive general tab](../assets/images/getting-started/locomotive-general.png)
3. Enter the locomotive details: 3. Enter the locomotive details:
- **Name** - e.g. “BR 03” or “NS 2400” - **Name** e.g. “BR 03” or “NS 2400”
- **Maximum speed** - e.g. 80 km/h - **Maximum speed** e.g. 80 km/h
4. Switch to the **Decoder** tab. \ 4. Switch to the **Decoder** tab. \
![Locomotive decoder tab](../assets/images/getting-started/locomotive-decoder.png) ![Locomotive decoder tab](../assets/images/getting-started/locomotive-decoder.png)
5. Enter the decoder details: 5. Enter the decoder details:
@ -45,9 +45,9 @@ The dialog has three tabs:
6. Switch to the **Functions** tab. \ 6. Switch to the **Functions** tab. \
![Locomotive functions tab](../assets/images/getting-started/locomotive-functions.png) ![Locomotive functions tab](../assets/images/getting-started/locomotive-functions.png)
7. Additional functions can be added using the ![plus](../assets/images/icons/light/add.png#only-light)![plus](../assets/images/icons/dark/add.png#only-dark) button. Double-click a function to edit its details. Function details: 7. Additional functions can be added using the ![plus](../assets/images/icons/light/add.png#only-light)![plus](../assets/images/icons/dark/add.png#only-dark) button. Double-click a function to edit its details. Function details:
- **#** - function number: F0, F1 etc. (just enter the number) - **#** function number: F0, F1 etc. (just enter the number)
- **Function** - **Function**
- **Name** - Short description of the function - **Name** Short description of the function
- **Type** - **Type**
8. Close the locomotive dialog. 8. Close the locomotive dialog.
@ -67,7 +67,7 @@ The train is now defined but not yet active.
## Step 4: Control the train ## Step 4: Control the train
1. Switch to **operate mode** (toggle the ![pencil](../assets/images/icons/light/edit.png#only-light)![pencil](../assets/images/icons/dark/edit.png#only-dark) button off). 1. Switch to **operate mode** (toggle the ![pencil](../assets/images/icons/light/edit.png#only-light)![pencil](../assets/images/icons/dark/edit.png#only-dark) button off).
2. Click the **play** button on the main toolbar, this allows train movements. 2. Click the ![play](../assets/images/icons/light/run.png#only-light)![play](../assets/images/icons/dark/run.png#only-dark) button on the main toolbar, this allows train movements.
3. Double click on the train in the list, this will open a throttle. \ 3. Double click on the train in the list, this will open a throttle. \
![Train throttle](../assets/images/getting-started/train-throttle.png) ![Train throttle](../assets/images/getting-started/train-throttle.png)
4. Click **Acquire** to activate the train and take control of speed and direction (see note below). \ 4. Click **Acquire** to activate the train and take control of speed and direction (see note below). \

Datei anzeigen

@ -21,11 +21,11 @@ If the server has no world loaded (the default on a fresh installation), the cli
Click *New world* to launch the wizard: Click *New world* to launch the wizard:
1. Enter a **name** for your world (for example *My First World*). 1. Enter a **name** for your world (for example *My First World*). \
![New world wizard: Set world name](../assets/images/getting-started/new-world-wizard-set-name.png) ![New world wizard: Set world name](../assets/images/getting-started/new-world-wizard-set-name.png)
2. Choose the **scale** (H0, N, Z, etc.). 2. Choose the **scale** (H0, N, Z, etc.). \
![New world wizard: Select world scale](../assets/images/getting-started/new-world-wizard-select-scale.png) ![New world wizard: Select world scale](../assets/images/getting-started/new-world-wizard-select-scale.png)
3. Finish the wizard to create your new, empty world. 3. Finish the wizard to create your new, empty world. \
![New world wizard: Finish](../assets/images/getting-started/new-world-wizard-finish.png) ![New world wizard: Finish](../assets/images/getting-started/new-world-wizard-finish.png)
## Step 3: Edit and operate modes ## Step 3: Edit and operate modes

Binäre Datei nicht angezeigt.

Nachher

Breite:  |  Höhe:  |  Größe: 476 B

Binäre Datei nicht angezeigt.

Nachher

Breite:  |  Höhe:  |  Größe: 461 B