frameworks/ktexttemplate/Mainpage.dox

0001
0002 // Put this in the KTextTemplate namespace so that autolinks to classes work without needing a KTextTemplate:: prefix.
0003
0004 /**
0005   @brief The KTextTemplate namespace holds all public %KTextTemplate API.
0006 */
0007 namespace KTextTemplate
0008 {
0009
0010 /** @mainpage The KTextTemplate Library
0011
0012   @section overview Overview
0013
0014   %KTextTemplate is a Free Software, Open Source Qt based library used for text processing.
0015
0016   The text template is modelled after the [Django template system](https://docs.djangoproject.com/en/1.9/ref/templates/language/):
0017
0018   @code
0019     <ul>
0020     {% for athlete in athlete_list %}
0021     <li>{{ athlete.name }}{% if athlete.isCaptain %} (C){% endif %}</li>
0022     {% endfor %}
0023     </ul>
0024   @endcode
0025
0026   %KTextTemplate is covered by the GNU Lesser General Public Licence version 2.1 or, at your option, any later version.
0027
0028   <table class="main_api" >
0029     <tr><th class="section" >Application API</th><th class="section">%Plugin API</th><th class="section">Guides</th></tr>
0030     <tr><td>
0031       - AbstractLocalizer
0032       - AbstractTemplateLoader
0033       - CachingLoaderDecorator
0034       - Context
0035       - Engine
0036       - FileSystemTemplateLoader
0037       - InMemoryTemplateLoader
0038       - OutputStream
0039       - QtLocalizer
0040       - Template
0041     </td><td>
0042       - AbstractNodeFactory
0043       - Exception
0044       - Filter
0045       - FilterExpression
0046       - Node
0047       - NodeList
0048       - Parser
0049       - RenderContext
0050       - SafeString
0051       - TagLibraryInterface
0052       - Variable
0053     </td><td>
0054       - @ref for_themers
0055       - @ref for_app_dev
0056       - @ref builtins
0057       - @ref extension
0058       - @ref examples
0059       - @ref differences_django
0060       - @ref using_and_deploying
0061       - @ref internals
0062       - @ref generic_types_and_templates
0063       - @ref i18n_l10n
0064     </td></tr>
0065   </table>
0066   <br />
0067
0068   @section start_community Community
0069
0070   The %KTextTemplate project mailing list is kde-pim@kde.org.
0071
0072   - Existing bugs https://bugs.kde.org/buglist.cgi?product=frameworks-ktexttemplate
0073   - File new bug https://bugs.kde.org/enter_bug.cgi?product=frameworks-ktexttemplate
0074
0075 */
0076
0077 }