Skip to content

Commit 8ca0340

Browse files
committed
cross link pages for show_player and variable_player
1 parent 2e74fb0 commit 8ca0340

File tree

6 files changed

+30
-32
lines changed

6 files changed

+30
-32
lines changed

docs/code/api_reference/config_players/show_player.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# show_player API Reference
22

3-
Config Reference:
4-
5-
* [show_player:](../../../config/show_player.md)
6-
73
`self.machine.show_player`
84

95
``` python
@@ -37,3 +33,8 @@ Handle subscriptions.
3733
`play(settings, context, calling_context, priority=0, **kwargs)`
3834

3935
Play, start, stop, pause, resume or advance show based on config.
36+
37+
## Related Pages:
38+
39+
* [show_player: Config Reference](../../../config/show_player.md)
40+
* [Show player Config Player Reference](../../../config_players/show_player.md)

docs/code/api_reference/config_players/variable_player.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# variable_player API Reference
22

3-
Config Reference:
4-
5-
* [variable_player:](../../../config/variable_player.md)
6-
73
`self.machine.variable_player`
84

95
``` python
@@ -49,3 +45,8 @@ Variable name.
4945
`validate_config_entry(settings: dict, name: str) → dict`
5046

5147
Validate one entry of this player.
48+
49+
## Related Pages:
50+
51+
* [variable_player: Config Reference](../../../config/variable_player.md)
52+
* [Variable player Config Player Reference](../../../config_players/variable_player.md)

docs/config/show_player.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,4 +351,5 @@ details.
351351

352352
* [Shows](../shows/index.md)
353353
* [Tutorial step 16: Create an attract mode display show](../tutorial/16_attract_mode_show.md)
354-
* [Show player](../config_players/show_player.md)
354+
* [Show player Config Player Reference](../config_players/show_player.md)
355+
* [Show player API Reference](../code/api_reference/config_players/show_player.md)

docs/config/variable_player.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -263,12 +263,14 @@ we can use in slides and widgets which matches the value of the album,
263263
and it's automatically updated whenever the player var "album_value"
264264
changes.
265265

266-
## Related How To guides
266+
## Related Pages:
267267

268268
* [Tutorial step 15: Add scoring](../tutorial/15_scoring.md)
269-
* [Variable player](../config_players/variable_player.md)
270269
* [Player Variables](../game_logic/players.md)
271270
* [Player Variables Reference](../player_vars/index.md)
272271
* [Machine Variables Reference](../machine_vars/index.md)
273272
* [Scoring](../game_logic/scoring/index.md)
274273
* [Persisting the State of a Logic Block in a Player Variable](../game_logic/logic_blocks/persisting_state_in_a_player_variable.md)
274+
275+
* [Variable player Config Player Reference](../config_players/variable_player.md)
276+
* [variable_player API Reference](../code/api_reference/config_players/variable_player.md)

docs/config_players/show_player.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ title: Show player
44

55
# Show player
66

7-
87
The *show player* is a
98
[config player](index.md)
109
that's used to start, stop, pause, resume, advance, and/or update
@@ -133,7 +132,7 @@ In shows, the show player is used via the `shows:` section of a step.
133132
parent show like a playlist, or as a controller that starts and stops
134133
other shows.)
135134

136-
## Config Options
135+
## Related Pages:
137136

138-
See [show_player:](../config/show_player.md) for config
139-
details.
137+
* [show_player: Config Reference](../config/show_player.md)
138+
* [show_player API Reference](../code/api_reference/config_players/show_player.md)

docs/config_players/variable_player.md

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,27 @@ title: Variable player
44

55
# Variable player
66

7+
The `variable_player` is a [config player](index.md) that's used to set
8+
the value of player and machine variables. This is commonly used for
9+
scoring in your machine.
710

8-
The `variable_player` is a
9-
[config player](index.md)
10-
that's used to set the value of player and machine variables. This is
11-
commonly used for scoring in your machine. See
12-
[variable_player](../config/variable_player.md) for more detailed information.
11+
See [variable_player](../config/variable_player.md) for more detailed information.
1312

14-
15-
See our
16-
[player variables reference](../player_vars/index.md) and
13+
See our [player variables reference](../player_vars/index.md) and
1714
[machine variables reference](../machine_vars/index.md) to learn about existing variables. You can also create
1815
player variables on the fly if they did not exist. If you want to define
19-
defaults for variables you may define them in the
20-
[player_vars:](../config/player_vars.md) or
16+
defaults for variables you may define them in the [player_vars:](../config/player_vars.md) or
2117
[machine_vars:](../config/machine_vars.md) sections.
2218

2319
## Usage in config files
2420

25-
In config files, the variable player is used via the `variable_player:`
26-
section.
21+
In config files, the variable player is used via the `variable_player:` section.
2722

2823
## Usage in shows
2924

30-
In shows, the variable player is used via the `variables:` section of a
31-
step.
25+
In shows, the variable player is used via the `variables:` section of a step.
3226

33-
## Config Options
27+
## Related Pages:
3428

35-
See [variable_player:](../config/variable_player.md) for config
36-
details.
29+
* [variable_player: Config Reference](../config/variable_player.md)
30+
* [variable_player API Reference](../code/api_reference/config_players/variable_player.md)

0 commit comments

Comments
 (0)