Merge pull request #6892 from keveleigh/header-standard

Standardize docs headers syntax

Author: keveleigh

Documentation/Boundary/ConfiguringBoundaryVisualization.md

@@ -6,7 +6,7 @@ The *Boundary Visualization Profile* provides options for configuring the visual
 
 ![Boundary Visualization General Settings](../../Documentation/Images/Boundary/BoundaryVisualizationGeneralSettings.png)
 
-**Boundary Height**
+### Boundary Height
 
 The boundary height indicates the distance above the floor plane at which the boundary ceiling should be rendered. The default value is 3 meters.
 

Documentation/Diagnostics/ConfiguringDiagnostics.md

@@ -4,7 +4,7 @@
 
 ![Diagnostics General Settings](../../Documentation/Images/Diagnostics/DiagnosticsGeneralSettings.png)
 
-**Show Diagnostics**
+### Show Diagnostics
 
 Indicates whether or not the diagnostics system is to display the configured diagnostic options.
 
@@ -14,27 +14,27 @@ When disabled, all configured diagnostic options will be hidden.
 
 ![Diagnostics Profiler Settings](../../Documentation/Images/Diagnostics/DiagnosticsProfilerSettings.png)
 
-**Show Profiler**
+### Show Profiler
 
 Indicates whether or not the Visual Profiler is to be displayed.
 
-**Frame Sample Rate**
+### Frame Sample Rate
 
 The amount of time, in seconds to collect frames for frame rate calculation. The range is 0 to 5 seconds.
 
-**Window Anchor**
+### Window Anchor
 
 To what portion of the view port should the profiler window be anchored. The default value is Lower Center.
 
-**Window Offset**
+### Window Offset
 
 The offset, from the center of the view port, to place the Visual Profiler. The offset will be in the direction of the *Window Anchor* property.
 
-**Window Scale**
+### Window Scale
 
 Size multiplier applied to the profiler window. For example, setting the value to 2 will double the window size.
 
-**Window Follow Speed**
+### Window Follow Speed
 
 The speed at which to move the profiler window to maintain visibility within the view port.
 

Documentation/EyeTracking/EyeTracking_TargetSelection.md

@@ -315,7 +315,7 @@ public class HitBehaviorDestroyOnSelect : MonoBehaviour
 }
 ```
 
-### Example #4: Use hand rays and eye gaze input together!
+### Example #4: Use hand rays and eye gaze input together
 
 Hand rays take priority over head and eye gaze targeting. This means, if hand rays are enabled, the moment the hands come into view, the hand ray will act as the primary pointer.
 However, there might be situations in which you want to use hand rays while still detecting whether a user is looking at a certain hologram. Easy! Essentially you require two steps:

Documentation/README_AppBar.md

@@ -1,10 +1,10 @@
-# App bar #
+# App bar
 
 ![App bar](../Documentation/Images/AppBar/MRTK_AppBar_Main.png)
 
 App bar is a UI component that is used together with the [bounding box](README_BoundingBox.md) script. It adds button controls to an object with the intent to manipulate it. Using the 'Adjust' button, the bounding box interface for an object can be de- / activated. The "Remove" button should remove the object from the scene.
 
-## How to use app bar ##
+## How to use app bar
 
 Drag and drop [AppBar.prefab](https://github.com/Microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Assets/MixedRealityToolkit.SDK/Features/UX/Prefabs/AppBar/AppBar.prefab) into the scene hierarchy. In the inspector panel of the component, assign any object with a bounding box as the *Target Bounding Box* to add the app bar to it.
 

Documentation/README_BoundingBox.md

@@ -94,17 +94,17 @@ private void PutABoxAroundIt(GameObject target)
 }
 ```
 
-## Inspector properties ##
+## Inspector properties
 
-**Target Object**
+### Target Object
 
 This property specifies which object will get transformed by the bounding box manipulation. If no object is set, the bounding box defaults to the owner object.
 
-**Bounds Override**
+### Bounds Override
 
 Sets a box collider from the object for bounds computation.
 
-**Activation Behavior**
+### Activation Behavior
 
 There are several options to activate the bounding box interface.
 
@@ -113,25 +113,25 @@ There are several options to activate the bounding box interface.
 * *Activate By Pointer*: Bounding Box becomes visible when it is targeted by a hand-ray pointer.
 * *Activate Manually*: Bounding Box does not become visible automatically. You can manually activate it through a script by accessing the boundingBox.Active property.
 
