sectiontoggle Plugin

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

This plugin converts DokuWiki headers into toggles which open and close the sections immediately below them.

The plugin will work out of the box with any template without any need for configuration. However, configuring the plugin as described in the section on Configuring for Mobile Devices may be useful for efficiency.¹⁾ A group of the most suitable templates for phones come pre-configured in the file templates.ini. You can also configure using the Configuration Manager.

When installed, the sections will initially be closed, except as described below under #Auto-Toggling. Clicking on a header will open the section immediately below the header. Clicking on it again will close the section. Using the two buttons described below, the user can open and close all the sections with a single click.

There are two situations where a toggled section will remain open when a page loads. This enables you to link to a section of a page and that section will be open when the page loads.

1. When the url accessing the page contains a hash element referencing a page section. For instance: [[wiki:dokuwiki#read_more]]. This link will go to the read more section of the page and the section will be open and ready for reading.
2. When the h_ini_open option is set. For instance:
   Welcome to your new DokuWiki;;DokuWiki Intro;;Read More.
   With this setting, when wiki:dokuwiki loads, two sections will remain open: DokuWiki Intro and Read More and when wiki:welcome loads the topmost Welcome to your new DokuWiki will be open.

The Dokuwiki table of contents also benefits from auto toggling. That is, when you click on a heading in the table of contents, not only will the page be directed to the heading, but the section will toggle open.

Headers without any text content below them will not be active and will not show the right arrow icon. They will simply be standard headers and not toggles. In addition, in the Configuration Manager, you can choose to prevent selected headers from being toggled, as in the sample page below. There the End of Page header is an h5, which is excluded from being toggled by the headers configuration option.

As an alternative to the traditional sidebar syntax for open and close buttons, this plugin now offers a more convenient option. Users can opt to use a toggle button located directly in the action menu of the page.

This feature enhances user experience by providing a streamlined and accessible way to control section visibility without the need for additional syntax.

To enable the action menu button:

1. Navigate to the plugin configuration settings.
2. Locate the option labeled “Show Section Toggle Button”.
3. Enable this option to display the toggle button in the action menu.

Note: Enabling this feature will replace the need for sidebar syntax for opening and closing sections. Users can still use the traditional method if preferred.

Inserting the following into the page will create two buttons, one which will open all the sections with one click and one which will close them:

~~stoggle_buttons~~

These buttons will be hidden if toggling is disabled using the suspend option, as described below under Configuration.

The following two macros will mark the start and end of an enclosing DIV within which headers will be converted to toggles. Headers elsewhere on the page will not have toggles attached to them.

  ~~stoggle_openDIV~~
  ~~stoggle_closeDIV~~

These should not cross DIV boundaries. I.E.

  DIV 1
  DIV section__toggle
  Div 1 closed
  DIV section__toggle closed.     

• Platform
  • all: section toggling will appear on all platforms, mobile and standard desktop systems
  • mobile : mobile only, desktops are excluded
  • none : toggling is disabled on all platforms.
• Name and Type
  • The type is either an id or a class, and the name is the id or class name of the divs which govern the headers. If you are using the DokuWiki template or one of the templates listed in templates.ini, the plugin automatically detects the template and will use the appropriate settings. In the case of the templates.ini file, type must be set to none or the file will be ignored.
• Headers and xcl_headers
  • The headers option selects the smallest header to be converted to a toggle. If you choose h6, all headers between h1 and h6 will be converted to toggles. You can, however, use the xcl_headers setting to omit selected headers from being converted to toggles. In this case, the section below the header will remain permanently visible.
• mobile_alt
  • When platform is set to all or mobile, this option enables you to switch to an alternate template that supports phones, in the event that your preferred template does not. If your preferred template does support phones, then set this option to blank. A check is made to insure that that alternate template is correctly installed, and if not the main template is used.
• tablet_alt
  • If set to true the mobile_alt template will be used for tablets.
• start_open
  • This option will not apply to mobile devices or to logged in users without edit permission.

When the toggle buttons are included on a page, they will not display if the platform is excluded from section toggling. So, if you want toggling only on mobile devices, you can still include these buttons on your page but they will not display on standard desktop systems.

When the DokuWiki template is in use, this plugin uses the template's platform recognition facility. For other templates, it uses the Mobile_Detect class from http://mobiledetect.net. You can go to that site to update the detection software. Currently, we are at version 2.8.33.²⁾

The example below is for manual configuration, using the plugin's options. Most templates from Weatherwax on which are usable with phones are pre-configured in templates.ini. That is, like the current dokuwiki template, they have been designed to accommodate the smaller sizes of phones. What works with a phone will work with a tablet. But there are quite a few templates which will not work with phones that do work on tablets.

The default template, which was the template that preceded the dokuwiki template, contains the following structure:

<div class="page">
  <!-- wikipage start -->
  <?php tpl_content()?>
  <!-- wikipage stop -->
</div>

The wiki page is included in the div which is defined by the class named page. To use this template, then, you would set type to class and name to page.

If you are using the dokuwiki template, the default settings for type and name will take precedence over these configuration settings, as they are hard-coded into the plugin. If you want to use the dokuwiki template with changes to its structure, then you must give it a different template name.

The plugin comes with a group of preconfigured templates. If your template is one of these, then it will work right out of the box and your plugin will read the type and name configuration values from an ini file named templates.ini, which is found in the root directory of the plugin. For this to work, the type option must be set to none in the sectiontoggle section of the Configuration Manager. This is only an issue if you have already used the Configuration Manager to set up the plugin for another template, since the plugin comes with type already set to none.

1. 20cones
2. adoradark
3. arctictut
4. bootstrap3
5. dokucms
6. flat
7. greensteel
8. kajukkk
9. minima
10. monochrome
11. prsnl10
12. sprintdoc
13. twentyfifteen
14. wallpaper
15. white
16. writr

These templates have been chosen for usability and popularity, covering a period of six years to seven years–Greebo through Weatherwax compatibles. Some popular templates like monobook are not suitable for phones and so have been omitted from this list. And some nice templates do not work as alternates, i.e. as mobile_alt, because they haven't been kept up-to-date. No doubt there are good early templates that can still be used. So, this list may grow, as more templates are tested. If you would like to have an entry added to the the ini file, open an issue on github. In the meantime you can add your choice to plugins/sectiontoggle/templates.ini.local³⁾, since additions to templates.ini may be overwritten on upgrades. The format for an entry in templates.ini.local is:

  [[template name]]
  type = id or class
  name = id or class name

Or, you can configure your template manually, as shown in the example.