Merge pull request #439 from Unity-Technologies/UNI-51319-documentation-fixes

Uni 51319 small documentation fixes

Author: vkovec

Packages/com.unity.formats.fbx/Documentation~/exporting.md

@@ -73,7 +73,7 @@ In addition, the **Projection** type (perspective/orthographic) and **Aspect Rat
 
 ## Lights
 
-The FBX Exporter exports Lights of type *Directional*, *Spot* , *Point*, and *Area*.
+The FBX Exporter exports Lights of type *Directional*, *Spot*, *Point*, and *Area*.
 
 It also exports the following Light attributes:
 
@@ -125,7 +125,6 @@ The FBX Exporter exports the following attributes for the Rotation Constraint ty
 The FBX Exporter exports the following attributes for the Rotation Constraint type:
 
 - Affected axes (X,Y,Z)
-
 - Rotation Offset
 - Rest Rotation
 - World Up Type
@@ -160,8 +159,8 @@ The FBX Exporter exports the following attributes for the Scale Constraint type:
 
 The FBX Exporter exports the following attributes for the Parent Constraint type:
 
-- Source Translation Offset (animated)
-- Source Rotation Offset (animated)
+- Source Translation Offset
+- Source Rotation Offset
 - Affect Rotation Axes
 - Affect Translation Axes
 - Rest Translation
@@ -215,13 +214,13 @@ When exporting an FBX file, the following Export Options window opens, displayin
 | __Destination__           | Which object to transfer the transform animation to.<br/><br/>This object receives the transform animation on objects between __Source__ and __Destination__ as well as the animation on the Source itself. |
 | __Export Format__         | Select the format to use in the FBX file (ASCII or Binary).  |
 | __Include__               | Choose whether to export both Models and Animation, only Models, or only Animations. |
-| __LOD level__             | For level of detail (LOD) groups, choose the desired level of detail to export (all, highest, or lowest). <br/><br/>**Notes:** - The FBX Exporter ignores LODs outside of selected hierarchy.<br/> - The FBX Exporter does not filter out objects that are used as LODs and doesn't export them if they aren’t direct descendants of their respective LOD Group |
+| __LOD level__             | For level of detail (LOD) groups, choose the desired level of detail to export (all, highest, or lowest). <br/><br/>**Notes:**<br/> - The FBX Exporter ignores LODs outside of selected hierarchy.<br/> - The FBX Exporter does not filter out objects that are used as LODs and doesn't export them if they aren’t direct descendants of their respective LOD Group |
 | __Object(s) Position__    | Choose whether to reset the exported objects to world center, or keep world transforms during export.<br/><br/>If you select multiple objects for export, and you choose __Local Centered__ from this drop-down menu, the FBX Exporter centers objects around a shared root while keeping their relative placement unchanged. |
 | __Animated Skinned Mesh__ | Check this option to export animation on objects with skinned meshes.<br/><br/>If unchecked, the FBX Exporter does not export animation on skinned meshes. |
