Added in documentation links and navigation sidebar

Author: synapticloop

book/.html

@@ -38,19 +38,20 @@ <h2>Welcome To Synapticloop Panl</h2>
 					<h3>Why?</h3>
 
 					<p>Because <code>/Caran+d'Ache/true/Black/bDW/</code> looks nicer than
-					<p><pre>
-					q=*:*&facet.mincount=1&rows=10&facet.field=lead_size_indicator&
-					facet.field=grip_material&facet.field=colours&facet.field=nib_shape&
-					facet.field=diameter&facet.field=cap_shape&facet.field=brand&
-					facet.field=mechanism_type&facet.field=length&facet.field=hardness_indicator
-					&facet.field=grip_type&facet.field=cap_material&facet.field=lead_grade_indicator
-					&facet.field=tubing_material&facet.field=in_built_sharpener&
-					facet.field=disassemble&facet.field=category&facet.field=body_shape&
-					facet.field=clip_material&facet.field=mechanism_material&facet.field=lead_length
-					&facet.field=body_material&facet.field=in_built_eraser&facet.field=grip_shape
-					&facet.field=relative_weight&facet.field=name&facet.field=nib_material
-					&facet.field=weight&facet.field=variants&facet=true&fq=brand:"Caran+d'Ache"
-					&fq=disassemble:"true"&fq=colours:"Black"&q.op=AND</pre></p>
+					<p>
+					<code>q=*:*&facet.mincount=1&rows=10&facet.field=lead_size_indicator&</code><br />
+					<code>facet.field=grip_material&facet.field=colours&facet.field=nib_shape&</code><br />
+					<code>facet.field=diameter&facet.field=cap_shape&facet.field=brand&</code><br />
+					<code>facet.field=mechanism_type&facet.field=length&facet.field=hardness_indicator</code><br />
+					<code>&facet.field=grip_type&facet.field=cap_material&facet.field=lead_grade_indicator</code><br />
+					<code>&facet.field=tubing_material&facet.field=in_built_sharpener&</code><br />
+					<code>facet.field=disassemble&facet.field=category&facet.field=body_shape&</code><br />
+					<code>facet.field=clip_material&facet.field=mechanism_material&facet.field=lead_length</code><br />
+					<code>&facet.field=body_material&facet.field=in_built_eraser&facet.field=grip_shape</code><br />
+					<code>&facet.field=relative_weight&facet.field=name&facet.field=nib_material</code><br />
+					<code>&facet.field=weight&facet.field=variants&facet=true&fq=brand:"Caran+d'Ache"</code><br />
+					<code>&fq=disassemble:"true"&fq=colours:"Black"&q.op=AND</code>
+				</p>
 
 					<h3>Additional Panl Niceties</h3>
 					<ol>
@@ -70,6 +71,7 @@ <h3>Additional Panl Niceties</h3>
 
 					<ul class="actions">
 						<li><a href="https://github.com/synapticloop/panl/" class="button alt">Browse the code</a></li>
+						<li><a href="https://synapticloop.github.io/panl/" class="button alt">Read the book online</a></li>
 					</ul>
 				</div>
 				<div class="4u$ 12u$(medium) important(medium)"><span class="image fit rounded"><img
@@ -88,7 +90,7 @@ <h3>Additional Panl Niceties</h3>
 		<div class="icon-grid">
 			<div class="row uniform 150%">
 				<section class="4u 6u(large) 12u$(small)"><i class="icon fa-book"></i>
-					<h3>Read the book</h3>
+					<h3>Read Offline</h3>
 					<p>Prefer a PDF all on one to print or take with you?</p>
 					<p><a href="#">Download the book...</a></p>
 				</section>

book/a-brief-introduction-to-solr.html

@@ -24,21 +24,25 @@
  *  IN THE SOFTWARE.
  */
 
+import com.synapticloop.debookeriser.book.LinkElement;
+import com.synapticloop.debookeriser.book.Page;
 import org.apache.commons.io.FileUtils;
 import org.jsoup.nodes.Document;
 import org.jsoup.nodes.Element;
-import org.jsoup.select.Elements;
 
 import java.io.*;
 import java.nio.charset.Charset;
