OpenHarmony Cangjie Documentation

Introduction

Welcome to the OpenHarmony Cangjie Documentation repository.

The Cangjie programming language is a general-purpose programming language designed for full-scenario application development. It balances development efficiency with runtime performance while providing an excellent programming experience.

This repository contains guides, API references, and other documentation related to developing OpenHarmony applications using the Cangjie programming language. We welcome you to read the documentation and participate in the OpenHarmony Cangjie Developer Documentation open-source project to collectively improve the developer documentation.

Currently, Cangjie only provides a subset of the OpenHarmony application development APIs. For a detailed overview of Cangjie's capabilities in OpenHarmony, please refer to Overview of Cangjie Capabilities in OpenHarmony

Documentation Architecture

The overall architecture of OpenHarmony Cangjie documentation is illustrated below:

Figure 1: Documentation Architecture Diagram

As shown above, the application developer documentation primarily includes:

1. Application Development Guide: Provides an overview of application development documentation to help developers understand the full picture.
2. Getting Started:
   • Quick Start: Introduces development preparations (basic concepts and tool setup) and guides developers through building their first OpenHarmony application using the Cangjie programming language, offering a preliminary understanding of OpenHarmony application development through a simple example.
   • Development Fundamentals: Covers foundational knowledge for OpenHarmony application development, including application package basics and configuration files.
   • Resource Classification and Access: Explains resource types such as strings, colors, fonts, spacing, and icons used in OpenHarmony application development.
   • Learning Cangjie Language: Introduces the features and syntax of the Cangjie programming language to help developers better understand and utilize it for OpenHarmony application development.
3. Development: Introduces related concepts, principles, and detailed development steps, including the following:
   • Application Framework: Includes Ability Kit (application framework services), ArkData (Ark data management), ArkUI (Ark UI framework), window management, screen management, ArkWeb (Ark Web), Core File Kit (basic file services), IPC Kit (inter-process communication services), Localization Kit (localization development services), etc.
   • System: Covers security (application access control, cryptographic algorithm framework services, key management services, etc.), networking (short-range communication services, network services, cellular communication services, etc.), basic functionalities (process/thread communication, upload/download services, etc.), hardware (sensor services), and debugging/optimization (performance analysis services, application testing services, debugging commands, etc.).
   • Media: Includes camera services, image processing services, media file management services, etc.
   • Graphics: Includes Ark 2D graphics services.
   • Application Services: Includes location services.
4. API Reference: Provides Cangjie language APIs for OpenHarmony application development, including functional descriptions, parameters, return values, permission details, and sample code to assist developers in understanding and using the Cangjie language for OpenHarmony application development.

Documentation Directory

The overall directory structure of the OpenHarmony Cangjie Documentation repository is as follows:

.
├── en                                   # English documentation directory (subdirectory structure mirrors zh-cn)
│   ├── application-dev                  # OpenHarmony-Cangjie application development documentation (guides, API references, etc.)
│   ├── CONTRIBUTING.md                  # Contribution guidelines
│   ├── COPYRIGHT                        # Copyright notice
│   ├── figures                          # Directory for images referenced in sibling files
│   ├── Overview-of-Cangjie-capabilities-in-OpenHarmony.md # Overview of Cangjie capabilities in OpenHarmony
│   └── README.md                        # Developer documentation overview
├── zh-cn                                # Chinese documentation directory
│   ├── application-dev
│   ├── CONTRIBUTING.md
│   ├── COPYRIGHT
│   ├── figures
│   ├── Overview-of-Cangjie-capabilities-in-OpenHarmony.md
│   └── README_zh.md
├── LICENSE                              # License file
├── OAT.xml                              # OAT rules file for repository OAT open-source checks
├── README.md                            # OpenHarmony-Cangjie documentation repository overview (English)
└── README_zh.md                         # OpenHarmony-Cangjie documentation repository overview (Chinese)

Contributing

We welcome your contributions and encourage developers to participate in documentation feedback and contributions in various ways.

You can review existing documentation, make changes, report quality issues, or contribute original content. For details, please refer to Contributing to Documentation.

License

The Cangjie developer documentation license can be found at License.

Related Repositories

• openharmony docs: OpenHarmony community documentation repository, containing application development documentation for OpenHarmony based on ArkTS language, as well as device development documentation and other developer resources.
• cangjie_docs: Cangjie community documentation repository, storing Cangjie language syntax, command-line tools, and other Cangjie-related knowledge.
• cangjie_runtime: Cangjie runtime and Cangjie programming language standard library. You can view the standard library API reference here.
• cangjie_stdx: Cangjie programming language stdx extension module repository. You can view the extension library API reference in this repository.