Merge pull request #615 from bosh/cross_linking

Begin cross linking pages

Author: bosh

docs/code/api_reference/config_players/coil_player.md

@@ -1,9 +1,5 @@
 # coil_player API Reference
 
-Config Reference:
-
-* [coil_player:](../../../config/coil_player.md)
-
 `self.machine.coil_player`
 
 ``` python
@@ -22,14 +18,20 @@ The coil_player is available via `self.machine.coil_player`.
 
 The coil_player has the following methods & attributes available. Note that methods & attributes inherited from the base class are not included here.
 
-` clear_context(context)`
+`clear_context(context)`
 
 Disable enabled coils.
 
-` get_express_config(value: str)`
+`get_express_config(value: str)`
 
 Parse short config version.
 
-` play(settings, context: str, calling_context: str, priority: int = 0, **kwargs)`
+`play(settings, context: str, calling_context: str, priority: int = 0, **kwargs)`
 
 Enable, Pulse or disable coils.
+
+## Related Pages:
+
+* [Coils (Solenoids)](../../../mechs/coils/index.md)
+* [coil_player: Config Reference](../../../config/coil_player.md)
+* [Coil player Config Player Reference](../../../config_players/coil_player.md)

docs/code/api_reference/config_players/event_player.md

@@ -1,9 +1,5 @@
 # event_player API Reference
 
-Config Reference:
-
-* [event_player:](../../../config/event_player.md)
-
 `self.machine.event_player`
 
 ``` python
@@ -33,3 +29,8 @@ Parse list.
 `play(settings, context, calling_context, priority=0, **kwargs)`
 
 Post (delayed) events.
+
+## Related Pages:
+
+* [event_player: Config Reference](../../../config/event_player.md)
+* [Event player Config Player Reference](../../../config_players/event_player.md)

docs/code/api_reference/config_players/flasher_player.md

@@ -1,9 +1,5 @@
 # flasher_player API Reference
 
-Config Reference:
-
-* [flasher_player:](../../../config/flasher_player.md)
-
 `self.machine.flasher_player`
 
 ``` python
@@ -29,3 +25,9 @@ Parse express config.
 `play(settings, context, calling_context, priority=0, **kwargs)`
 
 Flash flashers.
+
+## Related Pages:
+
+* [Flashers (Lights)](../../../mechs/lights/flashers.md)
+* [flasher_player: Config Reference](../../../config/flasher_player.md)
+* [flasher_player API Reference](../../../code/api_reference/config_players/flasher_player.md)

docs/code/api_reference/config_players/hardware_sound_player.md

@@ -1,9 +1,5 @@
 # hardware_sound_player API Reference
 
-Config Reference:
-
-* [hardware_sound_player:](../../../config/hardware_sound_player.md)
-
 `self.machine.hardware_sound_player`
 
 ``` python
@@ -33,3 +29,8 @@ Parse string config.
 `play(settings, context, calling_context, priority=0, **kwargs)`
 
 Play sound on external card.
+
+## Related Pages:
+
+* [hardware_sound_player: Config Reference](../../../config/hardware_sound_player.md)
+* [Hardware Sound player Config Player Reference](../../../config_players/hardware_sound_player.md)

docs/code/api_reference/config_players/light_player.md

@@ -1,9 +1,5 @@
 # light_player API Reference
 
-Config Reference:
-
-* [light_player:](../../../config/light_player.md)
-
 `self.machine.light_player`
 
 ``` python
@@ -37,3 +33,8 @@ Handle subscriptions.
 `play(settings, context, calling_context, priority=0, **kwargs)`
 
 Set light color based on config.
+
+## Related Pages:
+
+* [light_player: Config Reference](../../../config/light_player.md)
+* [Light player Config Player Reference](../../../config_players/light_player.md)

docs/code/api_reference/config_players/queue_event_player.md

@@ -1,9 +1,5 @@
 # queue_event_player API Reference
 
-Config Reference:
-
-* [queue_event_player:](../../../config/queue_event_player.md)
-
 `self.machine.queue_event_player`
 
 ``` python
@@ -33,3 +29,9 @@ Post queue events.
 `validate_config_entry(settings, name)`
 
 Validate one entry of this player.
+
+## Related Pages:
+
+* [Queue Events](../../../events/overview/event_types.md#queue-events)
+* [queue_event_player: Config Reference](../../../config/queue_event_player.md)
+* [Queue Event player Config Player Reference](../../../config/queue_event_player.md)

docs/code/api_reference/config_players/queue_relay_player.md

@@ -1,9 +1,5 @@
 # queue_relay_player API Reference
 
-Config Reference:
-
-* [queue_relay_player:](../../../config/queue_relay_player.md)
-
 `self.machine.queue_relay_player`
 
 ``` python
@@ -37,3 +33,8 @@ Block queue event.
 `validate_config_entry(settings, name)`
 
 Validate one entry of this player.
+
+## Related Pages:
+
+* [queue_relay_player: Config Reference](../../../config/queue_relay_player.md)
+* [Queue Relay player Config Player Reference](../../../config_players/queue_relay_player.md)

docs/code/api_reference/config_players/random_event_player.md

@@ -1,9 +1,5 @@
 # random_event_player API Reference
 
-Config Reference:
-
-* [random_event_player:](../../../config/random_event_player.md)
-
 `self.machine.random_event_player`
 
 ``` python
@@ -41,3 +37,8 @@ Play a random event from list based on config.
 `validate_config_entry(settings, name)`
 
 Validate one entry of this player.
+
+## Related Pages:
+
+* [random_event_player: Config Reference](../../../config/random_event_player.md)
+* [Random Event player Config Player Reference](../../../config_players/random_event_player.md)

docs/code/api_reference/config_players/score_queue_player.md

@@ -1,9 +1,5 @@
 # score_queue_player API Reference
 
-Config Reference:
-
-* [score_queue_player:](../../../config/score_queue_player.md)
-
 `self.machine.score_queue_player`
 
 ``` python
@@ -37,3 +33,8 @@ Variable name.
 `validate_config_entry(settings: dict, name: str) → dict`
 
 Validate one entry of this player.
+
+## Related Pages:
+
+* [How to implement solid state game style score queues](../../../game_logic/scoring/ss_style_score_queues.md)
+* [score_queue_player: Config Reference](../../../config/score_queue_player.md)

docs/code/api_reference/config_players/segment_display_player.md

@@ -1,9 +1,5 @@
 # segment_display_player API Reference
 
-Config Reference:
-
-* [segment_display_player:](../../../config/segment_display_player.md)
-
 `self.machine.segment_display_player`
 
 ``` python
@@ -33,3 +29,8 @@ Parse express config.
 `play(settings, context, calling_context, priority=0, **kwargs)`
 
 Show text on display.
+
+## Related Pages:
+
+* [segment_display_player: Config Reference](../../../config/segment_display_player.md)
+* [Segment Display player Config Player Reference](../../../config_players/segment_display_player.md)