clo/README.md

# clo
 - another personal draught of a typesetting language and engine.
 - website: https://kianting.info/wiki/w/Project:Clo
 - license: MIT 
 - issue tracking mailing list: `clo@kianting.info`

## changing journal
 - 20230904 建立 thenDo、matchRange的函數、refactor harfbuzzjs 以及libpdf 等測試界面
 - 20230905-06: 建立 : `toSome`, initial of basic tokenizer (`tokenize`),
   `matchAny`, `notDo`, `orDo`, `zeroOrMoreDo`, `zeroOrOnceDo`
 - 20230905-07:強化`tokenize`, 加強功能，加`Token`界面。
 - 20230907-08:強化`tokenize`。
 - 20230910 : add basic parser `CONST` rule, and add the grammar rule.
 - 20230914-15: 追加一寡 tokenizer ê 功能。
 - 20230918: 重新tuì下kàu頂起做parser. add rule
 - 20230921-22:add rule, report issue
 - 20230925-26: 試驗án-tsuánn解決[issue1](https://kianting.info/pipermail/clo_kianting.info/2023-September/000004.html), iáu-buē成功。
   - 凡勢用？
    ```
    FuncApp ::= Single FuncAppAux | Single
    FuncAppAUx ::= FunCallee FuncAppAUx
    FuncCallee ::= "(" ")" | "(" ARGS ")"
    ARGS = SINGLE "," ARGS | SINGLE
    ```
 - 20230928：basically fix `issue1`。其他ê物件猶著做。
 - 20230929：add multi args parsing for `callee`.
 - 20230930：tîng khí parser, using `js-token`.
 - 20231006: tîng siá parser, using `ts-parsec`.
 - 20231010: 初步完成tsit ê階段ê Parser`。
 - 20231012: clo->js converter successfully (maybe.)
 - 20231016：basic font guessing and `putText` function
 - 20231023-24:fix .ttc bug.
 - 20231026-27 : clo basic interface, preprocessor of stream of text,
  add cjk-english splitter, etc.
 - 20231029-30: hyphenating for english.
 - TODO：利用harfbuzz算文字的對應px寬度


 ## 之後的做法
  - 先做一個前處理註冊器，註冊下列的前處理
    - 中英文間距
    - 換行點
    - 空白轉為 [glue]
  - 前處理完成字串後，必須要：
    - 算出字元的Box
    - 利用 frame/box 資訊分行、分頁
    - 然後算出每個Box的x, y, page
    - 最後納入排版

## 排版語法

使用lisp表示，但其實是陣列
```lisp
  (hglue 寬度 伸展值)
  (vglue 高度 伸展值)
  (bp 原始模式 斷行模式) ; breakpoint
  (nl) ; newline
  (em 數字)
  (ex 數字)
  (span {"font-family" : "Noto Sans" , "font-size" : 16 })
  (vbox 高度 內容)
```

## How to generate documents
 - `typedoc /path/to/index.js [/path/to/index2.js ...]`
the generated page will be stored in `/src`.
-												Create README.md
											
										
										
											2023-09-04 21:45:46 +08:00
+								# clo
-												english breakline, and generate try to count the text size

											
										
										
											2023-10-30 02:18:29 +08:00
+								 - another personal draught of a typesetting language and engine.
 								 - website: https://kianting.info/wiki/w/Project:Clo
 								 - license: MIT
 								 - issue tracking mailing list: `clo@kianting.info`
-												modify readme

											
										
										
											2023-09-20 21:10:59 +08:00
-												Update README.md
											
										
										
											2023-09-04 21:49:55 +08:00
+								## changing journal
-												Update README.md
											
										
										
											2023-09-04 22:02:34 +08:00
+								 - 20230904 建立 thenDo、matchRange的函數、refactor harfbuzzjs 以及libpdf 等測試界面
-												Update README.md
											
										
										
											2023-09-06 00:02:07 +08:00
+								 - 20230905-06: 建立 : `toSome`, initial of basic tokenizer (`tokenize`),
-												Update README.md - today's log
											
										
										
											2023-09-06 00:01:53 +08:00
+								   `matchAny`, `notDo`, `orDo`, `zeroOrMoreDo`, `zeroOrOnceDo`
-												add tokenize's function, add interface `Token`

											
										
										
											2023-09-07 00:01:15 +08:00
+								 - 20230905-07:強化`tokenize`, 加強功能，加`Token`界面。
-												add readme

											
										
										
											2023-09-08 01:25:14 +08:00
+								 - 20230907-08:強化`tokenize`。
-												20230910 : add basic parser `CONST` rule, and add the grammar rule.

											
										
										
											2023-09-10 23:45:01 +08:00
+								 - 20230910 : add basic parser `CONST` rule, and add the grammar rule.
-												add readme

											
										
										
											2023-09-15 00:35:06 +08:00
+								 - 20230914-15: 追加一寡 tokenizer ê 功能。
-												rebuild parser

											
										
										
											2023-09-19 00:35:01 +08:00
+								 - 20230918: 重新tuì下kàu頂起做parser. add rule
-												add rule and find some issue

											
										
										
											2023-09-22 01:45:47 +08:00
+								 - 20230921-22:add rule, report issue
-												add some idea

											
										
										
											2023-09-26 00:47:11 +08:00
+								 - 20230925-26: 試驗án-tsuánn解決[issue1](https://kianting.info/pipermail/clo_kianting.info/2023-September/000004.html), iáu-buē成功。
 								   - 凡勢用？
 								    ```
 								    FuncApp ::= Single FuncAppAux | Single
 								    FuncAppAUx ::= FunCallee FuncAppAUx
 								    FuncCallee ::= "(" ")" | "(" ARGS ")"
 								    ARGS = SINGLE "," ARGS | SINGLE
-												basically fix issue #1 and add readme

											
										
										
											2023-09-28 23:44:42 +08:00
+								    ```
-												add callee multi arguments

											
										
										
											2023-09-29 11:09:20 +08:00
+								 - 20230928：basically fix `issue1`。其他ê物件猶著做。
-												add readme

											
										
										
											2023-09-30 21:47:37 +08:00
+								 - 20230929：add multi args parsing for `callee`.
-												rewrite parser

											
										
										
											2023-10-06 01:09:28 +08:00
+								 - 20230930：tîng khí parser, using `js-token`.
-												basic parser built

											
										
										
											2023-10-10 22:15:02 +08:00
+								 - 20231006: tîng siá parser, using `ts-parsec`.
-												20231012: clo->js converter successfully (maybe.)

											
										
										
											2023-10-12 00:39:32 +08:00
+								 - 20231010: 初步完成tsit ê階段ê Parser`。
-												20231016：basic font guessing and `putText` function
  - issues : the CJK font can't be in .ttc format. (upstream-problem)

											
										
										
											2023-10-16 00:30:32 +08:00
+								 - 20231012: clo->js converter successfully (maybe.)
 								 - 20231016：basic font guessing and `putText` function
-												add clo library initially with register of prepocessor

											
										
										
											2023-10-26 23:36:20 +08:00
+								 - 20231023-24:fix .ttc bug.
-												add cjk splitter

											
										
										
											2023-10-27 23:51:43 +08:00
+								 - 20231026-27 : clo basic interface, preprocessor of stream of text,
 								  add cjk-english splitter, etc.
-												add readme and todo

											
										
										
											2023-10-30 02:19:38 +08:00
+								 - 20231029-30: hyphenating for english.
 								 - TODO：利用harfbuzz算文字的對應px寬度
-												add clo library initially with register of prepocessor

											
										
										
											2023-10-26 23:36:20 +08:00
 								 ## 之後的做法
 								  - 先做一個前處理註冊器，註冊下列的前處理
 								    - 中英文間距
 								    - 換行點
 								    - 空白轉為 [glue]
 								  - 前處理完成字串後，必須要：
 								    - 算出字元的Box
 								    - 利用 frame/box 資訊分行、分頁
 								    - 然後算出每個Box的x, y, page
 								    - 最後納入排版
-												english breakline, and generate try to count the text size

											
										
										
											2023-10-30 02:18:29 +08:00
+								## 排版語法
-												add clo library initially with register of prepocessor

											
										
										
											2023-10-26 23:36:20 +08:00
 								使用lisp表示，但其實是陣列
 								```lisp
 								  (hglue 寬度 伸展值)
 								  (vglue 高度 伸展值)
-												english breakline, and generate try to count the text size

											
										
										
											2023-10-30 02:18:29 +08:00
+								  (bp 原始模式 斷行模式) ; breakpoint
 								  (nl) ; newline
-												add clo library initially with register of prepocessor

											
										
										
											2023-10-26 23:36:20 +08:00
+								  (em 數字)
 								  (ex 數字)
 								  (span {"font-family" : "Noto Sans" , "font-size" : 16 })
 								  (vbox 高度 內容)
-												english breakline, and generate try to count the text size

											
										
										
											2023-10-30 02:18:29 +08:00
+								```
 								## How to generate documents
 								 - `typedoc /path/to/index.js [/path/to/index2.js ...]`
 								the generated page will be stored in `/src`.