From 744874d5912965d730735addc62638935819b52e Mon Sep 17 00:00:00 2001 From: mattuy Date: Mon, 5 Oct 2020 20:51:21 +0800 Subject: [PATCH] improve docs --- README.md | 8 ++- docs/en/README-EN.md | 6 +- docs/en/example.html | 138 ++++++++++++++++++++++++++++++++++++++++++ docs/en/options.md | 2 +- docs/zh/example.html | 139 +++++++++++++++++++++++++++++++++++++++++++ example/index.html | 23 ++++--- package-lock.json | 2 +- package.json | 3 +- 8 files changed, 304 insertions(+), 17 deletions(-) create mode 100644 docs/en/example.html diff --git a/README.md b/README.md index 261d4bc..dd25644 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # TextFrame 一个通过canvas将长文本分成若干页渲染的js工具，处理排版禁则，支持辅助平面Unicode字符。目前仅工作于浏览器环境。 +[中文版](https://github.com/mattuylee/text-frame) | [English](https://github.com/mattuylee/text-frame/blob/master/docs/en/README-EN.md) + ## 项目介绍 在浏览器中，尽管css有分栏布局，但却很难实现“分页”。浏览器没有提供计算一个盒子可以显示多少文本的API，只有Canvas的上下文提供了一个`measureText()`方法，但它只能简单的计算一段文本的渲染宽度，当文本不止一行时就无法计算了。由于不同字体不同字符有不同的宽度，再加上各浏览器对排版禁则的处理不一致，基本杜绝了计算浏览器原生DOM元素能够显示多少文本的可能。 @@ -31,11 +33,11 @@ | 破折号 | ── | | 省略号 | …… | -本项目默认按照上述禁则处理排版禁则，但可以通过[选项](https://mattuylee.github.io/text-frame/zh/options.md)控制排版禁则。 +本项目默认按照上述禁则处理排版禁则，但可以通过[选项](https://github.com/mattuylee/text-frame/blob/master/docs/zh/options.md)控制排版禁则。 草案中规定，当碰到行首为（行首禁则中的）标点时，应遵守「先挤进，后推出」原则，即先尝试压缩当前行的标点，无法挤压再取前一行的最后一个字至下一行。考虑到标点符号压缩的复杂性，本项目暂未实现该特性，而是直接尝试取上一行的最后一字到下一行，如果直到上一行首都没找到允许出现在行首的字符，则采取不处理的方式。 ## 功能 -本项目定义了文本片段（text fragment）的概念。通过在选项中指定一个文本片段数组，可以对每一个片段设置不同的样式，如字体、颜色、对齐方式等，具体请参考[配置项](https://mattuylee.github.io/text-frame/zh/options.md)。一般来说，一个文本片段即一个文本段落，虽然文本片段内也支持换行，但不会有段间距和行缩进。在本项目文档中文本片段和文本段落等价，都是指`FragmentOptions`定义的文本片段。 +本项目定义了文本片段（text fragment）的概念。通过在选项中指定一个文本片段数组，可以对每一个片段设置不同的样式，如字体、颜色、对齐方式等，具体请参考[配置项](https://github.com/mattuylee/text-frame/blob/master/docs/zh/options.md)。一般来说，一个文本片段即一个文本段落，虽然文本片段内也支持换行，但不会有段间距和行缩进。在本项目文档中文本片段和文本段落等价，都是指`FragmentOptions`定义的文本片段。 本项目支持以下特性： * 每个段落单独设置字体、缩进、边距、字体颜色等； @@ -109,7 +111,7 @@ renderFrame(canvas.getContext('2d'), frames[0]); ``` -配置说明请参考[配置项](https://mattuylee.github.io/text-frame/zh/options.md)。 +配置说明请参考[配置项](https://github.com/mattuylee/text-frame/blob/master/docs/zh/options.md)。 ## 源码编译 diff --git a/docs/en/README-EN.md b/docs/en/README-EN.md index 4f4ee2c..7754677 100644 --- a/docs/en/README-EN.md +++ b/docs/en/README-EN.md @@ -1,6 +1,6 @@ # TextFrame -[中文版](https://github.com/mattuylee/text-frame) | [English](https://github.com/mattuylee/text-frame/docs/en/README-EN.md) +[中文版](https://github.com/mattuylee/text-frame) | [English](https://github.com/mattuylee/text-frame/blob/master/docs/en/README-EN.md) A javascript tool to split long text into frames, with typesetting prohibition processed and unicode full support. @@ -34,7 +34,7 @@ refering to [W3C draft](https://www.w3.org/TR/2020/WD-clreq-20201001/#prohibitio | Em dash and long dash | ── | | Ellipsis | …… | -This library take the above as default rules, but it can be configued with [options](https://mattuylee.github.io/text-frame/en/options.md). +This library take the above as default rules, but it can be configued with [options](https://github.com/mattuylee/text-frame/blob/master/docs/en/options.md). Here is an online [demo](https://mattuylee.github.io/text-frame/en/example.html). @@ -100,7 +100,7 @@ renderFrame(canvas.getContext('2d'), frames[0], true); // ...render ``` -Option reference sits [here](https://mattuylee.github.io/text-frame/en/options.md). +Option reference sits [here](https://github.com/mattuylee/text-frame/blob/master/docs/en/options.md). ## Build from Source diff --git a/docs/en/example.html b/docs/en/example.html new file mode 100644 index 0000000..a619746 --- /dev/null +++ b/docs/en/example.html @@ -0,0 +1,138 @@ + + + + + + + Test + + + + + +
+
+ + +
+
+ + + + 0 / 0 +
+
+ + + + + \ No newline at end of file diff --git a/docs/en/options.md b/docs/en/options.md index 59f9cb4..c7b20f3 100644 --- a/docs/en/options.md +++ b/docs/en/options.md @@ -24,7 +24,7 @@ export function renderFrame(context: CanvasRenderingContext2D, frame: TextFrame, ### canvasHeight * Type: `number` -* Default: 根据`viewHeight`计算。 +* Default: compute with `viewHeight` * Description: canvas.height is `viewHeight * window.devicePixelRatio` ### margin diff --git a/docs/zh/example.html b/docs/zh/example.html index e69de29..bb33bba 100644 --- a/docs/zh/example.html +++ b/docs/zh/example.html @@ -0,0 +1,139 @@ + + + + + + + Test + + + + + +
+
+ + +
+
+ + + + 0 / 0 +
+
+ + + + + \ No newline at end of file diff --git a/example/index.html b/example/index.html index 1c2425e..a619746 100644 --- a/example/index.html +++ b/example/index.html @@ -38,7 +38,7 @@ border: 1px solid darkgray; } - + @@ -51,15 +51,24 @@ fontSize: 16, margin: 16, fragments: [ - { - margin: { left: 16, right: 16, top: 32 }, - marginCollapse: false, - text: "在这里输入文本。" - }, + { + color: 'green', + fontSize: 20, + margin: 32, + textAlign: 'center', + text: "Caption" + }, + { + fontFamily: 'serif', + margin: { bottom: 32 }, + marginCollapse: true, + textAlign: 'justify', + text: "This is a multi-line text." + } ] } - +
diff --git a/package-lock.json b/package-lock.json index 7c755bd..234aab4 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,5 +1,5 @@ { - "name": "text-frame", + "name": "@mattuy/text-frame", "version": "0.0.1", "lockfileVersion": 1, "requires": true, diff --git a/package.json b/package.json index 4b4f4d7..1d001cc 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@mattuy/text-frame", - "version": "0.0.1", + "version": "0.0.4", "private": false, "description": "a javascript tool to split long text into pages, with typesetting prohibition processed and unicode full support.\n一个将长文本分成若干页的js工具，处理排版禁则，支持Unicode", "main": "index.js", @@ -11,7 +11,6 @@ "build": "rollup -c rollup.config.js --environment NODE_ENV:development", "dist": "rollup -c rollup.config.js --environment NODE_ENV:production", "debug": "rollup -c rollup.config.js --environment NODE_ENV:development --watch", - "install": "npm run build && npm run dist", "example": "rollup -c rollup.config.js --environment NODE_ENV:development --environment SERVE" }, "repository": {