Merge pull request #623 from bosh/var_reference_refactor

Var reference refactor

Author: bosh

docs/machine_vars/index.md

@@ -4,7 +4,6 @@ title: Machine Variables
 
 # Machine Variables
 
-
 MPF uses the concept of *machine variables* to track dynamically-created
 variables that apply on a machine-wide basis. Machine variables are
 similar in concept to
@@ -41,48 +40,75 @@ with your variable name. If you want to access the machine variable in a player,
 `{machine.my_var_name}`. In other words, when using the the first notation with the pipe symbol you access the value of the variable
 as a string, in the latter case using the dot notation you access the value itself.
 
-Video about player and machine variables:
+### Video about machine and [player variables](../player_vars/index.md):
 
 <div class="video-wrapper">
 <iframe width="560" height="315" src="https://www.youtube.com/embed/PUxEsNUGXPY" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
 </div>
 
+## Related Configs
+
+* [machine_vars: Config Reference](../config/machine_vars.md)
+* [variable_player: Config Reference](../config/variable_player.md)
+
+## Built-in Machine Variables
+
 You can create your own machine variables in your configs. There are
 also several machine variables that are automatically created. Here's a
 list of the machine variables that are "built in" and available for
-use in your configs:
+use in your configs, grouped by feature set:
+
+#### MPF general info
+
+* [mpf_extended_version](mpf_extended_version.md)
+* [mpf_version](mpf_version.md)
+* [python_version](python_version.md)
+* [platform](platform.md)
+* [platform_machine](platform_machine.md)
+* [platform_release](platform_release.md)
+* [platform_system](platform_system.md)
+* [platform_version](platform_version.md)
+
+#### Previous game scores
+
+* [player(x)_score](playerx_score.md)
+
+#### High scores
+
+* [(high_score_category)(position)_label](high_score_categoryposition_label.md)
+* [(high_score_category)(position)_name](high_score_categoryposition_name.md)
+* [(high_score_category)(position)_value](high_score_categoryposition_value.md)
+* [(high_score_category)(position)\_(variable_type)_(variable)](high_score_categoryposition_variabletype_variable.md)
+
+#### Credit management (if not on free play)
 
 * [credit_units](credit_units.md)
 * [credits_denominator](credits_denominator.md)
 * [credits_numerator](credits_numerator.md)
 * [credits_string](credits_string.md)
 * [credits_value](credits_value.md)
 * [credits_whole_num](credits_whole_num.md)
+
+#### MPF-MC version information (pre-MPF 0.80)
+
+* [mc_extended_version](mc_extended_version.md)
+* [mc_version](mc_version.md)
+
+## Platform-specific machine variables
+
+Some platforms will also add additional machine variables based on
+how they are set up. Some examples:
+
 * [fast_(x)_firmware](fast_x_firmware.md)
 * [fast_(x)_model](fast_x_model.md)
-* [(high_score_category)(position)_label](high_score_categoryposition_label.md)
-* [(high_score_category)(position)_name](high_score_categoryposition_name.md)
-* [(high_score_category)(position)_value](high_score_categoryposition_value.md)
-* [(high_score_category)(position)\_(variable_type)_(variable)](high_score_categoryposition_variabletype_variable.md)
 * [lisy_api_version](lisy_api_version.md)
 * [lisy_hardware](lisy_hardware.md)
 * [lisy_version](lisy_version.md)
-* [mc_extended_version](mc_extended_version.md)
-* [mc_version](mc_version.md)
-* [mpf_extended_version](mpf_extended_version.md)
-* [mpf_version](mpf_version.md)
 * [p_roc_hardware_version](p_roc_hardware_version.md)
 * [p_roc_revision](p_roc_revision.md)
 * [p_roc_version](p_roc_version.md)
 * [pkone_firmware](pkone_firmware.md)
 * [pkone_hardware](pkone_hardware.md)
-* [platform](platform.md)
-* [platform_machine](platform_machine.md)
-* [platform_release](platform_release.md)
-* [platform_system](platform_system.md)
-* [platform_version](platform_version.md)
-* [player(x)_score](playerx_score.md)
-* [python_version](python_version.md)
 
 ## Related Events
 

docs/player_vars/index.md

@@ -4,19 +4,23 @@ title: Player Variables Reference
 
 # Player Variables Reference
 
-
 Here's a list of all the different "built in"
 [player variables](../game_logic/players.md) that MPF uses.
 
 You can use these in your config files to trigger game logic or to
 display as text on your display.
 
-Video about player and machine variables:
+### Video about player and [machine variables](../machine_vars/index.md):
 
 <div class="video-wrapper">
 <iframe width="560" height="315" src="https://www.youtube.com/embed/PUxEsNUGXPY" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
 </div>
 
+## Related Configs
+
+* [player_vars: Config Reference](../config/player_vars.md)
+* [variable_player: Config Reference](../config/variable_player.md)
+
 Note that you can also create your own player variables in your configs,
 and most likely your machine will have several orders of magnitude more
 player variables than this list here.