Fix the keyboard intro

Fix the keyboard intro

Author: JE-Chen

docs/source/Eng/doc/callback_function/callback_function_doc.rst

@@ -1,10 +1,11 @@
-Callback function documentation
+回調函數 文件
 ----
 
 在 AutoControl 裡，Callback function 是由 Callback Executor 提供支援，
 以下是簡易的使用 Callback Executor 的範例，
 
 .. code-block:: python
+
     from je_auto_control import callback_executor
     # trigger_function will first to execute, but return value need to wait everything done
     # so this test will first print("test") then print(size_function_return_value)
@@ -20,8 +21,6 @@ Callback function documentation
 * ( 注意!，如果 callback_executor event_dict 裡面包含的 name: function 需與 executor 一樣，不一樣則是 Bug)
 * (當然跟 executor 一樣可以藉由添加外部 function 來擴充，請看下面例子)
 
------
-
 在這個範例裡，我們使用 callback_executor 執行定義在 AutoControl 的 size function，
 然後執行完 size function 後，會去執行傳遞給 callback_function 的 function，
 可以由 callback_param_method 參數來決定要使用的傳遞方法，
@@ -31,25 +30,19 @@ Callback function documentation
 實際上 size -> print 順序沒錯，但此例會先看到 print 之後才是 print(size_function_return_value)，
 因為 size function 只有回傳值本身沒有 print 的動作。
 
------
-
 如果我們想要在 callback_executor 裡面添加 function，可以使用如下:
 這段程式碼會把所有 time module 的 builtin, function, method, class
 載入到 callback executor，然後要使用被載入的 function 需要使用 package_function 名稱，
 例如 time.sleep 會變成 time_sleep
 
-----
-
 .. code-block:: python
+
     from je_auto_control import package_manager
     package_manager.add_package_to_callback_executor("time")
 
-----
-
 如果你需要查看被更新的 event_dict 可以使用
 
-----
-
 .. code-block:: python
+
     from je_auto_control import callback_executor
     print(callback_executor.event_dict)

docs/source/Eng/doc/cli/cli_doc.rst

@@ -1,22 +1,17 @@
-CLI documentation
-----
-
+命令列介面 文件
 ----
 
 我們可以使用 CLI 模式去執行 keyword.json 檔案或執行包含 Keyword.json files 的資料夾，
 以下這個範例是去執行指定路徑的關鍵字 json 檔
 
-----
-
 .. code-block::
+
     python je_auto_control --execute_file "C:\Users\JeffreyChen\Desktop\Code_Space\AutoControl\test\unit_test\argparse\test1.json"
 
 
-----
 
 以下這個範例是去執行指定路徑資料夾下所有的 keyword json 檔
 
-----
-
 .. code-block::
+
     python je_auto_control --execute_dir "C:\Users\JeffreyChen\Desktop\Code_Space\AutoControl\test\unit_test\argparse"

docs/source/Eng/doc/critical_exit/critical_exit_doc.rst

@@ -1,22 +1,16 @@
-Critical Exit documentation
+緊急退出 文件
 ----
-
-----
-
 * Critical Exit 是提供故障保護的機制。
 * Critical Exit 預設是關閉的。
 * 如果開啟，預設按鍵是 F7。
 * 開啟的方法是 CriticalExit().init_critical_exit()
 
-----
-
 以下這個範例是讓滑鼠不受控制的移動並拋出例外，
 當接收到例外，初始化 Critical Exit 並自動按下 F7，
 ( 注意! 如果修改這個範例必須極度小心。 )
 
-----
-
 .. code-block:: python
+
     import sys
 
     from je_auto_control import AutoControlMouseException

docs/source/Eng/doc/generate_report/generate_report_doc.rst

@@ -1,22 +1,17 @@
-Generate Report documentation
+報告產生 文件
 ----
 
 Generate Report 可以生成以下格式的報告
 * HTML
 * JSON
 * XML
-
-----
-
 * Generate Report 主要用來記錄與確認有哪些步驟執行，執行是否成功，
 * 如果要使用 Generate Report 需要先設定紀錄為 True，使用 test_record_instance.init_record = True
 * 下面的範例有搭配 keyword and executor 如果看不懂可以先去看看 executor
-
 以下是產生 HTML 的範例。
 
-----
-
 .. code-block:: python
+
     import sys
 
     from je_auto_control import execute_action
@@ -61,13 +56,11 @@ Generate Report 可以生成以下格式的報告
     print("\n\n")
     execute_action(test_list)
 
-----
 
 以下是產生 JSON 的範例。
 
-----
-
 .. code-block:: python
+
     import sys
 
     from je_auto_control import execute_action
@@ -112,13 +105,10 @@ Generate Report 可以生成以下格式的報告
     print("\n\n")
     execute_action(test_list)
 
-----
-
 以下是產生 XML 的範例。
 
-----
-
 .. code-block:: python
+
     import sys
 
     from je_auto_control import execute_action

docs/source/Eng/doc/image/image_doc.rst

