Debian Codegraph @

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

raw
1 # pgfornament – Drawing of Vectorian ornaments with PGF/TikZ
2
3 Release 1.3 2024/08/14
4
5 ## Description
6
7 This package allows the drawing of Vectorian ornaments (196) with pgf/tikz.
8 The documentation presents the syntax and parameters of the macro "pgfornament".
9 About tikzrput package:
10 This package contains the rput macro that can be used to place objects. This macro does similar actions of the rput macro from pstricks. Here this macro needs tikz to work.
11 With this new version comes a new family of ornaments.
12 Chennan Zhang drew the motifs using a CAD application, re-drew them in TikZ, and granted permission for these to be turned into a library pgfornament-han suitable for use with the pgfornament package by LianTze Lim.
13 It is now possible to use directly the library for Chinese traditional motifs and patterns.
14
15 ## About tikzrput package
16
17 This package contains the `\rput` macro that can be used to place objects. This
18 macro does similar actions of the `\rput` macro from pstricks. Here this macro
19 needs `tikz` to work.
20
21 ## Licence
22
23 The packages may be modified and distributed under the terms and
24 conditions of the [LaTeX Project Public
25 License](https://www.latex-project.org/lppl/), version 1.3c or greater.
26
27 ## Installation
28
29 The package `pgfornament` and `tikzrput` are present in `TeXLive` and `MiKTeX`, use the
30 package manager to install.
31
32 You can experiment with the `pgfornament` and `tikzrput` packages by placing all of the
33 distribution files in the directory containing your current tex file.
34
35 For manual instalation all files must be moved into the different directories in your
36 installation `TDS` tree or in your `TEXMFHOME`:
37
38 ```
39 doc/*.* -> TDS:doc/latex/pgfornament/*.*
40 code/latex/*.* -> TDS:tex/latex/pgfornament/*.*
41 code/generic/*.* -> TDS:tex/generic/pgfornament/*.*
42 ```
43
44 ## How to use it
45
46 To use the package `pgfornament`, place the following lines in the preamble of
47 your LaTeX document.
48
49 ```
50 \usepackage{pgfornament}
51 ```
52
53 ## Documentation
54
55 Documentations for `pgfornament` and `tikzrput` are available on CTAN and in your TeX distribution.
56
57 ## History
58
59 - v 1.3 Correction of bug (spurious space) by Tibor Tómács and correction of the documentation.
60
61 - v 1.2 Correction of bug (spurious space) by LianTze Lim.
62
63 - v 1.00 Add the Han ornanments and some new macros. Add some examples to the documentation. Thanks to Pablo Gonzáles L to help me with "Git".
64
65 - v0.21: `pgfornament.sty`, Christian Feuersänger thank you for seeing this bug
66 ornament/at now replaces the key at (conflict with at from pgf)
67
68 - v0.21: documentation: Peter Zimmermann thank you for seeing some bugs in the
69 examples .
70
71 - New section Problem to describe some difficulties