-import java.util.LinkedHashMap;
-import java.util.Map;
+import java.util.*;
 
 import org.jsoup.*;
 
 public class Main {
 	private final File googleDocsHTMLFile;
 	private String template;
+
+	private final List<Page> pages = new ArrayList<>();
+	private final Map<String, LinkElement> linkElements = new LinkedHashMap<>();
+
 	public Main(String fileName) {
 		this.googleDocsHTMLFile = new File(fileName);
 	}
@@ -52,45 +56,64 @@ public void loadTemplate() throws IOException {
 		template = FileUtils.readFileToString(new File("src/main/resources/template.html"), Charset.defaultCharset());
 	}
 
-	private Map<String, String> pages = new LinkedHashMap<>();
 	public void parseGoogleHTMLFile() throws IOException {
 		Document doc = Jsoup.parse(googleDocsHTMLFile);
-		boolean hasFirstPage = false;
-		String outputPage = "book/index.html";
 
 		StringBuilder styles = new StringBuilder();
 		for (Element style : doc.getElementsByTag("style")) {
 			styles.append(style.outerHtml());
 		}
+
 		template = template.replace("##STYLE##", styles.toString());
 
+		Page page = new Page("index", "book/", template);
+
 		boolean hasRemovedFirstDiv = false;
-		StringBuilder contents = new StringBuilder();
+
 		for (Element body : doc.getElementsByTag("body")) {
-			for (Element allElement : body.children()) {
-				String tagName = allElement.tag().getName();
+			for (Element childElement : body.children()) {
+				String tagName = childElement.tag().getName();
+
+				getAllIds(page.getPageTitle(), childElement);
+
 				if(tagName.equals("h1")) {
-					String temp = template.replace("##CONTENT##", contents.toString());
-					System.out.println(temp.length());
-					FileUtils.writeStringToFile(new File(outputPage), temp, Charset.defaultCharset());
-					outputPage = "book/" + getNicePageName(allElement.text()) +".html";
-					System.out.println(outputPage);
-					contents.setLength(0);
-					contents.append(allElement.outerHtml());
-				} else {
+					// now start a new page
+					pages.add(page);
 
+					page = new Page(childElement.text(), "book/", template);
+					linkElements.put("#" + childElement.attr("id"), new LinkElement(page.getPageTitle(), childElement));
+					page.addPageElement(childElement);
+				} else {
 					if(!hasRemovedFirstDiv && tagName.equals("div")) {
 						// skip this one
 					} else {
-						contents.append(allElement.outerHtml());
+						page.addPageElement(childElement);
 					}
-
 				}
 			}
+
+			pages.add(page);
+		}
+
+		for(Page outputPage : pages) {
+			outputPage.writeContent(linkElements);
 		}
 	}
-	private String getNicePageName(String pageName) {
-		return(pageName.toLowerCase().replaceAll("[^a-z0-9]", "-"));
+
+	private void getAllIds(String pageTitle, Element element) {
+		String id = element.attr("id");
+		// we only want to put in heading, which will be in order, not links to headings
+//		if(element.tagName().startsWith("h") && !id.isBlank()) {
+//			linkElements.put("#" + id, new LinkElement(pageTitle, element));
+//		}
+
+		if(!id.isBlank()) {
+			linkElements.put("#" + id, new LinkElement(pageTitle, element));
+		}
+
+		for(Element childElement : element.children()) {
+			getAllIds(pageTitle, childElement);
+		}
 	}
 
 	public static void main(String[] args) {

book/code-flow.html

@@ -0,0 +1,43 @@
+package com.synapticloop.debookeriser.book;
+
+import org.jsoup.nodes.Attribute;
+import org.jsoup.nodes.Element;
+
+public class LinkElement {
+	private final String pageTitle;
+	private final String id;
+	private final String tagName;
+	private final Element element;
+
+	public LinkElement(String pageTitle, Element element) {
+		this.pageTitle = pageTitle;
+		this.element = element;
+		this.tagName = element.tagName();
+
+		this.id = element.attr("id");
+	}
+
+	public String getLink() {
+		return(getNicePageName(pageTitle) + ".html#" + id);
+	}
+
+	private String getNicePageName(String pageTitle) {
+		return pageTitle.toLowerCase().replaceAll("[^a-z0-9]", "-");
+	}
+
+	public String getPageTitle() {
+		return (pageTitle);
+	}
+
+	public String getId() {
+		return (id);
+	}
+
+	public String getContent() {
+		return(element.text());
+	}
+
+	public String getTagName() {
+		return (tagName);
+	}
+}

book/design-considerations.html

@@ -0,0 +1,110 @@
+package com.synapticloop.debookeriser.book;
+
+import org.apache.commons.io.FileUtils;
+import org.jsoup.nodes.Element;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.charset.Charset;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+public class Page {
+	private final String pageTitle;
+	private final String baseDirectory;
+	private final String template;
+	private List<String> styles;
+	private List<PageElement> pageElements = new ArrayList<>();
+
+	public Page(String pageTitle, String baseDirectory, String template) {
+		this.pageTitle = pageTitle;
+		this.baseDirectory = baseDirectory;
+		this.template = template;
+	}
+
+	public void addPageElement(Element element) {
+		pageElements.add(new PageElement(element));
+	}
+
+	public void setStyles(List<String> styles) {
+		this.styles = styles;
+	}
+
+	public void writeContent(Map<String, LinkElement> linkElements) throws IOException {
+		String temp = template.replace("##CONTENT##", getPageContent(linkElements))
+				.replace("##NAVIGATION##", getPageNavigation(linkElements));
+		FileUtils.writeStringToFile(new File(baseDirectory + getNicePageName(pageTitle) + ".html"), temp, Charset.defaultCharset());
+	}
+
+	private String getNicePageName(String pageName) {
+		return(pageName.toLowerCase().replaceAll("[^a-z0-9]", "-"));
+	}
+
+	private String getPageContent(Map<String, LinkElement> linkElements) {
+		StringBuilder sb = new StringBuilder();
+
+		for(PageElement pageElement : pageElements) {
+			sb.append(pageElement.getContent(linkElements));
+		}
+
+		return(sb.toString());
+	}
+
+	private String getPageNavigation(Map<String, LinkElement> linkElements) {
+		boolean foundUs = false;
+		boolean hasFinished = false;
+		StringBuilder sb = new StringBuilder();
+		sb.append("<h2 style=\"margin: 0px 0px 0px 4px; padding: 2px;\"><a href=\"/panl/book/\">&raquo;Table of Contents</a></h2>");
+
+		for (String key : linkElements.keySet()) {
+			LinkElement linkElement = linkElements.get(key);
+			if(linkElement.getTagName().equals("h1")) {
+				if (linkElement.getPageTitle().equals(pageTitle)) {
+					sb.append("<section class=\"current-page\">");
+					foundUs = true;
+				} else {
+					if(foundUs) {
+						hasFinished = true;
+					}
+					foundUs = false;
+				}
+			}
+
+			String content = linkElement.getContent();
+			if(foundUs) {
+				if(!content.isBlank()) {
+					switch(linkElement.getTagName()) {
+						case "h1":
+							sb.append(String.format("<h1 style=\"margin: 0px; padding: 2px;\">%s</h4>", content));
+							break;
+						case "h2":
+							sb.append(String.format("<h2 style=\"margin: 0px 0px 0px 4px; padding: 2px;\"><a href=\"%s\">%s</a></h5>", linkElement.getLink(), content));
+							break;
+						case "h3":
+							sb.append(String.format("<h3 style=\"margin: 0px 0px 0px 8px; padding: 2px;\"><a href=\"%s\">%s</a></h6>", linkElement.getLink(), content));
+							break;
+					}
+				}
+			} else {
+				if(!content.isBlank()) {
+					switch (linkElement.getTagName()) {
+						case "h1":
+							if(hasFinished) {
+								sb.append("</section>");
+								hasFinished = false;
+							}
+							sb.append(String.format("<h2 style=\"margin: 0px 0px 0px 4px; padding: 2px;\"><a href=\"%s\">&raquo;%s</a></h5>", linkElement.getLink(), content));
+							break;
+					}
+				}
+			}
+		}
+
+		return(sb.toString());
+	}
+
+	public String getPageTitle() {
+		return (pageTitle);
+	}
+}

book/epilogue.html

@@ -0,0 +1,41 @@
+package com.synapticloop.debookeriser.book;
+
+import org.jsoup.nodes.Element;
+
+import java.util.Map;
+
+public class PageElement {
+	public static final String GOOGLE_TRACKING_URL = "https://www.google.com/url?q=";
+	private final Element element;
+
+	public PageElement(Element element) {
+		this.element = element;
+	}
+
+	public String getContent(Map<String, LinkElement> linkElements) {
+		convertAnchors(element, linkElements);
+		return (element.outerHtml());
+	}
+
+	private void convertAnchors(Element element, Map<String, LinkElement> linkElements) {
+		for (Element childElement : element.children()) {
+			if (childElement.tagName().equals("a")) {
+				String href = childElement.attr("href");
+				if (!href.startsWith("http")) {
+					if (linkElements.containsKey(href)) {
+						childElement.attr("href", linkElements.get(href).getLink());
+					}
+				} else {
+					if(href.startsWith(GOOGLE_TRACKING_URL)) {
+						href = href.substring(GOOGLE_TRACKING_URL.length(), href.indexOf("&"));
+					}
+					if(href.startsWith("https://docs.google.com")) {
+						href = "#";
+					}
+					childElement.attr("href", href);
+				}
+			}
+			convertAnchors(childElement, linkElements);
+		}
+	}
+}