Merge branch 'main' of https://github.com/OnClick9927/WooLocalization

Author: OnClick9927

docs/Docs/Text组件.md

@@ -0,0 +1,51 @@
+# 初始化
+在游戏启动脚本中进行初始化：
+``` csharp
+using WooLocalization;
+using UnityEngine;
+public class LocalizationInitializer : MonoBehaviour
+{
+    public LocalizationData localizationData; // 赋值你的本地化数据
+    private void Start()
+    {
+        // 设置记录器（用于保存当前语言设置）
+        Localization.SetRecorder(new DefaultRecorder());
+        // 设置本地化数据源
+        Localization.SetContext(localizationData);
+        // 设置默认语言
+        Localization.SetDefaultLocalizationType(Languages.zh_CHS);
+    }
+}
+```
+
+# 创建本地化数据
+在 Project 窗口右键创建LocalizationData文件并配置数据
+
+# 添加本地化组件
+给 UI 文本组件添加 LocalizationText 或 LocalizationTMP_Text 组件
+
+# Text/TMP 组件
+  * Context 设置文件
+  * Text  
+    * mode  
+      * 1.Normal：无操作 
+      * 2.New Key：输入Key和Value后点击Execute可以更新 
+      * 3.Replace Value：重新修改当前key的值
+    * Preview 当前语言的Key与Value
+  * key
+    * 此组件的key
+  * FormatArgs 
+    * 添加占位符的内容
+  * Font
+    * 设置字体
+  * FontSize 
+    * 设置字体大小
+  * Color 
+    * 设置文字颜色
+  * Material
+    * 设置材质球
+  * 每个属性中的mode选项
+    * 1.default ：默认资源配置
+    * 2.Custom : 
+    * 3.Asset : 配置此资源的Asset文件
+![](../_media/Component-Text.png)

docs/Docs/代码形式.md

@@ -0,0 +1,6 @@
+# 代码
+当不使用组件方式时如何使用
+``` csharp
+//调用静态类获取信息
+text.text=Localization.GetLocalization("Key")
+``` 

docs/Docs/其他资源使用.md

@@ -0,0 +1,6 @@
+# 其他类型资源本地化
+* 假如你有其他类型资源需要本地化处理，如Image，Prefab，Font
+* 1.创建对应资源Asset文件，并配置数据
+* 2.添加对应Localization组件，如：Sprite资源添加Localization_Image组件
+* 3.Localization_Image组件 - 勾选Sprite - mode选择Asset - asset选择对应文件即可
+* 4.使用ActorTest组件

docs/Docs/创建基础配置.md

@@ -0,0 +1,25 @@
+# 创建方法
+右键Project窗口 - Creat - Localization Data
+
+# 界面功能介绍
+* Clear Data
+  * 一键清除所有数据
+* Merge
+  * 合并选择的LocalizationData文件
+* Read Excel
+  * 从Excel文件夹中读取数据
+* Read From CSV / Write to CSV 
+  * 从本地路径中读写CSV文件
+* NewLanguage 
+  * 添加新语言
+* Language
+  * 选择语言
+* Key
+  * 用于在代码中引用对应文本的标识符
+* VAL 
+  * 用于在所需语言中显示的实际文本
+
+# 其他类型资源文件 
+Color、Font、Float等数据内容都可通过创建不同类型文件进行配置
+
+![tupian](../_media/LocalizationData.png)

docs/Docs/翻译.md

@@ -0,0 +1,5 @@
+# 使用有道翻译
+* 点击Register跳转注册 点击Code&Language跳转Api接入界面 
+* 填入Appid和AppSecret
+* 选择Asset文件右键 点击Translate 中指定翻译
+![](../_media/有道翻译.png)

docs/Docs/自定义扩展.md

