====== TOC Plugin ======

---- plugin ----
description: Allows to move TOC to the specified place in the page content
author     : Andriy Lesyuk
email      : s-andy@in.if.ua
type       : syntax, action
lastupdate : 2009-04-13
compatible : Greebo, !Hogfather, !Jack Jackrum
depends    : 
conflicts  : 
similar    : tocselect
tags       : include, mediawiki, toc
downloadurl: http://projects.andriylesyuk.com/attachments/download/92/toc.tgz
----

===== Download and Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

  * [[http://projects.andriylesyuk.com/attachments/download/92/toc.tgz|toc.tgz]]
  * [[http://sw.ixo.ca/toc.tgz|toc.tgz]] (USA)
  * [[https://informatica.temuco.udelmar.cl/~lmachuca/files/dokuwiki/toc.tgz|toc.tgz]] (Chile) FIXME
  

===== What for? =====

Sometimes it happens that core TOC conflicts with some other elements placed in the top right corner (e.g. tags). In this case the only solution is to turn off TOC using ''%%~~NOTOC~~%%''. TOC plugin adds new syntax code ''%%~~TOC~~%%'' which can be used to move TOC inside page content (e.g. like it is done on Wikipedia).

see also http://projects.andriylesyuk.com/project/dokuwiki/toc

===== Known bugs =====

  * You can use ''%%~~TOC~~%%'' several times in page content. But other TOCs won't work well...
  * There is currently no way to disable the default location of the TOC without also disabling THIS one. In other words: You have 2 TOCs or none.

===== Issue tracker =====

Issues should be reported [[http://projects.andriylesyuk.com/projects/dokuwiki-toc/issues|here]].

===== Discussion =====

>Please include the toc folder into the tar file. If you uncompress the plugin into your DokuWiki plugins folder, then the default action.php, style.css, and syntax.php will be overwritten :-(. Most plugins include a directory with the same name containing all the code files.
Fixed, thanks and sorry!

> This TOC plugin works with DokuWiki 2013-12-08 "Binky", however style.css file needs to modify if you want to get mediawiki-like TOC box. --- [[user>s.sahara|s.sahara]] //2014/03/01 02:42//

> This TOC plugin does not work with "Igor". It generates an exception as follows:

''dokuwiki\Exception\FatalException: Declaration of action_plugin_toc::register(&$controller) must be compatible with dokuwiki\Extension\ActionPlugin::register(Doku_Event_Handler $controller)

An unforeseen error has occured. This is most likely a bug somewhere. It might be a problem in the toc plugin.

More info has been written to the DokuWiki error log.''