cjk-spacer:0.2.0

packages/preview/cjk-spacer/0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ryuryu-ymj
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/preview/cjk-spacer/0.2.0/README.md

@@ -0,0 +1,78 @@
+# cjk-spacer
+
+Typst で日本語（CJK文字）を組むときの文字間の空きを改善するパッケージ．\
+A package to improve spacing between characters when typesetting Japanese (CJK) characters in Typst.
+
+## 機能 Features
+
+* 和文を途中で改行した場合にスペースを入れない．\
+  Prevents adding spaces when a Japanese text line breaks in the middle.
+
+  ![Comparison showing the removal of unwanted spaces caused by source code line breaks in Japanese text.](examples/comparison1.svg)
+
+* 数式と和文の間のスペースを自動で挿入．\
+  Automatically inserts spaces between mathematical expressions and Japanese text.
+
+  ![Comparison showing automatic spacing insertion between Japanese text and mathematical expressions.](examples/comparison2.svg)
+
+* 半角約物と和文の間のスペースを自動で挿入．\
+  Automatically inserts spaces between western punctuation marks and Japanese text.
+
+  ![Comparison showing automatic spacing insertion between Japanese text and western parentheses.](examples/comparison3.svg)
+
+
+## 使い方 Usage
+
+文書の冒頭に以下の行を追加する．show rule の定義は文書ごとに１回でよい．\
+Add the following lines to the beginning of your document.
+The show rule definition is only needed once per document.
+
+```typst
+#import "@preview/cjk-spacer:0.2.0": cjk-spacer
+#show: cjk-spacer
+```
+
+
+## 制限事項 Limitations
+数式内の和文テキストと数式の間に関しては自動スペースがうまく機能しません．その場合，`box` 関数でテキストを囲むようにしてください．\
+Automatic spacing does not work well between Japanese text inside an equation and the equation itself.
+In such cases, please wrap the text in a `box` function.
+
+![Comparison showing the spacing limitation inside equations and the box workaround.](examples/comparison4.svg)
+
+和文と他の element（太字など）の和文との間に明示的に半角スペースを入れることができません．もし多用する場合は四分空きのコマンドを定義すると便利でしょう．\
+It is not possible to explicitly insert a half-width space between Japanese text and other styled Japanese text elements (e.g., bold text).
+If you need this frequently, it may be useful to define a command for a quarter-em space.
+
+![Comparison showing the spacing limitation after strong Japanese text and a custom spacer workaround.](examples/comparison5.svg)
+
+
+## 別の手段 Alternative methods
+
+* [cjk-unbreak](https://typst.app/universe/package/cjk-unbreak):
+  和文（CJK文）の途中で改行した場合の間のスペースを除去するパッケージ．cjk-spacer の１つ目の機能と挙動はほぼ同じだが，実装方法が異なる．
+  cjk-unbreak は Typst の文書 AST を再帰的に探査して，和文の前後のスペースを除去していくので，一部未だ対応していない要素がある．
+  （例えば，`terms` 関数．詳しくは [Typstの「改行すると半角スペース入ってしまう問題」について ](https://note.com/bismuth083/n/n4f0300d3c1cf) のコメントを参照．）
+  一方，cjk-spacer は `text` 関数に対して和文の前後にゼロスペースを追加する show rule を定義する方式なので，すべての `text` に対して作用する．
+  \
+  A package that removes spaces inserted when a Japanese (CJK) text line breaks in the middle. Its behavior for the first feature is almost the same as cjk-spacer, but the implementation is different.
+  cjk-unbreak recursively traverses the Typst document AST to remove spaces before and after Japanese text, so some elements are not yet supported.
+  (For example, the `terms` function. See the comments on [Typstの「改行すると半角スペース入ってしまう問題」について ](https://note.com/bismuth083/n/n4f0300d3c1cf) for details.)
+  On the other hand, cjk-spacer uses a method that defines a show rule to add zero-width spaces before and after Japanese text for the `text` function, so it affects all `text` elements.
+
+  ![Comparison table demonstrating that cjk-spacer correctly removes unwanted spaces even within term lists, a case where cjk-unbreak currently fails.](examples/cjk-unbreak-comparison1.svg)
+
+* [Typstで和文と数式の間の空きをどうにかしたい話](https://qiita.com/zr_tex8r/items/a9d82669881d8442b574):
+  和文と数式の間のスペース問題に関する詳細な記事．cjk-spacer とは別の解決策も提示されてるが，外部フォントが必要である．
+  \
+  A detailed article on the spacing issue between Japanese text and mathematical expressions. It presents other solutions besides cjk-spacer, but they require some external font.
+
+
+## 変更履歴 Change logs
+
+* v0.2.0:
+  - 和文と半角約物の間にスペースを自動で挿入する機能を追加．\
+    Added a feature to automatically insert spaces between Japanese text and western punctuation marks.
+  - `lang` パラメータの廃止．\
+    Removed the `lang` parameter.
+* v0.1.0: Initial release.

packages/preview/cjk-spacer/0.2.0/examples/cjk-unbreak-comparison.typ

@@ -0,0 +1,41 @@
+#import "@preview/codly:1.3.0": *
+#show: codly-init
+#codly(lang-format: none)
+
+#set text(lang: "ja", font: "Noto Sans JP")
+#set page(width: 16cm, height: auto, margin: 2mm, fill: white)
+#show table.cell.where(y: 0): it => {
+  set text(.9em)
+  strong(it)
+}
+
+#let entrypoint = toml("/typst.toml").package.entrypoint
+#let usage = "#import \"/" + entrypoint + "\": *\n" + "#show: cjk-spacer\n"
+
+#let cjk-unbreak-usage = ```typst
+#import "@preview/cjk-unbreak:0.2.1": remove-cjk-break-space
+#show: remove-cjk-break-space
+
+```
+
+
+#let compare(source) = {
+  table(
+    columns: (1fr, 1fr, 1fr),
+    rows: auto,
+    align: center + horizon,
+    table.header([Example code], [Output (cjk-unbreak)], [Output (cjk-spacer)]),
+    {
+      source
+    },
+    eval(cjk-unbreak-usage.text + source.text, mode: "markup"),
+    eval(usage + source.text, mode: "markup"),
+  )
+}
+
+#compare(```typst
+/ 用語: #[
+    説明の途中で
+    改行
+  ]
+```)