Differences

This shows you the differences between two versions of the page.

--- plugin:instantpage [2019-03-03 01:26] – created grosse
+++ plugin:instantpage [2022-02-04 18:16] (current) – grosse
@@ Line 1: / Line 1: @@
-====== structsection Plugin ======
+====== instant.page Plugin ======
 ---- plugin ----
@@ Line 6: / Line 6: @@
 email      : mic.grosse+dokuwiki@googlemail.com
 type       : action
-lastupdate : 2019-03-03
+lastupdate : 2022-02-04
 compatible : Greebo
 depends    :
 conflicts  :
 similar    : fastwiki
-tags       :
+tags       : performance
 downloadurl: https://github.com/micgro42/dokuwiki-plugin-instantpage/zipball/master
@@ Line 26: / Line 26: @@
-===== Usage =====
+===== How it works =====
-This plugin prefetches a page when hovering over a link. Since it usually takes several hundred milliseconds to click on a link, this results in a significant faster experience.
+This plugin prefetches a page when hovering over a link. Since it usually takes several hundred milliseconds to click on a link, this results in a significant faster experience. Internally, it uses the script provided by [[https://instant.page/]].
+==== Limitations ====
+  * :!: This plugin doesn't work well with DokuWiki's [[:breadcrumbs|tracking breadcrumbs]]. It adds every preloaded page to that list of breadcrumbs. This is unfortunately unavoidable. I suggest using the hierarchical breadcrumbs instead. :!:
+  * There were reports that on **IE11**((If you are running a system where IE11 is the most advanced browser available, you are doing it wrong.)) there are some incompatibilities with the plugins [[plugin:IndexMenu]] and [[plugin:Newsticker]]? Reportedly, it is fine with other browsers. I cannot reproduce this.
+  * So far it works on Firefox, Chrome and Opera. It is supposed to work on IE11/Edge, however, I've been unable to verify that since I don't run Windows anymore. [[https://caniuse.com/#feat=link-rel-prefetch|Safari]] apparently refuses to implement that API 🤦‍
+  * It should work only on links to viewing other wikipages. It is disabled for all other modes, esp. edit-mode to prevent accidentally locking a page.
+  * It is also disabled for external pages.
 ===== Development =====
-=== Change Log ===
+==== Events ====
-{{rss>https://github.com/micgro42/dokuwiki-plugin-instantpage/commits/develop.atom date}}
+  * [[devel:event:ACTION_HEADERS_SEND]] -- used to allow short-term caching of the preloaded pages
+  * [[devel:event:TPL_METAHEADER_OUTPUT]] -- used fetch the instant.page script
+==== Change Log ====
+{{rss>https://github.com/micgro42/dokuwiki-plugin-instantpage/commits/master.atom date}}
 **Releases:**
 {{rss>https://github.com/micgro42/dokuwiki-plugin-instantpage/releases.atom description author}}