Luke Plant avatar Luke Plant committed 594c625

Comments (0)

Files changed (1)

-== Welcome ==
-
-Welcome to your wiki! This is the default page we've installed for your convenience. Go ahead and edit it.
-
-=== Wiki features ===
-
-This wiki uses the [[http://www.wikicreole.org/|Creole]] syntax, and is fully compatible with the 1.0 specification.
-
-The wiki itself is actually a hg repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately.
-
-Go ahead and try:
-
-{{{
-$ hg clone http://bitbucket.org/spookylukey/django-output-validator/wiki
-}}}
-
-Wiki pages are normal files, with the .wiki extension. You can edit them locally, as well as creating new ones.
-
-=== Syntax highlighting ===
-
-You can also highlight snippets of text, we use the excellent [[http://www.pygments.org/|Pygments]] library.
-
-Here's an example of some Python code:
-
-{{{
-#!python
-
-def wiki_rocks(text):
-	formatter = lambda t: "funky"+t
-	return formatter(text)
-}}}
-
-You can check out the source of this page to see how that's done, and make sure to bookmark [[http://pygments.org/docs/lexers/|the vast library of Pygment lexers]], we accept the 'short name' or the 'mimetype' of anything in there.
-
-Have fun!
+= Django Output Validator =
+
+== Summary ==
+
+This simple app does validation on all the HTML generated by your Django app, and keeps track of any pages that fail. You will no longer have any excuse for pages that aren't valid HTML :-) .
+
+== What it does ==
+
+It uses a middleware to intercept all outgoing HTML and validate it using an external command line application. It then logs any failures, and provides some pages for viewing and clearing out the list of failures. This means that it can catch HTML errors that are only produced by 'POST' actions, which otherwise are painful to check for (since a crawler won't get them).
+
+It currently does this synchronously, so it slows your app down. On my machine, it's only about 1/4 second per page, so it's well worth it, and obviously it is only meant for development purposes - you just comment out a few config lines to disable it for live sites.
+
+Here's a screenshot of it picking fault in an early version of itself:
+
+{{http://lukeplant.me.uk/resources/djangovalidator/validator_app_sshot.png|screen shot}}
+
+See the [[https://bitbucket.org/spookylukey/django-output-validator/src|README]] for installation and usage instructions.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.