This is an old revision of the document!
Table of Contents
Faster DokuWiki Plugin
Compatible with DokuWiki
- 2020-07-29 "Hogfather" yes
- 2018-04-22 "Greebo" yes
- 2017-02-19 "Frusterick Manners" yes
- 2016-06-26 "Elenor Of Tsort" yes
This plugin is part of my effort to make the DokuWiki experience smoother and faster. It provides full-featured inline section editing, and dramatically speeds up editing, edit previews and page loads.
These settings are available in the DokuWiki administrative interface, under “Configuration Settings.”
Inline Section Editing
Setting name: secedit
When this feature is enabled, section editing happens inline. That is, the piece of the page you want to edit is replaced with the editor. If you also enable the preview setting, previews will appear inline as well.
This feature should be compatible with all templates, and all plugins except those that change section editing behavior. If you discover any incompatibilities, please report a bug.
If you are using the discussion plugin, be aware that the inline edit toolbar will have reduced functionality. This is due to the way discussion works.
Setting name: preview
When this setting is enabled, editor previews (including section edit previews) appear below the editor, without reloading the page. To make this work with section editing, enable secedit. To make it work with normal editing, enable fastpages.
This setting should be compatible with all templates and plugins.
Fast Mode Switch
Setting name: fastpages
When this setting is enabled, changing page modes – for example, from viewing a page to editing it, or from site index to revision history – happens without reloading the page. Only the center content area is changed, and there is a loading animation while the new content is being loaded.1)
Enabling this feature fixes a bug in DokuWiki. You will no longer get an “are you sure you want to leave” alert when all you did was move the cursor around in the editor. You have to actually change something. This feature also works with the tags plugin, which makes that plugin behave better with many templates than it does now.
This feature might not be compatible with all templates, and it won't work with any plugin which changes content outside the main content area.
Plugin compatibility issues
- CKGedit doesn't work with sectionedit: https://github.com/zioth/dokuwiki_fastwiki/issues/24
- CodeMirror doesn't work with sectionedit: https://github.com/zioth/dokuwiki_fastwiki/issues/18
- QNA has conflicts with header syntax: https://github.com/zioth/dokuwiki_fastwiki/issues/33
- edittable fixed on 2015-09-16: https://github.com/zioth/dokuwiki_fastwiki/issues/23
- hidden fixed on 2015-12-25.
- imgpaste fixed on 2017-11-25. https://github.com/zioth/dokuwiki_fastwiki/issues/22
- struct fixed on 2018-01-02. https://github.com/zioth/dokuwiki_fastwiki/issues/25
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 transitions from every supported mode to every other supported mode. For example, if your url includes “?do=edit” and you switch to “show” mode, the plugin will be invoked, loading the new page quickly.
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.
- starter, and templates based on it:
Templates with built-in support
- None yet.
Fast Edit Saves
Setting name: fastsave
When this feature is enabled, saving from the editor does not reload the page. To make it work with section editing, enable secedit. To make it work with the regular editor, enable fastpages.
This feature might not be compatible with all templates. The issues are the same as with the fastpages setting.
Fast ID Switch
Setting names: fastshow, fastshow_same_ns, fastshow_include, fastshow_exclude
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.
In some wikis, the sidebar, header or footer is namespace-specific. If this is the case for your wiki, enable this setting, so that the feature is only used when switching to another page in the same namespace.
Use this if you only want the feature to work in a comma-delimited list of namespaces and pages.
Use this if you want the feature to work everywhere but in a comma-delimited list of namespaces and pages. You can use this together with fastshow_include to exclude certain sub-namespaces of the fastshow_include list.
If your wiki uses the Discussion plugin or Disqus plugin, it should work fine, since the discussion is part of the main content area and thus reloaded with the page change. However, if your template inserts a comments section outside the main content area, it will not be updated on page change. You can update your comments section by hooking into this plugin's API (see Integrating Fastwiki).
Even Faster ID Switch!
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 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 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.
Default=10. This is the maximum number of pages which can be fetched by a single AJAX request. If there are more than this many links on the page, they will be requested in batches.
Default=100. This is the maximum number of new (previously uncached) links that will be loaded on a single page. If there are more than this many links on a page, no preloading will happen at all. The page is so heavily linked that it's unlikely we'll cache the right page.
Template/Plugin developers: Integrating Fastwiki
While this plugin does have specific initialization code for some templates, that's not really maintainable. Templates change, and template creators may have different ideas in mind than I do. Because of this, I've added an event-based API for templates. More Details...
Plugins don't usually require any special integration with Fastwiki, but if you notice any bugs, you might be able to fix them using the same API that template developers use.
Please let me know if you add support to your template.
Templates with 3rd party integration
Plugins with 3rd party integration
- Fixed #46 - edit not working sometimes. Caused by the fix to #44 (2021-10-15 17:01)
- Fixed #44: Editing the text under Chrome (Android) does not work (2021-10-04 21:16)
- Fixed #42 - internal link button not working (2021-07-04 20:10)
- Fixed #41: Link wizard bug. Improved compatibility with latest doku e… (2021-04-07 16:23)
- Fixed #40 by updating plugin version (2020-10-30 15:55)
- Fixed #39 - Weird Conflict: Fastwiki + Nice URLs + Dokubook Template … (2020-09-23 16:47)
- Fixed #38 - Page narrows when editor activates (2020-07-01 15:00)
- Merge branch 'master' of https://github.com/zioth/dokuwiki_fastwiki (2020-07-01 15:00)
Where can I see it in action?
You can try out the inline section editor at http://zioth.com/wiki/playground2 (username: demo. password: demo).
How do I make my template/plugin work with fastwiki?
Why don't I see the preload setting?
The deployment of PHP on your server has the curl library disabled.