https://github.com/g0v/laweasyread-front

an extension for browsers to view Taiwan's law articles/websites easier
https://github.com/g0v/laweasyread-front

Last synced: about 2 months ago
JSON representation

an extension for browsers to view Taiwan's law articles/websites easier

• Host: GitHub
• URL: https://github.com/g0v/laweasyread-front
• Owner: g0v
• License: other
• Fork: true (kong0107/zhLawEasyRead)
• Created: 2013-08-09T12:27:44.000Z (over 11 years ago)
• Default Branch: v2.x
• Last Pushed: 2024-08-10T16:07:33.000Z (4 months ago)
• Last Synced: 2024-08-10T17:24:00.120Z (4 months ago)
• Language: JavaScript
• Homepage: http://hack.g0v.tw/laweasyread
• Size: 8.23 MB
• Stars: 20
• Watchers: 21
• Forks: 6
• Open Issues: 13
• Metadata Files:
  • Readme: README-dev.md
  • Changelog: changelog-dev.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-g0v - laweasyread-front - 法規亦毒氣 (Open Data Open Gov / 開放資料、開放政府 / 法制與政府組織（立法及法律、政府架構與人事、司法及判決）)

README

        
# Development

## Algorithm

對所有文字節點的內容進行比對，若內容包含法規名稱，則置換成新的 HTML 元素。

1. 前端將第一個 `TextNode` 的 `textContent` 傳給後端。

2. 後端依照 `ReplaceRule[]` 將前述字串拆為 `Fragment[]` 。此步驟只處理字串，每個被拆開的物件和字串彼此獨立。

3. 後端將前述 `Fragment[]` 轉換為 JsonML 並傳給前端。此步驟涉及陣列中個物件之間的前後關係，並參考原始文字節點的 *某些特徵* 。

4. 前端用 `createElementFromJsonML()` 將前述 JsonML 陣列轉為 `HTMLElement[]` 。

5. 前端將步驟一的 `TextNode` 置換為前述 `HTMLElement[]` 。

6. 回到步驟一，傳送下一個 `TextNode` 的資料。

前述「後端」並非指伺服器，而是瀏覽器擴充功能的背景頁。

原則是：盡量將可反覆進行的事情留在後端，只將「必須放在前端」的事情在前端做。以利用「後端只有一個實體」的機制節省資源。

開發時須留意後端沒有 DOM ，也就是沒有 `Document` 類別、沒有 `document` 實體，且前後端間只能傳輸可序列化資料。

網頁內嵌模式則沒有後端，而是在前端執行所有程式碼。

## Files

### meta

* `README.md`: 給一般人看的專案說明

* `README-dev.md`: 給開發者看的專案說明

* `LICENSE.md`: 授權條款

* `changelog.md`: 給一般人看的更新紀錄

* `changelog-dev.md`: 給開發者看的開發紀錄

* `g0v.json`: G0V 專案設定

* `package.json`: Node.js 專案設定

* `manifest.json`: 瀏覽器擴充元件設定

### codes for each modes

* `lib/kong-util.js`: 專案發起人自己開發的工具包 [kong-util](https://github.com/kong0107/kong-util/) 。

* `LER.back.js`: 擷取資料、不須 DOM 操作的部分；在瀏覽器外掛模式中，於背景執行（只有一個實體）。

* `LER.front.js`: 呼叫後端程式碼並處理 DOM 的部分；在瀏覽器外掛模式中，於前景執行（每個分頁一個實體）。

### codes only for browser extension

* `lib/storage.js`: 存取瀏覽器暫存資料的函數。

* `data/`:

  * `data/options_default.json`: 預設的使用者設定。

  * `data/exclude_terms.txt`: 不要匹配的詞彙清單。

* `content_scripts/`: 針對不同網站而設計的程式。

* `browser/`:

  * `background.js`: 後台實體的進入點。

  * `popup.*`: 按下外掛按鈕時會出現的浮動式窗。

* `options_ui/`: 瀏覽器設定頁面。

## Data Sources

* [全國法規資料庫](https://github.com/kong0107/mojLawSplitJSON/tree/arranged)

* [大法官解釋](https://github.com/kong0107/jyi)

* [憲法裁判](https://github.com/kong0107/cons.judicial)

## Important Cases

* 不符合中央法規標準法所定的格式：

  * 所得稅法第4條（第1項第16款第2段、第22款第3段）、第14條（第1項第9類第1款第2段）

  * 土地法第2條（「類」）

* 多個條文引用，且條文引用包含「前段」、「但書」等字樣：

  * 政黨法第7條第3項第3款

* 算式：

  * 全民健康保險藥物給付項目及支付標準 第75條

  * 營利事業所得稅查核準則第16條

* 表格

* 原始資料缺漏一些標點符號：

  * 中央研究院組織法第7條第1款

## To-Do List

* 立法院法律系統在所得稅法第14條的問題

* 嘗試支援「前條」。

* 整合 ronnywang 抓下來的立法院資料。

  * 「相關法條」資料

  * 正確的分項（除了所得稅法§14）

* 支援法規名稱被框住之後的條號連結，例如 `《刑法》第10條` 。

* 支援更多條號的格式（例如 `民法第3至5條` 、 `民法1124條`），但不能在不需要的時候跳出來。

* 支援切換成「只處理白名單中的網站」。

* 裁判書連結。

* 於頁面在例外清單中時，顯示適當標記。

* 判斷各種細則、辦法裡面所稱的「本法」是誰（部分行政命令有多個母法）