====== indexeverywhere Plugin ======

---- plugin ----
description: Adds the index to any page/sidebar
author     : Sascha Zantis 
email      : sascha.zantis@gmail.com 
type       : syntax
lastupdate : 2014-09-10
compatible : Ponder Stibbons, Frusterick Manners, !Hogfather
tags       : index, navigation, !broken
similar    : indexmenu

downloadurl: https://www.dropbox.com/s/os2ug0djjhdy5hm/indexeverywhere.zip?dl=1

----

===== Installation =====

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

===== Examples/Usage =====

Just put <code>~~INDEXEVERYWHERE~~</code> whereever you want the page you know from ?do=index without the

>**Sitemap**
>
>This is a sitemap over all available pages ordered by namespaces." text.

I created this plugin to use it in a [[config:sidebar|sidebar]] as main navigation tree.

Hint: You should also add <code>~~NOCACHE~~</code> wherever you use this.
===== Syntax =====

<code>~~INDEXEVERYWHERE~~</code>

===== Configuration and Settings =====

No configuration. For better styling access, the tree has the same id as the index itself ("#index__tree") and also the class indexeverywhere. I will look if the ID can cause issues and add a style.css if needed in the future.

===== Development =====

Should be compatible to any possible version, I created and tested it under Ponder Stibbons

=== Change Log ===

  * **2014-09-10**
    * Initial release

=== Known Bugs and Issues ===

None yet, please use github for issues




===== FAQ =====

Didn't hear any questions yet.

I found this plugin very useful as a quick way to get a Sitemap.  But a client had multiple-word file names and namespaces.  This removed the underscores so that the names could be wrapped on more than one line in a sidebar; otherwise they are broken by length based on the width of the sidebar.
<code php>
        $index = preg_replace_callback(
        "/>\s*([\w_]+)(?!\")\s*<\/a>/ms",
        create_function(
            '$matches',
              'return ">".str_replace("_"," ",$matches[1]) ."</a>";'
         ), $index);
 
       $index = preg_replace_callback(
       "/<(strong|b)>(.*?)<\/(strong|b)>/ms",
        create_function(
          '$matches',
          'return str_replace("_"," ",$matches[0]);'
        ),$index);       
 </code>      

====  The sitemap in sidebar can start from specific Namespace? ====