Changes between Version 21 and Version 22 of TracDev/Proposals/Jinja

Timestamp:

Mar 18, 2016, 12:27:35 AM (8 years ago)

Author:

Christian Boos

Comment:

moved the #jinjachecker section to its own page

TracDev/Proposals/Jinja

@@ -12 +12 @@
 
 [=#Status Status] of the branch (2016-03-17):
- - ported **63%** of the Genshi templates, 2 unit-tests failure (with mysql and psql), 8 functional tests failures
+ - ported **63%** of the Genshi templates, 2 unit-tests failures (with mysql and psql), 8 functional tests failures
  - clarify upgrade path for plugins that came to rely on `ITemplateStreamFilter`s?
    (127/898 plugins (14.1%) on trac-hacks.org use `filter_stream()`)
@@ -78 +78 @@
 See also PortingFromGenshiToJinja/Example for a full example presented side-by-side.
 
-=== `jinjachecker`
-
-Jinja2 is very helpful when it detects any kind of error, as you always end up with a meaningful backtrace. Nevertheless, it can be tedious to get the nesting of control structures right.
-
-To help with that, there's the [source:cboos.git/contrib/jinjachecker.py contrib/jinjachecker.py] tool.
-
-{{{
-python contrib/jinjachecker.py trac/wiki/templates/jwiki_view.html
-}}}
-
-It first analyzes the Jinja2 control structures, and tries to provide some helpful diagnostics in case of nesting or stylistic errors.
-It also adds curly braces to the statements, so if you have an editor which can do matching of brace pairs, you can quickly spot the origin o a nesting problem.
-
-Finally, while the indentation of the statements is free in Jinja2 templates, being consistent with it also helps to ensure a proper nesting.
-{{{
-# -- Jinja2 check for 'trac/wiki/templates/jwiki_view.html'
-   12    EXTENDS "jlayout.html"
-   18          {BLOCK title
-   19            {IF title:
-   21            }IF
-   22          }BLOCK title
-   25        {BLOCK head
-   26          SET modify_perm = 'WIKI_MODIFY' in perm(page.resource)
-   27          SET is_not_latest = page.exists and page.version != latest_version
-   31          {IF version or page.author == 'trac':
-   33          }IF
-   34          {IF modify_perm:
-   40          }IF
-   52        }BLOCK head
-   56        {BLOCK content
-   57          SET modify_perm = 'WIKI_MODIFY' in perm(page.resource)
-   58          SET create_perm = 'WIKI_CREATE' in perm(page.resource)
-   59          SET admin_perm = 'WIKI_ADMIN' in perm(page.resource)
-   60          SET is_not_latest = page.exists and page.version != latest_version
-   63          {IF version:
-   67                {WITH
-   68                  SET version = page.version
-   69                  SET author = authorinfo(page.author)
-   70                  SET date = pretty_dateinfo(page.time)
-   71                  SET hef = href.wiki(page.name, action='diff', version=page.version)
-   72                  {TRANS version, author, date, href
-   77                  }TRANS
-   78                }WITH
-   84          }IF
-   87            {IF page.exists:
-   91              SET last_modification = (page.comment and
-   97              {IF not version:
-  100                {WITH
-  101                  SET href = href.wiki(page.name, action='diff',
-  103                  SET date = pretty_dateinfo(page.time)
-  104                  {TRANS href, last_modification, date
-  109                  }TRANS
-  110                }WITH
-  116              }IF
-  117            ELSE:
-  119              {TRANS name = name_of(page.resource)
-  124              }TRANS
-  126            }IF
-  129          {WITH
-  130            SET alist = attachments
-  131            SET compact = True
-  132            SET foldable = True
-  133            INCLUDE "jlist_of_attachments.html"
-  134          }WITH
-  136          {WITH
-  137            SET delete_perm = 'WIKI_DELETE' in perm(page.resource)
-  138            SET rename_perm = 'WIKI_RENAME' in perm(page.resource)
-  139            {IF modify_perm or create_perm or delete_perm:
-  141              {IF modify_perm or create_perm:
-  145                {IF is_not_latest and modify_perm:
-  148                ELIF page.exists and modify_perm:
-  151                ELIF not page.exists and create_perm:
-  154                  {IF templates:
-  161                    {FOR t in sorted(templates):
-  165                    }FOR
-  168                  }IF
-  169                }IF
-  173              {IF page.exists:
-  174                {WITH alist = attachments
-  175                  INCLUDE "jattach_file_form.html"
-  176                }WITH
-  177              }IF
-  178            }IF
-  180            {IF page.exists and rename_perm:
-  187            }IF
-  188            {IF page.exists and delete_perm:
-  193                {IF page.version == latest_version:
-  195                }IF
-  199            }IF
-  201          }IF
-  202          }WITH
-  204          {IF not page.exists and higher:
-  208              {FOR markup in higher:
-  210              }FOR
-  213          }IF
-  215          {IF not page.exists and related:
-  219              {FOR markup in related:
-  221              }FOR
-  224          }IF
-  230        }BLOCK content
-# -- Jinja2 OK
-}}}
-
-As a second step, jinjachecker removes the Jinja2 markup and performs a validation of the document, using lxml.
-{{{
-# -- HTML check for 'trac/wiki/templates/jwiki_view.html'
-    1 
-...
-   13 
-   14 <!DOCTYPE html>
-   15 <html>
-   16   <head>
-   17     <title>
-   18 
-   19 
-   20       ${title} ${ super() }
-   21 
-   22 
-   23     </title>
-   24 
-   25 
-   26 
-   27 
-   28 
-   29     ${ super() }
-   30 
-...
-   52 
-   53   </head>
-   54 
-   55   <body>
-   56 
-   57 
-   58 
-   59 
-   60 
-   61     <div id="content" class="${classes('wiki', create=not page.exists)}">
-   62 
-...
-  213 
-  214 
-  215     </div>
-  216 
-  217     ${ super() }
-  218 
-  219 
-  220   </body>
-  221 </html>
-# -- HTML OK
-}}}
+In order to facilitate the creation of error-free Jinja2 templates for HTML (or XML), we also wrote a little utility called [PortingFromGenshiToJinja/Checker jinjachecker], which will help troubleshoot the most common nesting problems.