commenting example code

[nodejsws.git] / examples / simple / purls / justlayout.js
diff --git a/examples/simple/purls/justlayout.js b/examples/simple/purls/justlayout.js

index a108a99..050a4fc 100644 (file)
--- a/examples/simple/purls/justlayout.js
+++ b/examples/simple/purls/justlayout.js
@@ -1,3 +1,13 @@
+/*
+ *  this is an example of a purl that simply contains a layout and only a layout
+ *  
+ *  this is useful when you can do everything synchronously and just need to fling back
+ *  some content - if you tie layout to preRequest you can make preRequest determine
+ *  if you can simply use layout to push some simple html out and this simplifies the
+ *  whole request pipeline.
+ */
+
+
 exports.layout = function(request, response) {
        var tkl = "<html><body><h1>Just a Layout</h1>this purl is simply a layout";
        tkl += " and nothing else!</body></html>";