DOCS: Add uids to markdown documents so that dependent packages can link to the correct version. (#1714)

Joe Ward · jamesmcgill · web-flow · commit e8bbe3df8f8e · 2023-07-18T19:07:29.000+02:00
Co-authored-by: James McGill &lt;jamesmcgill@users.noreply.github.com&gt;
diff --git a/Packages/com.unity.inputsystem/Documentation~/ActionAssets.md b/Packages/com.unity.inputsystem/Documentation~/ActionAssets.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-action-assets
+---
 # Input Action Assets
 
 * [Creating Action Assets](#creating-input-action-assets)
diff --git a/Packages/com.unity.inputsystem/Documentation~/ActionBindings.md b/Packages/com.unity.inputsystem/Documentation~/ActionBindings.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-action-bindings
+---
 # Input Bindings
 
 * [Composite Bindings](#composite-bindings)
diff --git a/Packages/com.unity.inputsystem/Documentation~/Actions.md b/Packages/com.unity.inputsystem/Documentation~/Actions.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-actions
+---
 # Actions
 
 - [Actions](#actions)
diff --git a/Packages/com.unity.inputsystem/Documentation~/Architecture.md b/Packages/com.unity.inputsystem/Documentation~/Architecture.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-architecture
+---
 # Architecture
 
 The Input System has a layered architecture that consists of a low-level layer and a high-level layer.
diff --git a/Packages/com.unity.inputsystem/Documentation~/Concepts.md b/Packages/com.unity.inputsystem/Documentation~/Concepts.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-concepts
+---
 # Input System Concepts
 
 This page introduces the concepts that relate to working with the Input System.
diff --git a/Packages/com.unity.inputsystem/Documentation~/Contributing.md b/Packages/com.unity.inputsystem/Documentation~/Contributing.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-contributing
+---
 # Contributing
 
 The [full source code](https://github.com/Unity-Technologies/InputSystem) for the Input System is available on GitHub. This is also where most of the Input System's development happens.
diff --git a/Packages/com.unity.inputsystem/Documentation~/Controls.md b/Packages/com.unity.inputsystem/Documentation~/Controls.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-controls
+---
 # Controls
 
 * [Hierarchies](#control-hierarchies)
diff --git a/Packages/com.unity.inputsystem/Documentation~/Debugging.md b/Packages/com.unity.inputsystem/Documentation~/Debugging.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-debugging
+---
 # Debugging
 
 - [Debugging](#debugging)
diff --git a/Packages/com.unity.inputsystem/Documentation~/Devices.md b/Packages/com.unity.inputsystem/Documentation~/Devices.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-devices
+---
 # Devices
 
 - [Devices](#devices)
diff --git a/Packages/com.unity.inputsystem/Documentation~/EditorFeatures.md b/Packages/com.unity.inputsystem/Documentation~/EditorFeatures.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-editor-features
+---
 # Input System Editor Features
 
 This section describes how the Input System integrates with the Unity Editor, which allows you to read input in edit mode, debug input values, and set up automated input tests.
diff --git a/Packages/com.unity.inputsystem/Documentation~/Events.md b/Packages/com.unity.inputsystem/Documentation~/Events.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-events
+---
 # Input events
 
 * [Types of events](#types-of-events)
diff --git a/Packages/com.unity.inputsystem/Documentation~/Gamepad.md b/Packages/com.unity.inputsystem/Documentation~/Gamepad.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-gamepad
+---
 # Gamepad Support
 
 - [Gamepad Support](#gamepad-support)
diff --git a/Packages/com.unity.inputsystem/Documentation~/HID.md b/Packages/com.unity.inputsystem/Documentation~/HID.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-hid
+---
 # HID Support
 
 Human Interface Device (HID) is a [specification](https://www.usb.org/hid) to describe peripheral user input devices connected to computers via USB or Bluetooth. HID is commonly used to implement devices such as gamepads, joysticks, or racing wheels.
diff --git a/Packages/com.unity.inputsystem/Documentation~/HowDoI.md b/Packages/com.unity.inputsystem/Documentation~/HowDoI.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-how-do-i
+---
 # How do I…?
 
 A collection of frequently asked questions, and where to find their answers in the documentation.
diff --git a/Packages/com.unity.inputsystem/Documentation~/Installation.md b/Packages/com.unity.inputsystem/Documentation~/Installation.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-installation
+---
 # Installation guide
 
 * [Installing the package](#installing-the-package)
diff --git a/Packages/com.unity.inputsystem/Documentation~/Interactions.md b/Packages/com.unity.inputsystem/Documentation~/Interactions.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-interactions
+---
 # Interactions
 
 - [Interactions](#interactions)
diff --git a/Packages/com.unity.inputsystem/Documentation~/Joystick.md b/Packages/com.unity.inputsystem/Documentation~/Joystick.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-joystick
+---
 # Joystick support
 
 The Input System currently has limited support for joysticks as generic [HIDs](HID.md) only. The system attempts to identify Controls based on the information provided in the HID descriptor of the Device, but it might not always be accurate. These Devices often work best when you allow the user to [manually remap the Controls](../api/UnityEngine.InputSystem.InputActionRebindingExtensions.html).
diff --git a/Packages/com.unity.inputsystem/Documentation~/Keyboard.md b/Packages/com.unity.inputsystem/Documentation~/Keyboard.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-keyboard
+---
 # Keyboard support
 
 The [`Keyboard`](../api/UnityEngine.InputSystem.Keyboard.html) class defines a [Device](Devices.md) with a set of key Controls defined by the [`Key`](../api/UnityEngine.InputSystem.Key.html) enumeration.
diff --git a/Packages/com.unity.inputsystem/Documentation~/KnownLimitations.md b/Packages/com.unity.inputsystem/Documentation~/KnownLimitations.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-known-limitations
+---
 # Known Limitations
 
 The following is a list of known limitations that the Input System currently has.
diff --git a/Packages/com.unity.inputsystem/Documentation~/Layouts.md b/Packages/com.unity.inputsystem/Documentation~/Layouts.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-layouts
+---
 # Layouts
 
 * [Layout formats](#layout-formats)
diff --git a/Packages/com.unity.inputsystem/Documentation~/Migration.md b/Packages/com.unity.inputsystem/Documentation~/Migration.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-migration
+---
 # Migrating from the old input system
 
 This guide provides a list of APIs in `UnityEngine.Input` (and other related APIs in `UnityEngine`) and their corresponding APIs in the new Input System. Not all APIs have a corresponding version in the new API yet.
diff --git a/Packages/com.unity.inputsystem/Documentation~/Mouse.md b/Packages/com.unity.inputsystem/Documentation~/Mouse.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-mouse
+---
 # Mouse support
 
 The Input System represents mouse input with the [`Mouse`](../api/UnityEngine.InputSystem.Mouse.html) Device layout that the [`Mouse`](../api/UnityEngine.InputSystem.Mouse.html) class implements. Mice are based on the [`Pointer`](Pointers.md) layout.
diff --git a/Packages/com.unity.inputsystem/Documentation~/OnScreen.md b/Packages/com.unity.inputsystem/Documentation~/OnScreen.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-on-screen
+---
 # On-screen Controls
 
 You can use on-screen Controls to simulate Input Devices with UI widgets that the user interacts with on the screen. The most prominent example is the use of stick and button widgets on touchscreens to emulate a joystick or gamepad.
diff --git a/Packages/com.unity.inputsystem/Documentation~/Pen.md b/Packages/com.unity.inputsystem/Documentation~/Pen.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-pen
+---
 # Pen, tablet, and stylus support
 
 Pen support comprises both tablets on desktops (such as the various tablets produced by Wacom), and styluses on mobile devices (such as the stylus on the Samsung Note, the Apple Pencil on iOS, or the Surface Pen on the Microsoft Surface line of notebooks).
diff --git a/Packages/com.unity.inputsystem/Documentation~/PlayerInput.md b/Packages/com.unity.inputsystem/Documentation~/PlayerInput.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-player-input
+---
 # The PlayerInput component
 
 The Input System provides two related components that simplify how you set up and work with input: the **Player Input** component and the [**Player Input Manager**](PlayerInputManager.md) component.
diff --git a/Packages/com.unity.inputsystem/Documentation~/PlayerInputManager.md b/Packages/com.unity.inputsystem/Documentation~/PlayerInputManager.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-player-input-manager
+---
 # The Player Input Manager component
 
 >NOTE: The Input System package comes with a sample called `Simple Multiplayer` which you can install from the package manager UI in the Unity editor. The sample demonstrates how to use [`PlayerInputManager`](../api/UnityEngine.InputSystem.PlayerInputManager.html) to set up a simple local multiplayer scenario.
diff --git a/Packages/com.unity.inputsystem/Documentation~/Pointers.md b/Packages/com.unity.inputsystem/Documentation~/Pointers.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-pointers
+---
 # Pointers
 
 [`Pointer`](../api/UnityEngine.InputSystem.Pointer.html) Devices are defined as [`InputDevices`](../api/UnityEngine.InputSystem.InputDevice.html) that track positions on a 2D surface. The Input System supports three types of pointers:
diff --git a/Packages/com.unity.inputsystem/Documentation~/Processors.md b/Packages/com.unity.inputsystem/Documentation~/Processors.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-processors
+---
 # Processors
 
 An Input Processor takes a value and returns a processed result for it. The received value and result value must be of the same type. For example, you can use a [clamp](#clamp) Processor to clamp values from a control to a certain range.
diff --git a/Packages/com.unity.inputsystem/Documentation~/Sensors.md b/Packages/com.unity.inputsystem/Documentation~/Sensors.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-sensors
+---
 # Sensor support
 
 * [Sampling Frequency](#sampling-frequency)
diff --git a/Packages/com.unity.inputsystem/Documentation~/Settings.md b/Packages/com.unity.inputsystem/Documentation~/Settings.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-settings
+---
 # Input settings
 
 * [Update Mode](#update-mode)
diff --git a/Packages/com.unity.inputsystem/Documentation~/SupportedDevices.md b/Packages/com.unity.inputsystem/Documentation~/SupportedDevices.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-supported-devices
+---
 # Supported Input Devices
 
 This page lists Input Device types and products that the Input System package supports, and the platforms they're supported on.
diff --git a/Packages/com.unity.inputsystem/Documentation~/Testing.md b/Packages/com.unity.inputsystem/Documentation~/Testing.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-testing
+---
 # Input testing
 
 The Input System has built-in support for writing automated input tests. You can drive input entirely from code, without any dependencies on platform backends and physical hardware devices. The automated input tests you write consider the generated input to be the same as input generated at runtime by actual platform code.
diff --git a/Packages/com.unity.inputsystem/Documentation~/Touch.md b/Packages/com.unity.inputsystem/Documentation~/Touch.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-touch
+---
 # Touch support
 
 - [Touch support](#touch-support)
diff --git a/Packages/com.unity.inputsystem/Documentation~/UISupport.md b/Packages/com.unity.inputsystem/Documentation~/UISupport.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-ui-support
+---
 # UI support
 
 * [Setting up UI Input](#setting-up-ui-input)
diff --git a/Packages/com.unity.inputsystem/Documentation~/UseInEditor.md b/Packages/com.unity.inputsystem/Documentation~/UseInEditor.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-use-in-editor
+---
 # Using Input in the Editor
 
 Unlike Unity's old Input Manager, you can use the new Input System from within `EditorWindow` code as well. For example, you can gain access to pen pressure information like this:
diff --git a/Packages/com.unity.inputsystem/Documentation~/UserManagement.md b/Packages/com.unity.inputsystem/Documentation~/UserManagement.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-user-management
+---
 # User Management
 
 The Input System supports multi-user management through the [`InputUser`](../api/UnityEngine.InputSystem.Users.InputUser.html) class. This comprises both user account management features on platforms that have these capabilities built into them (such as Xbox and PS4), as well as features to manage Device allocations to one or more local users.
diff --git a/Packages/com.unity.inputsystem/Documentation~/Workflow-ActionsAsset.md b/Packages/com.unity.inputsystem/Documentation~/Workflow-ActionsAsset.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-workflow-actions-asset
+---
 # Workflow Overview - Using an Actions Asset
 
 ![image alt text](./Images/Workflow-ActionsAsset.svg)
diff --git a/Packages/com.unity.inputsystem/Documentation~/Workflow-Direct.md b/Packages/com.unity.inputsystem/Documentation~/Workflow-Direct.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-workflow-direct
+---
 # Workflow Overview - Directly Reading Device States
 
 ![image alt text](./Images/Workflow-Direct.svg)
diff --git a/Packages/com.unity.inputsystem/Documentation~/Workflow-Embedded.md b/Packages/com.unity.inputsystem/Documentation~/Workflow-Embedded.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-workflow-embedded
+---
 # Workflow Overview - Using Embedded Actions
 
 ![image alt text](./Images/Workflow-Embedded.svg)
diff --git a/Packages/com.unity.inputsystem/Documentation~/Workflow-PlayerInput.md b/Packages/com.unity.inputsystem/Documentation~/Workflow-PlayerInput.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-workflow-player-input
+---
 # Workflow Overview - Using an Actions Asset and PlayerInput Component
 
 ![image alt text](./Images/Workflow-PlayerInput.svg)
diff --git a/Packages/com.unity.inputsystem/Documentation~/Workflows.md b/Packages/com.unity.inputsystem/Documentation~/Workflows.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-workflows
+---
 
 # Input System Workflows
 
diff --git a/Packages/com.unity.inputsystem/Documentation~/index.md b/Packages/com.unity.inputsystem/Documentation~/index.md
@@ -1,3 +1,6 @@
+---
+uid: input-system-index
+---
 # Input System
 
 The **Input System** allows your users to control your game or app using a device, touch, or gestures.
