Armin Ronacher | 37a8851 | 2007-03-02 20:42:18 +0100 | [diff] [blame] | 1 | ====================== |
| 2 | Documentation Overview |
| 3 | ====================== |
| 4 | |
| 5 | Welcome in the Jinja documentation. |
| 6 | |
| 7 | - `Installing Jinja <installation.txt>`_ |
| 8 | |
Armin Ronacher | ee2c18e | 2007-04-20 22:39:04 +0200 | [diff] [blame] | 9 | - **Application Developer Documentation**: |
Armin Ronacher | 37a8851 | 2007-03-02 20:42:18 +0100 | [diff] [blame] | 10 | |
Armin Ronacher | ee2c18e | 2007-04-20 22:39:04 +0200 | [diff] [blame] | 11 | - `Quickstart <devintro.txt>`_ - getting started with Jinja |
Armin Ronacher | 37a8851 | 2007-03-02 20:42:18 +0100 | [diff] [blame] | 12 | |
Armin Ronacher | ee2c18e | 2007-04-20 22:39:04 +0200 | [diff] [blame] | 13 | - `Template Loaders <loaders.txt>`_ - documentation for the different |
| 14 | loader types and how to write custom ones. |
Armin Ronacher | 37a8851 | 2007-03-02 20:42:18 +0100 | [diff] [blame] | 15 | |
Armin Ronacher | ee2c18e | 2007-04-20 22:39:04 +0200 | [diff] [blame] | 16 | - `Filter Functions <filters.txt>`_ - information about how to write |
| 17 | custom filter functions. |
Armin Ronacher | 37a8851 | 2007-03-02 20:42:18 +0100 | [diff] [blame] | 18 | |
Armin Ronacher | ee2c18e | 2007-04-20 22:39:04 +0200 | [diff] [blame] | 19 | - `Test Functions <tests.txt>`_ - information about how to write |
| 20 | custom test functions. |
Armin Ronacher | 37a8851 | 2007-03-02 20:42:18 +0100 | [diff] [blame] | 21 | |
Armin Ronacher | ee2c18e | 2007-04-20 22:39:04 +0200 | [diff] [blame] | 22 | - `Global Objects <objects.txt>`_ - information about the special global |
| 23 | namespace in Jinja templates. |
Armin Ronacher | 94dd3d0 | 2007-03-14 18:43:57 +0100 | [diff] [blame] | 24 | |
Armin Ronacher | ee2c18e | 2007-04-20 22:39:04 +0200 | [diff] [blame] | 25 | - `Streaming Interface <streaming.txt>`_ - using Jinja for big templates |
| 26 | by streaming the output. |
Armin Ronacher | 02d81f7 | 2007-04-07 16:31:42 +0200 | [diff] [blame] | 27 | |
Armin Ronacher | ee2c18e | 2007-04-20 22:39:04 +0200 | [diff] [blame] | 28 | - `Internationalization <i18n.txt>`_ - how to internationalize applications |
| 29 | using Jinja templates. |
Armin Ronacher | 94dd3d0 | 2007-03-14 18:43:57 +0100 | [diff] [blame] | 30 | |
Armin Ronacher | ee2c18e | 2007-04-20 22:39:04 +0200 | [diff] [blame] | 31 | - `Alternative Syntax <altsyntax.txt>`_ - changing the default Jinja |
| 32 | block / variable / comment delimiters. |
Armin Ronacher | 37a8851 | 2007-03-02 20:42:18 +0100 | [diff] [blame] | 33 | |
Armin Ronacher | ee2c18e | 2007-04-20 22:39:04 +0200 | [diff] [blame] | 34 | - `API Documentation <api.txt>`_ - API documentation for public Jinja |
| 35 | objects like `Environment`. |
Armin Ronacher | 68c8725 | 2007-03-06 17:35:54 +0100 | [diff] [blame] | 36 | |
Armin Ronacher | ee2c18e | 2007-04-20 22:39:04 +0200 | [diff] [blame] | 37 | - `Translators <translators.txt>`_ - explanation about the Jinja template |
| 38 | translation interface. |
Armin Ronacher | abc0064 | 2007-03-15 09:16:54 +0100 | [diff] [blame] | 39 | |
Armin Ronacher | ee2c18e | 2007-04-20 22:39:04 +0200 | [diff] [blame] | 40 | - `Framework Integration <frameworks.txt>`_ - integrating Jinja into |
| 41 | python frameworks. |
Armin Ronacher | e9e1788 | 2007-03-19 17:52:24 +0100 | [diff] [blame] | 42 | |
Armin Ronacher | ee2c18e | 2007-04-20 22:39:04 +0200 | [diff] [blame] | 43 | - `Debugging Support <debugging.txt>`_ - debugging Jinja templates. |
Armin Ronacher | 2158091 | 2007-04-17 17:13:10 +0200 | [diff] [blame] | 44 | |
Armin Ronacher | ee2c18e | 2007-04-20 22:39:04 +0200 | [diff] [blame] | 45 | - `Developer Recipies <devrecipies.txt>`_ - tips and tricks for application |
| 46 | developers. |
Armin Ronacher | 2acbac1 | 2007-04-11 21:49:48 +0200 | [diff] [blame] | 47 | |
Armin Ronacher | ee2c18e | 2007-04-20 22:39:04 +0200 | [diff] [blame] | 48 | - **Template Designer Documentation**: |
Armin Ronacher | 37a8851 | 2007-03-02 20:42:18 +0100 | [diff] [blame] | 49 | |
Armin Ronacher | 4c9cfcc | 2007-04-29 18:21:13 +0200 | [diff] [blame] | 50 | - `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 Ronacher | 37a8851 | 2007-03-02 20:42:18 +0100 | [diff] [blame] | 66 | |
Armin Ronacher | ee2c18e | 2007-04-20 22:39:04 +0200 | [diff] [blame] | 67 | - `Differences To Django <fromdjango.txt>`_ - coming from django? Then this |
| 68 | document is for you. |
Armin Ronacher | 85ddd3b | 2007-03-14 17:34:34 +0100 | [diff] [blame] | 69 | |
Armin Ronacher | ee2c18e | 2007-04-20 22:39:04 +0200 | [diff] [blame] | 70 | - `Designer Recipies <recipies.txt>`_ - various tips and tricks for designers. |
Armin Ronacher | 41faf01 | 2007-03-22 18:40:59 +0100 | [diff] [blame] | 71 | |
Armin Ronacher | a38b312 | 2007-04-15 00:49:13 +0200 | [diff] [blame] | 72 | - `Changelog <changelog.txt>`_ |
| 73 | |
Armin Ronacher | 41faf01 | 2007-03-22 18:40:59 +0100 | [diff] [blame] | 74 | There is also support via IRC on the ``#pocoo`` channel on `irc.freenode.net`. |