@@ -1,18 +1,15 @@
-Image documentation
+圖片偵測 文件
 ----
 
 * Image 提供了關於圖像辨識的功能。
 * 定位一張圖片在螢幕中的位置。
 * 定位多張圖片在螢幕中的位置。
 * 定位圖片在螢幕中的位置並點擊。
 
-----
-
 以下範例是定位所有圖片
 
-----
-
 .. code-block:: python
+
     import time
 
     from je_auto_control import locate_all_image
@@ -26,13 +23,10 @@ Image documentation
     image_data = locate_all_image(screenshot(), detect_threshold=0.9, draw_image=False)
     print(image_data)
 
-----
-
-以下範例是定位並點擊'圖片
-
-----
+以下範例是定位並點擊圖片
 
 .. code-block:: python
+
     import time
 
     from je_auto_control import locate_and_click
@@ -45,13 +39,10 @@ Image documentation
     image_data = locate_and_click(screenshot(), "mouse_left", detect_threshold=0.9, draw_image=False)
     print(image_data)
 
-----
-
 以下範例是定位圖片
 
-----
-
 .. code-block:: python
+
     import time
 
     from je_auto_control import locate_image_center

docs/source/Eng/doc/info/info_doc.rst

@@ -1,4 +1,4 @@
-Installation documentation
+安裝 文件
 ----
 
 .. code-block:: python
@@ -15,6 +15,7 @@ Installation documentation
     * ubuntu 20.0.4
 
 | 如果想要在樹梅派使用
+
 .. code-block:: python
 
     sudo apt-get install python3

docs/source/Eng/doc/installation/installation_doc.rst

@@ -1,4 +1,4 @@
-Keyboard documentation
+鍵盤 文件
 ----
 
 * 主要用來模擬鍵盤的控制。
@@ -8,68 +8,53 @@ Keyboard documentation
 * special_table 是特定的鍵盤按鍵 ( 注意! 不是每個平台都有 )
 * keys_table 是所有可以使用的按鍵
 
-----
-
 .. code-block:: python
+
     from je_auto_control import keys_table, get_special_table
 
     print(keys_table)
     print(get_special_table())
 
-----
 
 以下範例是按著鍵盤的某個按鍵，並在一秒後釋放
 
-----
-
 .. code-block:: python
+
     from time import sleep
     from je_auto_control import press_key, release_key
 
     press_key("a")
     sleep(1)
     release_key("a")
 
-----
-
 以下範例是按下與釋放按鍵
 
-----
-
 .. code-block:: python
+
     from je_auto_control import type_key
 
     type_key("a")
 
-----
-
 以下範例是檢查鍵盤 a 鍵是否按著
 
-----
-
 .. code-block:: python
+
     from je_auto_control import check_key_is_press
 
     check_key_is_press("a")
 
-----
-
 以下範例是按下與放開一串按鍵
 
-----
-
 .. code-block:: python
+
     from je_auto_control import write
 
     write("abcdefg")
 
-----
-
 以下範例是按下按鍵並相反的釋放
 
-----
-
 .. code-block:: python
+
     import sys
 
     from je_auto_control import hotkey

docs/source/Eng/doc/keyboard/keyboard_doc.rst

@@ -1,11 +1,12 @@
-Keyword and Executor documentation
+鍵盤與執行者 文件
 ----
 
 * Keyword 是一個 JSON 檔案裏面包含許多自定義的關鍵字與參數。
 * Keyword 會與 Executor 搭配使用。
 * Keyword 的格式是以下範例，且在 JSON 檔案裡面使用一樣格式。
 
 .. code-block:: python
+
     [
         ["function_name_in_event_dict": {"param_name": param_value}],
         ["function_name_in_event_dict": {"param_name": param_value}],
@@ -14,45 +15,36 @@ Keyword and Executor documentation
         # If you are using position param
         ["function_name_in_event_dict": {param_value1, param_value2....}]
     ]
-----
 
 如果我們想要在 executor 裡面添加 function，可以使用如下:
 這段程式碼會把所有 time module 的 builtin, function, method, class
 載入到 executor，然後要使用被載入的 function 需要使用 package_function 名稱，
 例如 time.sleep 會變成 time_sleep
 
-----
-
 .. code-block:: python
+
     from je_auto_control import package_manager
     package_manager.add_package_to_executor("time")
 
-----
 
-如果你需要查看被更新的 event_dict 可以使用
 
-----
+如果你需要查看被更新的 event_dict 可以使用
 
 .. code-block:: python
+
     from je_auto_control import executor
     print(executor.event_dict)
 
-----
-
 如果我們想要執行 JSON 檔案
 
-----
-
 .. code-block:: python
+
     from je_auto_control import execute_action, read_action_json
     execute_action(read_action_json(file_path))
 
-----
-
 如果我們想要執行資料夾裡所有 JSON 檔案
 
-----
-
 .. code-block:: python
+
     from je_auto_control import execute_files, get_dir_files_as_list
     execute_files(get_dir_files_as_list(dir_path))