DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:fastwiki

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:fastwiki [2019-06-24 18:33] ziothplugin:fastwiki [2024-02-11 03:40] (current) zioth
Line 6: Line 6:
 email      : elifenton@this_is_not_a_real_email.fake email      : elifenton@this_is_not_a_real_email.fake
 type       : action, javascript type       : action, javascript
-lastupdate : 2017-11-05 +lastupdate : 2024-02-10 
-compatible : Hrun, Detritus, Elenor of Tsort, Frusterick Manners, Greebo+compatible : Hrun, Detritus, Elenor of Tsort, Frusterick Manners, Greebo, Hogfather, Igor, Jack Jackrum, Kaos
 depends    :  depends    : 
 conflicts  : ckgedit, codemirror, qna conflicts  : ckgedit, codemirror, qna
Line 72: Line 72:
 Templates have a variety of behavior when switching view modes. Some hide the sidebar in some modes. Some have links while others have buttons. I have made an effort to support many of the most popular templates. Feel free to request others, if you find that your favorite template doesn't behave correctly. Templates have a variety of behavior when switching view modes. Some hide the sidebar in some modes. Some have links while others have buttons. I have made an effort to support many of the most popular templates. Feel free to request others, if you find that your favorite template doesn't behave correctly.
  
-These templates support all functionality. That means that if you end up in some other mode (for example, by manually adding ?do=edit to the url)DokuWiki will still be super-fastreplacing content with AJAX requests.+These templates support transitions from every supported mode to every other supported mode. For example, if your url includes "?do=edit" and you switch to "show" modethe plugin will be invokedloading the new page quickly.
  
   * [[template:prsnl10|prsnl10]]   * [[template:prsnl10|prsnl10]]
   * [[template:vector|vector]]   * [[template:vector|vector]]
  
-These templates support all functionality from the "show" page. If you manually change the page, or reach another page through some unsupported link, the plugin will be disabled.+These templates load all transitions quickly, provided that you start in "show" mode. If your url includes "?do=edit" or other action, the plugin will be disabled.
  
   * [[template:starter|starter]], and templates based on it:   * [[template:starter|starter]], and templates based on it:
Line 86: Line 86:
   * [[template:scanlines|scanlines]]   * [[template:scanlines|scanlines]]
   * [[template:bootstrap3]]   * [[template:bootstrap3]]
 +  * [[template:dokubook]]
  
  
Line 105: Line 106:
  
 When this feature is enabled, entirely new pages load without reloading the page. For example, switching from a:b:c to a:b:d will not reload. However, the page will reload if there is an ACL difference between the two pages. That is, if you have the right to edit the current page but not the next page, the whole page will reload. When this feature is enabled, entirely new pages load without reloading the page. For example, switching from a:b:c to a:b:d will not reload. However, the page will reload if there is an ACL difference between the two pages. That is, if you have the right to edit the current page but not the next page, the whole page will reload.
 +
 +If anything other than the main page content changes when you switch pages, do not enable this setting (but see the other fastshow settings for how to limit it). For example, if the sidebar has page-specific content, that content will _not_ be reloaded on a page transition.
  
 The browser history will reflect the page change. Since Microsoft Internet Explorer 9 and below can't manipulate browser history, those browsers are automatically excluded from this feature. The browser history will reflect the page change. Since Microsoft Internet Explorer 9 and below can't manipulate browser history, those browsers are automatically excluded from this feature.
Line 127: Line 130:
 //Setting names: preload, preload_batchsize, preload_per_page// //Setting names: preload, preload_batchsize, preload_per_page//
  
-Want a super speed boost? Enable this experimental feature (along with //fastshow//) to pre-load links on the page. By the time the user clicks on a link, it may already be loaded, resulting in an instantaneous page switch. Pre-loads are remembered when you switch pages (within the limitations of //fastshow// settings), so for a heavily linked wiki, the site will get faster the longer you stay on it.+Want a super speed boost? Enable this experimental feature (along with //fastshow//) to pre-load links on the page. By the time the user clicks on a link, it may already be loaded, resulting in an instantaneous page switch. Pre-loads are remembered when you switch pages (within the limitations of //fastshow// settings), so for a heavily linked wiki, the site will get faster the more you use it.
  
 Warning: This feature will significantly increase network usage. A typical wiki might require 500kb for the first page loaded and 50kb for each subsequent page. With this setting enabled, you'll load an additional 5-20kb per link on the page. If you average 30 links a page (including sidebars), that's 320kb per page instead of just 50kb. Note that the additional size will not affect page load time; preloads don't happen until after the page is loaded. Warning: This feature will significantly increase network usage. A typical wiki might require 500kb for the first page loaded and 50kb for each subsequent page. With this setting enabled, you'll load an additional 5-20kb per link on the page. If you average 30 links a page (including sidebars), that's 320kb per page instead of just 50kb. Note that the additional size will not affect page load time; preloads don't happen until after the page is loaded.
  
-Warning: This feature will break page-count statistics. If you keep track of how many users visit each page, do not enable this feature. The exception is if the page counter is in the main wiki content.+Warning: This feature will break page-count statistics. If you keep track of how many users visit each page, do not enable this feature.
  
-Support for this feature is the same as for //fastshow.// **Note:** This feature will only be available if your php installation includes the curl library.+Support for this feature is the same as for //fastshow.// 
 + 
 +**Note:** This feature will only be available if your php installation includes the curl library.
  
 === Setting: preload_batchsize === === Setting: preload_batchsize ===
Line 151: Line 156:
  
 Please let me know if you add support to your template. Please let me know if you add support to your template.
 +
 +==Templates with 3rd party integration==
 +  * [[template:sprintdoc]]
 +
 +==Plugins with 3rd party integration==
 +  * [[plugin:dropfiles]]
 +  * [[plugin:struct]]
 +  * [[plugin:imgpaste]]
  
  
Line 170: Line 183:
  
 ==Where can I see it in action?== ==Where can I see it in action?==
-My site doesn't have open registration, but you can try http://zioth.com/wiki/playground2 (username: demo. password: demo) to see the inline editors. Only that one page is open.+You can try out the inline section editor at https://zioth.com/wiki/playground2 (username: demo. password: demo).
  
 ==How do I make my template/plugin work with fastwiki?== ==How do I make my template/plugin work with fastwiki?==
Line 181: Line 194:
 ===== Discussion ===== ===== Discussion =====
  
 +Hey Zioth was hoping to get ahold of you about some of your WRAP plugin extentions. Is there any way I can reach you? Thanks!
 +
 +Sure! You can reach me through my github page: https://github.com/zioth/contactme
plugin/fastwiki.1561394013.txt.gz · Last modified: 2019-06-24 18:33 by zioth

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki