diff --git a/en/application-dev/Readme-EN.md b/en/application-dev/Readme-EN.md index d6d13f7f74e7f817142bb4f97d4b5185810aa627..738aa15461938b8165360be3c8bb8a7531ed8235 100644 --- a/en/application-dev/Readme-EN.md +++ b/en/application-dev/Readme-EN.md @@ -7,15 +7,15 @@ - [OpenHarmony Release Notes](../release-notes/Readme.md) - Quick Start - Getting Started - - [Preparations](start-overview.md) - - [Getting Started with eTS](start-with-ets.md) - - [Getting Started with JavaScript in the Traditional Coding Approach](start-with-js.md) - - [Getting Started with JavaScript in the Low-Code Approach](start-with-js-low-code.md) + - - [Preparations](quick-start/start-overview.md) + - [Getting Started with eTS](quick-start/start-with-ets.md) + - [Getting Started with JavaScript in the Traditional Coding Approach](quick-start/start-with-js.md) + - [Getting Started with JavaScript in the Low-Code Approach](quick-start/start-with-js-low-code.md) - Development Fundamentals - - [Application Development Package Structure (FA Model)](package-structure.md) - - [Application Development Package Structure (Stage Model)](module-structure.md) - - [Resource File Categories](basic-resource-file-categories.md) - - [SysCap](syscap.md) + - [Application Development Package Structure (FA Model)](quick-start/package-structure.md) + - [Application Development Package Structure (Stage Model)](quick-start/module-structure.md) + - [Resource File Categories](quick-start/basic-resource-file-categories.md) + - [SysCap](quick-start/syscap.md) - Development - [Ability Development](ability/Readme-EN.md) - [UI Development](ui/Readme-EN.md) diff --git a/en/application-dev/reference/apis/js-apis-system-router.md b/en/application-dev/reference/apis/js-apis-system-router.md index c69a1599f615ae5fc0b4dfcfbf63d5b12033dd54..a93ffdfa68f6406c6290221d4c5fe757fd7c906b 100644 --- a/en/application-dev/reference/apis/js-apis-system-router.md +++ b/en/application-dev/reference/apis/js-apis-system-router.md @@ -280,7 +280,7 @@ Enables the display of a confirm dialog box before returning to the previous pag | Name | Type | Mandatory | Description | | ------- | ---------------------------------------- | ---- | -------------------------------------- | -| options | [EnableAlertBeforeBackPageOptions](#enableAlertbeforebackpageoptions6) | Yes | For details, see **EnableAlertBeforeBackPageOptions**.| +| options | [EnableAlertBeforeBackPageOptions](#enablealertbeforebackpageoptions6) | Yes | For details, see **EnableAlertBeforeBackPageOptions**.| **Example** diff --git a/en/application-dev/reference/apis/js-apis-zlib.md b/en/application-dev/reference/apis/js-apis-zlib.md index f1435417e60cc03f23ec9ef79166256000a1c0d8..2bf27848a2ed6025b0a8f7f961582aceec093372 100644 --- a/en/application-dev/reference/apis/js-apis-zlib.md +++ b/en/application-dev/reference/apis/js-apis-zlib.md @@ -127,9 +127,9 @@ zlib.unzipFile(inFile, outFile, options).then((data) => { | Name | Description | | --------------------------- | ------------------------------------------------------------ | -| level?: CompressLeve | See [zip.CompressLevel](#zip.CompressLevel).| -| memLevel?: MemLevel | See [zip.MemLevel](#zip.MemLevel) | -| strategy?: CompressStrategy | See [zip.CompressStrategy](#zip.CompressStrategy)| +| level?: CompressLeve | See [zip.CompressLevel](##zipcompresslevel). | +| memLevel?: MemLevel | See [zip.MemLevel](#zipmemlevel) | +| strategy?: CompressStrategy | See [zip.CompressStrategy](#zipcompressstrategy) | ## zip.MemLevel diff --git a/en/contribute/contribution-process.md b/en/contribute/contribution-process.md index a477b8658a0915049cdd23f6dc994d7c6a7b06a9..2544af35936a29020d37f26bc72516a555740f60 100755 --- a/en/contribute/contribution-process.md +++ b/en/contribute/contribution-process.md @@ -237,5 +237,5 @@ Visit [CI portal](http://ci.openharmony.cn/#/pipeLine). For details, visit [https://gitee.com/help/articles/4304](https://gitee.com/help/articles/4304). -Related topic: [FAQs](faqs.md) +Related topic: [FAQs](FAQ.md) diff --git a/en/contribute/documentation-contribution.md b/en/contribute/documentation-contribution.md index afd573b27c015e21a70aa8b008e558021d49137e..8a5eb74e52b929e155418875cef25dfde9ebdc15 100755 --- a/en/contribute/documentation-contribution.md +++ b/en/contribute/documentation-contribution.md @@ -65,7 +65,7 @@ You are welcome to contribute documents to the release. For details, see [Writin You are welcome to share your experience and expertise with other developers to help them get started. For example, you can contribute tutorials and FAQs by using the following templates: -- [Tutorial Template](template/tutorial-template.md.md). You can contribute tutorials in the `contribute/tutorial` folder. -- [FAQ Template](template/faq-template.md.md). You can contribute FAQs in the `contribute/faqs` folder. +- [Tutorial Template](template/tutorial-template.md). You can contribute tutorials in the `contribute/tutorial` folder. +- [FAQ Template](template/faq-template.md). You can contribute FAQs in the `contribute/faqs` folder. More writing templates are available in the **contribute** folder in the **Docs** repository. diff --git a/en/contribute/template/js-template.md b/en/contribute/template/js-template.md index 3db27cbb7917bb597e2e39086ed68e520b7a9ca5..fddf204b85f3fc9a981476e2a00b3c3556ed4d43 100644 --- a/en/contribute/template/js-template.md +++ b/en/contribute/template/js-template.md @@ -98,7 +98,7 @@ import call from '@ohos.telephony.call'; > > 4.4 - For a writable attribute, if only fixed fields are supported, describe them. > -> 4.5 - If the items in the table require different system capabilities, add the following description: The items in the table below require different system capabilities. For details, see the table. Then, describe the system capabilities for each item. See [Enumeration](#Enumeration). +> 4.5 - If the items in the table require different system capabilities, add the following description: The items in the table below require different system capabilities. For details, see the table. Then, describe the system capabilities for each item. See [Enums](#enums). **System capability**: SystemCapability.xxx.xxx (Mandatory) @@ -247,4 +247,5 @@ The following is an example of the custom type of a key-value pair. | Name | Type | Readable| Writable| Description | | ------------ | ------------------- | ---- | ---- | ------------------------------------------------------------ | | parameterUrl | string | Yes | Yes | Media output URI. The following types of URIs are supported:
1. Relative path whose protocol type is internal. Examples:
Temporary directory: internal://cache/test.mp4

2. Absolute path. Examples:
file:///data/data/ohos.xxx.xxx/files/test.mp4
| -| parameterOne | [CustomEnum](#Enumeration)| Yes | Yes | Describe the attributes. The requirements are similar to those for the parameter description. | +| parameterOne | [CustomEnum](#enums) | Yes | Yes | Describe the attributes. The requirements are similar to those for the parameter description. | + diff --git a/en/device-dev/faqs/faqs.md b/en/device-dev/faqs/faqs.md index 961b70d96a2813a26aa50ba8a8ea31b39cab95bd..e3206e139e8e1f60328f145b1fe69978d5cd5f50 100644 --- a/en/device-dev/faqs/faqs.md +++ b/en/device-dev/faqs/faqs.md @@ -4,7 +4,7 @@ - **[Overview of FAQs](faqs-overview.md)** -- **[Environment Setup](faqs-environment-building.md)** +- **[Environment Setup](faqs-environment-setup.md)** - **[Compilation and Building Subsystem](faqs-building.md)** @@ -12,8 +12,8 @@ - **[Kernel](faqs-kernel.md)** -- **[Porting](faqs-transplant.md)** +- **[Porting](faqs-porting.md)** -- **[Startup and Recovery](faqs-init.md)** +- **[Startup](faqs-startup.md)** -- **[System Applications](faqs-system-using.md)** +- **[System Applications](faqs-system-applications.md)** diff --git a/en/device-dev/hpm-part/hpm-part-development.md b/en/device-dev/hpm-part/hpm-part-development.md index b00b0739c06c29fb4b784fbaa9bed53c5ad0ee52..3493d72cca6f08534d839e19ea47e1fd0d2539e8 100644 --- a/en/device-dev/hpm-part/hpm-part-development.md +++ b/en/device-dev/hpm-part/hpm-part-development.md @@ -22,19 +22,19 @@ The hpm-cli tool is developed based on Node.js. Therefore, you must install Node You are advised to install the latest LTS version (not earlier than 12.x) of [Node.js](https://nodejs.org/). 2. Install the hpm-cli tool using **npm** delivered with **Node.js**. Run the following command: - + ``` npm install -g @ohos/hpm-cli ``` 3. Run the following command to check whether the installation is successful. If a hpm version is displayed, the installation is successful. - + ``` hpm -V or hpm --version ``` 4. (Optional) Run the following command to update the hpm version if needed: - + ``` npm update -g @ohos/hpm-cli ``` @@ -44,13 +44,13 @@ The hpm-cli tool is developed based on Node.js. Therefore, you must install Node After hpm-cli is installed, run the following command to view the hpm configuration: - + ``` hpm config ``` The default hpm configuration is displayed upon successful command execution. You can modify the default configuration as required. The following lists the common hpm configuration: - + ``` registry = https://hpm.harmonyos.com ### login Settings @@ -82,7 +82,7 @@ You can create an HPM Part by using a template or define an existing project as ### Creating an HPM Part Using a Template 1. Run the following command to create a directory: - + ``` hpm init -t default mybundle ``` @@ -91,7 +91,7 @@ You can create an HPM Part by using a template or define an existing project as > -In the preceding command, **default** indicates that the **default** template is used. You can use another template such as **simple** or **dist**. The generated directory structure is as follows: - + ``` / ├── headers # Header file (example) @@ -106,7 +106,7 @@ You can create an HPM Part by using a template or define an existing project as ``` 2. Write the code and build script of the HPM Part. - + ``` hpm init -t {templatename} -d {dir} {name} ``` @@ -120,14 +120,14 @@ You can create an HPM Part by using a template or define an existing project as The hpm-cli tool provides a few default templates. More templates are available on [DevEco Marketplace](https://repo.harmonyos.com). You can run the **hpm search -t template** command to search for a template stored on [DevEco Marketplace](https://repo.harmonyos.com). -![zh-cn_image_0000001217486680](figures/zh-cn_image_0000001217486680.png) +![en-us_image_0000001217486680](figures/en-us_image_0000001217486680.png) ### Defining an Existing Project as an HPM Part If you have a code project and need to distribute it on the HPM platform, run the following command in the project directory, for example, **mybundle2**: - + ``` hpm init ``` @@ -137,7 +137,7 @@ hpm init 2. Enter the version and description. A **bundle.json** file will be generated in the current directory. 3. Open the **bundle.json** file. - + ``` $ hpm init Your bundle will be created in directory ~\demo\mybundle2 @@ -148,7 +148,7 @@ hpm init ``` 4. Modify other information (such as the author, code repository, code directories, scripts, and dependencies) in **bundle.json**. An example is shown below: - + ``` { "name": "mybundle2", @@ -177,7 +177,7 @@ In the distribution metadata file, define the dependent HPM Parts and how to bui The following uses the **bundle.json** file as an example. In this example, the **dist** command uses the **hb** framework. - + ``` { "name": "@your/dist_name", @@ -225,7 +225,7 @@ The hpm-cli tool supports command integration so that you can select any build t This section describes how to build an executable file named **helloworld** in the **app** directory. - + ``` app ├── BUILD.gn @@ -237,7 +237,7 @@ app Create a **BUILD.gn** file in the same directory as **helloworld.c**. - + ``` touch BUILD.gn vim BUILD.gn @@ -245,7 +245,7 @@ vim BUILD.gn The following is an example of **BUILD.gn**: - + ``` executable("hello_world") { sources = [ @@ -268,28 +268,28 @@ executable("hello_world") { Run the following command to start the build: - + ``` hpm build ``` After all build operations are complete, the message "build succeed" is displayed. You need to check the build result. -![zh-cn_image_0000001262166533](figures/zh-cn_image_0000001262166533.png) +![en-us_image_0000001262166533](figures/en-us_image_0000001262166533.png) ### Building an Image Run the following command in the root directory of the current distribution: - + ``` hpm dist ``` The hpm-cli tool automatically starts the build. After the build is complete, an image file will be generated, as shown below: - + ``` out |-xxdist.img @@ -303,7 +303,7 @@ To publish an HPM Part, you must obtain an account and create an organization (o After that, generate a public key on the local PC based on your invitation code (which can be obtained on the **My profile** page on [DevEco Marketplace](https://repo.harmonyos.com)), and configure the public key on the **My profile** page. - + ``` hpm config set loginUser {your-invitation-code} hpm gen-keys @@ -315,7 +315,7 @@ Now you have the permission to publish HPM Parts in your organization. In the directory where the HPM Part is located, run the following command to pack and publish the HPM Part: - + ``` hpm publish ``` @@ -346,13 +346,13 @@ Visit [DevEco Marketplace](https://repo.harmonyos.com), search for HPM Parts tha 4. Run the **hpm build** command to perform build and output the build result. Run the following command in your project. Make sure that the project directory contains the **bundle.json** file. - + ``` $ hpm install @scope/the_bundle ``` The referenced HPM Part will be installed under **ohos_bundle** in the directory where your project is located. The directory structure is as follows: - + ``` project ├── ohos_bundle @@ -368,7 +368,7 @@ project Open the **bundle.json** file. You will see that the HPM Part has been introduced to the dependencies of your project. - + ``` { "dependencies": { @@ -379,7 +379,7 @@ Open the **bundle.json** file. You will see that the HPM Part has been introduce You can edit the dependencies of multiple HPM Parts in this file. - + ``` { "dependencies": { @@ -399,13 +399,13 @@ Run the **hpm install** command again to download and install all HPM Parts that If the referenced HPM Part is shared by multiple projects, for example, the compiler toolchain, you can install it globally. Run the following command in your project. Make sure that the project directory contains the **bundle.json** file. - + ``` $ hpm install -g @scope/the_tool ``` The referenced HPM Part will be installed in the directory specified by the **globalRepo** parameter of the **hpm config** command. - + ``` ~\.hpm\global\ohos_bundles │ └── scope @@ -415,7 +415,7 @@ $ hpm install -g @scope/the_tool > ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** > - For an HPM Part installed in a project, you can reference it using the environment variable **DEP_SCOPE_bundle_name** when running the hpm build command. > For example, after you run **hpm i \@opensource/gn** to install an HPM Part, edit the build script in the **bundle.json** file as follows: -> +> > ``` > "scripts": { > "build": "${DEP_OPENSOURCE_gn}/gn --version" @@ -425,14 +425,14 @@ $ hpm install -g @scope/the_tool > Then, you can run the **hpm build** command to call gn functions. > > - For a globally installed HPM Part, you can directly call the HPM Part using an environment variable or reference the HPM Part using the **${key}/tool_name** parameter in the **hpm config set key value** command. Example: -> +> > ``` > hpm i -g @ohos/opensource/gn > hpm config BUILD_SYS_GN ~/.hpm/global/ohos_bundles/opensource/gn > ``` > > You can edit the build script in the **bundle.json** file as follows: -> +> > ``` > "scripts": { > "build": "${BUILD_SYS_GN}/gn --version" diff --git a/en/device-dev/subsystems/Readme-EN.md b/en/device-dev/subsystems/Readme-EN.md index 83289e57bc02ebc24f6c7cd38e51e2e6d20f2bb0..a2d2508e6e57b0767afdd331410b42613f597445 100644 --- a/en/device-dev/subsystems/Readme-EN.md +++ b/en/device-dev/subsystems/Readme-EN.md @@ -62,9 +62,9 @@ - [Development Guidelines](subsys-application-framework-guide.md) - [Development Example](subsys-application-framework-demo.md) - [OTA Upgrade](subsys-ota-guide.md) -- [Telephony Service ](subsys-tel.md) - - [Telephony Service](telephony-service.md) - - [Development Guidelines](development-guidelines.md) +- [Telephony ](subsys-tel.md) + - [Telephony Overview](subsys-tel-overview.md) + - [Telephony Development](subsys-tel-guide.md) - [Security](subsys-security.md) - [Overview](subsys-security-overview.md) - [Development on Application Signature Verification](subsys-security-sigverify.md) diff --git a/en/device-dev/website.md b/en/device-dev/website.md index 90ace45acfc8819dcad3e8f237948095beb9385a..9a76eed3780b443549229d17808a152e33d58f3c 100644 --- a/en/device-dev/website.md +++ b/en/device-dev/website.md @@ -41,7 +41,7 @@ - Porting - Mini System SoC Porting Guide - Porting Preparations - - [Before You Start](porting/oem_transplant_chip_prepare_knows.md) + - [Before You Start](porting/porting-chip-prepare-knows.md) - [Building Adaptation Process](porting/porting-chip-prepare-process.md) - Kernel Porting - [Overview](porting/porting-chip-kernel-overview.md)