From d0e0fb65dc237bf28665c2132992445cc0b72699 Mon Sep 17 00:00:00 2001 From: Tan Kian-ting Date: Sat, 25 Nov 2023 22:52:06 +0800 Subject: [PATCH] update readme --- docs/assets/navigation.js | 2 +- docs/assets/search.js | 2 +- docs/classes/libclo.Clo.html | 57 +++++++----- docs/enums/libclo.Direction.html | 10 +-- docs/functions/libclo.applyVOffset.html | 65 ++++++++++++++ .../libclo.calculateTextWidthHeight.html | 2 +- .../libclo.calculateTextWidthHeightAux.html | 2 +- docs/functions/libclo.filterEmptyString.html | 2 +- docs/functions/libclo.hyphenForClo.html | 2 +- docs/functions/libclo.hyphenTkTree.html | 2 +- docs/functions/libclo.ptToPx.html | 2 +- docs/functions/libclo.putInVBox.html | 58 ++++++++++++ docs/functions/libclo.spacesToBreakpoint.html | 2 +- docs/functions/libclo.splitCJKV.html | 2 +- .../functions/libclo.twoReturnsToNewline.html | 4 +- docs/index.html | 6 +- docs/interfaces/libclo.BR.html | 90 +++++++++++++++++++ docs/interfaces/libclo.Box.html | 16 ++-- docs/interfaces/libclo.BreakPoint.html | 10 ++- docs/interfaces/libclo.CharBox.html | 24 ++--- docs/interfaces/libclo.FrameBox.html | 20 ++--- docs/interfaces/libclo.HGlue.html | 11 ++- docs/interfaces/libclo.VGlue.html | 75 ++++++++++++++++ docs/modules/libclo.html | 8 +- docs/types/libclo.BoxesItem.html | 2 +- docs/variables/libclo.A4_IN_PX.html | 2 +- docs/variables/libclo.cjkvBlocksInRegex.html | 2 +- docs/variables/libclo.cjkvRegexPattern.html | 2 +- docs/variables/libclo.defaultFrameStyle.html | 2 +- docs/variables/libclo.defaultTextStyle.html | 2 +- 30 files changed, 402 insertions(+), 84 deletions(-) create mode 100644 docs/functions/libclo.applyVOffset.html create mode 100644 docs/functions/libclo.putInVBox.html create mode 100644 docs/interfaces/libclo.BR.html create mode 100644 docs/interfaces/libclo.VGlue.html diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index f497438..1622270 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA52VUU/bMBCA/0ueqzE6YFvfShmjm4QqiLZJCCHjXGsvjh3Zl9Jq4r9j0jZx6nJBe3T83Xfns3u9+5cgrDAZJVJnsEoGSclQ+GVhskqBO6o/fxBYKL+X+1UyGg4SLqTKLOhkdNcIBKjyAhxvHUtmJXsMLFuiq/s0fB40ktIaDs6N7WLZeuaV5iiN3nkCqKs6O3m+D2RKPnJl4jNtvr/rUBfSQp27tYCuisbR7HdtX4IqJmEJXDHn2hIm+2UcD8PQcxPciNQIds54G+239w5xehZGW2D5zPg4UtJQlGsimO2pZotQlkvLCujR7BjKc/VdVUBJaoDsjVmBmyIUrQXXZae1m/09ycevn49Pwwc7PnmYXj/M/hx69VvXDiGePf+bL8+V4bmb6htYhD/ESBexPd6amTH0PdI92hAlrBnMWaWwvqlbXCsgtBHb70396p3aBqV6wBSvFEN4hX/LDMUVyIXAQ/Nl14s3QqJp059lXK3+I5GPInLNpfI39K0ocX2LVuoFkSFiCa9YlwL0pbGdkRUpQ6zXluapBei1bTDCVmJqZlQrNwBhcOXrhEhNPfDK7liMbDFMmpXEyY+fv0jhliE8+GRuACurfeJreFJSU407QB/4N7x/AVVnHoriBwAA" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA53WUW+bMBAH8O/Cc7SuWdtteUvSdc0mdVGK2KSqqlxzBA9jW8akQVO/+1xCwMTpUfUR+N/vDJZP3P0LDGxNMAmYiGEbjAJFTGovcxmXHIqT+vaH1OTcPsvsVTAZjwKaMh5rEMHkrgVS4OoSCtoZG6IZeXSUJtHnPo2fRy2itKRQFFO93nROUgpqmBR7xwn1qYuz53sH4+yRcum/0+7+m17qkmmoe3cKiDJvjfZ5X/virGLuLoFyUhTdEuaHyzgdu6WzVVfJhAGdENoVz1YHr3B+4dbKLVosD3e1X62BZEtp61CkTWHWPCV6YDVNBFOuNMlhgNlnMOf6Oy8BQ+oAJkRDQjQk2CVCsTCQd4qpVG9zds8PkI9fP5+eu8dlevawuHlY/jl25hprH0EOHf2bbWZc0qxYiBWs3THgcV52wK0zS2LsNxIDrBtF1BgSUnJT7/WtqTggrJcddkN79Ua2jSIqUYpX0a8kKcA5St1Ea0Q35s0054sSTktODLy0/s1ik14DW6eY/FrJO7pMy+07GtkqpFfCuN3vb7ky1a3RTKyRDl4WcdNKpSCupO6NX490Y4NamIUaYFDbxRBNmVAusU+5C2BCaRYi6k1DH9lnEKdQL3MrlPUgV/1x74F+GJU5M/MfPyMUbDKIY57kCkyphW18A0+cCWwDjqSP/CHc/wdrshTa9ggAAA==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index a339d75..30be7f5 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA62bbW/bOBLHv4vzNpsNn6Qk79rudrd3vSJojb1dFEWg2oytiywZEp04CPLdj5Rkacbm6MHOq8DxDP9D/mZGlGi9TPLsqZjcfH+ZPMTpfHLDzydptNKTm4n9qLeT88kmT+ynVTbfJLr4tfzvxdKsEvvVLImKQlv3yeT1fDdCIJsh1nk200XxLl88NgPdb9KZibN0NxSw8Qx7PllHuU5NE0+rI9pQlzpZ/6aLWSPyGOVx9BPEWxuMU2gFkvjnLMkOFqP69+DVMNPsdutZiHqY6vvuEOtAvOObp+yrNps8LabZF/2UxKmmxTzGxysX6yQ2H/71779ovcbkeJXl83qp049Z/gGgOBCCVqfMKLJZOc3e5zp6WGexdeiY2r7t8br3cWJ0/vtqbZ6/mTxOF7TsgempKzt9mOa6I2Wg1fFasyiZbZLI6Knemv/Gc7P8U8eLZcf6Uh5vH8O7TUd5djiNjOSqCeS3ONelSiOr082qkWy+HinAgkbh8/TrkLHPKruu8VsPv9LX6edBSpXdKUrT6ftBSpXdKUrvp9NBSpXdaCWuWqk//0g2bfHZJqLze9dXdorl92Pz4JKDlmZybWbLj9HMZPkgobN9l84JVhPwT65sjbeojR4Kt0anTDPL40WcRslwoTPg0jlDMAtCPNVPn+2VdD5CHLiMF+eX1yFT7T7lfbbVxSejV00A5nkNtHdfj1xgiPJjbv/agTqmuDM5BeN8Vy6f0iKe689wM9OjeOb37VzdZlZEOD+johyneIjXg+PYczopgMHrfbZFUqaY/xIXv8TpUuexKdNsrPTzYOnnt5Y29lL7zTwnw9lDjzcNZX5wqR6chm8dypPbfAwOY2f9piEs8Z6tL4bG/E2DmGVWtvOSgqNo7U8NAzbED8so7+6HtcUp7XAVp38PVDirbTvbzS5oSi7aDperbE+Si9N/Rszun9NnN1yusj1FbmhqjO/cPcJdjRsJj+7bPcJD2jYK4Oiu3RPIkKaNAjm6Z/cE0teyURBHdeyeAHobNorguH7dE0J/u0YxHNmtD4NANyKdjfrEJj1k6L0i9230jytoopjHCQwp3J6iHSc4pEB7inOcYF8hdhThOKHegusqtnFS/YXVWVS9YuBJ+zt59+nL3W27OWiftNeuO4uxT+eUEm2Z3t25+9aBImeNdeecmtAHZcYgyYtBSdJ41nEOS5hhAQzLHToCgHau76NNYqYHLeAgkn3LkagPNcsd9jDR1vR41dn/Hh7fJ9nsofiUftULcMp1oHpgeppqOcRtZGx9pt2i0HLsNYm3D5jhUUnt3lxsR5+PKMZhzylMvkHPEgmBM2zbvZXuuAWK4vSbyXW06hVEpsfqrXNdn01medEruW99rKolPkBtZzVCpbPBdupcDOuvzqmKCz6flG0uFtq8s9/3irZ2I6aHlBYDlRYnK0HstmTjwtbrqFwBTsfPNtV5ZPTt/H7AjKHt0bPelM2/f6KN3dFzy+N5/6Qqo4PbhHUeP9q5jlO8j7c6LR+U32ZFjLamlL7X5dgZF3qxsrZ6/iWbu1Plg+ftdNmQjifU0R/J83r5n2i7d0jbUVEHHseq53qVPWp0LEbJItPT9Npzlv427PPoV/9xXv/S5OZl8qjzwuXLzYRfiItr63If62TufpFThWUHzFaO6+RH/d1f2l1InUVl8uvl5Pz75bm4vgiD4MeP8+87j/KL8h+lGbOfmM+MITNuP3GfGUdmwn4SPjOBzKT9JH1mEpkp+0n5zBQyC+ynwGcWILPQfgp9ZiEyu7KfrnxmV8jMQvl+7TO7xsvrVpt5ObA9ECUJPwrMgrk1Z14aDONgbtmZOOdXF2F4jS0xEeZWnnmZMAyFucVnXiwMc2Fu/ZmXDMNomEPAvHAYpsMcBeblwzAg5kAwLyKGGXEHgnsZccyIOxDcy4jv1UtZMP6KwYy4A8G9RcMxI+5AcC8jjhlxB4J7GXHMiDsQ3MuIY0bcgeCWEbvg1wJbYkbcgbB3Gz5LzIg7EPzaa4kZiUsykwVmJBwIcem1xIyEAyGY13KvrZV9jfviFJiRcCCEvwViRsKBEF6aAjMSDoTw0hSYkXAghJemwIyEAyG8FScwI3FNcheYkbwkuUvMSDKSu8SMJCe5S8xICpK73Lv6SJK7xIykIrlLzEiWjLx9SWJGkq4jiRlJuo4kZiTpOpKYkaLrSGFGiq4jhRkpuo4UZqToOlKYkSoZebu32tskOBDSdm95EagQW2JGKqBnhBmpkJ4RZqQcCOm9IijMSDkQ0ntFUJhR4EBIbw8JMKPAgZDeHhJgRoEDIb09JMCMAgdC+vdTmFFQbuO8PSTAjIKSkbc6gr29nAMhvdwDzCgISe4BZhQ4EMp7fQ8wo8CBUF6aAWYUOhDKSzPEjEIHQnlphphR6EAoL80QMwodCOWlGWJGoQOhvDRDzCgsd9v+DTJmFDoQyksz3NtyOxDKSzPEjEIHIvAyCitG5f2RvTGyt7Kfqvske6ezewb1Mrmrb55sRtR3bi8TW/83L6/nE5sP9u9re9PkPjmJSFq3u/UWDmCbTjuApByrJ21AFnjZRPV7uV9+Jc0vv1pnHrTOnHTOcJhXrY/s8NFFXP7wD6gJoCYoT/ALd+AKFtdujQlXg3zstr7xYRSI5lfU7vSwPD7ZHWGAgRgYiI0cKNqg1WsfWduxODXWMsr3Vx2snaCSwz2o/1meDsRpXh0kgEQBIwTUEroRSs/17lAADCDBAOQyuAf8wEcBH3K68Hk88AXJGVDp0hwggqUCSyxEVYiyLkhFjVMf59y7h1RFdfIDIgEj2ktm5wgO/+EAIIPs1ZkYoD1OBvkCqLF6MuKynhSvJ0XRbEaMyx+eVm/ggKICcLgixqhe69DutY6ifgOkHQH0HmpZyoeRZTtYNw8j2wEUYBxSaV1C2asHDpKRU467p8tr93QZiII1DalEXmgTlc/igR+gGFDztX4L98RxFW0PO4kCvTOkemf1+Bg4AUwhlb+HWgJEK+pMkbLOmF3mUG3RvaA2L99gA0sOVpxyW5SPPEH6ggkzKvGrF3nus3yveYD+TcZZupoHU74pBHTB9YJR5VG/Udh6ASfKpz6EhOsMlplywnnEQO4yKnfdmWFRnxmCRgLWJKBdt/jaARJIUFlnnZ6RE1ASFLlVnGIlMDNBdRTrhJVADxAU6LR6JxAVBocZSaVk+zIFcASlwakGAE/F8uZUDJQlUA+pdNk7hgUgQWEE1ErVrlH5virIH5A+lKcxGd5dAjJU3qw35dULTRK4hdQSV8cO7cYNTTQARRVSeVSNsN88FLi8hFRi5AahZSDXGbWuzdFU6o6mTOa7wCjYfeiBDi8SYL4BNd/qFU2T+Te7IDXoAZLYuM0aWmqgTPlVb1DdR/ubLQbWmlHXNu/ehgNPfl1fZ1j9lxzJ/ETqIHRGxW6esrx6Rdhk6e59YrDwYItFjFD/PAq0HgBL7GKud1mq/qyoePB+BKQLDytPsVsNKndRG+QAO7+qPXc7PW8e2BvTdbyutnU333+8vv4f7WxkKT4/AAA="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA72c23LbOBKG30W+1XgMAiBp3yWZzcS72VmXo/LuVMrlYiRI4loiVSTlw7jy7gvw2E2heZBce5Vi1I2/ga/RAAnSb5Mkfk4nV9/fJo9htJhcOdNJFGzV5GqiL9XLZDrZJxt9tY0X+41Kf83/93ydbTf6p/kmSFOl3SeTn9OqBVfUTeySeK7S9EOyeqobWu6jeRbGUdUUsLE0O53sgkRFWR1Po8ObUNdqs/tNpfNa5ClIwuAHiLc0GKfQCGzCH/NNfDAYxX8PHo1sFt+8WAaibKb4vTvEMhBr+9lzfKuyfRKls/gP9bwJI0WLWYyPV053mzD79Pd/3NF6tcnxKuvX3VpFn+PkE0BxIAStTulRoLNyFn9MVPC4i0Pt0NG1tu3xustwk6nkb9td9votS8JoRcsemJ46srPHWaI6UgZaHa81Dzbz/SbI1Ey9ZP8OF9n6iwpX647xpTzeP4YP+47p2eF0fCS7fXYd3X2Mu8pCZXK8SrDbbV7v/rVcpqpjnKHVSC2/lvotTFTebK2jov221qh/HinA3Frh6+x2SNtnhV1X+42HXel29nWQUmF3itJs9nGQUmF3itLH2WyQUmE3WsmRjdSX3zf7ppzosqiSpamUlWL++9g8uHCatA7TL3ES/hVHwWaw1NmhU2cni04QAaRZorL5+nMwz+JkmHzbZZQ4HN27ni7f/f9G9+7o0b17j9G9O3J02+JwdPO1/Aat+4fCjdEp46zHaxXq8RoudAZcOnsIekGIR+r5q976LUaIA5fx4miMb7tUb0/L3SGNn5Vm3d24PQXcbQewLF38Eqa/hNFaJWGWD+hw8SHgbjuAjRV3Li49Jps7Ir0fUel1prZ1ANnrDmhXP4+kCPPjc6L/hVujwy5WJqfkyqJaxq6jNFyor/C2qUfxzO7bmU91r4hwfgRp3k76GO4Gx9FyOimAweN99jI2o/qkXwdLv763dKY39d+y181w9tDjXUNZHGyhB6fhe4fybG5zBodRWb9rCGt8d9gXQ23+rkHMYy3buRfAUTT2p4YBC+KndZB018PS4pRyuA2j/wxUOCttO8tNFTQlF7wMlytsT5ILoz9H9O7P03s3XK6wPUVuaGqMr9w9wl2FGwmPrts9wkPKNgrg6KrdE8iQoo0CObpm9wTSV7JREEdV7J4Aegs2iuC4et0TQn+5RjEcWa0Pg0B3N52F+sQiPaTp1iS3bfCPm9DEZB4nMGTi9kzacYJDJmjP5Bwn2DcROybhOKHeCdc12cZJ9U+szknVKwbO9D6Ih+s/Hm6azUFzple6VhZjn4tLyZtp+vBg7lsHipzV1p19qkMflBmDJM8HJUntWcY5LGGGBTAsd+gIANqFWgb7TTY7KAEHkbQtR6I+1Mx32MNEG9PjVef/fXz6uInnj+l1dKtW4Dz9QPXA9DTVvImbINPzM+oWhZZj1ySnOfiBh7Kle73Yjj6JlcyBNSfNkj16CEwInGHb7q10xy1QEEbfskQF215BZHqs3i5R5VsQcZL2Sratj1XVxAeoVVYjVDoLbKfO+bD6apyKuODzSdHkYqqyD/r3XtHGbkT3kNJqoNLqZCWIXU/ZMNXzdVSuAKfjexupJMjUzWI5oMfQ9uheB0mwSoLdOvyrP4daxkdr7vMFp1+utjt6PJNw0T+QhdHBrckuCZ/0+I5TXIYvKsofzt/EaYi2w5S+1eXYHqdqtdW2avFHvDDvzFRPvOCbF/Rs7fI9YQb/vnndrf8ZvLReROmYywcex6onahs/KXS+Sski09P0mqO5/gXA5tGvfj8t36a7eps8qSQ1WXM1cc75+aV2WYZqszBvHRZh6QbjrUE7uS9/u1NmCTcWhcmvF5Pp94upYOcXUtzfT79XHvkP+X/kZkxfMZsZQ2aOvnJsZg4y4/qK28w4MhP6StjMBDKT+krazCQyc/WVazNzkZmnrzybmYfMfH3l28x8ZKahfL+0mV3i4TWjzawcWAtETsKOArNgZsyZlQbDOJgZdmYFwjARZkaeWZkwDIWZwWdyyi/OL1wfW2IuzIw/s5JhGA0zCJgVDsN0mKHArHwYBsQMCGZFxDAjx4BwrIwczMgxIBw25fL8UrjYsjVf8gnjWC0xI8eAcKyMHMzIEbQ6ZuRIWh0zcgwIx8rdwYwcA8KR1jYxI8eAcFyrJWbkGBCOlbuDGfGckZU7x4w4I+PkmBF3yDh5q6zljKy5xDEjbkBway5xzIgbENw63zlmxA0Ibp3vHDPiBgTnU+6cS59hS8yIGxBcWC0xI25AcGm1xIzEBVkZBGYkDAh9x2OzxIyEAcE9qyVmJPK1x7fFKVqrT87ISlNgRsKAEFaaAjMSBoSw0hSYkTAghJWmwIyEASGslUFgRuKS5C4wI3lBcpeYkWQkd4kZSYfkLjEjyUnuEjOSguQuW5sESXKXmJHMGVlrncSMJD2PJGYk6XkkMSNJzyOJGbn0PHIxI5eeRy5m5NLzyMWMXHoeuZiRm2/jrBs0FzNy83lkrbRuay/n0j3CjFyP7hFm5ObzyLrKuJiRa0AI6yrjYkaeASGsNcTDjDwDQlpriIcZeQaEtNYQDzPyDAhprSEeZuQZENJaQzzMyMt329bZ4WFGngEhrdy91pbbI7l7mJFnQEjrXtHDjDwDQto38piRb0BI+14eM/JzRlaaPmbkGxCulaaPGfkGhGul6WNGvgHhWmn6mJFvQLhWmj5m5Oc3RVaaPmbkGxCulabfujMyIFwrIx8z8g0I18rILxjld7v6NjdTi+virlfft1bPMt8mD+WtsKifir5NdKW4evs5nejM0f/+bG6BzZWRCIR2e9i9oAYkaEBQjuYzjqe4/NijcWaicWakc/G4t/GSQFLPB7uXef1wU79+2Dg3ZxJvE046x7iPIEzZ4aPSMH/7tPHUW9pGjVOeCXLxGhe9R6dcmm/AgCuI0yHjzDACECGj5OrvjMypd37sVx29gYYYaIiNbCjYowFnAJK+4ybaWgdJCxQHnRFUPpkDph/5qVYYJcUBGEANWtDrDN1C7rmrDrNAcl6ABshhMAdTwAcMnUd2F54jAV8wVB6VYfXBNxgqHwwVLya+LAuAS7VTHkMuzVPOtDixBEMHWnSpTCpbMPgPGwCZr/cNRAPNaxAgX0BFYGUnxEXZKafsFEWzbjHMX5guvlEFAwXgcEm0UXz4qMyHj2n5jWTTAkgpaljyB9p5BdnVD7SbBvSCVLfgkyEYKO35AJKRU/OhOhXZmVMRkFggbJ9K5JXKgvwMCfgBih7VX+23Ms+rt8HLYSVxAU2fWouKIwjgBOaBT3X1UIuDaEWZKVKUGVNlDhWD+YR7kX/jDWowKMGU2yp/YA58ACaHStPiU9dlnLSKBxzuTtfsMcu/pQXTBugySrewBV7AifRJW2saKA2cdlpX32kdDBCYgw4rqDgU5PLkHkIG6pQTTmIGtkWMWknNQXtaHrSD/AdqHhWjznu87IAOClrv5RU5ASVB1cttGGElgE9QtUQ7YSWQ1YLKsqj4ZB/NSgeMo+MX4Dg1L5ovkkADoBY4XtkAVY3wYSuoDaDPPqUOz6WT+lwacAU57FM53HoRAniDrZlHDXvpGuR/mwIkI8hFyjPL4ta+HBCjnPaZvkVoLRkMJBWjZov2zPJjZjDGIEqf8isO7prNKxoiF1Qyn1o4ihba9cEFaeZTMyHJUGYxIMeonK7PdyNzvpvF1SLb2q+6YLR9avqmlrUSxO1RcRd/yyGL7Xt+mJVkA5swM3tWFDLYa1F+xZery6C953TgIlcukg6V1NatHgfTml+Wy25Z2CXFPst+IICg64zqe/YcJ8XfFMniqPoDJAAAuLEjWng6WIzADHGoTC/fjQQ9BgMuqp6W+263vHYpEnhTB5ezsiSKagypREblnIN05WVVltV22TqS99PJLtwVe+Or7/c/f/4PyHC4UqVHAAA="; \ No newline at end of file diff --git a/docs/classes/libclo.Clo.html b/docs/classes/libclo.Clo.html index 7597f83..af9df01 100644 --- a/docs/classes/libclo.Clo.html +++ b/docs/classes/libclo.Clo.html @@ -25,7 +25,7 @@ +
  • Defined in libclo/index.ts:469
    • @@ -48,11 +48,12 @@ getAttr getGlyphMaxHeight grid +paragraphize preprocessorRegister putText removeBreakPoints removeGlue -segmentedNodesToFrameBox +segmentedNodesToFrameBoxAux setAttr
    @@ -64,7 +65,7 @@

  • Returns Clo

    • +
  • Defined in libclo/index.ts:478

    • Properties

    @@ -79,7 +80,7 @@
    [index: string]: any
    +
  • Defined in libclo/index.ts:475

    • mainStream

    mainStream: string[]
    @@ -87,7 +88,7 @@
    +
  • Defined in libclo/index.ts:471

    • preprocessors

    preprocessors: Function[]
    @@ -95,7 +96,7 @@
    +
  • Defined in libclo/index.ts:473

    • Methods

    @@ -117,7 +118,7 @@
    +
  • Defined in libclo/index.ts:701

    • generatePdf

    +
  • Defined in libclo/index.ts:518

    • getAttr

    Returns any

    +
  • Defined in libclo/index.ts:501

    • getGlyphMaxHeight

    +
  • Defined in libclo/index.ts:789

    • Private grid

    Returns void

    +
  • Defined in libclo/index.ts:644
    • +
    +

    paragraphize

    +

    preprocessorRegister

    +
  • Defined in libclo/index.ts:514

    • putText

    Returns Promise<[PDFDocument, TextStyle, fontPathPSNamePair]>

    +
  • Defined in libclo/index.ts:589

    • removeBreakPoints

    +
  • Defined in libclo/index.ts:835

    • removeGlue

    Returns BoxesItem[]

    -
    -

    segmentedNodesToFrameBox

    +
  • Defined in libclo/index.ts:795
    • +
    +

    segmentedNodesToFrameBoxAux

    +
  • Defined in libclo/index.ts:737

    • setAttr

    Returns void

    +
  • Defined in libclo/index.ts:497
    • @@ -312,11 +326,12 @@
  • getAttr
  • getGlyphMaxHeight
  • grid
    • +
  • paragraphize
  • preprocessorRegister
  • putText
  • removeBreakPoints
  • removeGlue
    • -
  • segmentedNodesToFrameBox
    • +
  • segmentedNodesToFrameBoxAux
  • setAttr
    • +
  • Defined in libclo/index.ts:22
    • @@ -43,22 +43,22 @@ etc.

    BTT

    BTT: 3
    +
  • Defined in libclo/index.ts:26

    • LTR

    LTR: 0
    +
  • Defined in libclo/index.ts:23

    • RTL

    RTL: 1
    +
  • Defined in libclo/index.ts:24

    • TTB

    TTB: 2
    +
  • Defined in libclo/index.ts:25
    • diff --git a/docs/functions/libclo.applyVOffset.html b/docs/functions/libclo.applyVOffset.html new file mode 100644 index 0000000..371df40 --- /dev/null +++ b/docs/functions/libclo.applyVOffset.html @@ -0,0 +1,65 @@ +applyVOffset | clo
    +
    + +
    +
    +
    +
    + +

    Function applyVOffset

    +
    +
      + +
    • +

      apply vertical offset to a box

      +
      +
      +

      Parameters

      +
        +
      • +
        box: Box
        +

        the box to be applied

        +
        +
        • +
      • +
        voffset: number
        +

        the vertical offset

        +
        +
      +

      Returns Box

      applied box

      + +
    +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    +
    +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/docs/functions/libclo.calculateTextWidthHeight.html b/docs/functions/libclo.calculateTextWidthHeight.html index cb14d54..afbf719 100644 --- a/docs/functions/libclo.calculateTextWidthHeight.html +++ b/docs/functions/libclo.calculateTextWidthHeight.html @@ -32,7 +32,7 @@

    Returns Promise<BoxesItem[]>

    +
  • Defined in libclo/index.ts:302
    • diff --git a/docs/functions/libclo.calculateTextWidthHeightAux.html b/docs/functions/libclo.calculateTextWidthHeightAux.html index 3ded441..4779252 100644 --- a/docs/functions/libclo.calculateTextWidthHeightAux.html +++ b/docs/functions/libclo.calculateTextWidthHeightAux.html @@ -36,7 +36,7 @@

    Returns Promise<[BoxesItem, TextStyle, fontkit.Font]>

    +
  • Defined in libclo/index.ts:325
    • diff --git a/docs/functions/libclo.filterEmptyString.html b/docs/functions/libclo.filterEmptyString.html index 81d408c..f81cb8a 100644 --- a/docs/functions/libclo.filterEmptyString.html +++ b/docs/functions/libclo.filterEmptyString.html @@ -38,7 +38,7 @@

    Returns tkTree

    +
  • Defined in libclo/index.ts:246
    • diff --git a/docs/functions/libclo.hyphenForClo.html b/docs/functions/libclo.hyphenForClo.html index 3223dc0..f5df61f 100644 --- a/docs/functions/libclo.hyphenForClo.html +++ b/docs/functions/libclo.hyphenForClo.html @@ -38,7 +38,7 @@

    Returns tkTree

    +
  • Defined in libclo/index.ts:210
    • diff --git a/docs/functions/libclo.hyphenTkTree.html b/docs/functions/libclo.hyphenTkTree.html index 01e3e0a..dca6a04 100644 --- a/docs/functions/libclo.hyphenTkTree.html +++ b/docs/functions/libclo.hyphenTkTree.html @@ -41,7 +41,7 @@

    Returns tkTree

    +
  • Defined in libclo/index.ts:265
    • diff --git a/docs/functions/libclo.ptToPx.html b/docs/functions/libclo.ptToPx.html index f8b5a09..35b91fe 100644 --- a/docs/functions/libclo.ptToPx.html +++ b/docs/functions/libclo.ptToPx.html @@ -34,7 +34,7 @@
    +
  • Defined in libclo/index.ts:137
    • diff --git a/docs/functions/libclo.putInVBox.html b/docs/functions/libclo.putInVBox.html new file mode 100644 index 0000000..8299438 --- /dev/null +++ b/docs/functions/libclo.putInVBox.html @@ -0,0 +1,58 @@ +putInVBox | clo
    +
    + +
    +
    +
    +
    + +

    Function putInVBox

    +
    +
      + +
    • +

      put childrenBox inside VBox

      +
      +
      +

      Parameters

      +
        +
      • +
        childrenBox: Box[]
        • +
      • +
        parentBox: Box
      +

      Returns Box

      +
    +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    +
    +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/docs/functions/libclo.spacesToBreakpoint.html b/docs/functions/libclo.spacesToBreakpoint.html index 9b9f6b4..219a244 100644 --- a/docs/functions/libclo.spacesToBreakpoint.html +++ b/docs/functions/libclo.spacesToBreakpoint.html @@ -40,7 +40,7 @@
    +
  • Defined in libclo/index.ts:224
    • diff --git a/docs/functions/libclo.splitCJKV.html b/docs/functions/libclo.splitCJKV.html index 9d395f6..3cb4927 100644 --- a/docs/functions/libclo.splitCJKV.html +++ b/docs/functions/libclo.splitCJKV.html @@ -41,7 +41,7 @@
    +
  • Defined in libclo/index.ts:190
    • diff --git a/docs/functions/libclo.twoReturnsToNewline.html b/docs/functions/libclo.twoReturnsToNewline.html index 982caf9..787565c 100644 --- a/docs/functions/libclo.twoReturnsToNewline.html +++ b/docs/functions/libclo.twoReturnsToNewline.html @@ -20,7 +20,7 @@
    • -

      convert '\n\n' to newline command ["nl"]

      +

      convert '\n\n' to new paragraph command ["br"]

      Parameters

      @@ -39,7 +39,7 @@
    +
  • Defined in libclo/index.ts:153
    • diff --git a/docs/index.html b/docs/index.html index e0ebddb..44c1db4 100644 --- a/docs/index.html +++ b/docs/index.html @@ -16,6 +16,7 @@
  • another personal draught of a typesetting language and engine.
  • website: https://kianting.info/wiki/w/Project:Clo
  • license: MIT
    • +
  • docs : https://buhong.kianting.info/docs/clo/index.html
  • issue tracking mailing list: clo@kianting.info

    • How to use

      cd /path/to/clo
      node . [.clo FILE] --output-js=[.js FILE]
      node [.js FILE]
