Initial commit.

Author: congma

README.md

@@ -0,0 +1,54 @@
+## pentareader
+
+pentareader: a [Pentadactyl][pdlink] plugin interfacing Firefox's [reader
+view][rview].
+
+
+### Usage
+
+* `:reader` or `:unreader`: enable/disable reader view, if applicable.
+* `:togglereader`, `:tr`: toggle reader view mode.
+* The optional `.penta` file adds a keyboard mapping
+  <kbd>&lt;Leader&gt;</kbd><kbd>r</kbd> for the `:togglereader` command.
+  The <kbd>&lt;Leader&gt;</kbd> key is the back-solidus <kbd>&bsol;</kbd> by
+  default, but can be configured in your `.pentadactylrc` file.
+
+
+### Installation
+
+Copy the files `pentaread.js` and `pentaread.penta` to your
+`~/.pentadactyl/plugins/` directory.  After that you may need to rehash
+Pentadactyl (`:rehash`) or restart Firefox.
+
+
+### Copyright
+
+Copyright (c) 2017, Cong Ma  
+All rights reserved.
+
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+
+[pdlink]: https://github.com/5digits/dactyl/
+[rview]: https://support.mozilla.org/t5/Basic-Browsing/Firefox-Reader-View-for-clutter-free-web-pages/ta-p/38466

pentaread.js

@@ -0,0 +1,132 @@
+/* pentaread -- Pentadactyl plugin interfacing Firefox's reader view.  See
+ * embedded documentation.
+ *
+ * Installation:
+ * 	Copy the .js and .penta (optional) files to ~/.pentadactyl/plugins/
+ * 	The JavaScript file implements the :reader and :unreader commands,
+ * 	and the command :togglereader to swith between the modes.
+ * 	The .penta file creates key mappings in normal mode.
+ *
+ * Copyright:
+ * 	Copyright (c) 2017, Cong Ma <cma@pmo.ac.cn>
+ * 	All rights reserved.
+ *
+ * License:
+ * 	BSD license <http://opensource.org/licenses/BSD-2-Clause>
+ */
+
+"use strict";
+
+
+var readerhead = "about:reader?url=";
+
+
+/* Return boolean: are we in reader mode? */
+var reader_mode_p = function ()
+{
+    return buffer.documentURI.spec.startsWith(readerhead);
+};
+
+/* Go to reader view of current buffer (web page) */
+var to_reader = function ()
+{
+    if ( buffer.documentURI.schemeIs("http") || 
+	 buffer.documentURI.schemeIs("https") )
+    {
+	return dactyl.open("".concat(readerhead,
+	    encodeURIComponent(buffer.documentURI.spec)));
+    } else {
+	return dactyl.echoerr("pentaread: error: URI scheme not applicable.");
+    };
+};
+
+/* Go from reader view to normal web page view */
+var from_reader = function ()
+{
+    if ( reader_mode_p() )
+    {
+	return dactyl.open(decodeURIComponent(
+	    buffer.documentURI.spec.replace(readerhead, "")));
+    } else {
+	return dactyl.echoerr("pentaread: error: buffer not in reader mode.");
+    };
+};
+
+/* Toggle reader mode */
+var toggle_reader = function ()
+{
+    if ( reader_mode_p() )
+	return from_reader();
+    else
+	return to_reader();
+};
+
+
+/* Pentadactyl commands */
+group.commands.add(["reader"],
+    "Go to reader view of current page.",
+    to_reader,
+    {"argcount": 0},
+    true)
+
+group.commands.add(["unreader"],
+    "Go from reader view to web page.",
+    from_reader,
+    {"argcount": 0},
+    true)
+
+group.commands.add(["togglereader", "tr"],
+    "Toggle reader view.",
+    toggle_reader,
+    {"argcount": 0},
+    true)
+
+/* Plugin manifest */
+var INFO =
+["plugin", {
+    name:    "pentaread",
+    version: "0.1",
+    href:    "https://github.com/congma/pentaread/",
+    summary: "pentaread - access Firefox reader mode from Pentadactyl",
+    xmlns:   "dactyl"},
+
+    ["author", {
+	email:  "cma@pmo.ac.cn",
+	href:   "https://cma.lamost.org/"}, "Cong Ma"],
+
+    ["license", {href: "http://opensource.org/licenses/BSD-2-Clause"},
+	"BSD License"],
+
+    ["project", {name: "Pentadactyl", "min-version": "1.0" }],
+
+    ["p", {},
+	"The plugin ", ["str", {}, "pentaread"], " interfaes Firefox's ",
+	" Reader View feature."],
+
+    ["item", {},
+	["tags", {}, ":reader"],
+	["strut", {}],
+	["spec", {}, ":reader"],
+	["description", {},
+	    ["p", {}, "Go to reader view of current web page."]]],
+
+    ["item", {},
+	["tags", {}, ":unreader"],
+	["strut", {}],
+	["spec", {}, ":unreader"],
+	["description", {},
+	    ["p", {}, "Go from reader view to web page."]]],
+
+    ["item", {},
+	["tags", {}, ":tr :togglereader"],
+	["strut", {}],
+	["spec", {}, ":togglereader"],
+	["description", {},
+	    ["p", {}, "Toggle reader view."],
+	    ["p", {},
+		"By default, this command is mapped to",
+		" the key combo ", ["str", {}, ["k", {name: "Leader"}], "r"],
+		":"],
+	    ["code", {},
+		["ex", {}, ":nmap"], " ", ["k", {name: "Leader"}],
+		"r ", ["ex", {}, ":togglereader"], ["k", {name: "CR"}]]]]];

pentaread.penta

@@ -0,0 +1,5 @@
+"Use the <Leader>r key combo to access the :togglereader command.
+nmap <Leader>r :togglereader<CR>
+
+
+" vim: set ft=pentadactyl