完善并补充部分文档 (cocos#1640)

* 完善并补充部分文档

* Apply suggestions from code review

Co-authored-by: Slack-Moehrle <[email protected]>
Co-authored-by: ChiaNing <[email protected]>

Co-authored-by: Slack-Moehrle <[email protected]>
Co-authored-by: ChiaNing <[email protected]>

Author: 3 people

Diff for: en/asset/dynamic-load-resources.md

@@ -142,7 +142,7 @@ assetManager.loadRemote<ImageAsset>(remoteUrl, function (err, imageAsset) {
 
 // Remote texture url without file extensions, then you need to define the file type explicitly
 remoteUrl = "http://unknown.org/emoji?id=124982374";
-assetManager.loadRemote<ImageAsset>(remoteUrl, {type: 'png'}, function (err, imageAsset) {
+assetManager.loadRemote<ImageAsset>(remoteUrl, {ext: 'png'}, function (err, imageAsset) {
     const spriteFrame = new SpriteFrame();
     const texture = new Texture2D();
     texture.image = imageAsset;

Diff for: en/asset/mesh.md

@@ -35,9 +35,12 @@ When the model asset file (`.fbx` or `.gltf`) is selected in the __Assets__ pane
 
 ![mesh_model](mesh/mesh_model.jpg)
 
-- `Normals` -- Normals information, including **Optional**, **Exclude**, **Require**, **Recalculate**
-- `Tangents` -- Tangents information, including **Optional**, **Exclude**, **Require**, **Recalculate**
-- `SkipValidation` -- SkipValidation, whether to skip standard checks
+| Property | Description |
+| :--- | :--- |
+| Normals | Normals import setting, including the following four options:<br>1. **Optional**: Import normals only if the model file contains normals.<br>2. **Exclude**: Do not import normals.<br>3. **Required**: Import normals that are contained in the model file, or recalculate if not contained. It is recommended to use this option if the model data itself is fine, without additional processing.<br>4. **Recalculate**: Recalculate normals and import, ignoring whether if the model file contain normals. Selecting this option will increase the calculated amount, but it will eliminate the subsequent problems caused by the absence of normalization of the model's original normal data. |
+| Tangents | Tangents import setting, including Optional、Exclude、Require、Recalculate four options, option feature can refer to the description of **Normals**, the two are not very different. |
+| Skip Validation | Skip validation of the model file |
+| Disable mesh split | Currently there is a joint-counting-based mesh splitting process during the import pipeline to workaround the max uniform vector limit problem for real-time calculated skeletal animation system on many platforms. This process has a preference impact on other runtime system too. So if it can be pre-determined that the real-time calculated skeletal animations (when `useBakedAnimation` option of the **SkeletalAnimation** component is unchecked) will not be used, this option can be checked to improve preference. But note that toggling this would update the corresponding prefab, so all the references in the scene should be updated as well to accompany that. This process will be removed in further refactors. |
 
 ### Animation Module
 

Diff for: en/asset/mesh/mesh_model.jpg

@@ -4,12 +4,28 @@ __Sprite Frame__ is a container for __UI rendering__ and basic graphics, which m
 
 ## Importing Sprite Frame Assets
 
-Use the __default asset import__ method to import image assets into the project, then set the type of image as __sprite-frame__ and can then be seen in the **Assets** panel.
+Use the default [asset import](asset-workflow.md) method to import image assets into the project, then set the type of image as __sprite-frame__ in the **Inspeactor** panel:
+
+![set sprite-frame](sprite-frame/set-spriteframe.png)
+
+Creator will then automatically create a spriteFrame resource under it as shown below:
 
 ![imported texture](sprite-frame/imported_texture.png)
 
 Image assets will use thumbnails of their own pictures as icons in the **Assets** panel. When the image sub-asset is selected in the **Assets** panel, a thumbnail of the image is displayed below the **Inspector** panel.
 
+The `spriteFrame` has the following properties:
+
+| Property | Description |
+| :--- | :--- |
+| Packable | Whether to be packed into Dynamic Atlas. |
+| Rotated  | Read-only property, cannot be changed. Used to see if the sub-asset in the Texture Packer asset is rotated. |
+| Offset X, Y | Read-only property, cannot be changed. Used to view the offset of the rectangle in Texture Packer asset. |
+| Trim Type | Set the trim type, including:<br>1. Auto -- Automatic trim<br>2. Custom -- Custom trim<br>3. None -- No trim, use original texture<br>For details, please refer to the [Auto Trim for SpriteFrame](trim.md) documentation |
+| Trim Threshold | Set the transparency threshold, trim off the pixels whose transparency is below the set value.<br>The default value is 1, and the range of values is 0~1.<br>Only takes effect when **Trim Type** is set to **Auto**.  |
+| Trim X, Y, Width, Height | Sets the trim rect, only takes effect when **Trim Type** is set to **Custom**. |
+| Border Top, Bottom, Left, Right | Set the texture margins of the 9-sliced, which can be edited visually by clicking on the **Edit** button below.  |
+
 ## Using a Sprite Frame
 
 ### The object contained in the container is using textures

Diff for: en/asset/sprite-frame.md

@@ -58,7 +58,6 @@ The following is an example of how DragonBones replaces the texture. Replace the
         @property({ type: dragonBones.ArmatureDisplay })
         replaceArmatureDisplay: dragonBones.ArmatureDisplay | null = null;
 
-
         _leftWeaponIndex = 0;
         _rightDisplayIndex = 0;
         _rightDisplayNames:string[] = [];

Diff for: en/asset/sprite-frame/imported_texture.png

@@ -18,7 +18,7 @@ Select the node and choose **Add Component -> Spine -> Skeleton** on the **Inspe
 | SkeletonData          | Skeleton information data, drag and drop the skeleton assets exported from Spine. into this property
 | Default Skin          | Select the default skin.
 | Animation             | The name of the currently playing animation.
-| Animation Cache Mode  | Rendering mode, the default is **REALTIME** mode. <br>1. **REALTIME** mode, real-time computing, supports all Spine features. <br>2. **SHARED_CACHE** mode, caches, and shares skeletal animations and texture data, equivalent to pre-baked skeletal animations. **SHARED_CACHE** mode has higher performance, but does not support motion fusion, motion overlay, and only supports motion start and end events. As for memory, when creating N (N>=3) animations with the same skeleton and the same action, the memory advantage is obvious. In summary, **SHARED_CACHE** mode is suitable for scene animations, effects, replica monsters, NPCs, etc., and can greatly improve frame rates and reduce memory consumption. <br>3. **PRIVATE_CACHE** mode, similar to **SHARED_CACHE** but does not share animation and texture data, so there is no memory advantage, only performance advantage. Use **PRIVATE_CACHE** to take advantage of the high performance of the cache mode and to also implement texture replacement (which cannot share the texture data).
+| Animation Cache Mode  | Rendering mode, the default is **REALTIME** mode. <br>1. **REALTIME** mode, real-time computing, supports all Spine features. <br>2. **SHARED_CACHE** mode, caches, and shares skeletal animations and texture data, equivalent to pre-baked skeletal animations. **SHARED_CACHE** mode has higher performance, but does not support motion fusion, motion overlay, and only supports motion start and end events. As for memory, when creating N (N>=3) animations with the same skeleton and the same action, the memory advantage is obvious. In summary, **SHARED_CACHE** mode is suitable for scene animations, effects, replica monsters, NPCs, etc., and can greatly improve frame rates and reduce memory consumption. <br>3. **PRIVATE_CACHE** mode, similar to **SHARED_CACHE**, but does not share animation and texture data, and will occupy extra memory, there is only a performance advantage, and it may cause stutter if using this mode a lot to play animation. Use **PRIVATE_CACHE** to take advantage of the high performance of the cache mode and to also implement texture replacement (which cannot share the texture data).
 | Loop                  | Whether to loop the current animation.
 | Premultiplied Alpha   | Whether to enable premultiplied alpha for the image, default is True.<br>This item needs to be disabled when the transparent area of the image appears as a color block, and enabled when the translucent area of the image turns black.
 | Time Scale            | The time scale of all animations in the current skeleton.

Diff for: en/asset/sprite-frame/set-spriteframe.png

@@ -6,7 +6,7 @@ __Cocos Creator__ officially supports the release of games to the **Huawei Quick
 
 ## Environment Configuration
 
-- Download the [Huawei Quick APP Loader](https://developer.huawei.com/consumer/en/doc/development/quickApp-Guides/quickapp-installtool) and install it on your Android device (Android Phone 6.0 or above is recommended)
+- Download the [Huawei Quick APP Loader](https://developer.huawei.com/consumer/en/doc/development/quickApp-Guides/quickapp-installtool#h1-1575365259108) and install it on your Android device (Android Phone 6.0 or above is recommended)
 
 - Install [nodejs-8.1.4](https://nodejs.org/en/download/) or above, globally.
 

Diff for: en/editor/components/dragonbones.md

@@ -14,7 +14,7 @@ The component interfaces for the skinning model are described in [SkinnedMeshRen
 | :--- | :---
 | **materials** | The material used to render the model, one material corresponds to one submesh in the mesh.
 | **LightmapSettings** | For baking Lightmap, please refer to [Lightmapping](../../concepts/scene/light/lightmap.md) for details.
-**shadowCastingMode** | Specifies whether the current model will cast shadows, which needs to [enable shadow effect](../../concepts/scene/shadow.md#enable-shadow-effect) in the scene first
+| **shadowCastingMode** | Specifies whether the current model will cast shadows, which needs to [enable shadow effect](../../concepts/scene/shadow.md#enable-shadow-effect) in the scene first
 | **ReceiveShadow** | Specifies whether the current model will receive and display shadow effects generated by other objects, which needs to [enable shadow effect](../../concepts/scene/shadow.md#enable-shadow-effect) in the scene first. This property takes effect only when the shadow type is __ShadowMap__.
 | **mesh** | 3D model assets for rendering.
 

Diff for: en/editor/components/spine.md

@@ -324,3 +324,4 @@ Notice from the above two figures, there is a big difference between v2.4.3 and
 - [Learn TypeScript in Y minutes [cn]](https://learnxinyminutes.com/docs/zh-cn/typescript-cn/)
 - [TypeScript GitHub](https://github.com/Microsoft/TypeScript)
 - [The Best Resources For Learning TypeScript for Game Development](https://www.cocos.com/en/the-best-resources-for-learning-typescript-for-game-development)
+- [3 Excuses Developers Give To Avoid TypeScript — and the Better Reasons They Should Use It](https://betterprogramming.pub/the-bad-reasons-people-avoid-typescript-and-the-better-reasons-why-they-shouldnt-86f8d98534de)

Diff for: en/editor/publish/publish-huawei-mini-game.md

@@ -31,4 +31,8 @@ __Cocos Creator__ scripts are used to implement user-defined (game) behaviors.
 
 As a very commonly used system in the engine, we provide a complete and efficient event system for developers to use. For details, please see:
 
- [Event Mechanism](../engine/event/index.md)
+[Event Mechanism](../engine/event/index.md)
+
+## More Reference
+
+- [Recommended coding standards](./reference/coding-standards.md)

Diff for: en/engine/renderable/model-component.md

@@ -37,6 +37,18 @@ Cocos Creator supports TypeScript 4.1.0. The following restrictions are based on
 
 Developers can still use `tsconfig.json` in their projects to work with the IDE to implement features such as type checking. In order to make the IDE's TypeScript checking compatible with the Creator's behavior, developers need to pay some extra attention to [tsconfig](./tsconfig.md).
 
+### TypeScript Reference Tutorial
+
+- [Tutorial: v3.0 TypeScript question answering and experience sharing](https://discuss.cocos2d-x.org/t/tutorial-3-0-typescript-question-answering-and-experience-sharing/52932)
+- [TypeScript Official Website](https://www.typescriptlang.org/)
+- [TypeScript - Classes](https://www.typescriptlang.org/docs/handbook/classes.html)
+- [TypeScript - Decorators](https://www.typescriptlang.org/docs/handbook/decorators.html)
+- [TypeScript - DefinitelyTyped](http://definitelytyped.org/)
+- [Learn TypeScript in Y minutes [cn]](https://learnxinyminutes.com/docs/zh-cn/typescript-cn/)
+- [TypeScript GitHub](https://github.com/Microsoft/TypeScript)
+- [The Best Resources For Learning TypeScript for Game Development](https://www.cocos.com/en/the-best-resources-for-learning-typescript-for-game-development)
+- [3 Excuses Developers Give To Avoid TypeScript — and the Better Reasons They Should Use It](https://betterprogramming.pub/the-bad-reasons-people-avoid-typescript-and-the-better-reasons-why-they-shouldnt-86f8d98534de)
+
 ## JavaScript
 
 ### Language Features
@@ -101,7 +113,7 @@ import blah from './blah-blah';
 export default blah;
 ```
 
-## Related Tutorials
+### JavaScript Related Tutorials
 
 - [JavaScript Standard Reference Tutorial [cn]](https://wangdoc.com/javascript/)
 - [JavaScript Garden](https://bonsaiden.github.io/JavaScript-Garden/)