]> git.kianting.info Git - clo/blob - README.md
add readme and todo
[clo] / README.md
1 # clo
2 - another personal draught of a typesetting language and engine.
3 - website: https://kianting.info/wiki/w/Project:Clo
4 - license: MIT
5 - issue tracking mailing list: `clo@kianting.info`
6
7 ## changing journal
8 - 20230904 建立 thenDo、matchRange的函數、refactor harfbuzzjs 以及libpdf 等測試界面
9 - 20230905-06: 建立 : `toSome`, initial of basic tokenizer (`tokenize`),
10 `matchAny`, `notDo`, `orDo`, `zeroOrMoreDo`, `zeroOrOnceDo`
11 - 20230905-07:強化`tokenize`, 加強功能,加`Token`界面。
12 - 20230907-08:強化`tokenize`
13 - 20230910 : add basic parser `CONST` rule, and add the grammar rule.
14 - 20230914-15: 追加一寡 tokenizer ê 功能。
15 - 20230918: 重新tuì下kàu頂起做parser. add rule
16 - 20230921-22:add rule, report issue
17 - 20230925-26: 試驗án-tsuánn解決[issue1](https://kianting.info/pipermail/clo_kianting.info/2023-September/000004.html), iáu-buē成功。
18 - 凡勢用?
19 ```
20 FuncApp ::= Single FuncAppAux | Single
21 FuncAppAUx ::= FunCallee FuncAppAUx
22 FuncCallee ::= "(" ")" | "(" ARGS ")"
23 ARGS = SINGLE "," ARGS | SINGLE
24 ```
25 - 20230928:basically fix `issue1`。其他ê物件猶著做。
26 - 20230929:add multi args parsing for `callee`.
27 - 20230930:tîng khí parser, using `js-token`.
28 - 20231006: tîng siá parser, using `ts-parsec`.
29 - 20231010: 初步完成tsit ê階段ê Parser`。
30 - 20231012: clo->js converter successfully (maybe.)
31 - 20231016:basic font guessing and `putText` function
32 - 20231023-24:fix .ttc bug.
33 - 20231026-27 : clo basic interface, preprocessor of stream of text,
34 add cjk-english splitter, etc.
35 - 20231029-30: hyphenating for english.
36 - TODO:利用harfbuzz算文字的對應px寬度
37
38
39 ## 之後的做法
40 - 先做一個前處理註冊器,註冊下列的前處理
41 - 中英文間距
42 - 換行點
43 - 空白轉為 [glue]
44 - 前處理完成字串後,必須要:
45 - 算出字元的Box
46 - 利用 frame/box 資訊分行、分頁
47 - 然後算出每個Box的x, y, page
48 - 最後納入排版
49
50 ## 排版語法
51
52 使用lisp表示,但其實是陣列
53 ```lisp
54 (hglue 寬度 伸展值)
55 (vglue 高度 伸展值)
56 (bp 原始模式 斷行模式) ; breakpoint
57 (nl) ; newline
58 (em 數字)
59 (ex 數字)
60 (span {"font-family" : "Noto Sans" , "font-size" : 16 })
61 (vbox 高度 內容)
62 ```
63
64 ## How to generate documents
65 - `typedoc /path/to/index.js [/path/to/index2.js ...]`
66 the generated page will be stored in `/src`.