-| __Compatible Naming__     | Check this option to control renaming the GameObject and Materials during export. <br/><br/>The FBX Exporter ensures compatible naming with Autodesk® Maya® and Autodesk® Maya LT™ to avoid unexpected name changes between Unity and Autodesk® Maya® and Autodesk® Maya LT™. During export the FBX Exporter replaces characters in Unity names as follows:<br/> - Replaces invalid characters with underscores ("_"). Invalid characters are all non-alphanumeric characters, except for the colon (":").<br/> - Adds an underscore ("_") to names that begin with a number.<br/> - Replaces diacritics. For example, replaces "é" with “e”.<br/><br/>For FBX Model filenames, the FBX Exporter ensures that names do not contain invalid characters for the file system. The set of invalid characters may differ between file systems.<br/><br/>**Note:** If you have a Material with a space in its name, the space is replaced with an underscore ("_"). This results in a new Material being created when it is imported. For example, the Material named "Default Material" is exported as "Default_Material" and is created as a new Material when it is imported. If you want the exported Material to match an existing Material in the scene, you must manually rename the Material before exporting. |
+| __Compatible Naming__     | Check this option to control renaming the GameObject and Materials during export. <br/><br/>The FBX Exporter ensures compatible naming with Autodesk® Maya® and Autodesk® Maya LT™ to avoid unexpected name changes between Unity and Autodesk® Maya® and Autodesk® Maya LT™. During export the FBX Exporter replaces characters in Unity names as follows:<br/> - Replaces invalid characters with underscores ("\_"). Invalid characters are all non-alphanumeric characters, except for the colon (":").<br/> - Adds an underscore ("\_") to names that begin with a number.<br/> - Replaces diacritics. For example, replaces "é" with “e”.<br/><br/>**Note:** If you have a Material with a space in its name, the space is replaced with an underscore ("_"). This results in a new Material being created when it is imported. For example, the Material named "Default Material" is exported as "Default_Material" and is created as a new Material when it is imported. If you want the exported Material to match an existing Material in the scene, you must manually rename the Material before exporting. |
 | __Export Unrendered__     | Check this option to export meshes that either don't have a renderer component, or that have a disabled renderer component. For example, a simplified mesh used as a Mesh collider. |
 
-
+**Note:** For FBX Model filenames, the FBX Exporter ensures that names do not contain invalid characters for the file system. The set of invalid characters may differ between file systems.
 
 ## Exporting animation from the Timeline
 
@@ -230,13 +229,13 @@ In order to export an animation clip from the timeline, in the Timeline editor s
 
 ## Exporting with relevant system units
 
-The FBX Exporter exports in centimeter units (cm) with the Mesh set to real world meter (m) scale. For example, if vertex[0] is at [1, 1, 1] m., it is converted to [100, 100, 100] cm. 
+The FBX Exporter exports in centimeter units (cm) with the Mesh set to real world meter (m) scale. For example, if vertex[0] is at [1, 1, 1] m, it is converted to [100, 100, 100] cm. 
 
 In Autodesk® 3ds Max®, it is recommended to set the system units to centimeters to avoid any scaling on Model import and export.
 
 There are no specific import options to adjust between Unity and Autodesk® Maya® and Autodesk® Maya LT™. When working in Autodesk® Maya® and Autodesk® Maya LT™, you can set the working units to meters if you prefer. 
 
-For example, when working with large models in Autodesk® Maya® and Autodesk® Maya LT™, to ensure that the models clip to meters, adjust the scale of the near and far clipping planes for all cameras by 100x. In addition, you should scale lights by 100x so that objects display in the viewport.
+When working with large models in Autodesk® Maya® and Autodesk® Maya LT™, to ensure that the models clip to meters, adjust the scale of the near and far clipping planes for all cameras by 100x. In addition, you should scale lights and cameras by 100x so that objects display in the viewport.
 
 ## Known issues
 

Packages/com.unity.formats.fbx/Documentation~/images/FBXExporter_FBXExportSettingsWindow.png

@@ -22,8 +22,6 @@ The Unity Integration for Autodesk® Maya® and Autodesk® Maya LT™ feature su
 
 * Autodesk® Maya® and Autodesk® Maya LT™ 2017
 * Autodesk® Maya® and Autodesk® Maya LT™ 2018
-* Autodesk® Maya® and Autodesk® Maya LT™ LT 2017
-* Autodesk® Maya® and Autodesk® Maya LT™ LT 2018
 
 The Unity Integration for Autodesk® 3ds Max® feature supports the following versions of Autodesk® 3ds Max®:
 
@@ -32,28 +30,40 @@ The Unity Integration for Autodesk® 3ds Max® feature supports the following ve
 
 ## Known issues
 
