blob: ba1c4eb0afddaf32ed042ebb09ee28975187d0ee [file] [log] [blame]
Armin Ronacher37a88512007-03-02 20:42:18 +01001======================
2Documentation Overview
3======================
4
5Welcome in the Jinja documentation.
6
7- `Installing Jinja <installation.txt>`_
8
Armin Ronacheree2c18e2007-04-20 22:39:04 +02009- **Application Developer Documentation**:
Armin Ronacher37a88512007-03-02 20:42:18 +010010
Armin Ronacheree2c18e2007-04-20 22:39:04 +020011 - `Quickstart <devintro.txt>`_ - getting started with Jinja
Armin Ronacher37a88512007-03-02 20:42:18 +010012
Armin Ronacheree2c18e2007-04-20 22:39:04 +020013 - `Template Loaders <loaders.txt>`_ - documentation for the different
14 loader types and how to write custom ones.
Armin Ronacher37a88512007-03-02 20:42:18 +010015
Armin Ronacheree2c18e2007-04-20 22:39:04 +020016 - `Filter Functions <filters.txt>`_ - information about how to write
17 custom filter functions.
Armin Ronacher37a88512007-03-02 20:42:18 +010018
Armin Ronacheree2c18e2007-04-20 22:39:04 +020019 - `Test Functions <tests.txt>`_ - information about how to write
20 custom test functions.
Armin Ronacher37a88512007-03-02 20:42:18 +010021
Armin Ronacheree2c18e2007-04-20 22:39:04 +020022 - `Global Objects <objects.txt>`_ - information about the special global
23 namespace in Jinja templates.
Armin Ronacher94dd3d02007-03-14 18:43:57 +010024
Armin Ronacheree2c18e2007-04-20 22:39:04 +020025 - `Streaming Interface <streaming.txt>`_ - using Jinja for big templates
26 by streaming the output.
Armin Ronacher02d81f72007-04-07 16:31:42 +020027
Armin Ronacheree2c18e2007-04-20 22:39:04 +020028 - `Internationalization <i18n.txt>`_ - how to internationalize applications
29 using Jinja templates.
Armin Ronacher94dd3d02007-03-14 18:43:57 +010030
Armin Ronacheree2c18e2007-04-20 22:39:04 +020031 - `Alternative Syntax <altsyntax.txt>`_ - changing the default Jinja
32 block / variable / comment delimiters.
Armin Ronacher37a88512007-03-02 20:42:18 +010033
Armin Ronacheree2c18e2007-04-20 22:39:04 +020034 - `API Documentation <api.txt>`_ - API documentation for public Jinja
35 objects like `Environment`.
Armin Ronacher68c87252007-03-06 17:35:54 +010036
Armin Ronacheree2c18e2007-04-20 22:39:04 +020037 - `Translators <translators.txt>`_ - explanation about the Jinja template
38 translation interface.
Armin Ronacherabc00642007-03-15 09:16:54 +010039
Armin Ronacheree2c18e2007-04-20 22:39:04 +020040 - `Framework Integration <frameworks.txt>`_ - integrating Jinja into
41 python frameworks.
Armin Ronachere9e17882007-03-19 17:52:24 +010042
Armin Ronacheree2c18e2007-04-20 22:39:04 +020043 - `Debugging Support <debugging.txt>`_ - debugging Jinja templates.
Armin Ronacher21580912007-04-17 17:13:10 +020044
Armin Ronacheree2c18e2007-04-20 22:39:04 +020045 - `Developer Recipies <devrecipies.txt>`_ - tips and tricks for application
46 developers.
Armin Ronacher2acbac12007-04-11 21:49:48 +020047
Armin Ronacheree2c18e2007-04-20 22:39:04 +020048- **Template Designer Documentation**:
Armin Ronacher37a88512007-03-02 20:42:18 +010049
Armin Ronacher4c9cfcc2007-04-29 18:21:13 +020050 - `Syntax Reference <designerdoc.txt>`_ - quick overview over the Jinja
51 syntax elements.
52
53 - `Template Inheritance <inheritance.txt>`_ - template inheritance howto.
54
55 - `Filters, Tests and Helper Functions <builtins.txt>`_ - list of filters
56 and test/helper functions.
57
58 - `Whitespace and Escaping <escaping.txt>`_ - how to escape markup and
59 control whitespace.
60
61 - `Scopes and Variable Behavior <scopes.txt>`_ - behavior of undefined
62 variables and scoping rules.
63
64 - `Template Internationalization <templatei18n.txt>`_ - how to internationalize
65 Jinja templates.
Armin Ronacher37a88512007-03-02 20:42:18 +010066
Armin Ronacheree2c18e2007-04-20 22:39:04 +020067 - `Differences To Django <fromdjango.txt>`_ - coming from django? Then this
68 document is for you.
Armin Ronacher85ddd3b2007-03-14 17:34:34 +010069
Armin Ronacheree2c18e2007-04-20 22:39:04 +020070 - `Designer Recipies <recipies.txt>`_ - various tips and tricks for designers.
Armin Ronacher41faf012007-03-22 18:40:59 +010071
Armin Ronachera38b3122007-04-15 00:49:13 +020072- `Changelog <changelog.txt>`_
73
Armin Ronacher41faf012007-03-22 18:40:59 +010074There is also support via IRC on the ``#pocoo`` channel on `irc.freenode.net`.