Formatting fixes & minor wording tweaks

Author: peterflynn

SUMMARY.md

@@ -3,13 +3,15 @@
 * [Quick start](./README.md)
   * [Quick start](./tutorials/quick-start/index.md)
   * [Quick start - React](./tutorials/quick-start-react/index.md)
+  * [Quick start - Panel UI](./tutorials/quick-start-panel/index.md)
   * [Debugging plugins](./tutorials/debugging/index.md)
 * [Plugin Development 101](./plugin-development-guidelines/index.md)
   * [Plugin structure](./reference/structure/index.md)
     * [Plugin location](./reference/structure/location.md)
     * [Folder structure](./reference/structure/folder-structure.md)
       * [manifest.json](./reference/structure/manifest.md)
       * [main.js](./reference/structure/handlers.md)
+    * [Menu structure](./reference/structure/menu-structure.md)
   * [JavaScript and XD plugin APIs](./reference/javascript/index.md)
     * [JavaScript support](./reference/javascript/javascript-support.md)
     * [Sync and async](./reference/javascript/sync-async.md)
@@ -55,6 +57,10 @@
       * [Modal dialogs](./reference/ui/dialogs/index.md)
         * [Showing dialogs](./reference/ui/dialogs/showing.md)
         * [Dismissing dialogs](./reference/ui/dialogs/dismissal.md)
+      * [Panels](./reference/ui/panels/index.md)
+        * [show() callback](./reference/ui/panels/show.md)
+        * [hide() callback](./reference/ui/panels/hide.md)
+        * [update() callback](./reference/ui/panels/update.md)
     * [Resources - Sticker Sheet](./plugin-design-guidelines/ui_resources/Sticker_sheet.md)
 * [Step-by-step Tutorials](./tutorials/index.md)
   * [Working with content](./tutorials/content-index.md)

changes.md

