diff --git a/docs-source/src/en/about/changelog.md b/docs-source/src/en/about/changelog.md index c944e1b..a86827a 100644 --- a/docs-source/src/en/about/changelog.md +++ b/docs-source/src/en/about/changelog.md @@ -4,13 +4,13 @@ ::: danger -We will only maintain the latest API version, if you are using an outdate API version, you voluntarily renounce any possibility of maintenance. +We will only maintain the latest API version. If you are using an outdated API version, you voluntarily renounce any possibility of maintenance. ::: ::: warning -To avoid translation time consumption, Changelog will use **Google Translation** from **Chinese** to **English**, please refer to the original text for actual reference. +To avoid translation time consumption, the Changelog will use **Google Translation** from **Chinese** to **English**. Please refer to the original text for actual reference. Time zone of version release date: **UTC+8** diff --git a/docs-source/src/en/about/contacts.md b/docs-source/src/en/about/contacts.md index 41f8607..da6ecac 100644 --- a/docs-source/src/en/about/contacts.md +++ b/docs-source/src/en/about/contacts.md @@ -1,6 +1,6 @@ # Contact Us -> If you have any questions in use, or have any constructive suggestions, you can contact us. +> If you have any questions during use, or have any constructive suggestions, you can contact us. Join our developers group. diff --git a/docs-source/src/en/about/future.md b/docs-source/src/en/about/future.md index 5c3f62a..81fa2f8 100644 --- a/docs-source/src/en/about/future.md +++ b/docs-source/src/en/about/future.md @@ -1,4 +1,4 @@ -# Looking for Future +# Looking Toward the Future > The future is bright and uncertain, let us look forward to the future development space of `PanguText`. diff --git a/docs-source/src/en/guide/home.md b/docs-source/src/en/guide/home.md index f089614..55bf113 100644 --- a/docs-source/src/en/guide/home.md +++ b/docs-source/src/en/guide/home.md @@ -1,4 +1,4 @@ -# Introduce +# Introduction > `PanguText` is a solution for CJK (Chinese, Japanese, Korean) and English word, half-width number spacing. @@ -13,7 +13,7 @@ Currently, the known vendor solutions are as follows: - Xiaomi’s (HyperOS) text typography optimization - OrginOS’s font-based text typography optimization -However, these solutions are closed and cannot be implemented on other platforms. +However, these solutions are closed-source and cannot be implemented on other platforms. We aim to provide an open-source solution adaptable to various scenarios, featuring low intrusiveness and easy integration, allowing more developers to effectively address text typography issues. The primary inspiration for this project comes from [pangu.js](https://github.com/vinta/pangu.js), which offers a set of regular expressions for CJK typography. @@ -66,5 +66,5 @@ The maintenance of this project is inseparable from the support and contribution This project is currently in its early stages, and there may still be some problems or lack of functions you need. -If possible, feel free to submit a PR to contribute features you think are needed to this project or goto [GitHub Issues](repo://issues) +If possible, feel free to submit a PR to contribute features you think are needed to this project or go to [GitHub Issues](repo://issues) to make suggestions to us. \ No newline at end of file diff --git a/docs-source/src/en/guide/quick-start.md b/docs-source/src/en/guide/quick-start.md index 6ec226b..70d46c6 100644 --- a/docs-source/src/en/guide/quick-start.md +++ b/docs-source/src/en/guide/quick-start.md @@ -5,7 +5,7 @@ ## Project Requirements The project needs to be created using `Android Studio` or `IntelliJ IDEA` and be of type Android or Kotlin Multiplatform -project and have integrated Kotlin environment dependencies. +project with integrated Kotlin environment dependencies. - Android Studio (It is recommended to get the latest version [from here](https://developer.android.com/studio)) @@ -15,8 +15,8 @@ project and have integrated Kotlin environment dependencies. ### Configure Repositories -The dependencies of `PanguText` are published in **Maven Central** and our public repository, -you can use the following method to configure repositories. +The dependencies of `PanguText` are published in **Maven Central** and our public repository. +You can use the following method to configure repositories. We recommend using Kotlin DSL as the Gradle build script language and [SweetDependency](https://github.com/HighCapable/SweetDependency) to manage dependencies. @@ -45,7 +45,7 @@ repositories { google() mavenCentral() // (Optional) You can add this URL to use our public repository - // When Sonatype-OSS fails and cannot publish dependencies, this repository is added as a backup + // When Sonatype OSS fails and cannot publish dependencies, this repository is added as a backup // For details, please visit: https://github.com/HighCapable/maven-repository maven("https://raw.githubusercontent.com/HighCapable/maven-repository/main/repository/releases") } diff --git a/docs-source/src/en/library/android.md b/docs-source/src/en/library/android.md index 9e2963e..c40d298 100644 --- a/docs-source/src/en/library/android.md +++ b/docs-source/src/en/library/android.md @@ -93,7 +93,7 @@ Integrating `PanguText` into your current project is very easy. You don't need t #### Inject to LayoutInflater -`PanguText` supports direct injection of `LayoutInflater.Factory2` or creating a `LayoutInflater.Factory2` instance for the current `Activity` to take over the entire view. This is the recommended integration method, as it allows for non-intrusive and quick integration without modifying any existing layouts. +`PanguText` supports direct injection of `LayoutInflater.Factory2` or creating a `LayoutInflater.Factory2` instance for the current `Activity` to take over the entire view layout inflation. This is the recommended integration method, as it allows for non-intrusive and quick integration without modifying any existing layouts. > The following example @@ -113,7 +113,7 @@ class MainActivity : AppCompatActivity() { ::: tip -Since `LayoutInflater.Factory2` is taken over, recycled layouts like `ListView` and `RecyclerView` can also be correctly taken over. +Since `LayoutInflater.Factory2` is taken over, recycled layouts like `ListView` and `RecyclerView` can also be correctly handled. After injecting the `LayoutInflater` instance in the `Activity`, the following instances attached to the current `Context` will automatically take effect: @@ -122,7 +122,7 @@ After injecting the `LayoutInflater` instance in the `Activity`, the following i - `PopupWindow` - `Toast` (foreground only in higher system versions) -Layouts based on `RemoteView` will not take effect because they are remote objects and do not use the current `Context`'s `LayoutInflater` for layout loading. +Layouts based on `RemoteView` will not take effect because they are remote objects and do not use the current `Context`'s `LayoutInflater` for layout inflation. ::: @@ -166,7 +166,7 @@ class MainActivity : Activity() { ::: tip `PanguTextFactory2` can be used not only with `Activity` but also injected into any existing `LayoutInflater` instance. -However, please inject before the `LayoutInflater` instance is used to load the layout, otherwise it will not take effect. +However, please inject it before the `LayoutInflater` instance is used to inflate the layout, otherwise it will not take effect. ::: @@ -174,7 +174,7 @@ However, please inject before the `LayoutInflater` instance is used to load the You can use `PanguTextPatcher` to patch existing `View` or `ViewGroup` instances. -Patch the entire root layout, and `PanguTextPatcher` will automatically patch all `TextView` or its subclasses under the root layout. +Patch the entire root layout, and `PanguTextPatcher` will automatically patch all `TextView` instances or their subclasses under the root layout. > The following example @@ -326,19 +326,19 @@ config.isEnabled = true // If issues occur, you can disable it. When disabled, Spanned text will return the original text. config.isProcessedSpanned = true // Whether to automatically re-measure the text width after processing. -// Note: [PanguText] after injecting text and changing the text, +// Note: After [PanguText] injects text and changes the text, // the width of [TextView] will not be calculated automatically. // At this time, this feature will call [TextView.setText] to re-execute the measurements, -// which can fix every time in some dynamic layouts (such as `RecyclerView`) changes in text width, -// but may cause performance issues, you can choose to disable this feature. +// which can fix issues in some dynamic layouts (such as `RecyclerView`) where text width changes each time, +// but may cause performance issues. You can choose to disable this feature. // To prevent unnecessary performance overhead, // this feature only takes effect on [TextView] with `maxLines` set to 1 or `singleLine`. config.isAutoRemeasureText = true // Set patterns to exclude during formatting using regular expressions. // For example, exclude all URLs. config.excludePatterns.add("https?://\\S+".toRegex()) -// For example, exclude emoji placeholders like "[doge]", -// if you use [ImageSpan] to display emoji images, you can choose to exclude these placeholders. +// For example, exclude emoji placeholders like "[doge]". +// If you use [ImageSpan] to display emoji images, you can choose to exclude these placeholders. config.excludePatterns.add("\\[.*?]".toRegex()) // Set the spacing ratio for CJK characters. // This determines the final layout effect.