@@ -51,7 +52,8 @@
 
  • 20231109-10: Keng-kái oa̍h-chōa ián-sǹg-hoat.
    • 
 
  • 20231113: the algorithm is basically fixed, and make a bigFrame to prepare for convert to boxes and positions.
    • 
 
  • 20231115-16: grid and basic types laying.
    • 
-
  • 231120 fix the line-breaking algorithm
    • 
+
  • 20231120: fix the line-breaking algorithm
    • 
+
  • 20231125: multiple paragraph basic
    • 
 
 
    之後的做法
      
 
    • 先做一個前處理註冊器，註冊下列的前處理
        
@@ -69,7 +71,7 @@
 
 
      
 
      排版語法
      使用lisp表示，但其實是陣列
      
-
        (hglue 寬度 伸展值)
        (vglue 高度 伸展值)
        (bp 原始模式 斷行模式) ; breakpoint
        (nl) ; newline
        (em 數字)
        (ex 數字)
        (span {"font-family" : "Noto Sans" , "font-size" : 16 })
        (vbox 高度 內容)
+
        (hglue 寬度 伸展值)
        (vglue 高度 伸展值)
        (bp 原始模式 斷行模式) ; breakpoint
        (br) ; force newline
        (em 數字)
        (ex 數字)
        (span {"font-family" : "Noto Sans" , "font-size" : 16 })
        (vbox 高度 內容)
 
      
 
      How to generate documents
        
 
      • typedoc /path/to/src1 [/path/to/another/src/or/.js ...]