-* When installing a new version of the FBX Exporter package after using version 1.1.0.b1, the link between Assets and FbxPrefab components may be lost. See [Updating from 1.1.0b1](#Repairs_1_1_0b_1) for repairing instructions.
+* When installing a new version of the FBX Exporter package after using version 1.3.0f1 or earlier, the link between Assets and FbxPrefab components may be lost. See [Updating from 1.3.0f1 or earlier](#Repairs_1_3_0f_1) for repairing instructions.
 
 * The FBX Exporter package does not support exporting .asset files.
 
-<a name="Repairs_1_1_0b_1"></a>
+<a name="Repairs_1_3_0f_1"></a>
 ## Installing the FBX Exporter
 
 To install this package, follow the instructions in the [Package Manager documentation](https://docs.unity3d.com/Packages/com.unity.package-manager-ui@latest).
 
 Verify that the FBX Exporter is correctly installed by opening it (from the top menu: **GameObject** > **Export To FBX**).
 
-### Updating from 1.1.0b1
+### Updating from 1.3.0f1 or earlier
 
-If your previous version of the FBX Exporter package was 1.1.0b1, some Assets in your Project may lose their FbxPrefab components. To repair this issue, follow these steps: 
+If your previous version of the FBX Exporter package was version 1.3.0f1 or earlier, follow these steps for updating:
+
+Before you install the FBX Exporter Package, follow these steps (recommended):
+
+1. Back up your Project.
+
+2. Restart Unity.
+
+3. Delete the *FbxExporters* folder.
+
+4. Install the FBX Exporter from the [Package Manager](https://docs.unity3d.com/Packages/com.unity.package-manager-ui@latest)
+
+Some Assets in your Project may lose their FbxPrefab components. To repair this issue, follow these steps: 
 
 1. If your Project Assets are serialized as Binary, select __Edit__ > __Project Settings__ > __Editor__ to view the Editor Settings. 
 
 2. Change the __Asset Serialization__ mode to __Force Text__. The __Force Text__ option converts all Project Assets to text.
 
 3. Before continuing, back up your Project.
 
-4. Select __Edit__ > __Project Settings__ > __Fbx Export__ to view the [Fbx Export Settings](options.html).
+4. Select __Edit__ > __Project Settings__ > __FBX Export__ to view the [FBX Export Settings](options.html).
 
   ![Run Component Updated button](images/FBXExporter_RunComponentUpdater.png)
 

Packages/com.unity.formats.fbx/Documentation~/images/FBXExporter_RunComponentUpdater.png

@@ -41,7 +41,7 @@ If you enabled the __Keep Open__ option in the [Fbx Export Settings](options.htm
 
 
 
-## Manually Installing an Autodesk® Maya® or Autodesk® Maya LT™ Integration
+## Manually Installing an Autodesk® Maya®<br/>or Autodesk® Maya LT™ Integration
 
 In some cases, you have to install your integration manually. For example, you may be using an unsupported version of Autodesk® Maya® or Autodesk® Maya LT™.
 
@@ -53,13 +53,13 @@ To manually install an Autodesk® Maya® or Autodesk® Maya LT™ Integration, f
 
 3. Copy the contents of *Integrations/Autodesk/maya/UnityFbxForMaya.txt* from the unzipped folder to the following file:
 
-  * On Windows:<br/>*C:\Users\{username}\Documents\maya\modules\UnityFbxForMaya.mod*
+  * On Windows:<br/>*C:\Users\\{username}\Documents\maya\modules\UnityFbxForMaya.mod*
   * On Mac:<br/>*$HOME/Library/Preferences/Autodesk/Maya/modules/UnityFbxForMaya.mod*
 
-4. In *UnityFbxForMaya.mod*, modify the following line (mel code):
+4. In *UnityFbxForMaya.mod*, modify the following line (mel code): <br/>
   ```UnityFbxForMaya {Version} {UnityIntegrationsPath}/Integrations/Autodesk/maya```
 
-  Where `{Version}` = `2.0.0` (or your version number of the FBX Exporter package) and `{UnityIntegrationsPath}` = the location where you unzipped *UnityFbxForMaya.zip* in step 1.
+  Set `{Version}` = `2.0.0` (or your version number of the FBX Exporter package) and `{UnityIntegrationsPath}` = the location where you unzipped *UnityFbxForMaya.zip* in step 1.
 
 5. Locate the following file (if it doesn't exist, create the file):
 
@@ -73,14 +73,14 @@ To manually install an Autodesk® Maya® or Autodesk® Maya LT™ Integration, f
 
   ![](images/FBXExporter_MayaAccessScriptEditor.png) 
 
-8. Run the following (mel code):
+8. Run the following (mel code): <br/>
   ```unityConfigure "{UnityProjectPath}" "{ExportSettingsPath}" "{ImportSettingsPath}" 0 0;```
 
   Where you replace `{UnityProjectPath}` with the path to your Unity Project, and  `{ExportSettingsPath}` with the path to *Integrations/Autodesk/maya/scripts/unityFbxExportSettings.mel* and `{ImportSettingsPath}` with the path to *Integrations/Autodesk/maya/scripts/unityFbxImportSettings.mel*.
 
 
 
-## Working with Autodesk® Maya® 2017+ and Autodesk® Maya LT™ 2017+
+## Working with Autodesk® Maya® 2017+<br/>and Autodesk® Maya LT™ 2017+
 
 ### Importing from Unity
 
@@ -119,7 +119,7 @@ __File__ > __Unity__ > __Export__ exports both Models and animation contained in
 
 __File__ > __Unity__ > __Export Model Only__ exports all Models in the selected export sets, but does not export any animation.
 
-__File__ > __Unity__ > __Export Animation Only__ exports only the animation applied to the objects in the export set as well as the minimum components required for the animation (such as transforms, animated lights and cameras).
+__File__ > __Unity__ > __Export Animation Only__ exports only the animation applied to the objects in the export set as well as the minimum components required for the animation (such as transforms).
 
 > ***Note:*** If no animation file with the **@** notation has been imported, then this option has no effect. The workaround for exporting a new animation is to first import an empty FBX file with the **@** notation (*{model}@anim.fbx*), so that the export set is configured correctly.
 
@@ -128,6 +128,10 @@ In order to export objects from the desired export set, you can select one or mo
 If you select multiple sets or objects from multiple sets, then the FBX Exporter exports each set to its respective file defined in the attributes of the set.
 
 
+### Known Issues
+
+* Exporting animation only for animated lights and cameras is not currently supported
+
 ## Working with Autodesk® 3ds Max® 2017+
 
 ### Importing from Unity
@@ -156,7 +160,7 @@ This dummy contains the imported file’s path and filename as custom attributes
 
 ![Custom attributes on a UnityExportSet dummy](images/FBXExporter_MaxUnityExportSetCustomAttribs.png)
 
-The **@** notation (*<modelname>@<animation>.fbx*), indicates that this is an animation file belonging to the Model contained in *model.fbx*.
+The **@** notation (**modelname**@**animation**.fbx), indicates that this is an animation file belonging to the Model contained in *model.fbx*.
 
 For instance, if you import a file called *[email protected]*, the export set is based on the name before the **@** symbol. Therefore, it uses the same set as *model.fbx*. 
 

Packages/com.unity.formats.fbx/Documentation~/index.md

@@ -16,6 +16,6 @@ Use the Fbx Export Settings window to specify whether or not to automatically up
 | __Keep Open__                 | Check this option to keep the selected 3D modeling software open after installing it. |
 | __Hide Native Menu__          | Check this option to hide the native __Send to Unity__ menu in Autodesk® Maya® and Autodesk® Maya LT™. |
 | __Install Unity Integration__ | Click this button to install [Unity Integration](integration.html) for the selected __3D Application__. |
-| __Run Component Updater__     | Click this button to run the [Component Updater](#Repairs_1_1_0b_1) to repair any broken FbxPrefab components if you were using a previous version of the FBX Exporter package. |
+| __Run Component Updater__     | Click this button to run the [Component Updater](index.html#Repairs_1_3_0f_1) to repair any broken FbxPrefab components if you were using a previous version of the FBX Exporter package. |