frameworks/ktexttemplate/README.md

0001
0002 The KTextTemplate Library
0003 =========================
0004
0005 * About KTextTemplate
0006 * Installation
0007 * Licensing
0008 * Contributing
0009
0010 About KTextTemplate
0011 -------------------
0012
0013 KTextTemplate is a Free Software library written using the [Qt framework](http://code.qt.io).
0014
0015 The goal of KTextTemplate is to make it easier for application developers to
0016 separate the structure of documents from the data they contain, opening the door
0017 for theming and advanced generation of other text such as code.
0018
0019 The syntax uses the syntax of the [Django template system](https://docs.djangoproject.com/en/1.9/ref/templates/language/), and
0020 the core design of Django is reused in KTextTemplate.
0021
0022     <ul>
0023     {% for athlete in athlete_list %}
0024     <li>{{ athlete.name }}{% if athlete.isCaptain %} (C){% endif %}</li>
0025     {% endfor %}
0026     </ul>
0027
0028 Part of the design of both template systems is that application developers can
0029 extend the syntax by implementing their own tags and filters. For details of how
0030 to do that, see the [API documentation](http://www.kde.org/apidox/extension.html).
0031
0032 Installation
0033 ------------
0034
0035 To build KTextTemplate, you need at least Qt6.0 (with development packages) and CMake 3.16.
0036 Out-of-source builds are recommended:
0037
0038     mkdir build
0039     cd build
0040     cmake -DCMAKE_INSTALL_PREFIX=$prefix ..
0041     cmake --build .
0042     cmake --build . --target install
0043
0044 Licensing
0045 ---------
0046
0047 KTextTemplate is covered by the GNU Lesser General Public License Version 2.1, or
0048 at your option, any later version. All contributions to KTextTemplate must be
0049 covered by the same license.
0050
0051 The details of the license are in the COPYING file in the source distribution.