Extend printheaderfooter.js example documentation

The comment now explains how to delegate the header/footer setup to the loaded HTML page by giving an explicit HTML example that defines the required PhantomJSPrinting object ISSUE: 512 (http://code.google.com/p/phantomjs/issues/detail?id=512)
jonleighton · Apr 30, 2012 · b3d74c9 · b3d74c9
1 parent e185a5c
commit b3d74c9
Showing 1 changed file with 21 additions and 2 deletions.
diff --git a/examples/printheaderfooter.js b/examples/printheaderfooter.js
@@ -41,11 +41,30 @@ if (system.args.length < 3) {
         } else {
             /* check whether the loaded page overwrites the header/footer setting,
                i.e. whether a PhantomJSPriting object exists. Use that then instead
-               of our defaults above. */
+               of our defaults above.
+
+               example:
+               <html>
+                 <head>
+                   <script type="text/javascript">
+                     var PhantomJSPrinting = {
+                        header: {
+                            height: "1cm",
+                            contents: function(pageNum, numPages) { return pageNum + "/" + numPages; }
+                        },
+                        footer: {
+                            height: "1cm",
+                            contents: function(pageNum, numPages) { return pageNum + "/" + numPages; }
+                        }
+                     };
+                   </script>
+                 </head>
+                 <body><h1>asdfadsf</h1><p>asdfadsfycvx</p></body>
+              </html>
+            */
             if (page.evaluate(function(){return typeof PhantomJSPrinting == "object";})) {
                 paperSize = page.paperSize;
                 paperSize.header.height = page.evaluate(function() {
-                    console.log("woot?", PhantomJSPrinting.header.height);
                     return PhantomJSPrinting.header.height;
                 });
                 paperSize.header.contents = phantom.callback(function(pageNum, numPages) {