!5147 【OpenHarmony开源贡献者计划2022】[英文]TS API相关格式及表达问题

Merge pull request !5147 from king_he/0608-a

!5147 【OpenHarmony开源贡献者计划2022】[英文]TS API相关格式及表达问题
Merge pull request !5147 from king_he/0608-a
fee7c97e · openharmony_ci · Gitee · c7545e47 · 2ecbe899 · fee7c97e
8 changed file
--- a/en/application-dev/reference/arkui-ts/ts-basic-components-toggle.md
+++ b/en/application-dev/reference/arkui-ts/ts-basic-components-toggle.md
@@ -4,6 +4,7 @@
 > **NOTE**<br>
 > This component is supported since API version 8. Updates will be marked with a superscript to indicate their earliest API version.

+The **<Toggle\>** component can be used to change settings between two states.

 ## Required Permissions


--- a/en/application-dev/reference/arkui-ts/ts-basic-components-web.md
+++ b/en/application-dev/reference/arkui-ts/ts-basic-components-web.md
 # Web

->![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** 
->This component is supported since API version 8. Updates will be marked with a superscript to indicate their earliest API version.
+> **NOTE**<br>
+> This component is supported since API version 8. Updates will be marked with a superscript to indicate their earliest API version.

 The **<Web\>** component can be used to display web pages.

@@ -42,8 +42,7 @@ None
 | onlineImageAccess | boolean                                  | true           | Whether to enable access to online images through HTTP and HTTPS. By default, this feature is enabled. |
 | zoomAccess        | boolean                                  | true           | Whether to enable zoom gestures. By default, zoom gestures are enabled. |

-> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** 
->
+> **NOTE**<br> 
 > Only the following universal attributes are supported: [width](ts-universal-attributes-size.md#Attributes), [height](ts-universal-attributes-size.md#Attributes), [padding](ts-universal-attributes-size.md#Attributes), [margin](ts-universal-attributes-size.md#Attributes), and [border](ts-universal-attributes-border.md#Attributes).
 - <span id="MixedMode">MixedMode</span>

@@ -85,7 +84,7 @@ Universal events are not supported.
 - MessageLevel enums

  | Name  | Description        |
-  | ----- | :----------------- |
+  | ----- | ------------------ |
  | Debug | Debug level.       |
  | Error | Error level.       |
  | Info  | Information level. |
@@ -100,8 +99,8 @@ Represents the result returned to the **\<Web>** component to indicate the opera

  | Name                  | Description                              |
  | --------------------- | ---------------------------------------- |
-  | handleCancel(): void  | <p>Notifies the **\<Web>** component that the user touches the Cancel button in the dialog box.</p> |
-  | handleConfirm(): void | <p>Notifies the **\<Web>** component that the user touches the Confirm button in the dialog box.</p> |
+  | handleCancel(): void  | <p>Notifies the **\<Web>** component that the user touches the **Cancel** button in the dialog box.  |
+  | handleConfirm(): void | <p>Notifies the **\<Web>** component that the user touches the **Confirm** button in the dialog box. |

 ### WebResourceError

@@ -181,7 +180,7 @@ Indicates whether a specific number of steps forward or backward can be performe

  | Name | Type   | Mandatory | Default Value | Description                              |
  | ---- | ------ | --------- | ------------- | ---------------------------------------- |
-  | step | number | Yes       | -             | Number of the steps to take. A positive number means to going forward, and a negative number means to going backward. |
+  | step | number | Yes       | -             | Number of the steps to take. A positive number means going forward, and a negative number means going backward. |

 - Return value

@@ -273,7 +272,7 @@ Objects injected through **registerJavaScriptProxy** are still valid on a new pa

 onActive(): void

-Invoked to instruct the **\<Web>** component to enter the foreground, active state.
+Invoked to instruct the **\<Web>** component to enter the active state.

 ### onInactive

@@ -312,7 +311,7 @@ Asynchronously executes a JavaScript script. This API uses a callback to return
  | Name     | Type                     | Mandatory | Default Value | Description                              |
  | -------- | ------------------------ | --------- | ------------- | ---------------------------------------- |
  | script   | string                   | Yes       | -             | JavaScript script.                       |
-  | callback | (result: string) => void | No        | -             | Callback used to return the result. Returns **null** if the JavaScript script fails to be executed or no value is returned. |
+  | callback | (result: string) => void | No        | -             | Callback used to return the result. The value **null** indicates that the JavaScript script fails to be executed or no value is returned. |

 ### stop


--- a/en/application-dev/reference/arkui-ts/ts-basic-components-xcomponent.md
+++ b/en/application-dev/reference/arkui-ts/ts-basic-components-xcomponent.md
 # XComponent

-  > ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
+  > **NOTE**<br>
  > This component is supported since API version 8. Updates will be marked with a superscript to indicate their earliest API version.

  The **\<XComponent>** can accept and display the EGL/OpenGLES and media data input.
@@ -19,20 +19,20 @@

  - Name

-    | Name       | Type                                     | Mandatory| Description                                                        |
-    | ----------- | --------------------------------------------- | ---- | ------------------------------------------------------------ |
-    | id          | string                                        | Yes  | Unique ID of the component. The value can contain a maximum of 128 characters.                   |
-    | type        | string                                        | Yes  | Type of the component. The options are as follows:<br>-**surface**: The content of this component is displayed individually, without being combined with that of other components.<br>-**component**: The content of this component is displayed after having been combined with that of other components.<br>This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR.|
-    | libraryname | string                                        | No  | Name of the dynamic library generated after compilation at the application native layer.                            |
+    | Name        | Type                                    | Mandatory | Description                                                        |
+    | ----------- | --------------------------------------- | --------- | ------------------------------------------------------------ |
+    | id          | string                                        | Yes | Unique ID of the component. The value can contain a maximum of 128 characters.                   |
+    | type        | string                                        | Yes | Type of the component. The options are as follows:<br>-**surface**: The content of this component is displayed individually, without being combined with that of other components.<br>-**component**: The content of this component is displayed after having been combined with that of other components.<br>This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR.|
+    | libraryname | string                                        | No  | Name of the dynamic library generated after compilation at the application native layer. |
    | controller  | [XComponentController](#XComponentController) | No  | Controller bound to the component, which can be used to invoke methods of the component.              |


 ## Events

-| Name                           | Description                |
+| Name                            | Description              |
 | ------------------------------- | ------------------------ |
-| onLoad(context?: object) => void | Triggered when the plug-in is loaded.|
-| onDestroy() => void             | Triggered when the plug-in is destroyed.|
+| onLoad(context?: object) => void | Triggered when the plug-in is loaded. |
+| onDestroy() => void              | Triggered when the plug-in is destroyed. |

 ## XComponentController

@@ -52,9 +52,9 @@ Obtains the ID of the surface held by the **\<XComponent>**. The ID can be used

  - Return value

-    | Type  | Description                       |
+    | Type   | Description                 |
    | ------ | --------------------------- |
-    | string | ID of the surface held by the **\<XComponent>**.|
+    | string | ID of the surface held by the **\<XComponent>**. |

 ### setXComponentSurfaceSize

@@ -64,10 +64,10 @@ Sets the width and height of the surface held by the **\<XComponent>**.

 - Parameters

-  | Name       | Type| Mandatory| Default Value| Description                         |
+  | Name       | Type | Mandatory | Default Value | Description              |
  | ------------- | -------- | ---- | ------ | ----------------------------- |
-  | surfaceWidth  | number   | Yes  | -      | Width of the surface held by the **\<XComponent>**.|
-  | surfaceHeight | number   | Yes  | -      | Height of the surface held by the **\<XComponent>**.|
+  | surfaceWidth  | number   | Yes  | -      | Width of the surface held by the **\<XComponent>**. |
+  | surfaceHeight | number   | Yes  | -      | Height of the surface held by the **\<XComponent>**. |

 ### getXComponentContext


--- a/en/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md
+++ b/en/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md
 # LongPressGesture


-> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
+> **NOTE**<br>
 > This gesture is supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version.

-
 ## Required Permissions

 None
@@ -15,7 +14,7 @@ None
 LongPressGesture(options?: { fingers?: number, repeat?: boolean, duration?: number })

 - Parameters
-    | Name | Type | Mandatory | Default Value | Description |
+  | Name | Type | Mandatory | Default Value | Description |
  | -------- | -------- | -------- | -------- | -------- |
  | fingers | number | No | 1 | Minimum number of fingers to trigger a long press gesture. The value ranges from 1 to 10. |
  | repeat | boolean | No | false | Whether to continuously trigger the event callback. |
@@ -31,7 +30,7 @@ LongPressGesture(options?: { fingers?: number, repeat?: boolean, duration?: numb
 | onActionCancel(event: () =&gt; void) | Callback invoked when a tap cancellation event is received after a long press gesture is recognized. |

 - GestureEvent attributes related to the long press gesture
-    | Name | Type | Description |
+  | Name | Type | Description |
  | -------- | -------- | -------- |
  | repeat | boolean | Whether the event is repeated. |


--- a/en/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md
+++ b/en/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md
 # PanGesture

-
 > ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
 > This gesture is supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version.

-
 ## Required Permissions

 None
@@ -15,14 +13,14 @@ None
 PanGesture(options?: { fingers?: number, direction?: PanDirection, distance?: number } | [PanGestureOption](#pangestureoptions))

 - Parameters
-    | Name | Type | Mandatory | Default Value | Description |
+  | Name | Type | Mandatory | Default Value | Description |
  | -------- | -------- | -------- | -------- | -------- |
-  | fingers | number | No | 1 | Minimum number of fingers to trigger a long press gesture. The value ranges from 1 to 10. |
+  | fingers | number | No | 1 | Minimum number of fingers to trigger a slide gesture. The value ranges from 1 to 10. |
  | direction | PanDirection | No | All | Slide direction. The enumerated value supports the AND (&amp;) and OR (\|) operations. |
  | distance | number | No | 5.0 | Minimum slide recognition distance, in vp. |

 - PanDirection enums
-    | Name | Description |
+  | Name | Description |
  | -------- | -------- |
  | All | All directions. |
  | Horizontal | Horizontal slide. |
@@ -44,7 +42,7 @@ PanGestureOptions(options?: { fingers?: number, direction?: PanDirection, distan
  For details, see **PanGesture**.

 - APIs
-    | Name | Description |
+  | Name | Description |
  | -------- | -------- |
  | setDirection(value: PanDirection) | Sets the direction. |
  | setDistance(value: number) | Sets the distance. |
@@ -61,7 +59,7 @@ PanGestureOptions(options?: { fingers?: number, direction?: PanDirection, distan
 | onActionCancel(callback: () =&gt; void) | Callback invoked when a tap cancellation event is received after a pan gesture is recognized. |

 - GestureEvent attributes related to the pan gesture  
-    | Name | Type | Description |
+  | Name | Type | Description |
  | -------- | -------- | -------- |
  | offsetX | number | Offset of the gesture event, in vp. |
  | offsetY | number | Offset of the gesture event, in vp. |

--- a/en/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md
+++ b/en/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md
 # PinchGesture


-> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
+> **NOTE**<br>
 > This gesture is supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version.


@@ -15,7 +15,7 @@ None
 PinchGesture(options?: { fingers?: number, distance?: number })

 - Parameters
-    | Name | Type | Mandatory | Default Value | Description |
+  | Name | Type | Mandatory | Default Value | Description |
  | -------- | -------- | -------- | -------- | -------- |
  | fingers | number | No | 2 | Minimum number of fingers to trigger a pinch. The value ranges from 2 to 5. |
  | distance | number | No | 3.0 | Minimum recognition distance, in vp. |
@@ -31,7 +31,7 @@ PinchGesture(options?: { fingers?: number, distance?: number })
 | onActionCancel(event: () =&gt; void) | Callback invoked when a tap cancellation event is received after a pinch gesture is recognized. |

 - GestureEvent attributes related to the pinch gesture  
-    | Name | Type | Description |
+  | Name | Type | Description |
  | -------- | -------- | -------- |
  | scale | number | Scale ratio. This attribute is used for the pinch gesture. |
  | pinchCenterX | number | X-coordinate of the center of the pinch gesture, in px. |

--- a/en/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md
+++ b/en/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md
 # RotationGesture


-> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
+> **NOTE**<br>
 > This gesture is supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version.


@@ -15,7 +15,7 @@ None
 RotationGesture(options?: { fingers?: number, angle?: number })

 - Parameters
-    | Name | Type | Mandatory | Default Value | Description |
+  | Name | Type | Mandatory | Default Value | Description |
  | -------- | -------- | -------- | -------- | -------- |
  | fingers | number | No | 2 | Minimum number of fingers to trigger a rotation. The value ranges from 2 to 5. |
  | angle | number | No | 1.0 | Minimum degree that can trigger the rotation gesture. |
@@ -31,7 +31,7 @@ RotationGesture(options?: { fingers?: number, angle?: number })
 | onActionCancel(event: () =&gt; void) | Callback invoked when a tap cancellation event is received after the rotation gesture is recognized. |

 - GestureEvent attributes related to the rotation gesture  
-    | Name | Type | Description |
+  | Name | Type | Description |
  | -------- | -------- | -------- |
  | angle | number | Rotation angle. |


--- a/en/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md
+++ b/en/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md
 # SwipeGesture


-> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
+> **NOTE**<br>
 > This gesture is supported since API version 8. Updates will be marked with a superscript to indicate their earliest API version.


@@ -15,14 +15,14 @@ None
 SwipeGesture(value?: { fingers?: number; direction?: SwipeDirection; speed?: number })

 - Parameters
-    | Name | Type | Mandatory | Default Value | Description |
+  | Name | Type | Mandatory | Default Value | Description |
  | -------- | -------- | -------- | -------- | -------- |
  | fingers | number | No | 1 | Minimum number of fingers to trigger a swipe gesture. The value ranges from 1 to 10. |
  | direction | SwipeDirection | No | SwipeDirection.All | Swipe direction. |
  | speed | number | No | 100 | Minimum speed of the swipe gesture (100 vp/s). |

 - SwipeDirection enums
-    | Name | Description |
+  | Name | Description |
  | -------- | -------- |
  | All | All directions. |
  | Horizontal | Horizontal direction. |
@@ -37,7 +37,7 @@ SwipeGesture(value?: { fingers?: number; direction?: SwipeDirection; speed?: num


 - GestureEvent attributes related to the swipe gesture  
-    | Name | Type | Description |
+  | Name | Type | Description |
  | -------- | -------- | -------- |
  | angle | number | Angle of the swipe gesture.<br/>>&nbsp;![icon-note.gif](public_sys-resources/icon-note.gif)&nbsp;**NOTE**<br/>>&nbsp;Angle calculation method: After the swipe gesture is identified, a line connecting the two fingers is identified as the initial line. As the fingers swipe, the line between the fingers rotates. Based on the coordinates of the initial line's and current line's end points, an arc tangent function is used to calculate the respective included angle of the points relative to the horizontal direction. Rotation angle = arctan2(cy2-cy1,cx2-cx1) - arctan2(y2-y1,x2-x1). The initial line is used as the coordinate system. The clockwise rotation is 0 to 180 degrees, and the counter-clockwise rotation is –180 to 0 degrees. |
  | speed | number | Speed of the swipe gesture. |