Merge pull request #8 from ZZHow1024/develop

MagicEncoding4.0.0
ZZHow1024 · Sep 14, 2024 · baaba15 · baaba15
2 parents 5fff4f5 + f758465
commit baaba15
Show file tree

Hide file tree

Showing 19 changed files with 1,029 additions and 65 deletions.
diff --git a/README.md b/README.md
@@ -18,6 +18,12 @@ https://github.com/ZZHow1024/MagicEncoding/releases
 
 ---
 
+## What is it?
+
+MagicEncoding is a cross-platform encoding processing tool that supports character set conversion of character files, encoding and decoding of character text (Unicode and URL) and Unix timestamps (conversion between timestamps and time and shortcut operations on time).
+
+---
+
 ## License
 
 This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
@@ -26,6 +32,8 @@ This project is licensed under the GNU General Public License v3.0 - see the [LI
 
 ## **Instructions for use**
 
+Download address: https://github.com/ZZHow1024/MagicEncoding/releases
+
 - Determine the operating system you are using.
     - Linux:
         - Select .deb installation package/ .rpm installation package.
@@ -39,13 +47,56 @@ This project is licensed under the GNU General Public License v3.0 - see the [LI
 - Start MagicEncoding.
 - You can select the language in the lower right corner of MagicEncoding's main interface.
     - Currently supports Chinese (Simplified / Traditional) and English.
-- Drag the folder or file to obtain the path, enter the suffix name to be filtered (separate multiple suffix names with "&"), and click Find File.
-- Select the original encoding and target encoding, and click "Start Conversion".
+- You can select the function category (Character file / Character text / Unix timestamp) above MagicEncoding.
+    - Character file
+        - Drag the folder or file to get the path, fill in the suffix name to be filtered (multiple suffix names are separated by "&"), and click "Find files".
+        - Choose whether to overwrite the original file.
+        - Select the original encoding and the target encoding, and click "Start conversion".
+    - Character text
+        - Continue to select Unicode / URL.
+            - Unicode
+                - Fill in the text content to be encoded in the text box above, click "**↓**", and the encoded text will be displayed in the text box below.
+                - Fill in the text content to be decoded in the text box below, click "**↑**", and the decoded text will be displayed in the text box above.
+            - URL
+                - Fill in the text content to be encoded in the text box above, select the character set of the original text, click "**↓**", and the encoded text will be displayed in the text box below.
+                - Fill in the text content to be decoded in the text box below, select the character set of the original text, click "**↑**", and the decoded text will be displayed in the text box above.
+    - Unix timestamp
+        - Basic functions
+            - When entering this module, the current timestamp will be automatically obtained, but it will not be updated in real time. Click "Refresh" to re-obtain the current timestamp.
+            - Fill in the timestamp to be converted in the left text box, select the timestamp unit (seconds / milliseconds), click "-->", and the converted time will be displayed in the right text box.
+            - Fill in the time to be converted in the right text box, select the timestamp unit (seconds / milliseconds), click "<--", and the converted timestamp will be displayed in the left text box.
+        - Quick operations
+            - Fill in the timestamp or time. If you fill in both, the operation will be based on the time (the content in the right text box).
+            - Select the operation type (Move forward / Move backward).
+            - Fill in the year, month, day, hour, minute and second (only Arabic numerals are supported), click "Operate", and the timestamp and time after the operation will overwrite the original content.
+- Click "Reset" to clear the filled content.
+
+---
+
+## Supported file character sets
+
+- Supported file character sets for conversion: Big5, Big5-HKSCS, CESU-8, EUC-JP, EUC-KR, GB18030, GB2312, GBK, IBM-Thai, IBM00858, IBM01140, IBM01141, IBM01142, IBM01143, IBM01144, IBM01145, IBM01146, IBM01147, IBM01148, IBM01149, IBM037, IBM1026, IBM1047, IBM273, IBM277, IBM278, IBM280, IBM284, IBM285, IBM290, IBM297, IBM420, IBM424, IBM437, IBM500, IBM775, IBM850, IBM852, IBM855, IBM857, IBM860, IBM861, IBM862, IBM863, IBM864, IBM865, IBM866, IBM868, IBM869, IBM870, IBM871, IBM918, ISO-2022-CN, ISO-2022-JP, ISO-2022-JP-2, ISO-2022-KR, ISO-8859-1, ISO-8859-13, ISO-8859-15, ISO-8859-16, ISO-8859-2, ISO-8859-3, ISO-8859-4, ISO-8859-5, ISO-8859-6, ISO-8859-7, ISO-8859-8, ISO-8859-9, JIS_X0201, JIS_X0212-1990, KOI8-R, KOI8-U, Shift_JIS, TIS-620, US-ASCII, UTF-16, UTF-16BE, UTF-16LE, UTF-32, UTF-32BE, UTF-32LE, UTF-8, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1255, windows-1256, windows-1257, windows-1258, windows-31j, x-Big5-HKSCS-2001, x-Big5-Solaris, x-euc-jp-linux, x-EUC-TW, x-eucJP-Open, x-IBM1006, x-IBM1025, x-IBM1046, x-IBM1097, x-IBM1098, x-IBM1112, x-IBM1122, x-IBM1123, x-IBM1124, x-IBM1129, x-IBM1166, x-IBM1364, x-IBM1381, x-IBM1383, x-IBM29626C, x-IBM300, x-IBM33722, x-IBM737, x-IBM833, x-IBM834, x-IBM856, x-IBM874, x-IBM875, x-IBM921, x-IBM922, x-IBM930, x-IBM933, x-IBM935, x-IBM937, x-IBM939, x-IBM942, x-IBM942C, x-IBM943, x-IBM943C, x-IBM948, x-IBM949, x-IBM949C, x-IBM950, x-IBM964, x-IBM970, x-ISCII91, x-ISO-2022-CN-CNS, x-ISO-2022-CN-GB, x-iso-8859-11, x-JIS0208, x-JISAutoDetect, x-Johab, x-MacArabic, x-MacCentralEurope, x-MacCroatian, x-MacCyrillic, x-MacDingbat, x-MacGreek, x-MacHebrew, x-MacIceland, x-MacRoman, x-MacRomania, x-MacSymbol, x-MacThai, x-MacTurkish, x-MacUkraine, x-MS932_0213, x-MS950-HKSCS, x-MS950-HKSCS-XP, x-mswin-936, x-PCK, x-SJIS_0213, x-UTF-16LE-BOM, X-UTF-32BE-BOM, X-UTF-32LE-BOM, x-windows-50220, x-windows-50221, x-windows-874, x-windows-949, x-windows-950, x-windows-iso2022jp.
+- Supports automatic identification of file character sets:[Encodings that can be detected](https://github.com/albfernandez/juniversalchardet?tab=readme-ov-file#encodings-that-can-be-detected).
+
+---
+
+## Dependencies
+
+This project requires the following libraries:
+
+- [**juniversalchardet**](https://github.com/albfernandez/juniversalchardet): Used for character encoding detection.
+- [**OpenJFX**](https://openjfx.io/): JavaFX library for building the graphical user interface.
 
 ---
 
-## Function Introduction
+## Functional introduction of each version
 
+- MagicEncoding4.0.0
+    - Unicode encoding and decoding of character text.
+    - URL encoding and decoding of character text.
+    - Unix timestamp.
+        - Supports conversion between timestamp and time
+        - Supports time shortcut operations
 - MagicEncoding3.0.0
     - Automatic encoding recognition.
     - Single file conversion.
@@ -63,7 +114,11 @@ This project is licensed under the GNU General Public License v3.0 - see the [LI
 
 ---
 
-## **Renderings**
+## Main interface of each version
+
+![MagicEncoding4.0.0_EN](https://www.notion.so/image/https%3A%2F%2Fprod-files-secure.s3.us-west-2.amazonaws.com%2F4b165318-6383-451c-8845-110b786c9f0a%2Fbec5cc32-9058-45d2-baeb-3b24dfc55b96%2FMagicEncoding4.0.0_EN.png?table=block&id=100e64bd-e40f-8088-9b6a-ce06348c8739&t=100e64bd-e40f-8088-9b6a-ce06348c8739&width=1624&cache=v2)
+
+MagicEncoding4.0.0_EN
 
 ![MagicEncoding3.0.0_EN](https://www.notion.so/image/https%3A%2F%2Fprod-files-secure.s3.us-west-2.amazonaws.com%2F4b165318-6383-451c-8845-110b786c9f0a%2Fa48f9fb0-5ca9-4b3e-aa65-5c0b9b8f53a4%2FMagicEncoding3.0.0_EN.png?table=block&id=e473a771-1ea7-42ab-9cc2-b124f8610072&t=e473a771-1ea7-42ab-9cc2-b124f8610072&width=1624&cache=v2)
 

diff --git a/README_ZH.md b/README_ZH.md
@@ -18,14 +18,22 @@ https://github.com/ZZHow1024/MagicEncoding/releases
 
 ---
 
-## License
+## 它是什么？
 
-This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
+MagicEncoding 是一款跨平台的编码处理工具，支持字符文件的字符集转换、字符文本的编解码（Unicode 与 URL）和 Unix 时间戳（时间戳与时间相互转换 和 时间的快捷操作）。
+
+---
+
+## 许可证
+
+该项目根据 GNU 通用公共许可证 v3.0 获得许可 - 有关详细信息，请参阅 [LICENSE](LICENSE) 文件。
 
 ---
 
 ## 使用说明
 
+下载地址：https://github.com/ZZHow1024/MagicEncoding/releases
+
 - 确定您使用的操作系统。
     - Linux：
         - 选择 .deb安装包 / .rpm安装包。
@@ -39,13 +47,56 @@ This project is licensed under the GNU General Public License v3.0 - see the [LI
 - 启动 MagicEncoding。
 - 在 MagicEncoding 的主界面右下方可以选择语言。
     - 当前支持中文（简体 / 繁体）与英文。
-- 拖拽文件夹或文件获取路径，填入需要筛选的后缀名（多种后缀名用“&”分隔），单击“查找文件”。
-- 选择原始编码与目标编码，单击“开始转换”。
+- 在 MagicEncoding 的上方可以选择功能分类（字符文件 / 字符文本 / Unix 时间戳）。
+    - 字符文件
+        - 拖拽文件夹或文件获取路径，填入需要筛选的后缀名（多种后缀名用“&”分隔），单击“查找文件”。
+        - 选择是否覆盖原文件。
+        - 选择原始编码与目标编码，单击“开始转换”。
+    - 字符文本
+        - 继续选择 Unicode / URL。
+            - Unicode
+                - 将待编码的文本内容填入上方文本框中，单击“**↓**”，编码后的文本将显示在下方文本框中。
+                - 将待解码的文本内容填入下方文本框中，单击“**↑**”，解码后的文本将显示在上方文本框中。
+            - URL
+                - 将待编码的文本内容填入上方文本框中，选择原文本的字符集，单击“**↓**”，编码后的文本将显示在下方文本框中。
+                - 将待解码的文本内容填入下方文本框中，选择原文本的字符集，单击“**↑**”，解码后的文本将显示在上方文本框中。
+    - Unix时间戳
+        - 基础功能
+            - 当进入此模块时会自动获取当前的时间戳，但这不会实时更新，单击“刷新”可以重新获取当前的时间戳。
+            - 将待转换的时间戳填入左方文本框中，选择时间戳的单位（秒 / 毫秒），单击“-->”，转换后的时间将显示在右方文本框中。
+            - 将待转换的时间填入右方文本框中，选择时间戳的单位（秒 / 毫秒），单击“<--”，转换后的时间戳将显示在左方文本框中。
+        - 快捷操作
+            - 填写时间戳或时间，若同时填写将在时间（右方文本框中的内容）的基础上进行操作。
+            - 选择操作类型（向前 / 向后）。
+            - 分别填入年、月、日、时、分和秒（仅支持阿拉伯数字），单击“操作”，操作后的时间戳和时间将会覆盖原始内容。
+- 单击“重置”可清空填写的内容。
+
+---
+
+## 支持的文件字符集
+
+- 支持转换的文件字符集：Big5，Big5-HKSCS，CESU-8，EUC-JP，EUC-KR，GB18030，GB2312，GBK，IBM-Thai，IBM00858，IBM01140，IBM01141，IBM01142，IBM01143，IBM01144，IBM01145，IBM01146，IBM01147，IBM01148，IBM01149，IBM037，IBM1026，IBM1047，IBM273，IBM277，IBM278，IBM280，IBM284，IBM285，IBM290，IBM297，IBM420，IBM424，IBM437，IBM500，IBM775，IBM850，IBM852，IBM855，IBM857，IBM860，IBM861，IBM862，IBM863，IBM864，IBM865，IBM866，IBM868，IBM869，IBM870，IBM871，IBM918，ISO-2022-CN，ISO-2022-JP，ISO-2022-JP-2，ISO-2022-KR，ISO-8859-1，ISO-8859-13，ISO-8859-15，ISO-8859-16，ISO-8859-2，ISO-8859-3，ISO-8859-4，ISO-8859-5，ISO-8859-6，ISO-8859-7，ISO-8859-8，ISO-8859-9，JIS_X0201，JIS_X0212-1990，KOI8-R，KOI8-U，Shift_JIS，TIS-620，US-ASCII，UTF-16，UTF-16BE，UTF-16LE，UTF-32，UTF-32BE，UTF-32LE，UTF-8，windows-1250，windows-1251，windows-1252，windows-1253，windows-1254，windows-1255，windows-1256，windows-1257，windows-1258，windows-31j，x-Big5-HKSCS-2001，x-Big5-Solaris，x-euc-jp-linux，x-EUC-TW，x-eucJP-Open，x-IBM1006，x-IBM1025，x-IBM1046，x-IBM1097，x-IBM1098，x-IBM1112，x-IBM1122，x-IBM1123，x-IBM1124，x-IBM1129，x-IBM1166，x-IBM1364，x-IBM1381，x-IBM1383，x-IBM29626C，x-IBM300，x-IBM33722，x-IBM737，x-IBM833，x-IBM834，x-IBM856，x-IBM874，x-IBM875，x-IBM921，x-IBM922，x-IBM930，x-IBM933，x-IBM935，x-IBM937，x-IBM939，x-IBM942，x-IBM942C，x-IBM943，x-IBM943C，x-IBM948，x-IBM949，x-IBM949C，x-IBM950，x-IBM964，x-IBM970，x-ISCII91，x-ISO-2022-CN-CNS，x-ISO-2022-CN-GB，x-iso-8859-11，x-JIS0208，x-JISAutoDetect，x-Johab，x-MacArabic，x-MacCentralEurope，x-MacCroatian，x-MacCyrillic，x-MacDingbat，x-MacGreek，x-MacHebrew，x-MacIceland，x-MacRoman，x-MacRomania，x-MacSymbol，x-MacThai，x-MacTurkish，x-MacUkraine，x-MS932_0213，x-MS950-HKSCS，x-MS950-HKSCS-XP，x-mswin-936，x-PCK，x-SJIS_0213，x-UTF-16LE-BOM，X-UTF-32BE-BOM，X-UTF-32LE-BOM，x-windows-50220，x-windows-50221，x-windows-874，x-windows-949，x-windows-950，x-windows-iso2022jp。
+- 支持自动识别的文件字符集：[Encodings that can be detected](https://github.com/albfernandez/juniversalchardet?tab=readme-ov-file#encodings-that-can-be-detected)。
+
+---
+
+## 依赖项
+
+该项目需要以下库：
+
+- [**juniversalchardet**](https://github.com/albfernandez/juniversalchardet)：用于字符编码检测。
+- [**OpenJFX**](https://openjfx.io/)：用于构建图形用户界面的 JavaFX 库。
 
 ---
 
-## 功能介绍
+## 各版本功能介绍
 
+- MagicEncoding4.0.0
+    - 字符文本的 Unicode 编解码。
+    - 字符文本的 URL 编解码。
+    - Unix 时间戳。
+        - 时间戳与时间相互转换
+        - 时间快捷操作
 - MagicEncoding3.0.0
     - 自动识别编码。
     - 单文件转换。
@@ -63,7 +114,11 @@ This project is licensed under the GNU General Public License v3.0 - see the [LI
 
 ---
 
-## **效果图**
+## 各版本主界面
+
+![MagicEncoding4.0.0_ZH](https://www.notion.so/image/https%3A%2F%2Fprod-files-secure.s3.us-west-2.amazonaws.com%2F4b165318-6383-451c-8845-110b786c9f0a%2Fb10a48cd-ee7f-49bd-a5c9-1a337b93b79a%2FMagicEncoding4.0.0_ZH.png?table=block&id=100e64bd-e40f-806d-8cd1-dd4538d217ba&t=100e64bd-e40f-806d-8cd1-dd4538d217ba&width=1624&cache=v2)
+
+MagicEncoding4.0.0_ZH
 
 ![MagicEncoding3.0.0_ZH](https://www.notion.so/image/https%3A%2F%2Fprod-files-secure.s3.us-west-2.amazonaws.com%2F4b165318-6383-451c-8845-110b786c9f0a%2F59e24efe-e112-48a3-8ca6-fa721270fca0%2FMagicEncoding3.0.0_ZH.png?table=block&id=63c5eb8e-9288-4418-a76b-627ee422a9c5&t=63c5eb8e-9288-4418-a76b-627ee422a9c5&width=1624&cache=v2)