Skip to content

Latest commit

 

History

History
139 lines (94 loc) · 5.89 KB

README.md

File metadata and controls

139 lines (94 loc) · 5.89 KB
Raw

Video demo

影片示範

Deditor 可幫助文書處理軟體（例如 Windows 內建記事本，VB6 寫的報表軟體）加入語法高亮功能（syntax highlighting）等現代 IDE 有的功能，且不需修改目標程式。

Table of Contents

Background

作者在醫院工作，醫院提供的放射科報告輸入軟體的輸入界面是 VB6 的 textarea 控制項。沒有語法高亮、自動完成、拼寫檢查、佈景主題等現代 IDE 或文書處理軟體普遍具有的功能。長時間使用眼睛不適、容易出錯。請求資訊單位重構軟體基於各種理由不切實際。因此利用 Autohotkey 腳本和 Codemirror 建了 overlay UI，可以在不修改原始報表軟體的前提下提供上述功能。VB6 textarea 用了後可立刻升級成半套 IDE

軟體特色：

  1. 不用修改原始報表軟體。由程式負責 overlay UI 和原始報表軟體控制項的文字同步
  2. 提供語法高亮、自動完成、拼寫檢查
  3. 語法高亮和自動完成、拼寫檢查字典關鍵字可自訂。目前字典使用源自放射科教科書的單詞。語法高亮關鍵字來自作者業務用關鍵字清單。

QuickStart

  1. 確認電腦已安裝 Google Chrome 瀏覽器和 Autohotkey。
  2. 把 Deditor 下載至任意目錄。把 config.ahk.template 複製為 config.ahk
  3. 執行 Windows 內建記事本（Windows 7 為開始 -> 執行 -> notepad.exe）。 要套用在記事本外的程式，必須修改 config.ahk。
  4. 執行 showeditor.ahk

Usage

Requirement

  • 使用者必須已安裝 Google Chrome browser 和 Autohotkey。
  • Windows 7, 10 有測試。Windows XP、8 未測試。

Install

  1. 對任何程式第一次使用 Deditor 前需進行設定，先開啟欲加入語法高亮的文書處理軟體，使用 Autohotkey 內建的 Window Spy 查出需要語法高亮功能的控制項 classNN。再修改 config.ahk，將 targetExeName 和 targetControl 設定為執行檔名稱和控制項 classNN。以 Windows 內建記事本為例，設定如下：
	targetExeName := "notepad.exe"
	targetControl := "Edit1"
  1. 平常要使用，先開啟文書處理軟體，再啟動 showeditor.ahk 即可。
  2. 若目標程式的控制項會和 Deditor 互相覆蓋，可把 hideOriginalControl 設為 true
	hideOriginalControl:=true

Default keys

按鍵 說明
F4 移動到第一個 underscore
F5 將選取文字合併成一段
Ctrl + ; 移動到下一個 underscore
Ctrl + ' 移動到上一個 underscore
Ctrl + ] 文字放大
Ctrl + [ 文字縮小
Ctrl + Z Undo
Ctrl + Y Redo
Ctrl + F1 更改布景主題
Numpad End 活化 Deditor 窗口

Configuration

  • colorrule.txt 可運用 css 設定「哪些關鍵字可變色」和「變甚麼顏色」，內附 colorrule.txt 已內建可參考關鍵字，檔案格式如下：
  • 布景主題在 config.ahk 指定
  • CSS 設定檔可在 assets/theme 找到。
                     ; 分號後面可加註解
                     ; ##classname 表示後續文字套 cm-classname 的 CSS style
##critical           ; 例如 ##critical 表示後續文字套 cm-critical CSS style
tumor                ; tumor 關鍵字不分大小寫一律套用 cm-critical 樣式
reg:prominent.*hilum ; "reg:" 前綴，表示後面是 regular expression，配對不分大小寫
                     ; prominent right hilum、prominent left hilum.... 都套用 cm-critical 樣式

##info1              ; 這行以後的關鍵字，套用 cm-info1 CSS class
  • assets/config.js 包含前端環境設定，例如每列超過幾個字元後換行
  • lib/uievent.ahk 使用者可用類似 event hook 的方式「攔截」 各事件進行客製化。事件何時被呼叫可直接看 .ahk 腳本
  • 預設按鍵分別定義於 assets/loadlibrary.js 和 showeditor.ahk

Architecture

.                   根目錄，包含主要腳本和依賴工具
│  
├─assets			前端相關資源，包含 HTML、JS、web font
│  ├─codemirror
│  └─theme			布景主題
├─editsrv  			editorsrv.exe 原始碼，透過 websocket 協助 Chrome 與「外界」溝通
└─lib				其他必要 Autohotkey 腳本

使用者看到的 Deditor 輸入介面，實際上是運行在 Chrome 瀏覽器的 CodeMirror 代碼編輯器。

Deditor 啟動後會呼叫 Chrome，將編輯器作為 Chrome App 執行，然後 Chrome 的視窗會被「注入」目標程式。Chrome 和目標程式間文字、游標位置的同步透過 Javascript、editorsrv.exe（由 Rust 編寫）、Autohotkey 腳本進行

Building

Deditor 基本由腳本組成，只有由 Rust 編寫的 editorsrv.exe 需要額外編譯。現有穩定版本 Rust 應該都能透過 cargo build 直接編譯 第一次編譯 editorsrv 可能需要執行： rustup target add i686-pc-windows-msvc

Contributing

歡迎 pull request 和 fork。也歡迎一起在 Github 上討論。

Disclaimer

本軟體及所含之其他資訊按「現況」（as is）提供，作者對其之使用不作任何保證。使用者應自負風險，應用於生產環境前強烈建議仔細測試。

作者非專業軟體開發人員，作為業餘愛好項目之腳本程式，代碼寫法和架構不嚴謹，特別是完全沒有測試、代碼水平不高但 JS 又特別差等等，請多包涵。

其餘聲明請仔細參閱其他文件

License

請參閱 LICENSE.md

3rd-party-licenses

請參閱 3rd-party-licenses.md