Merge pull request #3825 from keveleigh/spell-check

wiwei · web-flow · commit 0143b99f7add · 2019-04-04T09:49:54.000-07:00
Spell check: documentation pass
diff --git a/Documentation/DevDocGuide.md b/Documentation/DevDocGuide.md
@@ -68,7 +68,7 @@ The toc file in the root of the project defines entries in the top navigation ba
 toc.yml files can be used for structuring and there can be any amount of those files. For more info about defining entries for toc.yml check the [docfx documentation entry on toc](https://dotnet.github.io/docfx/tutorial/intro_toc.html).
 
 ## Resource files
-There are some files like images, videos or pdfs that the documentation can refer to but are not converted by docfx. For those files there's a resource section in the docfx.json. Files in that section will only be copied over without performing any conversion on them.
+There are some files like images, videos or PDFs that the documentation can refer to but are not converted by docfx. For those files there's a resource section in the docfx.json. Files in that section will only be copied over without performing any conversion on them.
 
 Currently there's a definition for the following resource types:
 
diff --git a/Documentation/InputSimulation/InputSimulationService.md b/Documentation/InputSimulation/InputSimulationService.md
@@ -1,9 +1,9 @@
 # Input Simulation Service
 
 The Input Simulation Service emulates the behaviour of devices and platforms that may not be available in the Unity editor. Examples include:
-* Hololens or VR device head tracking
-* Hololens hand gestures
-* Hololens 2 articulated hand tracking
+* HoloLens or VR device head tracking
+* HoloLens hand gestures
+* HoloLens 2 articulated hand tracking
 
 Users can use a conventional keyboard and mouse combination to control simulated devices at runtime. This allows testing of interactions in the Unity editor without first deploying to a device.
 
diff --git a/Documentation/MixedRealityConfigurationGuide.md b/Documentation/MixedRealityConfigurationGuide.md
@@ -173,7 +173,7 @@ The diagnostics profile provides several simple systems to monitor whilst the pr
 
 One of the more advanced areas of the Mixed Reality Toolkit is its [service locator pattern](https://en.wikipedia.org/wiki/Service_locator_pattern) implementation which allows the registering of any "Service" with the framework. This allows the framework to be both extended with new features / systems easily but also allows for projects to take advantage of these capabilities to register their own runtime components.
 
-> You can read more about the underlying framework and it's implementation in [Stephen Hodgson's article on the Mixed Reality Framework](https://medium.com/@stephen_hodgson/the-mixed-reality-framework-6fdb5c11feb2)
+> You can read more about the underlying framework and its implementation in [Stephen Hodgson's article on the Mixed Reality Framework](https://medium.com/@stephen_hodgson/the-mixed-reality-framework-6fdb5c11feb2)
 
 Any registered service still gets the full advantage of all of the Unity events, without the overhead and cost of implementing a MonoBehaviour or clunky singleton patterns.  This allows for pure C# components with no scene overhead for running both foreground and background processes, e.g. spawning systems, runtime gamelogic, or practically anything else.
 
@@ -253,7 +253,7 @@ There's an additional helper button to quickly jump to the Gaze Provider to over
 
 ## Gestures Configuration
 
-Gestures are a system specific implementation allowing you to assign Input Actions to the various "Gesture" input methods provided by various SDK's (e.g. HoloLens).
+Gestures are a system specific implementation allowing you to assign Input Actions to the various "Gesture" input methods provided by various SDKs (e.g. HoloLens).
 
 > Note, the current implementation is for the HoloLens only and will be enhanced for other systems as they are added to the Toolkit in the future (no dates yet).
 
diff --git a/Documentation/README_AppBar.md b/Documentation/README_AppBar.md
@@ -4,7 +4,7 @@
 App Bar is a UI component used with Bounding Box. Using the 'Adjust' button, you can turn on/off the Bounding Box interface for manipulating object.
 
 ## How to use App Bar
-Drog and drop **AppBar** prefab into the scene hierarchy. In the inspector panel of the AppBar, you will see **Bounding Box** under **Target Bounding Box** section. Assign any objects that has Bounding Box. **Important: Target object's Bounding Box activation option should be 'Activate Manually'**
+Drag and drop **AppBar** prefab into the scene hierarchy. In the inspector panel of the AppBar, you will see **Bounding Box** under **Target Bounding Box** section. Assign any objects that has Bounding Box. **Important: Target object's Bounding Box activation option should be 'Activate Manually'**
 
 <img src="/External/ReadMeImages/AppBar/MRTK_AppBar_Setup1.png" width="450">
 
diff --git a/Documentation/README_BoundingBox.md b/Documentation/README_BoundingBox.md
@@ -61,4 +61,4 @@ If you want to make the object movable using far interaction, you can combine [`
 
 <img src="/External/ReadMeImages/BoundingBox/MRTK_BoundingBox_ManipulationHandler.png" width="450">
 
-In order for the bounding box edges to be highlighted the same way when moving it using [`ManipulationHandler`](README_ManipulationHandler.md)'s far interaction, it is advised to connect its events for **On Manipulation Started** / **On Manipulation Ended** to `BoundingBox.HightlightWires` / `BoundingBox.UnhighlightWires` respectively, as shown in the screenshot above.
+In order for the bounding box edges to be highlighted the same way when moving it using [`ManipulationHandler`](README_ManipulationHandler.md)'s far interaction, it is advised to connect its events for **On Manipulation Started** / **On Manipulation Ended** to `BoundingBox.HighlightWires` / `BoundingBox.UnhighlightWires` respectively, as shown in the screenshot above.
diff --git a/Documentation/README_Button.md b/Documentation/README_Button.md
@@ -22,7 +22,7 @@ In the idle state, the button's front plate is not visible. As a finger approach
 
 <img src="/External/ReadMeImages/Button/MRTK_Button_InteractionStates.png" width="600">
 
-The subtle pulse effect is triggerd by the `PressableButton.` The `PressableButton` looks for `ProximityLight(s)` that live on the currently interacting pointer. If any `ProximityLight(s)` are found, the ProximityLight.Pulse method is called which automatically animates shader parameters to display a pulse.
+The subtle pulse effect is triggered by the `PressableButton.` The `PressableButton` looks for `ProximityLight(s)` that live on the currently interacting pointer. If any `ProximityLight(s)` are found, the ProximityLight.Pulse method is called which automatically animates shader parameters to display a pulse.
 
 ## Property Inspector of PressableButton 
 ![Button](/External/ReadMeImages/Button/MRTK_Button_Structure.png)
diff --git a/Documentation/README_FingertipVisualization.md b/Documentation/README_FingertipVisualization.md
@@ -12,7 +12,7 @@ By default the fingertip visualization will work in any Unity scene that is conf
         - 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 interactible 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.
+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 ###
 
diff --git a/Documentation/README_Interactable.md b/Documentation/README_Interactable.md
@@ -69,7 +69,7 @@ Example of the Default Theme.
 Example of a Color Theme
 
 The best way to save a profile of a button, with all the themes and targets setup, is to create a prefab of your button.
-_Note: Themes that effect mesh objects (Color or Shader Themes) are able to detect the shader properties in the material assigned to the target object. A drop down list of shader properties will define how the values of the theme are applied and is a conveience of this ability. Conflicts can arrise if the same theme is used on objects that do not share the same material shader setting. Best practice is to create a seperate theme for objects with different shaders; this is not an issue when using the same Color Theme on a text object and a mesh object, because all the shader properties are ignored on text objects._
+_Note: Themes that effect mesh objects (Color or Shader Themes) are able to detect the shader properties in the material assigned to the target object. A drop down list of shader properties will define how the values of the theme are applied and is a convenience of this ability. Conflicts can arise if the same theme is used on objects that do not share the same material shader setting. Best practice is to create a separate theme for objects with different shaders; this is not an issue when using the same Color Theme on a text object and a mesh object, because all the shader properties are ignored on text objects._
 
 ### Creating Toggles
 Toggle or multi-step buttons can be created in the Profile using the Dimensions field. The idea is that each set of states can have multiple dimensions and in this case, when the Dimensions value is increased, slots for additional themes are provided for each item in the Profile. This allows for a Normal Theme and a Toggled Theme to be used depending if the Interactable is toggled or not. 
@@ -116,7 +116,7 @@ States are a list of terms that can be used to define interactions phases, like
 
 Interactable States provides two major roles.
 - Establish a list of states that we care about. This list will be displayed in the themes and can also be referenced by the events.
-- Controls how different interaction phases are ranked into states. For instance, a press state is also in a focused state, but the InteractableStates class will define it is a press state based on the ranking preferences setup in the State scriptableObject.
+- Controls how different interaction phases are ranked into states. For instance, a press state is also in a focused state, but the InteractableStates class will define it is a press state based on the ranking preferences setup in the State ScriptableObject.
 
 <img src="/External/ReadMeImages/Interactable/StatesScriptableObject.png" width="450">
 
@@ -232,7 +232,7 @@ public override void OnUpdate(InteractableStates state, Interactable source)
             bool isDefault = state.GetState(InteractableStates.InteractableStateEnum.Default).Value > 0;
             bool hasGesture = state.GetState(InteractableStates.InteractableStateEnum.Gesture).Value > 0;
             bool hasGestureMax = state.GetState(InteractableStates.InteractableStateEnum.GestureMax).Value > 0;
-            bool hasCollistion = state.GetState(InteractableStates.InteractableStateEnum.Collision).Value > 0;
+            bool hasCollision = state.GetState(InteractableStates.InteractableStateEnum.Collision).Value > 0;
             bool hasPhysicalTouch = state.GetState(InteractableStates.InteractableStateEnum.PhysicalTouch).Value > 0;
             bool hasCustom = state.GetState(InteractableStates.InteractableStateEnum.Custom).Value > 0;
             or:
diff --git a/Documentation/README_ManipulationHandler.md b/Documentation/README_ManipulationHandler.md
@@ -47,7 +47,7 @@ Specifies how the object will behave when it is being grabbed with one hand/cont
 ### One Hand Rotation Mode Options
 * Maintain original rotation - does not rotate object as it is being moved
 * Maintain rotation to user - maintains the object's original rotation to the user
-* Gravity aligned maintain rotation to user - maintain's object's original rotation to user, but makes the object vertical. Useful for bounding boxes.
+* Gravity aligned maintain rotation to user - maintains object's original rotation to user, but makes the object vertical. Useful for bounding boxes.
 * Face user - ensures object always faces the user. Useful for slates/panels.
 * Face away from user - ensures object always faces away from user. Useful for slates/panels that are configured backwards.
 * Rotate about object center - Only works for articulated hands/controllers. Rotate object using rotation of the hand/controller, but about the object center point. Useful for inspecting at a distance.
diff --git a/Documentation/README_Pointers.md b/Documentation/README_Pointers.md
@@ -29,7 +29,7 @@ For other controllers like HoloLens 2 articulated hands, the rotation matches th
 ### GGV Pointer
 GGV stands for "Gaze, Gesture, Voice"<sup>[2](https://docs.microsoft.com/en-us/windows/mixed-reality/gaze)</sup>. The GGV pointer's position and direction is driven by the head's position and rotation. The pointer is used to provide input that matches the HoloLens V1 input style of head gaze + airtap<sup>[3](https://docs.microsoft.com/en-us/windows/mixed-reality/gestures)</sup>.
 
-In the pointer profile you can see that the V1 Hololens input system is provided for you via the mapping of "GGVHand" (V1 HoloLens hand) to the GGVPointer. 
+In the pointer profile you can see that the V1 HoloLens input system is provided for you via the mapping of "GGVHand" (V1 HoloLens hand) to the GGVPointer. 
 
 <img src="/External/ReadMeImages/Pointers/MRTK_GGVPointer_HL1.jpg" width="600">
 
diff --git a/Documentation/README_Solver.md b/Documentation/README_Solver.md
@@ -25,7 +25,7 @@ When **UpdateLinkedTransform** is *true*, the solver will calculate position & o
 ## How do I add a solver to my scene?
 - Add the desired behavior to an object. **SolverHandler** will be added automatically. You can mix and match, their order will change how the object behaves at runtime.
 - **SolverHandler** has two fields for setting the reference object. You can choose a tracked object (such as the user camera or L/R motion controllers), or instead use the **TransformTarget** field which overrides any set tracked object. This enables you to have solvers reference any scene object. Yes, that means objects can have tag alongs and cast surface magnetism as well as tracked objects. Very handy.
-- Surface magnatism scripts rely on a *LayerMask* for raycasting. As a recommendation, create a custom *LayerMask* (the example uses *Surface*). Note that using *default* or *everything* will result in UI components or cursors contributing to the solver. This can produce weird and unexpected behavior. Objects lurching toward you etc...
+- Surface magnetism scripts rely on a *LayerMask* for raycasting. As a recommendation, create a custom *LayerMask* (the example uses *Surface*). Note that using *default* or *everything* will result in UI components or cursors contributing to the solver. This can produce weird and unexpected behavior. Objects lurching toward you etc...
 
 <img src="/External/ReadMeImages/Solver/MRTK_Solver_Orbital.png" width="450">
 
@@ -37,4 +37,4 @@ Example of using Orbital solver in the [Slate](README_Slate.md) prefab.
 
 
 ## Known Issues
-- Sometimes solvers behave differently than one may expect based on the order in which they're executed. Previous solvers can change or even neutralize the behavior of earlier sovlers. Try re-arranging their execution order if the settings on a particular solver aren't having the desired effect.
+- Sometimes solvers behave differently than one may expect based on the order in which they're executed. Previous solvers can change or even neutralize the behavior of earlier solvers. Try re-arranging their execution order if the settings on a particular solver aren't having the desired effect.
diff --git a/Documentation/SpatialAwareness/ConfiguringSpatialAwarenessMeshObserver.md b/Documentation/SpatialAwareness/ConfiguringSpatialAwarenessMeshObserver.md
@@ -1,6 +1,6 @@
 # Configuring the Spatial Awareness Mesh Observer
 
-The spatial swareness mesh observer profile provides options for configuring:
+The spatial awareness mesh observer profile provides options for configuring:
 - [General Settings](#general-settings)
 - [Physics Settings](#physics-settings)
 - [Level of Detail Settings](#level-of-detail-settings)
diff --git a/Documentation/toc.yml b/Documentation/toc.yml
@@ -54,9 +54,9 @@
       items:
       - name: Interactable
         href: README_Interactable.md
-      - name: Obeject Manipulation 
+      - name: Object Manipulation 
         href: README_ManipulationHandler.md      
-      - name: Fintertip Visualization
+      - name: Fingertip Visualization
         href: README_FingertipVisualization.md      
       - name: Hand Interaction Example 
         href: README_HandInteractionExamples.md           

Original file line number	Diff line number	Diff line change
@@ -61,4 +61,4 @@ If you want to make the object movable using far interaction, you can combine [`
`61`	`61`
`62`	`62`	`<img src="/External/ReadMeImages/BoundingBox/MRTK_BoundingBox_ManipulationHandler.png" width="450">`
`63`	`63`
`64`		-In order for the bounding box edges to be highlighted the same way when moving it using [`ManipulationHandler`](README_ManipulationHandler.md)'s far interaction, it is advised to connect its events for On Manipulation Started / On Manipulation Ended to `BoundingBox.HightlightWires` / `BoundingBox.UnhighlightWires` respectively, as shown in the screenshot above.
	`64`	+In order for the bounding box edges to be highlighted the same way when moving it using [`ManipulationHandler`](README_ManipulationHandler.md)'s far interaction, it is advised to connect its events for On Manipulation Started / On Manipulation Ended to `BoundingBox.HighlightWires` / `BoundingBox.UnhighlightWires` respectively, as shown in the screenshot above.