Merge pull request #9 from Padam87/docs

Improved documentation

Author: Padam87

README.md

@@ -13,8 +13,6 @@
 
 A bundle to rasterize web pages with PhantomJS for Symfony2
 
-## 1. Example ##
-
 ```php
 $response = new Response(
     $this->get('padam87_rasterize.rasterizer')->rasterize(
@@ -27,35 +25,13 @@ $response = new Response(
 );
 ```
 
-## 2. Installation ##
-
-### 2.1. Composer ###
-
-    "padam87/rasterize-bundle": "~1.0",
+[Installation](Resources/docs/configuration_reference.md)
 
-### 2.2. AppKernel ###
+[Configuration reference](Resources/docs/configuration_reference.md)
 
-    $bundles = array(
-		...
-        new Padam87\RasterizeBundle\Padam87RasterizeBundle(),
-    );
+**How to...**
+ - [pass arguments to the javascript file?](Resources/docs/how_to_pass_arguments.md)
+ - [ignore SSL errors?](Resources/docs/how_to_ignore_ssl_errors.md)
 
-### 2.3 Install assets ###
 
-	php app/console assets:install
 
-## 3. Configuration reference ##
-
-*NOTE: No configuration necessary by default*
-
-```YAML
-padam87_rasterize:
-    web_dir:              /../web # Temp dir location related to %kernel.root_dir%.
-    temp_dir:             /bundles/padam87rasterize/temp # Temp dir location related to web dir. Must be in a location accessible by the web server.
-    phantomjs:
-        callable:             phantomjs
-        options:              [] # https://github.com/ariya/phantomjs/wiki/API-Reference#wiki-command-line-options
-    script:               /bundles/padam87rasterize/js/rasterize.js # Relative to web dir
-    arguments: # You can define your own custom arguments. Will be added by default to every process.
-        format:              pdf # Default, will always be added, even if you remove it from here.
-```

Resources/docs/configuration_reference.md

@@ -0,0 +1,15 @@
+## Configuration reference ##
+
+*NOTE: No configuration necessary by default*
+
+```YAML
+padam87_rasterize:
+    web_dir:              /../web # Temp dir location related to %kernel.root_dir%.
+    temp_dir:             /bundles/padam87rasterize/temp # Temp dir location related to web dir. Must be in a location accessible by the web server.
+    phantomjs:
+        callable:             phantomjs
+        options:              [] # https://github.com/ariya/phantomjs/wiki/API-Reference#wiki-command-line-options
+    script:               /bundles/padam87rasterize/js/rasterize.js # Relative to web dir
+    arguments: # You can define your own custom arguments. Will be added by default to every process.
+        format:              pdf # Default, will always be added, even if you remove it from here.
+```

Resources/docs/how_to_ignore_ssl_errors.md

@@ -0,0 +1,12 @@
+# How to ignore SSL errors
+
+Phantomjs, by default does not play nice with Self-signed certificates.
+If you are working with one, you need to ignore ssl errors.
+
+```yaml
+padam87_rasterize:
+    phantomjs:
+        options:
+            --ssl-protocol: tlsv1
+            --ignore-ssl-errors: true
+```

Resources/docs/how_to_pass_arguments.md

@@ -0,0 +1,54 @@
+# How to pass arguments to the javascript file
+
+In this example, we will use arguments to programmatically set the orientation of the PDF.
+
+First, the configuration should be changed
+
+```yaml
+padam87_rasterize:
+    script:               /js/my-rasterize.js
+    arguments:
+        format: pdf
+        orientation: portrait
+```
+
+Note that the orientation argument has been added, by default it will be set as `portrait`.
+
+A custom javascript is also necessary, to handle the newly received argument.
+
+```js
+var page = require('webpage').create(),
+    system = require('system'),
+    address, output, format, orientation;
+
+address = system.args[1];
+output = system.args[2];
+format = system.args[3];
+orientation = system.args[4];
+
+page.viewportSize = { width: 1000, height: 3000 };
+page.paperSize = { format: 'A4', orientation: orientation, border: '1cm' };
+
+page.open(address, function (status) {
+    if (status !== 'success') {
+        console.log('Unable to load the address!');
+        phantom.exit(1);
+    } else {
+        window.setTimeout(function () {
+            page.render(output, { format: format });
+            phantom.exit(0);
+        }, 200);
+    }
+});
+```
+
+To change the orientation to `landscape`, you need to add one more parameter to the rasterizer call.
+
+```php
+$this->get('padam87_rasterize.rasterizer')->rasterize(
+    $this->renderView('Bundle:Folder:template.pdf.twig')
+    [
+        'orientation' => 'landscape'
+    ]
+);
+```

Resources/docs/install.md

@@ -0,0 +1,16 @@
+## Installation ##
+
+### Composer ###
+
+    "padam87/rasterize-bundle": "~1.0",
+
+### AppKernel ###
+
+    $bundles = array(
+        ...
+        new Padam87\RasterizeBundle\Padam87RasterizeBundle(),
+    );
+
+### Install assets ###
+
+    php app/console assets:install