fixed 30ca3390 from https://gitee.com/wusongqing/docs/pulls/4572

Added subsys-build-gn-hap-compilation-guide.md EN
Signed-off-by: Nwusongqing <wusongqing@huawei.com>

en/device-dev/subsystems/Readme-EN.md

@@ -5,6 +5,7 @@
   - [Building the Standard System](subsys-build-standard-large.md)
   - [Build System Coding Specifications and Best Practices](subsys-build-gn-coding-style-and-best-practice.md)
   - [Building the Kconfig Visual Configuration](subsys-build-gn-kconfig-visual-config-guide.md)
+  - [HAP Build Guide](subsys-build-gn-hap-compilation-guide.md)
 - [Distributed Remote Startup](subsys-remote-start.md)
 - Graphics
   - [Graphics Overview](subsys-graphics-overview.md)

en/device-dev/subsystems/subsys-build-gn-hap-compilation-guide.md

+# HAP Build Guide
+
+## Overview
+
+### Basic Concepts
+| Term| Description|
+| -------------- | ---------------------- |
+| HAP            | OpenHarmony Ability Package, released as a HAP file, with the file name extension .hap. One HAP file describes all content of an application, including code, resources, third-party libraries, and an application configuration file.|
+| Ability        | An abstraction of a functionality that an application can provide. It is the minimum unit for the system to schedule the application. An application can contain one or more **Ability** instances.|
+| FA             | Feature Ability, an ability that provides a UI for user interaction in the ability framework of the FA model. The FA supports only the Page ability template.|
+| PA             | Particle Ability, an ability that does not have a UI in the ability framework of the FA model. It provides service and support for FAs. For example, a PA can function as a background service to provide computing capabilities or as a data warehouse to provide data access capabilities. The PA supports three types of templates: Service, Data, and Form ability templates.|
+| FA Model        | One of the two ability framework models. The FA model applies to application development using API version 8 and earlier versions. The FA model provides FAs and PAs. The FA supports the Page ability template, and the PA supports the Service, Data, and Form ability templates. For details, see [FA Model Overview](../../application-dev/ability/fa-brief.md).|
+| Stage Model| One of the two ability framework models. The stage model applies to application development using API version 9 and later versions. The stage model provides abilities and Extension abilities. The latter ones are extended to Service Extension abilities, Form Extension abilities, Data Share Extension abilities, and more.|
+
+### Function
+The HAP provides HAP build functions and supports FA and stage models.
+
+## How to Develop
+
+### Templates Provided by the Build Subsystem
+#### ohos_hap
+
+This template declares a HAP target, which generates a HAP that will be packaged into the system image.
+
+| Supported Variable| Description|
+| --------- | ---- |
+| hap_profile | Configuration file of the HAP. It is **config.json** for the FA mode and **module.json** for the stage model.|
+| raw_assets | Raw assets, which are directly copied to the **assets** directory of the HAP.|
+| resources | Resources, which are stored in the **assets/entry/resources** directory after build.|
+| js_assets | JS resources, which are stored in the **assets/js/default** directory after ACE build.|
+| ets_assets | eTS resources, which are stored in the **assets/js/default** directory after ACE build.|
+| deps | Dependencies of the target.|
+| shared_libraries | Native libraries on which the target depends.|
+| hap_name | HAP name, which is optional. By default, it is the target name.|
+| final_hap_path | Path whether the generated HAP is stored. This variable optional. It takes precedence over **hap_name**.|
+| subsystem_name | Name of the subsystem that the HAP belongs to. The name must be consistent with that defined in **ohos.build**. Otherwise, the HAP will fail to be installed in the system image.|
+| part_name | Name of the part that the HAP belongs to. The name must be the same as that of **subsystem_name**.|
+| js2abc | Whether to convert JS code of the HAP into ARK bytecode.|
+| ets2abc | Whether to convert eTS code of the HAP into ARK bytecode.|
+| certificate_profile | Authorization file of the HAP, which is used for signature.|
+| certificate_file | Certificate file. The certificate file and authorization file can be applies from the OpenHarmony official website.|
+| keystore_path | Keystore file, which is used for signature.|
+| keystore_password | Keystore password, which is used for signature.|
+| key_alias | Alias of a key.|
+| module_install_name | Name of the HAP during installation.|
+| module_install_dir | Installation path of the HAP in the system. The default path is **system/app**.|
+| js_build_mode | Whether the release or debug build mode is used. This attribute is optional. The default value is **release**.|
+
+#### ohos_app_scope
+Declares the AppScope module of the HAP. The **app_profile** and **sources** variables of the target will be concatenated to a specific **entry** for build. This template is used only in the stage model.
+
+| Supported Variable| Description|
+| --------- | ---- |
+| app_profile | **app.json** file in the AppScope module of the HAP. This attribute is used only in the stage model.|
+| sources | Resources in the AppScope module of the HAP. This attribute is used only in the stage model.|
+
+#### ohos_js_assets
+Provides JS or eTS code, which is stored in the **assets/js/default** directory after ACE build. In the stage model, this template is stored in the **assets/js** or **assets/ets** directory, varying according to the programming language.
+
+| Supported Variable| Description|
+| --------- | ---- |
+| hap_profile | Configuration file of the HAP. It is **config.json** for the FA mode and **module.json** for the stage model.|
+| source_dir | JS or eTS code path, which is compatible with the **ability** directory of the FA model.|
+| ets2abc | eTS code path. This attribute is used only for widget configuration. In other development scenarios, use the configuration in the **ohos_hap** template.|
+| js2abc | JS code path. This attribute is used only for widget configuration. In other development scenarios, use the configuration in the **ohos_hap** template.|
+
+#### ohos_assets
+Provides raw assets, which are directly copied to the **assets** directory of the HAP.
+
+| Supported Variable| Description|
+|---------- | ---- |
+| sources | Path of the raw assets.|
+
+#### ohos_resources
+Resources, which are stored in the **assets/entry/resources** directory for the FA model and in the **resources** directory for the stage model.
+
+| Supported Variable| Description|
+| --------- | ---- |
+| hap_profile | Configuration file of the HAP. It is **config.json** for the FA mode and **module.json** for the stage model.|
+| sources | Resource file path.|
+| deps | Dependencies of the target. You must configure dependencies on the **ohos_app_scope** target for the stage model.|
+
+### Procedure
+
+1. Save the developed application example to the **applications/standard/** directory.
+
+2. Configure the GN script **applications/standard/example/BUILD.gn**. The following is an example of the FA model. For details about more **BUILD.gn** configurations, see [GN Script Configuration Example](#gn-script-configuration-example).
+   ```
+   import("//build/ohos.gni") # Reference ohos.gni.
+
+   ohos_hap("example") {
+     hap_profile = "./src/main/config.json" # config.json
+     js_assets = ["./src/main/js/default"]
+     raw_assets = ["./raw_assets"]
+     resources = ["./src/main/resources"]
+     shared_libraries = [
+       "//third_party/libpng:libpng", # Native library
+     ]
+     certificate_profile = "../signature/systemui.p7b" # Certificate file
+     hap_name = "SystemUI-NavigationBar" # Name
+     part_name = "prebuilt_hap"
+     subsystem_name = "applications"
+   }
+   ```
+
+3. Modify the **applications/standard/hap/ohos.build** file. The following is an example:
+   ```
+   {
+     "subsystem": "applications",
+     "parts": {
+       "prebuilt_hap": {
+         "module_list": [
+           ...
+           "//applications/standard/example:example" # Add a build target.
+         ]
+       }
+     }
+   }
+   ```
+
+4. Run the build command.
+   ```
+   # Perform full building.
+   ./build.sh --product-name {product_name}
+
+   # Build the HAP only.
+   ./build.sh --product-name {product_name} --build-target applications/standard/example:example
+   ```
+
+5. The build target is generated. The following shows the decompressed HAP in the FA model.
+   ```
+     Length      Date    Time    Name
+   ---------  ---------- -----   ----
+        1439  2009-01-01 00:00   assets/raw_assets                                 -----> raw_assets
+         354  2009-01-01 00:00   assets/entry/resources.index                      ------> resources
+           1  2009-01-01 00:00   assets/entry/resources/base/media/attributes.key  ------> resources
+           1  2009-01-01 00:00   assets/entry/resources/base/media/constants.key   ------> resources
+           1  2009-01-01 00:00   assets/entry/resources/base/media/contents.key    ------> resources
+        6790  2009-01-01 00:00   assets/entry/resources/base/media/icon.png        ------> resources
+           1  2009-01-01 00:00   assets/entry/resources/base/media/nodes.key       ------> resources
+       11170  2009-01-01 00:00   assets/js/default/app.js                          ------> js_assets
+          48  2009-01-01 00:00   assets/js/default/i18n/en-US.json                 ------> js_assets
+          50  2009-01-01 00:00   assets/js/default/i18n/zh-CN.json                 ------> js_assets
+         224  2009-01-01 00:00   assets/js/default/manifest.json                   ------> js_assets
+       41481  2009-01-01 00:00   assets/js/default/pages/index/index.js            ------> js_assets
+         909  2009-01-01 00:00   config.json                                       ------> hap_profile
+      266248  2009-01-01 00:00   libs/libpng.z.so                                  ------> shared_libraries
+   ```
+
+### GN Script Configuration Example
+- Example of multiple abilities in the FA model
+
+   ```
+   import("//build/ohos.gni")
+
+   ohos_hap("dataability") {
+     hap_profile = "entry/src/main/config.json"
+     deps = [
+       ":dataability_js_assets",
+       ":dataability_resources",
+     ]
+     certificate_profile = "signature/openharmony_sx.p7b"
+     hap_name = "dataability"
+     part_name = "prebuilt_hap"
+     subsystem_name = "applications"
+   }
+
+   ohos_js_assets("dataability_js_assets") {
+     ets2abc = true
+     source_dir = "entry/src/main/ets"
+     hap_profile = "entry/src/main/config.json"
+   }
+
+   ohos_resources("dataability_resources") {
+     sources = [
+       "entry/src/main/resources",
+     ]
+     hap_profile = "entry/src/main/config.json"
+   }
+
+   ```
+
+- Example of a JS widget in the FA model
+
+   ```
+   import("//build/ohos.gni")
+   
+   ohos_hap("FormOfFaJs") {
+     hap_profile = "entry/src/main/config.json"
+     deps = [
+       ":FormOfFaJs_js_assets",
+       ":FormOfFaJs_resources",
+     ]
+     certificate_profile = "signature/openharmony_sx.p7b"
+     hap_name = "FormOfFaJs"
+     part_name = "prebuilt_hap"
+     subsystem_name = "applications"
+   }
+   
+   ohos_js_assets("FormOfFaJs_js_assets") {
+     hap_profile = "entry/src/main/config.json"
+     js2abc = true
+     source_dir = "entry/src/main/js"
+   }
+   
+   ohos_resources("FormOfFaJs_resources") {
+     sources = [
+       "entry/src/main/resources",
+     ]
+     hap_profile = "entry/src/main/config.json"
+   }
+   ```
+
+- Example of an eTS widget in the FA model
+
+   ```
+   import("//build/ohos.gni")
+   
+   ohos_hap("FormOfFaEts") {
+     hap_profile = "entry/src/main/config.json"
+     deps = [
+       ":FormOfFaEts_js_assets",
+       ":FormOfFaEts_form_js_assets",
+       ":FormOfFaEts_resources",
+     ]
+     certificate_profile = "signature/openharmony_sx.p7b"
+     hap_name = "FormOfFaEts"
+     part_name = "prebuilt_hap"
+     subsystem_name = "applications"
+   }
+   
+   ohos_js_assets("FormOfFaEts_js_assets") {
+     hap_profile = "entry/src/main/config.json"
+     ets2abc = true
+     source_dir = "entry/src/main/ets"
+   }
+   
+   ohos_js_assets("FormOfFaEts_form_js_assets") {
+     hap_profile = "entry/src/main/config.json"
+     js2abc = true
+     source_dir = "entry/src/main/js"
+   }
+   
+   ohos_resources("FormOfFaEts_resources") {
+     sources = [
+       "entry/src/main/resources",
+     ]
+     hap_profile = "entry/src/main/config.json"
+   }
+   ```
+
+- Example of the stage model
+
+   ```
+   import("//build/ohos.gni")
+   
+   ohos_hap("actmoduletest") {
+     hap_profile = "entry/src/main/module.json"
+     deps = [
+       ":actmoduletest_js_assets",
+       ":actmoduletest_resources",
+     ]
+     certificate_profile = "signature/openharmony_sx.p7b"
+     hap_name = "actmoduletest"
+     part_name = "prebuilt_hap"
+     subsystem_name = "applications"
+   }
+   
+   ohos_app_scope("actmoduletest_app_profile") {
+     app_profile = "AppScope/app.json"
+     sources = [ "AppScope/resources" ]
+   }
+   
+   ohos_js_assets("actmoduletest_js_assets") {
+     ets2abc = true
+     source_dir = "entry/src/main/ets"
+   }
+   
+   ohos_resources("actmoduletest_resources") {
+     sources = [
+       "entry/src/main/resources",
+     ]
+     deps = [
+       ":actmoduletest_app_profile",
+     ]
+     hap_profile = "entry/src/main/module.json"
+   }
+   ```
+
+- Example of a widget in the stage model
+
+   ```
+   import("//build/ohos.gni")
+   
+   ohos_hap("FormOfStageEts") {
+     hap_profile = "entry/src/main/module.json"
+     deps = [
+       ":FormOfStageEts_js_assets",
+       ":FormOfStageEts_form_js_assets",
+       ":FormOfStageEts_resources",
+     ]
+     js_build_mode = "debug" # The default value is release.
+     certificate_profile = "signature/openharmony_sx.p7b"
+     hap_name = "FormOfStageEts"
+     part_name = "prebuilt_hap"
+     subsystem_name = "applications"
+   }
+   
+   ohos_js_assets("FormOfStageEts_js_assets") {
+     hap_profile = "entry/src/main/module.json"
+     ets2abc = true
+     source_dir = "entry/src/main/ets"
+   }
+   
+   ohos_js_assets("FormOfStageEts_form_js_assets") {
+     hap_profile = "entry/src/main/module.json"
+     js2abc = true
+     source_dir = "entry/src/main/js"
+   }
+   
+   ohos_app_scope("FormOfStageEts_app_profile") {
+     app_profile = "AppScope/app.json"
+     sources = [ "AppScope/resources" ]
+   }
+   
+   ohos_resources("FormOfStageEts_resources") {
+     sources = [
+       "entry/src/main/resources",
+     ]
+     deps = [
+       ":FormOfStageEts_app_profile",
+     ]
+     hap_profile = "entry/src/main/module.json"
+   }
+   ```