@@ -0,0 +1,109 @@
+# Localization-Asset文件扩展  以Texture举例
+``` csharp
+using UnityEngine;
+namespace WooLocalization
+{
+    [CreateAssetMenu(menuName = "WooLocalization/TextureActorAsset")]
+    public class TextureActorAsset : ActorAsset<Texture>
+    {
+    }
+}
+
+using UnityEditor;
+using UnityEngine;
+namespace WooLocalization
+{
+    [CustomEditor(typeof(TextureActorAsset))]
+    class TextureActorAssetEditor : ActorAssetEditor<Texture, TextureActorAsset>
+    {
+        protected override float GetRowHeight()
+        {
+            return 60;
+        }
+        
+        protected override Texture DrawField(Rect pos, Texture src)
+        {
+            float min = Mathf.Min(pos.width, pos.height);
+            pos.size = Vector2.one * min;
+            return EditorGUI.ObjectField(pos, src, typeof(Texture), false) as Texture;
+        }
+
+    }
+}
+```
+# 组件扩展 以Texture举例
+```csharp
+using System.Collections.Generic;
+using UnityEngine;
+
+namespace WooLocalization
+{
+    [DisallowMultipleComponent]
+    public class LocalizationTexture : LocalizationBehavior
+    {
+        public class TextureActor : LocalizationMapActor<LocalizationBehavior, Texture>
+        {
+            private Texture ins;
+            public TextureActor(bool enable) : base(enable)
+            {
+            }
+            public override Texture GetDefault() => default;
+            protected override void Execute(string language, LocalizationBehavior component)
+            {
+#if UNITY_EDITOR
+                if (!Application.isPlaying) return;
+
+                if (UnityEditor.SceneManagement.EditorSceneManager.IsPreviewSceneObject(component)) return;
+#endif
+                var texture = GetValue(language);
+                if (texture != null)
+                {
+                }
+            }
+        }
+        public TextureActor Texture = new TextureActor(true);
+        protected override List<ILocalizationActor> GetActors()
+        {
+            return new List<ILocalizationActor>() {
+                Texture
+            };
+        }
+    }
+}
+
+
+using System;
+using UnityEditor;
+using UnityEngine;
+using static WooLocalization.LocalizationTexture;
+
+namespace WooLocalization
+{
+
+    [CustomEditor(typeof(LocalizationTexture))]
+    class LocalizationTextureEditor : LocalizationBehaviorEditor<LocalizationTexture>
+    {
+        [LocalizationActorEditorAttribute]
+
+        class TextureActorEditor : LocalizationMapActorEditor<LocalizationTexture.TextureActor, Texture, LocalizationBehavior>
+        {
+            protected override Type GetAssetType() => typeof(TextureActorAsset);
+
+            protected override bool NeedExecute() => false;
+
+        }
+    }
+}
+```
+
+# ActorTest扩展 以Texture举例
+```csharp
+public class ActorTest : WooLocalization.LocalizationBehavior
+{
+    protected override List<ILocalizationActor> GetActors()
+    {
+        return new List<ILocalizationActor>() {_texture };
+    }
+    public ObjectActor<Texture> _texture = new ObjectActor<Texture>(true);
+}
+```

docs/Docs/设置默认配置.md

@@ -0,0 +1,16 @@
+# GenKeys
+点击后生成key、sprite、Languages的字段和方法脚本
+
+# Localization Window
+* CSVRegex
+  * 正则表达式相关内容
+* Translator
+  * 有道翻译
+  * 点击跳转有道界面注册登录 并申请应用获取id sercet 输入Appid 和AppSecret 
+* DefaultData
+  * 设置语言映射和语言
+* ImportTMPExtend
+  * 添加TMP相关脚本
+
+![](../_media/LocalizationWindow.png)
+

docs/_sidebar.md

@@ -3,12 +3,11 @@
 
   - [安装](Docs/install.md)
   - [测试](Docs/test.md)
-  - [简介](Docs/简介.md)
-  - [快速使用](Docs/快速使用.md)
-  - [LocalizationData](Docs/LocalizationData.md)
-  - [Tools](Docs/Tools.md)
-  - [组件](Docs/组件.md)
-  - [初始化](Docs/初始化.md)
-  - [Demo](Docs/Demo.md)
-  - [API](Docs/API.md)
-  - [快速使用](Docs/快速使用.md)
+  - [创建基础配置](Docs/创建基础配置.md)
+  - [设置默认配置](Docs/设置默认配置.md)
+  - [Text组件](Docs/Text组件.md)
+  - [其他资源使用](Docs/其他资源使用.md)
+  - [代码形式](Docs/代码形式.md)
+  - [翻译](Docs/翻译.md)
+  - [自定义扩展](Docs/自定义扩展.md)
+