diff --git a/docs/interfaces/libclo.BR.html b/docs/interfaces/libclo.BR.html
new file mode 100644
index 0000000..80a14c4
--- /dev/null
+++ b/docs/interfaces/libclo.BR.html
@@ -0,0 +1,90 @@
+BR | clo
        
+
        
+
+
        
+
        
+
        
+
        
+
+
        Interface BR
        
+
        
+
        BR is like html br
        
+
        
+
        
+
        
+
        Hierarchy
        
+
        
+
        
+
        
+
        
+
+
        
+
        
+
        Properties
        
+
        isBR
+newLined
+original
+
        
+
        
+
        Properties
        
+
        
+
        isBR
        
+
        isBR: true
        
+
        
+
        newLined
        
+
        newLined: BoxesItem
        
+
        
+
        original
        
+
        original: BoxesItem
        
+
        
+
        
+
        
+
        
+
        Settings
        
+
        
+
        
+
        Member Visibility
        
+
          
+
          • 
+
          • 
+
          • 
+
        
+
        
+
        Theme
        
+
        
+
        On This Page
        
+
        
+
        
+
        
+
        
+
        
+
        Generated using TypeDoc
        
+
        
\ No newline at end of file
diff --git a/docs/interfaces/libclo.Box.html b/docs/interfaces/libclo.Box.html
index 3f9a8d4..3b37c5f 100644
--- a/docs/interfaces/libclo.Box.html
+++ b/docs/interfaces/libclo.Box.html
@@ -36,7 +36,7 @@
 
      • FrameBox
        • 
 
      • CharBox
    
