Create new JS snippet API

Module_API_Docs.md

@@ -168,6 +168,27 @@ exit(page_renderer::render_username("admin")); // Output would be something like
 ?>
 ```
 
+#### `page_renderer::AddJSLink(string $scriptUrl)`
+Add a remote JS script to rendered pages. Links added via this method translate to something like `<script src='{script url}' defer></script>`.
+```php
+<?php
+
+page_renderer::AddJSLink("http://bobsrockets.com/js/awesomescript.js");
+
+?>
+```
+
+#### `page_renderer::AddJSSnippet(string $snippet)`
+Adds a snippet of javascript to generated pages. The snippet in question will be guaranteed to run after the DOM content has loaded (but the `onload` event may not have fired yet). Snippets added via this method will be translated into something like `<script defer>{snippet}</script>`.
+
+```php
+<?php
+
+page_renderer::AddJSSnippet("alert('Hai!');");
+
+?>
+```
+
 #### `page_renderer::register_part_preprocessor($code)`
 This function's use is more complicated to explain. Pepperminty Wiki renders pages with a very simple templating system. For example, in the template a page's content is denoted by `{content}`. A function registered here will be passed all the components of a page _just_ before they are dropped into the template. Note that the function you pass in here should take a *reference* to the components, as the return value of the function passed is discarded. Here's an example:
 

build/index.php

@@ -1241,21 +1241,23 @@ class page_renderer
 	{
 		global $settings;
 		$result = self::get_css_as_html();
+		$result .= self::getJS();
 		
 		if(module_exists("feature-search"))
 			$result .= "\t\t<link type='application/opensearchdescription+xml' rel='search' href='?action=opensearch-description' />";
 		
 		if(!empty($settings->enable_math_rendering))
+		{
 			$result .= "<script type='text/x-mathjax-config'>
-  MathJax.Hub.Config({
+		MathJax.Hub.Config({
-    tex2jax: {
+		tex2jax: {
-      inlineMath: [ ['$','$'], ['\\\\(','\\\\)'] ],
+		inlineMath: [ ['$','$'], ['\\\\(','\\\\)'] ],
-      processEscapes: true,
+		processEscapes: true,
-      skipTags: ['script','noscript','style','textarea','pre','code']
+		skipTags: ['script','noscript','style','textarea','pre','code']
-    }
+		}
-  });
+		});
-</script>
+	</script>";
-<script async src='https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-MML-AM_CHTML'></script>";
+		}
 		
 		return $result;
 	}
@@ -1295,6 +1297,29 @@ class page_renderer
 			return "<style>$css</style>\n";
 		}
 	}
+	
+	private static $jsSnippets = [];
+	private static $jsLinks = [];
+	public function AddJSLink(string $scriptUrl)
+	{
+		$jsLinks[] = $scriptUrl;
+	}
+	public function AddJSSnippet(string $script)
+	{
+		$jsSnippets[] = $script;
+	}
+	
+	private static function getJS()
+	{
+		$result = "";
+		foreach(static::$jsSnippets as $snippet)
+			$result .= "<script defer>$snippet</script>\n";
+		foreach(static::$jsLinks as $link)
+			$result .= "<script src='" . $link . "' defer></script>\n";
+		return $result;
+	}
+	
+	// ~
 
 	public static $nav_divider = "<span class='nav-divider inflexible'> | </span>";
 
@@ -1369,6 +1394,8 @@ class page_renderer
 
 		return $result;
 	}
+	
+	// ~
 
 	public static function generate_all_pages_datalist()
 	{
@@ -1387,6 +1414,11 @@ class page_renderer
 	}
 }
 
+if(!empty($settings->enable_math_rendering))
+{
+	page_renderer::AddJSLink("https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-MML-AM_CHTML");
+}
+
 /// Finish setting up the environment object ///
 $env->page = $_GET["page"];
 if(isset($_GET["revision"]) and is_numeric($_GET["revision"]))
@@ -3785,7 +3817,7 @@ register_module([
 
 register_module([
 	"name" => "Page editor",
-	"version" => "0.15",
+	"version" => "0.15.1",
 	"author" => "Starbeamrainbowlabs",
 	"description" => "Allows you to edit pages by adding the edit and save actions. You should probably include this one.",
 	"id" => "page-edit",
@@ -3871,37 +3903,31 @@ register_module([
 			<input type='text' name='tags' value='$page_tags' placeholder='Enter some tags for the page here. Separate them with commas.' title='Enter some tags for the page here. Separate them with commas.' tabindex='2' />
 			<p class='editing-message'>$settings->editing_message</p>
 			<input name='submit-edit' type='submit' value='Save Page' tabindex='3' />
-			<script>
-				// Adapted from https://jsfiddle.net/2wAzx/13/
-				document.querySelector(\"[name=content]\").addEventListener(\"keydown\", (event) => {
-					if(event.keyCode !== 9) return true;
-					var currentValue = event.target.value, startPos = event.target.selectionStart, endPos = event.target.selectionEnd;
-					event.target.value = currentValue.substring(0, startPos) + \"\\t\" + currentValue.substring(endPos);
-					event.target.selectionStart = event.target.selectionEnd = startPos + 1;
-					event.stopPropagation(); event.preventDefault();
-					return false;
-				});
-			</script>
 		</form>";
+			page_renderer::AddJSSnippet("// Adapted from https://jsfiddle.net/2wAzx/13/
+document.querySelector(\"[name=content]\").addEventListener(\"keydown\", (event) => {
+	if(event.keyCode !== 9) return true;
+	var currentValue = event.target.value, startPos = event.target.selectionStart, endPos = event.target.selectionEnd;
+	event.target.value = currentValue.substring(0, startPos) + \"\\t\" + currentValue.substring(endPos);
+	event.target.selectionStart = event.target.selectionEnd = startPos + 1;
+	event.stopPropagation(); event.preventDefault();
+	return false;
+});");
 			
 			// ~
 			
 			/// ~~~ Smart saving ~~~ ///
 			
-			$content .= <<<SMARTSAVE
+			page_renderer::AddJSSnippet('// Smart saving
-<!-- Smart saving script -->
+function getSmartSaveKey() { return document.querySelector("main h1").innerHTML.replace("Creating ", "").replace("Editing ", "").trim(); }
-<script>
+// Saving
-	function getSmartSaveKey() { return document.querySelector("main h1").innerHTML.replace("Creating ", "").replace("Editing ", "").trim(); }
+document.querySelector("textarea[name=content]").addEventListener("keyup", function(event) { window.localStorage.setItem(getSmartSaveKey(), event.target.value) });
-	// Saving
+// Loading
-	document.querySelector("textarea[name=content]").addEventListener("keyup", function(event) { window.localStorage.setItem(getSmartSaveKey(), event.target.value) });
+window.addEventListener("load", function(event) {
-	// Loading
+	var editor = document.querySelector("textarea[name=content]");
-	window.addEventListener("load", function(event) {
+	if(editor.value.length > 0) return; // Don\'t restore if there\'s data in the editor already
-		var editor = document.querySelector("textarea[name=content]");
+	editor.value = localStorage.getItem(getSmartSaveKey());
-		if(editor.value.length > 0) return; // Don't restore if there's data in the editor already
+});');
-		editor.value = localStorage.getItem(getSmartSaveKey());
-	});
-</script>
-SMARTSAVE;
 			
 			exit(page_renderer::render_main("$title - $settings->sitename", $content));
 		});

core.php

@@ -933,21 +933,23 @@ class page_renderer
 	{
 		global $settings;
 		$result = self::get_css_as_html();
+		$result .= self::getJS();
 		
 		if(module_exists("feature-search"))
 			$result .= "\t\t<link type='application/opensearchdescription+xml' rel='search' href='?action=opensearch-description' />";
 		
 		if(!empty($settings->enable_math_rendering))
+		{
 			$result .= "<script type='text/x-mathjax-config'>
-  MathJax.Hub.Config({
+		MathJax.Hub.Config({
-    tex2jax: {
+		tex2jax: {
-      inlineMath: [ ['$','$'], ['\\\\(','\\\\)'] ],
+		inlineMath: [ ['$','$'], ['\\\\(','\\\\)'] ],
-      processEscapes: true,
+		processEscapes: true,
-      skipTags: ['script','noscript','style','textarea','pre','code']
+		skipTags: ['script','noscript','style','textarea','pre','code']
-    }
+		}
-  });
+		});
-</script>
+	</script>";
-<script async src='https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-MML-AM_CHTML'></script>";
+		}
 		
 		return $result;
 	}
@@ -987,6 +989,29 @@ class page_renderer
 			return "<style>$css</style>\n";
 		}
 	}
+	
+	private static $jsSnippets = [];
+	private static $jsLinks = [];
+	public function AddJSLink(string $scriptUrl)
+	{
+		$jsLinks[] = $scriptUrl;
+	}
+	public function AddJSSnippet(string $script)
+	{
+		$jsSnippets[] = $script;
+	}
+	
+	private static function getJS()
+	{
+		$result = "";
+		foreach(static::$jsSnippets as $snippet)
+			$result .= "<script defer>$snippet</script>\n";
+		foreach(static::$jsLinks as $link)
+			$result .= "<script src='" . $link . "' defer></script>\n";
+		return $result;
+	}
+	
+	// ~
 
 	public static $nav_divider = "<span class='nav-divider inflexible'> | </span>";
 
@@ -1061,6 +1086,8 @@ class page_renderer
 
 		return $result;
 	}
+	
+	// ~
 
 	public static function generate_all_pages_datalist()
 	{
@@ -1079,6 +1106,11 @@ class page_renderer
 	}
 }
 
+if(!empty($settings->enable_math_rendering))
+{
+	page_renderer::AddJSLink("https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-MML-AM_CHTML");
+}
+
 /// Finish setting up the environment object ///
 $env->page = $_GET["page"];
 if(isset($_GET["revision"]) and is_numeric($_GET["revision"]))

module_index.json

@@ -118,11 +118,11 @@
     },
     {
         "name": "Page editor",
-        "version": "0.15",
+        "version": "0.15.1",
         "author": "Starbeamrainbowlabs",
         "description": "Allows you to edit pages by adding the edit and save actions. You should probably include this one.",
         "id": "page-edit",
-        "lastupdate": 1477151244,
+        "lastupdate": 1477821977,
         "optional": false
     },
     {

modules/page-edit.php

@@ -1,7 +1,7 @@
 <?php
 register_module([
 	"name" => "Page editor",
-	"version" => "0.15",
+	"version" => "0.15.1",
 	"author" => "Starbeamrainbowlabs",
 	"description" => "Allows you to edit pages by adding the edit and save actions. You should probably include this one.",
 	"id" => "page-edit",
@@ -87,37 +87,31 @@ register_module([
 			<input type='text' name='tags' value='$page_tags' placeholder='Enter some tags for the page here. Separate them with commas.' title='Enter some tags for the page here. Separate them with commas.' tabindex='2' />
 			<p class='editing-message'>$settings->editing_message</p>
 			<input name='submit-edit' type='submit' value='Save Page' tabindex='3' />
-			<script>
-				// Adapted from https://jsfiddle.net/2wAzx/13/
-				document.querySelector(\"[name=content]\").addEventListener(\"keydown\", (event) => {
-					if(event.keyCode !== 9) return true;
-					var currentValue = event.target.value, startPos = event.target.selectionStart, endPos = event.target.selectionEnd;
-					event.target.value = currentValue.substring(0, startPos) + \"\\t\" + currentValue.substring(endPos);
-					event.target.selectionStart = event.target.selectionEnd = startPos + 1;
-					event.stopPropagation(); event.preventDefault();
-					return false;
-				});
-			</script>
 		</form>";
+			page_renderer::AddJSSnippet("// Adapted from https://jsfiddle.net/2wAzx/13/
+document.querySelector(\"[name=content]\").addEventListener(\"keydown\", (event) => {
+	if(event.keyCode !== 9) return true;
+	var currentValue = event.target.value, startPos = event.target.selectionStart, endPos = event.target.selectionEnd;
+	event.target.value = currentValue.substring(0, startPos) + \"\\t\" + currentValue.substring(endPos);
+	event.target.selectionStart = event.target.selectionEnd = startPos + 1;
+	event.stopPropagation(); event.preventDefault();
+	return false;
+});");
 			
 			// ~
 			
 			/// ~~~ Smart saving ~~~ ///
 			
-			$content .= <<<SMARTSAVE
+			page_renderer::AddJSSnippet('// Smart saving
-<!-- Smart saving script -->
+function getSmartSaveKey() { return document.querySelector("main h1").innerHTML.replace("Creating ", "").replace("Editing ", "").trim(); }
-<script>
+// Saving
-	function getSmartSaveKey() { return document.querySelector("main h1").innerHTML.replace("Creating ", "").replace("Editing ", "").trim(); }
+document.querySelector("textarea[name=content]").addEventListener("keyup", function(event) { window.localStorage.setItem(getSmartSaveKey(), event.target.value) });
-	// Saving
+// Loading
-	document.querySelector("textarea[name=content]").addEventListener("keyup", function(event) { window.localStorage.setItem(getSmartSaveKey(), event.target.value) });
+window.addEventListener("load", function(event) {
-	// Loading
+	var editor = document.querySelector("textarea[name=content]");
-	window.addEventListener("load", function(event) {
+	if(editor.value.length > 0) return; // Don\'t restore if there\'s data in the editor already
-		var editor = document.querySelector("textarea[name=content]");
+	editor.value = localStorage.getItem(getSmartSaveKey());
-		if(editor.value.length > 0) return; // Don't restore if there's data in the editor already
+});');
-		editor.value = localStorage.getItem(getSmartSaveKey());
-	});
-</script>
-SMARTSAVE;
 			
 			exit(page_renderer::render_main("$title - $settings->sitename", $content));
 		});