再更新文档

xresloader · Jun 9, 2020 · 47c20e9 · 47c20e9
1 parent e23bbde
commit 47c20e9
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 8 deletions.
diff --git a/source/sample/quick_start/sample-conf/sample.xml b/source/sample/quick_start/sample-conf/sample.xml
@@ -2,10 +2,11 @@
 <root>
     <global>
         <work_dir desc="工作目录，相对于当前xml的目录，我们的Excel文件放在这里">.</work_dir>
-        <xresloader_path desc="指向前面下载的 转表工具-xresloader，相对于当前xml的目录">../xresloader/target/xresloader-1.4.3.jar</xresloader_path>
+        <xresloader_path desc="指向前面下载的 转表工具-xresloader，相对于当前xml的目录">../xresloader/target/xresloader-2.8.0.jar</xresloader_path>
 
         <proto desc="协议类型，-p选项">protobuf</proto>
-        <output_type desc="输出类型，对饮-t选项，输出二进制">bin</output_type>
+        <output_type desc="输出类型，对应-t选项，输出二进制">bin</output_type>
+        <output_type desc="多种输出时可以额外定义某个节点的重命名规则" rename="/(?i)\.bin$/\.json/">json</output_type>
         <proto_file desc="协议描述文件，-f选项">kind.pb</proto_file>
 
         <output_dir desc="输出目录，-o选项">../sample-data</output_dir>

diff --git a/source/users/advance_usage.rst b/source/users/advance_usage.rst
@@ -4,9 +4,9 @@
 .. _xresloader: https://github.com/xresloader/xresloader
 .. _xresloader sample: https://github.com/xresloader/xresloader/tree/master/sample
 .. _`xresloader/sample/proto_v3/kind.proto`: https://github.com/xresloader/xresloader/blob/master/sample/proto_v3/kind.proto
-.. _xresloader header extensions: https://github.com/xresloader/xresloader/tree/master/header/extensions
-.. _xresloader header extensions v2: https://github.com/xresloader/xresloader/tree/master/header/extensions/v2
-.. _xresloader header extensions v3: https://github.com/xresloader/xresloader/tree/master/header/extensions/v3
+.. _`xresloader/header/extensions`: https://github.com/xresloader/xresloader/tree/master/header/extensions
+.. _`xresloader/header/extensions/v2`: https://github.com/xresloader/xresloader/tree/master/header/extensions/v2
+.. _`xresloader/header/extensions/v3`: https://github.com/xresloader/xresloader/tree/master/header/extensions/v3
 
 文本替换（别名/宏）
 -----------------------------------------------------
@@ -93,7 +93,7 @@
 Protobuf 插件支持
 -----------------------------------------------------
 
-项目中可以导入 `xresloader header extensions`_ 目录， 然后通过导入 `xresloader header extensions v2`_ 或 `xresloader header extensions v3`_ 中的相应proto文件，就可以获得额外的插件扩展支持。
+项目中可以导入 `xresloader/header/extensions`_ 目录， 然后通过导入 `xresloader/header/extensions/v2`_ 或 `xresloader/header/extensions/v3`_ 中的相应proto文件，就可以获得额外的插件扩展支持。
 
 > 注意: 使用插件功能时　生成pb的时候也要导入插件的proto文件和protobuf官方include目录里的 google/protobuf/descriptor.proto 文件。
 

diff --git a/source/users/faq.rst b/source/users/faq.rst
@@ -100,4 +100,10 @@ repeated的数值类型在proto v2里默认是 ``[ packed = false ]`` 而在prot
 ----------------------------------------------------------------------------------------------------------------
 
 主要是因为（当前版本4.X）UE的 ``UEnum()`` 的支持仅支持基于 ``uint8`` 的，但是protobuf的field number是 ``int32`` 。为了兼容性所以没有使用 ``UEnum()`` 。 
-如果输出int32的话再UE里不太好操作，所以输出了字符串类型，方便蓝图里或UE代码里通过UE内置的反射机制访问。
+如果输出int32的话在UE里不太好操作，所以输出了字符串类型，方便蓝图里或UE代码里通过UE内置的反射机制访问。
+
+提示 ``Can not reserve enough space for XXX objecct heap``
+----------------------------------------------------------------------------------------------------------------
+
+在转换很大的Excel文件时（上万行数据），会需要很高的内存（>=1GB）。所以为了方便我们在批量转表sample的xml中配置了 ``<java_option desc="java选项-最大内存限制2GB">-Xmx2048m</java_option>`` 。
+如果出现这个提示可能是32位jre无法分配这么多地址空间导致的，可以在xml里删除这个配置。但是还是建议使用64位jre。
diff --git a/source/users/output_format.rst b/source/users/output_format.rst
@@ -172,7 +172,7 @@ xresloader从2.0.0版本开始支持导出UE所支持的CSV或者JSON格式数
 .. image:: ../_static/users/ue-blueprint.png
 
 如果我们希望在Excel里配置引用UE内的资源文件，可以使用 ``org.xresloader.ue.ue_type_name`` 插件和 ``org.xresloader.ue.ue_type_is_class`` 插件。
-前者会把UE的输出代码转为 ```TSoftObjectPtr<ue_type_name>``` 来指向UE内的资源，后者会把UE的输出代码转为 ```TSoftClassPtr<ue_type_name>``` 来指向UE内的类型。
+前者会把UE的输出代码转为 ``TSoftObjectPtr<ue_type_name>`` 来指向UE内的资源，后者会把UE的输出代码转为 ``TSoftClassPtr<ue_type_name>`` 来指向UE内的类型。
 
 比如我们配置字段: