file filtering for backslashes

Author: synapticloop

README.md

@@ -1,4 +1,4 @@
-<a name="documentr_top"></a>[![Build Status](https://travis-ci.org/synapticloop/documentr.svg?branch=master)](https://travis-ci.org/synapticloop/documentr) [![Download](https://api.bintray.com/packages/synapticloop/maven/documentr/images/download.svg)](https://bintray.com/synapticloop/maven/documentr/_latestVersion) [![GitHub Release](https://img.shields.io/github/release/synapticloop/documentr.svg)](https://github.com/synapticloop/documentr/releases) [![Gradle Plugin Release](https://img.shields.io/badge/gradle%20plugin-2.6.3-blue.svg)](https://plugins.gradle.org/plugin/synapticloop.documentr) 
+<a name="documentr_top"></a>[![Build Status](https://travis-ci.org/synapticloop/documentr.svg?branch=master)](https://travis-ci.org/synapticloop/documentr) [![Download](https://api.bintray.com/packages/synapticloop/maven/documentr/images/download.svg)](https://bintray.com/synapticloop/maven/documentr/_latestVersion) [![GitHub Release](https://img.shields.io/github/release/synapticloop/documentr.svg)](https://github.com/synapticloop/documentr/releases) [![Gradle Plugin Release](https://img.shields.io/badge/gradle%20plugin-2.7.0-blue.svg)](https://plugins.gradle.org/plugin/synapticloop.documentr) 
 
 > **This project requires JVM version of at least 1.7**
 
@@ -234,7 +234,7 @@ This is a simple JSON file as show below:
 
 		{ "type":"inbuilt", "value":"jvm-compatability" },
 
-		{ "type": "markup", "value": "nn# Table of Contentsnn" },
+		{ "type": "markup", "value": "\n\n# Table of Contents\n\n" },
 
 		{ "type": "toc", "value": "2" },
 		{ "type": "toclinks", "value": "true" },
@@ -246,27 +246,27 @@ This is a simple JSON file as show below:
 
 		{ "type":"file", "value":"src/docs/pre-usage.md" },
 
-		{ "type": "markup", "value": "### The `documentr.json` filenn" },
-		{ "type": "markup", "value": "This is a simple JSON file as show below:nn" },
-		{ "type": "markup", "value":"n```n" },
+		{ "type": "markup", "value": "### The `documentr.json` file\n\n" },
+		{ "type": "markup", "value": "This is a simple JSON file as show below:\n\n" },
+		{ "type": "markup", "value":"\n```\n" },
 
 
 		{ "type": "file", "value":"documentr.json" },
 
 
-		{ "type": "markup", "value":"n```n" },
-		{ "type": "markup", "value":"> *in fact - the above file is included from the file system `documentr.json`, so that it is always up-to-date with the correct information...*nn" },
+		{ "type": "markup", "value":"\n```\n" },
+		{ "type": "markup", "value":"> *in fact - the above file is included from the file system `documentr.json`, so that it is always up-to-date with the correct information...*\n\n" },
 
 		{ "type":"template", "value":"src/docs/post-usage.md.templar" },
 
-		{ "type":"markup", "value":"nn```n" },
+		{ "type":"markup", "value":"\n\n```\n" },
 
 
 		{ "type":"file", "value":"src/main/resources/USAGE.txt" },
 		{ "type":"file", "value":"src/main/resources/HELP.txt" },
 
 
-		{ "type":"markup", "value":"n```n" },
+		{ "type":"markup", "value":"\n```\n" },
 
 		{ "type": "file", "value":"src/docs/table-of-contents.md" },
 
@@ -324,7 +324,7 @@ buildscript {
 		}
 	}
 	dependencies {
-		classpath "gradle.plugin.synapticloop:documentr:2.6.3"
+		classpath "gradle.plugin.synapticloop:documentr:2.7.0"
 	}
 }
 
@@ -339,7 +339,7 @@ apply plugin: "synapticloop.documentr"
 
 ```
 plugins {
-	id 'synapticloop.documentr' version '2.6.3'
+	id 'synapticloop.documentr' version '2.7.0'
 }
 ```
 
@@ -376,7 +376,7 @@ simply run
 
 
 ```
-java -jar documentr-2.6.3-all.jar
+java -jar documentr-2.7.0-all.jar
 ```
 
 
@@ -392,7 +392,7 @@ Running:
 
 
 ```
-java -jar documentr-2.6.3-all.jar --help
+java -jar documentr-2.7.0-all.jar --help
 ```
 
 
@@ -462,7 +462,7 @@ be one of the following:
         {dumpcontext} - which dumps all available context key/value pairs to
         the output
   - file - the file will be included as is with no parsing done on it
-  - markup - any valid markdown, with 'n' being replaced with a new line 
+  - markup - any valid markdown, with '\n' being replaced with a new line 
         character.  No templar parsing is done on this.
   - markdown - an alias for markup
   - inbuilt - one of the in-built templates (see below for a list of the 
@@ -533,11 +533,11 @@ simply by entering the following line into you `documentr.json` file:
 
 
 ```
-{ "type": "markup", "value": "\n\n# Table of Contents\n\n" },
+{ "type": "markup", "value": "\\n\\n# Table of Contents\\n\\n" },
 
 { "type": "toc", "value": "2" },
 { "type": "toclinks", "value": "true" },
-{ "type": "toplink", "value": " <a name="documentr_top"></a>" },
+{ "type": "toplink", "value": " <a name=\"documentr_top\"></a>" },
 { "type": "tocbacktotop", "value": " <sup><sup>[top](#documentr_top)</sup></sup>" },
 ```
 
@@ -561,7 +561,7 @@ contents for headers up to level `h6`.
 ### `{ "type": "toplink" }`
 
 This is the anchor name to go back to the top of the README file (rather than 
-the top of the page.  By default this is always set to `<a name=\"#documentr_top\"></a>` 
+the top of the page.  By default this is always set to `<a name=\\"#documentr_top\\"></a>` 
 if you wish to change the `tocbacktotop`, then you will need to change this as 
 well.
 
@@ -825,9 +825,9 @@ repositories {
 
 ```
 dependencies {
-	runtime(group: 'synapticloop', name: 'documentr', version: '2.6.3', ext: 'jar')
+	runtime(group: 'synapticloop', name: 'documentr', version: '2.7.0', ext: 'jar')
 
-	compile(group: 'synapticloop', name: 'documentr', version: '2.6.3', ext: 'jar')
+	compile(group: 'synapticloop', name: 'documentr', version: '2.7.0', ext: 'jar')
 }
 ```
 
@@ -839,9 +839,9 @@ or, more simply for versions of gradle greater than 2.1
 
 ```
 dependencies {
-	runtime 'synapticloop:documentr:2.6.3'
+	runtime 'synapticloop:documentr:2.7.0'
 
-	compile 'synapticloop:documentr:2.6.3'
+	compile 'synapticloop:documentr:2.7.0'
 }
 ```
 
@@ -859,7 +859,7 @@ dependencies {
 <dependency>
 	<groupId>synapticloop</groupId>
 	<artifactId>documentr</artifactId>
-	<version>2.6.3</version>
+	<version>2.7.0</version>
 	<type>jar</type>
 </dependency>
 ```
@@ -924,7 +924,7 @@ This should appear in the artefact repository along with the compiled code, as a
 
 For example:
 
-`documentr-2.6.3.jar -> documentr-2.6.3-all.jar`
+`documentr-2.7.0.jar -> documentr-2.7.0-all.jar`
 
 
 

build.gradle

@@ -13,7 +13,7 @@ buildscript {
 	}
 
 	dependencies {
-		classpath 'synapticloop:documentr:2.6.3'
+		classpath 'synapticloop:documentr:2.7.0'
 	}
 }
 
@@ -37,7 +37,7 @@ group = 'synapticloop'
 archivesBaseName = 'documentr'
 description = """documentation (README) generator for projects in both markdown and asciidoc - this utilises the templar templating language - including generation of table of contents"""
 
-version = '2.6.3'
+version = '2.7.0'
 
 sourceCompatibility = 1.7
 targetCompatibility = 1.7

src/main/java/synapticloop/documentr/generator/Generator.java

@@ -74,6 +74,7 @@ public class Generator {
 
 	private static final String KEY_VALUE = "value";
 	private static final String KEY_TYPE = "type";
+	private static final String KEY_CONTEXT = "context";
 
 	private static final int TYPE_FILE = 1;
 	private static final int TYPE_INBUILT = 0;
@@ -225,7 +226,7 @@ public void generate() throws DocumentrException {
 					switch(TYPE_LOOKUP.get(type)) {
 					case TYPE_FILE:
 						stringBuilder.append("{pre\n");
-						stringBuilder.append(FileUtils.readFileToString(new File(pathname)));
+						stringBuilder.append(FileUtils.readFileToString(new File(pathname)).replace("\\", "\\\\"));
 						stringBuilder.append("\npre}\n");
 						break;
 					case TYPE_MARKUP:
@@ -502,7 +503,7 @@ private String getInbuiltTemplateName(String template) {
 	 * @param jsonObject the json object that contains the context items
 	 */
 	private void overrideContext(TemplarContext templarContext, JSONObject jsonObject) {
-		JSONObject contextObject = jsonObject.getJSONObject("context");
+		JSONObject contextObject = jsonObject.getJSONObject(KEY_CONTEXT);
 		if(null != contextObject) {
 			Iterator<String> keys = contextObject.keys();
 			while (keys.hasNext()) {