@@ -12,7 +12,7 @@ _The new layout engine likely constitutes a **breaking change** for any plugin w
     * [How to define a panel](./reference/structure/handlers.md#panel)
     * [Panel overview / reference](./reference/ui/panels/index.md)
     * [Panel Quick Start tutorial](./tutorials/quick-start-panel/index.md)
-    * [Migrating from dialogs to panels](./tutorials/how-to-migrate-from-modal-to-panel/index.md).
+    * [Migrating from dialogs to panels](./tutorials/how-to-migrate-from-modal-to-panel/index.md)
 * A new default stylesheet is provided for plugin UI that renders inside a plugin. This means that UI that renders in one manner in a modal dialog may not render in the same exact manner in a panel.
 
 ### UXP 3 HTML/CSS changes
@@ -29,8 +29,8 @@ In order to gain access to most of these features, your plugin must _opt-in_ to
 
 * **Layout engine**
     * **Inline layout** -- You now have the ability to write code like `<p>This is <a href="...">a link</a></p>` and have the link render _inline_ with the rest of the text
-    * **Layout now defaults to inline** (no longer flexbox) -- This has a tremendous impact on pre-existing plugin UI code: now `span` elements will render with `inline`, `button`s will render as `inline-block`, etc.
-    * **`overflow` defaults to `visible`** (no longer `hidden`), as per the web specification
+    * **Layout now defaults to inline** (no longer flexbox) -- _This may break existing plugin UI code:_ now `span` elements will render with `inline`, `button`s will render as `inline-block`, etc.
+    * **`overflow` defaults to `visible`** (no longer `hidden`), per the web specification -- _This may break existing plugin UI code._
     * `object-fit` -- to control the size of images
     * `z-index`
 * **SVG UI elements**
@@ -46,7 +46,7 @@ In order to gain access to most of these features, your plugin must _opt-in_ to
     * `calc()` -- For example, `width: calc(100% - 9px)`. Note that you can mix units, just like you can on the web.
     * Inheritance -- The CSS parser now understands `initial`, `unset`, and `inherit`. You can also use `!important` to override styles (although you should use this as a last resort).
     * Default styles are now easier to override as the specificity in the default stylesheet has been reduced.
-* _Basic_ **Tab index** support: Setting `tab-index` to `0` will now cause any element to be focusable. You can **not** yet control the tab order.
+* **Keyboard focus** -- Setting `tab-index` to `0` will now cause any element to be focusable. You can **not** yet control the tab order.
 
 ### Known Issues
 

known-issues.md

@@ -2,7 +2,7 @@
 
 ## General Issues
 
-- Icons may be blurry or missing in the plugin panel if you don't include the full set of 24px, 48px, 96px, 144px, and 192px sizes in your plugin bundle and manifest.
+- Icons may be blurry or missing in the plugin panel if you don't include the full set of sizes (24px, 48px, 96px, 144px, 192px) in your plugin bundle and manifest.
 - Developer/Side-loading Specific
   - Plugin menus and handlers may not be in-sync across documents during development
     - If someone modifies a plugin's files on disk while XD is running, and then opens more windows in XD, any windows that were open before reflect the old version of the plugin while windows that were opened later reflect the new version of the plugin. The menu bar will always reflect the old version of the plugin regardless of which window is current.

reference/application.md

@@ -33,7 +33,7 @@ For UI events that often occur in rapid-fire clusters, such as dragging a slider
 | Param   | Type          | Description                                                         |
 | ------- | ------------- | ------------------------------------------------------------------- |
 | options | EditSettings= | Optional settings object (see below). This argument can be omitted. |
-| editFunction | !function(!Selection, !RootNode):?Promise | Function which performs your plugin's edits to the scenegraph. |
+| editFunction | !function(!Selection, !RootNode):?Promise | Function which will perform your plugin's edits to the scenegraph. |
 
 **Typedef EditSettings**
 
@@ -63,6 +63,8 @@ panelButton.addEventListener("click", event => {
 
 ---
 
+<a name="module_application-createRenditions"></a>
+
 ### *application.createRenditions(renditions)*
 
 Generate renditions of nodes in the document in a batch. Overwrites any existing files without warning.

reference/core/lifecycle.md

@@ -43,7 +43,7 @@ Edit operations can only occur via user-initiated actions in your plugin: invoki
 
 #### Edit operation duration
 * An edit operation begins when:
-    * a) Your plugin's menu [command handler](../structure/handlers.md) is called (this is automatically wrapped in an edit operation)
+    * a) Your plugin's menu [command handler](../structure/handlers.md#command) is called (this is automatically wrapped in an edit operation)
     * a) Your plugin's panel UI code explicitly [calls `application.editDocument()`](#initiating-an-edit-operation-from-panel-ui)
 * If the edit code returns synchronously, the edit operation is done as soon as it returns.
 * If the edit code returns a Promise, the edit operation continues asynchronously until the Promise completes. _The user can't do anything else in XD_ until the operation completes, so normally you'd only return a Promise if your plugin has a dialog box open that the user is interacting with or that is showing a progress indicator.

reference/ui/panels/index.md

@@ -206,9 +206,9 @@ Note: you can either reuse your panel's UI nodes, or destroy and recreate the pa
 
 ## Handling Selection Change
 
-As you can see in the example above, every time the user's `selection` changes, your third (optional) lifecycle method `update` will trigger. You will have access to both `selection` and `root` as parameters in the function. This means that your panel can display dynamic content based on what user has selected in the document.
+As you can see in the example above, every time the user's `selection` changes, your (optional) lifecycle method `update` will trigger. You will have access to both `selection` and `root` as parameters in the function. This means that your panel can display dynamic content based on what user has selected in the document.
 
-{% tabs sample="Sample", html="HTML", js="JS", react="React" %}
+{% tabs sample="Sample", html="HTML", js="JS" %}
 
 {% content "sample" %}
 
@@ -392,6 +392,10 @@ module.exports = {
 };
 ```
 
+{% endtabs %}
+
+## Further Reading
+
 Refer to the panel lifecycle method documentation to learn more about these methods:
 
 - [Show](./show.md)