Debian Codegraph @

texmf-dist/doc/latex/tkz-elements/README.md

raw
1 # tkz-elements — Euclidean geometry with LuaLaTeX
2
3 _Current release: **[2026/04/11 version 5.06c]**_
4
5 `tkz-elements` is a Lua library that performs the computations needed to define the objects of a Euclidean geometry figure (points, lines, circles, conics, triangles, paths, …).
6 All numerical work happens in **Lua**; drawing is done with **tkz-euclide** (recommended) or **TikZ**.
7
8 ---
9
10 ## Features
11 - **Object-oriented design**: classes `point`, `line`, `circle`, `conic`, `triangle`, `path`, …
12 - **Rich geometry toolbox**: bisectors, altitudes, tangents, radical axis/center, Poncelet point, orthopole, Kimberling points, mixtilinear circle, Morley/Soddy/Napoleon constructions, Apollonius problems and more.
13 - **Utilities module**: helpers for formatting, solving equations, trigonometry/angles, barycentric & trilinear coordinates, comparisons, rounding, etc.
14 - **Smooth Lua → TikZ transfer**: send computed objects from Lua to TikZ/`tkz-euclide` via simple macros.
15
16
17 ## Requirements
18 - **LuaLaTeX** (Lua 5.3)
19 - **tkz‑euclide** (or **TikZ**)
20 - A recent TeX distribution (TeX Live / MiKTeX / MacTeX)
21
22 > > Tip: If you use `xcolor`, load it **before** `tkz-euclide`.
23
24 ## Installation
25 `tkz-elements` is available via TeX Live and MiKTeX package managers.
26
27 For a manual install, place the files in your TDS tree (or `TEXMFHOME`) following the usual LaTeX directory structure.
28
29 ## Quick start
30 ```tex
31 % !TEX TS-program = lualatex
32 \documentclass{standalone}
33 \usepackage[mini]{tkz-euclide}
34 \usepackage{tkz-elements}
35 \begin{document}
36 \directlua{
37 init_elements()
38 -- Create geometry in Lua
39 z.A = point(0,0)
40 z.B = point(2,0)
41 z.C = point(1,1.2)
42 }
43 \begin{tikzpicture}
44 % Transfer Lua points to TikZ nodes A, B, C
45 \tkzGetNodes
46 % Draw with tkz-euclide / TikZ
47 \tkzDrawPolygon(A,B,C)
48 \tkzDrawPoints(A,B,C)
49 \tkzLabelPoints(A,B,C)
50 \end{tikzpicture}
51 \end{document}
52 ```
53 > Alternative: the `tkzelements` environment (requires `luacode`).
54
55 ## Documentation & examples
56 - Project page and examples (including **Golden Arbelos**): <http://altermundus.fr>
57 - The full manual ships with the distribution (see `doc/`).
58 If you build from sources, the manual is produced at:
59 `doc/src/build/TKZdoc-elements-main.pdf`
60
61 ---
62
63 ## GitHub (source, issues, roadmap)
64 Development happens on GitHub:
65 - **Repository**: <https://github.com/al-ma-dev/tkz-elements>
66 - **Issues**: <https://github.com/al-ma-dev/tkz-elements/issues>
67 - **Changelog**: see `CHANGELOG.md`
68 - **Contributing guide**: `CONTRIBUTING.md` (PRs welcome)
69 - **License**: LPPL 1.3c
70
71 ### Report bugs / request features
72 Please open a GitHub issue and include:
73 - a **MWE** (Minimal Working Example) in LaTeX;
74 - your **TeX distribution** (TeX Live/MacTeX/MiKTeX), LuaLaTeX version, OS;
75 - relevant **log excerpts** (with `-file-line-error`).
76
77 ### Versioning & releases
78 - Versions follow the scheme `4.xx c` (e.g., `4.35c`) and are tagged on GitHub.
79 - The PDF manual ships in the repository and on CTAN.
80
81 The official version number and release date of **tkz-elements** are recorded in:
82
83 - `tkz-elements.sty` (LaTeX package file, visible in the log),
84 - `README.md` (this file),
85 - `CHANGELOG.md` (detailed history),
86 - `doc/tkz-elements.pdf` (documentation front page).
87
88 Lua source files (`tkz_elements_xxx.lua`) no longer carry their own version/date headers.
89
90 ---
91
92 ## License
93 This work may be modified and distributed under the terms of the
94 [LaTeX Project Public License](https://www.latex-project.org/lppl/), version 1.3c or later.
95
96 ## Changelog
97 Detailed changes are tracked in **CHANGELOG.md**.
98
99 ## Author
100 Alain Matthes — al (dot) ma (at) mac (dot) com