+
  • Defined in libclo/index.ts:81
    • 
 
    
 
    
 
    
@@ -58,37 +58,37 @@
 
    content
    
 
    content: null | string | Box[]
    
+
  • Defined in libclo/index.ts:88
    • 
 
    
 
    direction
    
 
    direction: Direction
    
+
  • Defined in libclo/index.ts:85
    • 
 
    
 
    height
    
 
    height: number
    
+
  • Defined in libclo/index.ts:87
    • 
 
    
 
    textStyle
    
 
    textStyle: null | TextStyle
    
+
  • Defined in libclo/index.ts:84
    • 
 
    
 
    width
    
 
    width: number
    
+
  • Defined in libclo/index.ts:86
    • 
 
    
 
    x
    
 
    x: null | number
    
+
  • Defined in libclo/index.ts:82
    • 
 
    
 
    y
    
 
    y: null | number
    +
  • Defined in libclo/index.ts:83
    • diff --git a/docs/interfaces/libclo.BreakPoint.html b/docs/interfaces/libclo.BreakPoint.html index 1088207..5ad6777 100644 --- a/docs/interfaces/libclo.BreakPoint.html +++ b/docs/interfaces/libclo.BreakPoint.html @@ -19,9 +19,11 @@

    Hierarchy

      -
    • BreakPoint
    @@ -38,12 +40,12 @@

    newLined

    newLined: BoxesItem
    +
  • Defined in libclo/index.ts:44

    • original

    original: BoxesItem
    +
  • Defined in libclo/index.ts:43
    • diff --git a/docs/interfaces/libclo.CharBox.html b/docs/interfaces/libclo.CharBox.html index 956d92f..9e8740e 100644 --- a/docs/interfaces/libclo.CharBox.html +++ b/docs/interfaces/libclo.CharBox.html @@ -35,7 +35,7 @@
    • CharBox
    +
  • Defined in libclo/index.ts:64
    • @@ -62,63 +62,63 @@
    content: null | string | Box[]
    +
  • Defined in libclo/index.ts:88

    • direction

    direction: Direction
    +
  • Defined in libclo/index.ts:85

    • height

    height: number
    +
  • Defined in libclo/index.ts:87

    • maxX

    maxX: number
    +
  • Defined in libclo/index.ts:66

    • maxY

    maxY: number
    +
  • Defined in libclo/index.ts:68

    • minX

    minX: number
    +
  • Defined in libclo/index.ts:65

    • minY

    minY: number
    +
  • Defined in libclo/index.ts:67

    • textStyle

    textStyle: null | TextStyle
    +
  • Defined in libclo/index.ts:84

    • width

    width: number
    +
  • Defined in libclo/index.ts:86

    • x

    x: null | number
    +
  • Defined in libclo/index.ts:82

    • y

    y: null | number
    +
  • Defined in libclo/index.ts:83
    • diff --git a/docs/interfaces/libclo.FrameBox.html b/docs/interfaces/libclo.FrameBox.html index f7ec4fc..f304d63 100644 --- a/docs/interfaces/libclo.FrameBox.html +++ b/docs/interfaces/libclo.FrameBox.html @@ -31,7 +31,7 @@
    • FrameBox
    +
  • Defined in libclo/index.ts:59
    • @@ -55,54 +55,54 @@

    baseLineskip

    baseLineskip: null | number
    +
  • Defined in libclo/index.ts:61

    • content

    content: null | string | Box[]
    +
  • Defined in libclo/index.ts:88

    • direction

    direction: Direction
    +
  • Defined in libclo/index.ts:85

    • directionInsideLine

    directionInsideLine: Direction
    +
  • Defined in libclo/index.ts:60

    • height

    height: number
    +
  • Defined in libclo/index.ts:87

    • textStyle

    textStyle: null | TextStyle
    +
  • Defined in libclo/index.ts:84

    • width

    width: number
    +
  • Defined in libclo/index.ts:86

    • x

    x: null | number
    +
  • Defined in libclo/index.ts:82

    • y

    y: null | number
    +
  • Defined in libclo/index.ts:83
    • diff --git a/docs/interfaces/libclo.HGlue.html b/docs/interfaces/libclo.HGlue.html index a760ae5..9d45507 100644 --- a/docs/interfaces/libclo.HGlue.html +++ b/docs/interfaces/libclo.HGlue.html @@ -36,15 +36,21 @@

    Properties

    -
    stretchFactor +
    isHorizonalGlue +stretchFactor

    Properties

    +
    +

    isHorizonalGlue

    +
    isHorizonalGlue: true

    stretchFactor

    stretchFactor: number
    +
  • Defined in libclo/index.ts:34
    • @@ -64,6 +70,7 @@

    On This Page

    Interfaces

    -
    Box +
    BR +Box BreakPoint CharBox FrameBox HGlue +VGlue

    Type Aliases

    @@ -50,12 +52,14 @@

    Functions

    -
    calculateTextWidthHeight +
    applyVOffset +calculateTextWidthHeight calculateTextWidthHeightAux filterEmptyString hyphenForClo hyphenTkTree ptToPx +putInVBox spacesToBreakpoint splitCJKV twoReturnsToNewline diff --git a/docs/types/libclo.BoxesItem.html b/docs/types/libclo.BoxesItem.html index 870c895..adb9d03 100644 --- a/docs/types/libclo.BoxesItem.html +++ b/docs/types/libclo.BoxesItem.html @@ -18,7 +18,7 @@

    Type alias BoxesItem

    BoxesItem: HGlue | Box | BreakPoint | BoxesItem[]
    +
  • Defined in libclo/index.ts:52
    • diff --git a/docs/variables/libclo.A4_IN_PX.html b/docs/variables/libclo.A4_IN_PX.html index 969b276..85a42b6 100644 --- a/docs/variables/libclo.A4_IN_PX.html +++ b/docs/variables/libclo.A4_IN_PX.html @@ -28,7 +28,7 @@
    width: number
    +
  • Defined in libclo/index.ts:95
    • diff --git a/docs/variables/libclo.cjkvBlocksInRegex.html b/docs/variables/libclo.cjkvBlocksInRegex.html index 5585299..65cd28c 100644 --- a/docs/variables/libclo.cjkvBlocksInRegex.html +++ b/docs/variables/libclo.cjkvBlocksInRegex.html @@ -28,7 +28,7 @@
    +
  • Defined in libclo/index.ts:125
    • diff --git a/docs/variables/libclo.cjkvRegexPattern.html b/docs/variables/libclo.cjkvRegexPattern.html index c2bb8ef..da6d56b 100644 --- a/docs/variables/libclo.cjkvRegexPattern.html +++ b/docs/variables/libclo.cjkvRegexPattern.html @@ -18,7 +18,7 @@

    Variable cjkvRegexPatternConst

    cjkvRegexPattern: RegExp = ...
    +
  • Defined in libclo/index.ts:127
    • diff --git a/docs/variables/libclo.defaultFrameStyle.html b/docs/variables/libclo.defaultFrameStyle.html index a07bfaa..fee1aa4 100644 --- a/docs/variables/libclo.defaultFrameStyle.html +++ b/docs/variables/libclo.defaultFrameStyle.html @@ -18,7 +18,7 @@

    Variable defaultFrameStyleConst

    defaultFrameStyle: FrameBox = ...
    +
  • Defined in libclo/index.ts:105
    • diff --git a/docs/variables/libclo.defaultTextStyle.html b/docs/variables/libclo.defaultTextStyle.html index 2e3fd63..76ae31c 100644 --- a/docs/variables/libclo.defaultTextStyle.html +++ b/docs/variables/libclo.defaultTextStyle.html @@ -18,7 +18,7 @@

    Variable defaultTextStyleConst

    defaultTextStyle: TextStyle = ...
    +
  • Defined in libclo/index.ts:98
    • -- 2.39.2