Debian Codegraph @

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

raw
1 tikzquests
2 ==========
3
4 A parametric questions' repository.
5
6 For more details, see the documentation,
7 [tikzquests.pdf](http://mirrors.ctan.org/macros/latex/contrib/tikzquests/doc/tikzquests.pdf)
8
9 --------------
10
11 ## Requirements
12 * none besides a fairly recent LaTeX distribution as recent as 2022/06/01
13 (with the new in kernel *\ProcessKeyOptions* and *\NewDocumentCommand*)
14
15 ## Installation
16 The stable version is available at [CTAN](https://ctan.org/pkg/tikzquests).
17
18 ## Usage
19 ### Stable version
20 Just place
21 ```latex
22 \usepackage{tikzquests}
23 ```
24
25 in the preamble and compile away.
26
27
28 Be aware that options might change between versions, so you have to check them manually.
29
30
31 ## Contacting Author
32
33 For bug reports and enhancement suggestions, the preferred way is to use
34 [the project's issue page](https://github.com/alceu-frigeri/tikzquests/issues).
35 Please be ready to provide an example code showing the bug, if any.
36
37 Please do not use the issue page for generic help on how to use the package.
38
39 * git: https://github.com/alceu-frigeri/tikzquests
40
41 -------------
42 Copyright 2024-present by Alceu Frigeri
43
44 This work may be distributed and/or modified under the
45 conditions of
46
47 * The [LaTeX Project Public License](http://www.latex-project.org/lppl.txt), version 1.3c (or later), and/or
48 * The [GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.html), version 3 (or later)
49
50 This work has the LPPL maintenance status *maintained*.
51
52 The Current Maintainer of this work is Alceu Frigeri
53
54 -------------
55 ## This work consists of the files
56
57 * tikzquests.sty
58 - The Package itself
59
60 * README.md (this file)
61 - quick introduction
62
63 * tikzquests.tex
64 - package documentation
65
66 * tikzquests.pdf
67 - documentation in PDF format
68
69 -------------
70 ## Change log
71 * Version 2.3 (this)
72 - using ```\pkginfograbProvidesExplPackage```
73 - removing all kernel scratch variables references.
74 - added 'keys prefix' package option. re-factored keys setting with \seq
75 - further code clean up
76
77 * Version 2.2/2.2a
78 - switching over pkginfograb package's info
79 - new package options allowing to change key's set and definition strategy (local instead of global).
80 - "re-inserting" missing optional parameter in \ftikzQuestion (last one)
81
82 * Version 2.1
83 - documentation typos
84 - some code cleanup
85 - removing duplicates before processing key`s ID/idx
86
87 * Version 2.0a
88 - documentation typos
89 - issue [#4](https://github.com/alceu-frigeri/tikzquests/issues/4)
90 - code cleanup
91
92 * Version 2.0
93 - re-factoring: fully re-written as expl3 code (and solving [#3](https://github.com/alceu-frigeri/tikzquests/issues/3))
94 - re-factoring: some commands renamed (old ones still accessible, but deprecated)
95 - new, more flexible, command for listing questions: \QuestionsFmtList
96 - documentation.
97
98 * Version 1.4
99 - internals: delaying keys expansion
100 - re-factoring: pgfkeys partly re-written as expl3 code.
101 - re-factoring: some commands renamed (old ones still accessible, but deprecated)
102 - removed (deprecated) "old keys"
103 - documentation
104
105 * Version 1.3
106 - Added an optional parameter to \defQuestionAlias allowing to "copy" questions from one repository into another. see documentation.
107
108 * Version 1.2
109 - Added the concept of 'sub-repositories' (relevant when listing the questions of a repository). see documentation.
110
111 * Version 1.1
112 - Documentation typos, and issue [#1](https://github.com/alceu-frigeri/tikzquests/issues/1).
113
114 * Version 1.0
115 - Initial release by CTAN.