-**Scale Minimum**
+### Scale Minimum
 
 The minimum allowed scale. This property is deprecated and it is preferable to add a [`TransformScaleHandler`](https://github.com/Microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Assets/MixedRealityToolkit.SDK/Features/Input/Handlers/TransformScaleHandler.cs) script. If this script is added, the minimum scale will be taken from it instead of from BoundingBox.
 
-**Scale Maximum**
+### Scale Maximum
 
 The maximum allowed scale. This property is deprecated and it is preferable to add a [`TransformScaleHandler`](https://github.com/Microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Assets/MixedRealityToolkit.SDK/Features/Input/Handlers/TransformScaleHandler.cs) script. If this script is added, the maximum scale will be taken from it instead of from BoundingBox.
 
-**Box Display**
+### Box Display
 
 Various bounding box visualization options.
 
 If Flatten Axis is set to *Flatten Auto*, the script will disallow manipulation along the axis with the smallest extent. This results in a 2D bounding box, which is usually used for thin objects.
 
-**Handles**
+### Handles
 
 You can assign the material and prefab to override the handle style. If no handles are assigned, they will be displayed in the default style.
 
-## Events ##
+## Events
 
 Bounding box provides the following events. The example uses these events to play audio feedback.
 
@@ -177,7 +177,7 @@ Show and hide the handles with animation based on the distance to the hands. It
 * **Medium Scale**: Scale value of the handle asset when the hands are within the range of the Bounding Box interaction(distance defined above by 'Handle Close Proximity'. Use 1 to show normal size)
 * **Close Scale**: Scale value of the handle asset when the hands are within the grab interaction(distance defined above by 'Handle Close Proximity'. Use 1.x to show bigger size)
 
-## Making an object movable with manipulation handler ##
+## Making an object movable with manipulation handler
 
 A bounding box can be combined with [`ManipulationHandler.cs`](README_ManipulationHandler.md) to make the object movable using far interaction. The manipulation handler supports both one and two-handed interactions. [Hand tracking](Input/HandTracking.md) can be used to interact with an object up close.
 

Documentation/README_Button.md

@@ -189,7 +189,7 @@ You will see the object responds to both far(hand ray or gaze cursor) and near(h
 <img src="../Documentation/Images/Button/MRTK_PressableButtonCubeRun3.jpg">
 <img src="../Documentation/Images/Button/MRTK_PressableButtonCubeRun4.jpg">
 
-## Custom Button Examples ##
+## Custom Button Examples
 
 In the [HandInteractionExample scene](README_HandInteractionExamples.md), you can take a look at the piano and round button examples which are both using `PressableButton`.
 

Documentation/README_ExampleHub.md

@@ -1,17 +1,19 @@
-# MRTK Examples Hub #
+# MRTK Examples Hub
 
 ![MRTK Examples Hub](../Documentation/Images/ExamplesHub/MRTK_ExamplesHub.png)
 
 MRTK Examples Hub is a Unity scene that makes it easy to experience multiple scenes. It uses MRTK's Scene System to load & unload the scenes.
 
 **MRTKExamplesHub.unity** is the container scene that has shared components including ``MixedRealityToolkit`` and ``MixedRealityPlayspace``. **MRTKExamplesHubMainMenu.unity** scene has the cube buttons.
 
-## Prerequisite ##
+## Prerequisite
 
 MRTK Examples Hub uses [Scene Transition Service](https://microsoft.github.io/MixedRealityToolkit-Unity/Documentation/Extensions/SceneTransitionService/SceneTransitionServiceOverview.html) and related scripts. If you are using MRTK through Unity packages, please import **Microsoft.MixedReality.Toolkit.Unity.Extensions.x.x.x.unitypackage** which is part of the [release packages](https://github.com/microsoft/MixedRealityToolkit-Unity/releases). If you are using MRTK through the repository clone, you should already have **MixedRealityToolkit.Extensions** folder in your project.
 
-## MRTKExamplesHub Scene and the Scene System ##
-Open **MRTKExamplesHub.unity** which is located at ``MixedRealityToolkit.Examples/Experimental/Demos/ExamplesHub/Scenes/`` It is an empty scene with MixedRealityToolkit, MixedRealityPlayspace and LoadHubOnStartup. This scene is configured to use MRTK's Scene System. Click ``MixedRealitySceneSystem`` under MixedRealityToolkit. It will display the Scene System's information in the Inspector panel.
+## MRTKExamplesHub Scene and the Scene System
+
+Open **MRTKExamplesHub.unity** which is located at `MixedRealityToolkit.Examples/Experimental/Demos/ExamplesHub/Scenes/` It is an empty scene with MixedRealityToolkit, MixedRealityPlayspace and LoadHubOnStartup. This scene is configured to use MRTK's Scene System. Click `MixedRealitySceneSystem` under MixedRealityToolkit. It will display the Scene System's information in the Inspector panel.
+
 <br/><br/><img src="../Documentation/Images/ExamplesHub/MRTK_ExamplesHub_Hierarchy.png" width="300">
 <br/><br/><img src="../Documentation/Images/ExamplesHub/MRTK_ExamplesHub_Inspector1.png" width="450">
 
@@ -23,13 +25,13 @@ On the bottom of the Inspector, it displays the list of the scenes defined in th
 <br/><br/><img src="../Documentation/Images/ExamplesHub/MRTK_ExamplesHub_SceneSystem5.png">
 Example of loading multiple scenes.
 
-## Running the scene ##
+## Running the scene
 
 The scene works in both Unity's game mode and on device. Run the **MRTKExamplesHub** scene in the Unity editor and use MRTK's input simulation to interact with the scene contents. To build and deploy, simply build **MRTKExamplesHub** scene with other scenes that are included in the Scene System's list. The inspector also makes it easy to add scenes to the Build Settings. In the Building Settings, make sure **MRTKExamplesHub** scene is on the top of the list at index 0.
 
 <img src="../Documentation/Images/ExamplesHub/MRTK_ExamplesHub_BuildSettings.png" width="450">
 
-## How MRTKExamplesHub loads a scene ##
+## How MRTKExamplesHub loads a scene
 
 In the **MRTKExamplesHub** scene, you can find the ``ExamplesHubButton`` prefab.
 There is a **FrontPlate** object in the prefab which contains ``Interactable``.
@@ -46,18 +48,17 @@ Please refer to the [Scene System](SceneSystem/SceneSystemGettingStarted.md) pag
 ```c#
 MixedRealityToolkit.SceneSystem.LoadContent(contentName, loadSceneMode);
 ```
- 
-## Returning to the main menu scene ##
+
+## Returning to the main menu scene
 
 To return to the main menu scene (MRTKExamplesHubMainMenu scene), you can use the same Scene System `LoadContent()` method. The **ToggleFeaturesPanelExamplesHub.prefab** provides the 'Home' button which contains the **LoadContentScene** script. Use this prefab or provide a custom home button in each scene to allow the user to return to the main scene. One can put the **ToggleFeaturesPanelExamplesHub.prefab** in the **MRTKExamplesHub** scene to make it always visible since **MRTKExamplesHub** is a shared container scene. Make sure to hide/deactivate **ToggleFeaturesPanel.prefab** in each example scene.
 
 <img src="../Documentation/Images/ExamplesHub/MRTK_ExamplesHubToggleFeaturesPanel.png">
 
 <img src="../Documentation/Images/ExamplesHub/MRTK_ExamplesHubHomeButton.png" width="450">
 
+## Adding additional buttons
 
-
-## Adding additional buttons ##
 In the **CubeCollection** object, duplicate (or add) _ExampleHubButton_ prefabs and click **Update Collection** in the `GridObjectCollection`.
 This will update the cylinder layout based on the new total number of buttons.
 Please refer to the [Object Collection](README_ObjectCollection.md) page for more details.

Documentation/README_FingertipVisualization.md

@@ -1,24 +1,24 @@
-# Fingertip visualization #
+# Fingertip visualization
 
 ![Fingertip visualization](../Documentation/Images/Fingertip/MRTK_FingertipVisualization_Main.png)
 
 The fingertip affordance helps the user recognize the distance from the target object. The ring shape visual adjusts its size based on the distance from the fingertip to the object. The fingertip visualization is primarily controlled by the [FingerCursor.prefab](https://github.com/Microsoft/MixedRealityToolkit-Unity/blob/mrtk_release/Assets/MixedRealityToolkit.SDK/Features/UX/Prefabs/Cursors/FingerCursor.prefab) (and script) which is spawned as the cursor prefab of the *PokePointer*. Other components of the visualization include the *ProximityLight* script, and *MixedRealityStandard* shader.
 
-## How to use the fingertip visualization ##
+## How to use the fingertip visualization
 
 By default the fingertip visualization will work in any Unity scene that is configured to spawn a FingerCursor. Spawning of the FingerCursor occurs in the *DefaultMixedRealityToolkitConfigurationProfile* under:
 
 *DefaultMixedRealityInputSystemProfile > DefaultMixedRealityInputPointerProfile > PokePointer > FingerCursor*
 
 At a high level the fingertip visualization works by using a proximity light to project a colored gradient on any nearby surfaces that accept proximity lights. The finger cursor then looks for any nearby interactable surfaces, which are determined by parent `IMixedRealityNearPointer(s)`, to align the finger ring with a surface as the finger moves towards a surface. As a finger approaches a surface the finger ring is also dynamically animated using the round corner properties of the MixedRealityStandard shader.
 
-## Example scene ##
+## Example scene
 
 You can find fingertip visualization examples in almost any scene that works with articulated hands, but is prominent in the [HandInteractionExample scene](README_HandInteractionExamples.md).
 
 ![Fingertip visualization](../Documentation/Images/Fingertip/MRTK_FingertipVisualization_States.png)
 
-## Inspector properties ##
+## Inspector properties
 
 **FingerCursor**
 Many of the finger cursor properties are inherited from the base cursor class. Important properties include the far / near surface margins and widths which drive the finger ring animation in the MixedRealityStandard shader. For other properties please hover over the inspector tool tips.

Documentation/README_HandInteractionExamples.md

@@ -1,4 +1,4 @@
-# Hand interaction examples scene #
+# Hand interaction examples scene
 
 ![Hand Interaction Examples](../Documentation/Images/MRTK_Examples.png)
 
@@ -13,27 +13,27 @@ If you see large text after the TextMesh Pro import, open another Unity scene an
 
 <img src="../Documentation/Images/HandInteractionExamples/MRTK_Examples_TMP1.png" width="350">
 
-## Pressable button ##
+## Pressable button
 
 See [button](README_Button.md) page for the details.
 ![Hand Interaction Examples](../Documentation/Images/HandInteractionExamples/MRTK_Examples_PressTouch.png)
 
-## Bounding box ##
+## Bounding box
 
 See [bounding box](README_BoundingBox.md) page for the details.
 ![Hand Interaction Examples](../Documentation/Images/HandInteractionExamples/MRTK_Examples_BoundingBox.png)
 
-## Manipulation handler ##
+## Manipulation handler
 
 See [manipulation handler](README_ManipulationHandler.md) page for the details.
 ![Hand Interaction Examples](../Documentation/Images/HandInteractionExamples/MRTK_Examples_Manipulation.png)
 
-## Slate ##
+## Slate
 
 See [slate](README_Slate.md) page for the details.
 ![Hand Interaction Examples](../Documentation/Images/HandInteractionExamples/MRTK_Examples_Slate.png)
 
-## System keyboard ##
+## System keyboard
 
 See [system keyboard](README_SystemKeyboard.md) page for the details.
 ![Hand Interaction Examples](../Documentation/Images/HandInteractionExamples/MRTK_Examples_Keyboard.png)

Documentation/README_LostTrackingService.md

@@ -4,7 +4,8 @@
 
 Lost Tracking Extension Service provides HoloLens shell style animated visual for the lost tracking state.
 
-## How to use Lost Tracking Extensions ##
-In MRTK Profile, add **Lost Tracking Service** to the Extensions. Assign **DefaultLostTrackingServiceProfile** which includes **LostTrackingVisualPrefab**. 
+## How to use Lost Tracking Extensions
 
-<img src="../Documentation/Images/LostTracking/LostTracking_Extensions.png" width="550">
+In MRTK Profile, add **Lost Tracking Service** to the Extensions. Assign **DefaultLostTrackingServiceProfile** which includes **LostTrackingVisualPrefab**.
+
+<img src="../Documentation/Images/LostTracking/LostTracking_Extensions.png" width="550">