Debian Codegraph @

texmf-dist/doc/latex/kksymbols/README.md

raw
1 # KKsymbols
2
3 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
4
5 **Enclosing characters in various shapes for LuaLaTeX / 文字の囲み記号作成パッケージ**
6
7 ---
8
9 ## Overview / 概要
10
11 `KKsymbols` is a LaTeX package for enclosing characters in circles, squares, diamonds, or brackets. It features automatic scaling and baseline correction to ensure a consistent appearance in both horizontal and vertical writing modes.<br>
12 `KKsymbols` は、文字を丸、四角、菱形、括弧などで囲むためのコマンドを提供するパッケージです。自動スケーリングとベースライン補正機能を備えており、横書き・縦書きのどちらでも適切な外観を維持します。
13
14 - **Version**: 2.1.4
15 - **Date**: 2026-04-17
16 - **Author**: Kosei Kawaguchi (a.k.a. KKTeX)
17 - **License**: MIT
18 - **Repository**: [https://github.com/KKTeX/KKsymbols](https://github.com/KKTeX/KKsymbols)
19 - **Support**: [email protected]
20
21 ---
22
23 ## Acknowledgements / Credits
24 In developing this package, I made extensive use of the advice I received from Mr. Yusuke Terada.
25
26 I recommend you to refer to his article when you develop new-type symbols on LaTeX.
27
28 - **Link**: [https://doratex.hatenablog.jp/entry/20211205/1638697391](https://doratex.hatenablog.jp/entry/20211205/1638697391)
29 ---
30
31 ## Key Features / 特徴
32
33 - **Various Enclosures / 多彩な囲み形状**
34 - Easily enclose text in circles, squares, diamonds, and brackets.
35 - 丸、四角、菱形、括弧による囲み文字を簡単に作成できます。
36
37 - **Smart Scaling & Alignment / 自動調整機能**
38 - Features automatic scaling and baseline correction for perfect alignment with surrounding text.
39 - 文字サイズに合わせた自動スケーリングと、ベースラインの自動補正機能を搭載しています。
40
41 - **Multi-Directional Support / 縦書き・横書き両対応**
42 - Works seamlessly in both horizontal and vertical writing modes.
43 - 横書きだけでなく、縦書き環境でも崩れることなく使用可能です。
44
45 - **Modern Engine Support / LuaLaTeX専用**
46 - Optimized specifically for LuaLaTeX.
47 - LuaLaTeXに最適化された設計となっています。
48
49 ---
50
51 ## Prerequisites / 前提条件
52
53 > This package is **LuaLaTeX-only**.
54 > 本パッケージは **LuaLaTeX専用** です。
55
56 **Dependencies / 依存パッケージ:**
57 - `LuaLaTeX-ja`, `tikz`, `clac`, `luacode`, `kvoptions`
58
59 ---
60
61 ## Usage / 使用方法
62
63 For detailed usage and examples, please refer to the documentation file: `kksymbols-doc.tex`.<br>
64 具体的な使用方法や例については、ドキュメントファイル `kksymbols-doc.tex` を参照してください。