Changes between Version 1 and Version 2 of TracDev/JinjaChecker

Timestamp:

Jul 21, 2016, 1:24:57 PM (8 years ago)

Author:

Christian Boos

Comment:

restructure the page by adding an #Example section

TracDev/JinjaChecker

@@ -5 +5 @@
 To help with that problem, we wrote the [source:cboos.git/contrib/jinjachecker.py contrib/jinjachecker.py] tool.
 
+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.
+
+== Example
+
+The command:
 {{{
 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.
+outputs:
 {{{
 # -- Jinja2 check for 'trac/wiki/templates/jwiki_view.html'
@@ -102 +107 @@
 }}}
 
-As a second step, jinjachecker removes the Jinja2 markup and performs a validation of the document, using lxml.
+and:
 {{{
 # -- HTML check for 'trac/wiki/templates/jwiki_view.html'
@@ -149 +154 @@
 # -- HTML OK
 }}}
+
+The second part of this output is only generated if you have [pypi:lxml] installed. If that's the case, after having checked the Jinja2 syntax nesting in a first step, the jinjachecker tool removes the Jinja2 markup and performs a validation of the document using lxml in a second step.