Jump to main content Jump to doc navigation

SyntaxChecker

Other versions: 2.x (current) — Found a problem? Please edit this page or report an issue.

What is SyntaxChecker?

SyntaxChecker is a plugin that checks the syntax of your MODX tags and alerts you to problems. This helps ensure that your documents and templates render the way you expect them to.

Requirements

  • MODX Revolution 2.1 or later
  • PHP5 or later

History

SyntaxChecker was first released on December 20, 2011.

Download

It can be downloaded from within the MODX Revolution manager via Package Management, or from the MODX Extras Repository, here: http://modx.com/extras/package/syntaxchecker

Usage examples

Once you've activated the plugin, no other action is required. Just observe that if your pages or templates have glitches in their tags, you'll see an error window pop up when you try to save.

The following represents some of the conditions that are checked for (see the readme.txt file for a full list):

  1. Basic integrity check: equal number of '[[' and ']]'
  2. No looping conditions (e.g. where you put [[*content]] inside your content).
  3. Snippets exist? e.g. [[Waaaayfinder]]
  4. Chunks exist? e.g. [[$mispelled]]
  5. Resources exist? e.g. [[~123]]
  6. Settings exist? e.g. [[++site_url]]
  7. Document variables exist? e.g. [[*kontent]]
  8. Property sets exist? e.g. [[Snippet@myPropSet]]
  9. Output filters exist? e.g. [[Snippet:my_filter]]
  10. Parameters are prefixed with an ampersand? e.g. [[Snippet? whoops=xyz]]
  11. Parameters delineated from the token via a question mark, e.g. [[Snippet &no=question]]
  12. Parameter names and values are separated by an equals sign, e.g. [[Snippet &notequal]]
  13. When saving a template, ensure that the TVs are assigned to the current template.

Troubleshooting