====== Indexmenu plugin ====== ---- plugin ---- description: Show a customizable and sortable index for a namespace. author : Samuele Tognini email : samuele@netsons.org type : syntax lastupdate : 2008-04-12 compatible : 2006-03-09, 2006-11-06, 2007-06-26, 2007-06-26b, rc2008-04-11 depends : conflicts : indexmenu2 similar : indexmenu2, alphaindex tags : tree, menu, index ---- This [[plugin]] allows you to insert a customizable index or a list of pages starting from a specified namespace. It should be useful in Dokuwiki sites where pages are organized by [[:namespaces]]. Main features are: * Customizable javascript themes. * Sortable by date,title and metadata infos. * Ajax support in order to speed it up in sites with many pages. * Customizable [[.:indexmenu#The context menu|context mouse menu]] for common page actions. * Toc pages preview. * Hide namespaces/pages according to your site [[acls]] settings. More info at the [[.:indexmenu#Acl Cache]] section. {{http://samuele.netsons.org/dokuwiki/media/indexmenu1.jpg}} {{http://samuele.netsons.org/dokuwiki/media/indexmenu2.jpg}} * You can try it [[http://samuele.netsons.org/dokuwiki/doku.php?id=playground:playground|here]]. * Thanks to Geir Landrö and his javascript [[http://www.destroydrop.com/javascripts/tree/|dTree]] menu. * Thanks also to Roland Hellebart and his [[.:tree]] plugin for the dTree idea. * **MANY MANY thanks to indexmenu users**, the most useful work is done by them (look at the [[.:indexmenu:discussion]] page). * Feel free to improve it. ====== Syntax ====== Arguments inside "[]" parenthesis are optional: {{indexmenu>[namespace[#n]] [ns1[#n] ... nsn[#n]] | [js[#theme]] [tsort] ...}} Settings before the "|" separator: ^Option ^Action ^Comment| ^ //''namespace''// | Main namespace name. Index starts from it. | Optional with //**n**// or //**nons**//; "**.**" is the current namespace; ".." or an empty value shows the root site namespace; ".:ns1" is the ns1 namespace inside current namespace. | ^ //''n''// | Number that specifies, in //**js** mode//, the tree level to open, while, in nojs mode, it is the max level to show.| Optional; it can be used together with //**nons**//. Not defined opens all nodes, whereas equal to ''0'' or ''1'' closes them.| ^ //''ns1[#n] %%...%% nsn[#n]''// | A list of optional namespaces inside main //**namespace**//. Every namespace will be opened or closed at the specified //**n**// level. | Optional. It can be used together with //**nons**//. Not defined **n** opens all nodes, whereas equal to ''0'' closes them.| Settings after the "|" separator: ^Option ^Action ^Notes| ^ ''js'' | Javascript render method: the index is an expandable tree menu. | Optional; without //**n**//, all nodes are open, with it, nodes are open till //**n**// level.| ^ ''nons'' | Exclude namespaces nodes from index. It shows only the pages. | Optional. | ^ ''nopg'' | Exclude pages nodes from index. It shows only the namespaces. | Optional. | ^ ''tsort'' | Sort pages by title. | Useful when [[config:useheading]] is on. Optional.| ^ ''dsort'' | Sort pages by date creation. | Optional.| ^ ''msort[#meta]'' | Sort pages by a custom [[:metadata]] information. Without the optional **meta** parameter, it'll be used the custom sorting number specified with the %%{{indexmenu_n>N}}%% syntax (read below for more info). **meta** should refer to the [[:metadata#data structure]] (Array values are managed throught the ":" separator, for example: "msort#date:modified). |You can use the tsort/dsort option togheter with msort in order to sort pages without metadata tag in a different way from the default Dokuwiki one (sorted by page name). Optional.| ^ ''rsort'' | Reverse the sorting of pages. | Optional.| ^ ''nsort'' | Sort also namespaces according to the previous sort options. | Optional.| ^ ''max#n//[#m]//'' | The node at //**n**// level will retrive all its childs nodes through the ajax mechanism. Optionally, instead of retrive them in one time, it can retrives them with ajax every //**m**// sublevels.| Optional. Cookie are automatically disabled, just like with //**noocookie**//. It affects the server loading and speeds up the loading of page in dokuwikis with an high amount of pages. It works only in //**js**// | ^ ''navbar'' | The tree opens itself automatically at the current page namespace. It's good as navigation sidebar.| **ATTENTION**: It also sets ''id=1'', therefore use only one navbar indexmenu in you site or set manually different //**id**// for other navbar trees. It works only in //**js**// | ^ //''theme''// | Theme name for indexmenu icons | A theme is a set of icons inside ''images'' directory as described in [[.:indexmenu#Theme tutorial]]. Admins can download and share themes in admin panel. It works only in //**js**// | ^ ''id[#random|//n//]'' | Cookie id for a js indexmenu. By default is ''random'', but you can force it to be a //**n**// fixed number ( i.e ''id#20'' ).| Useful only when you need two or more navbar tree or when a page is uncached and you don't use the //**nocookie**// option. Read the [[.:indexmenu#Js does not remember its prevous state]] section. **ATTENTION:** id must be unique for every indexmenu in your dokuwiki site or you'll get strange js behaviors. It works only in //**js**// | ^ ''maxjs#//n//'' | It sets how many js tree levels to render when page loads. Remaining nodes are rendered (slightly slower) only when they are open by users, by //**optional namespaces**// option, by cookies or by //**navbar**// option. | Default //**n**// is 1 so that it will speed up the page loading, above all with an high amount of pages. It affects only the user-client cpu speed, not the webserver load. It works only in //**js**// | ^ ''nocookie'' | By default js indexmenu remember selected,open and closed nodes by user during navigation. With this option it doesn't remember them and the tree is blocked to its start status. | It works only in //**js**//| ^ ''noscroll'' | Disable the javascript scrolling feature. It could solve visualization problems. | It works only in //**js**//| ^ ''notoc'' | Disable the toc-preview feature. | It works only in //**js**//| ===== Metadata tag syntax ===== By default nodes are sorted by page name (or by title/date if you use the tsort/dsort syntax), but you can also specify a custom sort number for every page inserting a metadata tag in the pages with this syntax: {{indexmenu_n>N}} Where N is a number. Then you need to use the "msort" option in your indexmenu tree syntax. For example you can change the order of this tree: -Root |_Don |_Van |_Vliet in this way: -Root |_Vliet {{indexmenu_n>1}} |_Van {{indexmenu_n>2}} |_Don {{indexmenu_n>3}} Pages without metadata information are sorted by page name if you don't use the tsort or dsort option in this way: {{indexmenu>..#1|tsort msort}} ===== Examples ===== A sample of an indexmenu that could be used inside a navigation sidebar.Its initial status is blocked by the nocookie option, so, when the page is reloaded, it doesn't remember the open and closed nodes by the user.: {{indexmenu>..#1|js navbar nocookie}} Sample navigation bar where nodes after the third level are retrived with ajax every 2 sublevels: {{indexmenu>..#1|js navbar max#3#2}} Standard Dokuwiki index showing only pages inside wiki:plugins and lower namespaces (max two levels): {{indexmenu>wiki:plugins#2|nons}} ====== How to install ====== :!: On 2003-09-03 Dokuwiki, before upgrading indexmenu through [[plugin:plugin|plugin manager]] be sure to update the download link, because new indexmenu will not work on the old dokuwiki. |Download the [[http://samuele.netsons.org/dokuwiki/media/indexmenu.zip|zip]] file and unpack it into ''lib/plugins'' folder or use the [[plugin:plugin]] manager.| |Mirror link: http://Xxoomer.alice.it/satogni/misc/indexmenu.zip (Remove the first X).| ===== Development ===== Development release contains features and bug fixes that will be in next public release and it should be used for [[:development]] purposes. Unlike the stable release, included Javascript files are not compacted so the network load is a little bit higher. Even it should work concerning indexmenu main features, use it only on a test enviroment or after a backup of your site data. My [[http://samuele.netsons.org/dokuwiki|site]] is always based on this release. The version returned by the development release is always the same of the stable one so upgrading from stable to development with plugin manager does not work. Before installing the development release be sure to have first manaually deleted the old indexmenu directory. Also be sure that, as last step, server/client cache is purged following 4 and 5 of the [[.:indexmenu#the_tree_is_not_displayed]] section. [[http://samuele.netsons.org/darcs/indexmenu/indexmenu.tar.gz]] ==== Darcs ==== If you're interested, there's also an indexmenu [[devel:darcs]] repository. darcs get --partial http://samuele.netsons.org/darcs/indexmenu To create a patch, go in your downloaded indexmenu directory and: #Check for new patches and install them: darcs pull #Modify source files creating your own patch and record it with: darcs record #Send the patch to me via mail: darcs send ===== Dokuwiki 2003-09-03 ===== |:!: This version will'not be upgraded anymore.| Indexmenu v2.7 compatible with old 2003-09-03 Dokuwiki version. Download the [[http://samuele.netsons.org/dokuwiki/media/indexmenu-2.7-2003-09-03.zip|2003-09-03 zip]] file and unpack it into ''lib/plugins'' folder or use the [[plugin:plugin]] manager. [[http://samuele.netsons.org/dokuwiki/doku.php?id=dokuwiki:plugins:indexmenu#old_versions|Old versions]] ===== Manually install ===== Create the folder ''indexmenu'' in dokuwiki ''/lib/plugins'' directory ((Be sure it is readable by web server user.))and refer to the [[http://samuele.netsons.org/dokuwiki/doku.php?id=dokuwiki:plugins:indexmenu|Indexmenu source code]] for files to create. Create the ''indexmenu'' subdirectories ''images/default'' and put inside it the icons set at [[http://www.destroydrop.com/javascripts/tree/img/|Dtree]] site and create the lacking ones following the [[.:indexmenu#Theme tutorial]] scheme. ====== Configuration ====== Indexmenu is fully configurable from [[plugin:config|Configuration Manager]]. Indexmenu compatible with old [[.:indexmenu#Dokuwiki 2003-09-03]] needs to be configured through ''/conf/local.php'' configuration file (values are explained below). ===== Namespaces title and link ===== First of all, if you want that the tree displays the heading title of pages instead of the their name, you need to set the [[config:useheading]] on. Then, with the ''headpage'' global option, you'll be able to set from wich pages retrive titles. Every namespace will retrive its title from the heading title of a page, called headpage, and will be linked directly to it. You can choose a name for the page from which retrive the title or use a special value: ^Value ^Page ^Example ^ |**any value** | The page inside the namespace | public(ns):myvalue(page) | |**:inside:** | a page with the same name of namespace, beneath the namespace | public(ns):public(page) | |**:same:** | a page with the same name of namespace, at the same level of the namespace | public(page) <=> public(ns) | |**:start:** | the global [[config:startpage|start]] page name inside the namespace| public(ns):start(page) | You can specify more than one option using "," as separator. For every namespace, every value will be checked till the first existent headpage is founded. ''/conf/local.php'' for [[.:indexmenu#Dokuwiki 2003-09-03]]: //it will check first for pub(ns)=pub(page), then pub:jack, than pub:conf_start. $conf['plugin_indexmenu']['headpage']=":same:,jack,:start:"; To get a better visualization you could use the ''hide_headpage'' option, that hides headpages in the rendered indexmenu tree. ''/conf/local.php'' for [[.:indexmenu#Dokuwiki 2003-09-03]]: $conf['plugin_indexmenu']['hide_headpage']=true; ===== Acl Cache ===== Optimize the cache of indexmenu according to acls. More info [[.:indexmenu#about acls]] can also help. The choice of the method affects only the visualization of nodes on the indexmenu tree, not the page authorizations. The **Groups** option is the default setting. * **None**: Standard. It is the faster method and it does not create further cache files, but the nodes with denied permission could be showed to no-authorized users or viceversa. Recommended when you don't deny pages access by acl or you don't care how the tree is displayed or you use the %%~~NOCACHE~~%% syntax in the indexmenu page. * **User**: Per-User login. Slower method and it creates a lot of cache files (depending on the amount of your DW site users, so for sites with few users it's not a problem), but it always hides correctly denied pages. Recommended when you have page acls that depend on users login. * **Groups**: Per-groups membership. Good compromise between the previous methods, but in case that you deny pages read acl to a single user login, he could anyway displays that nodes in the tree. Recommended when your whole site acls depend on groups membership. ===== Replace index ===== A page that will replace the main dokuwiki index. Create it and insert the indexmenu syntax. Use id#random in indexmenu options if you already have an indexmenu sidebar with navbar option. My suggestion is: {{indexmenu>..|js navbar nocookie id#random}} ===== Skip Index ===== You can skip namespaces through the ''skip_index'' option. A namespaces full path has to be declared as a file system path (i.e: "mydir/mysubdir"). It supports Regular Expression. There are also some issues [[.:indexmenu#About empty namespaces]] that should be readed. ''/conf/local.php'' for [[.:indexmenu#Dokuwiki 2003-09-03]]: //It will skip any discussion,wiki or playground namespace. $conf['plugin_indexmenu']['skip_index']="/\/(discussion|wiki|playground)(\.\w+)?$/i"; ===== Skip Files ===== With the ''skip_file'' option you can skip also pages. Pages are checked as dokuwiki text files (i.e: start.txt). A page full path have to be declared as a file system path (i.e: "mydir/start.txt"). It supports Regular Expression. There are also some issues [[.:indexmenu#About empty namespaces]] that should be readed. ''/conf/local.php'' for [[.:indexmenu#Dokuwiki 2003-09-03]]: //It will skip any copyright or navigation page. $conf['plugin_indexmenu']['skip_file']="/(copyright|navigation)/i"; :!: I installed the latest version (Dokuwiki 2007-06-26b) and was not able to 'skip files'. The correct code is // in /conf/local.php $conf['plugin']['indexmenu']['skip_file'] = '/(copyright|navigation|syntax|site|dokuwiki)/i'; >You're right, but that note is for the old 2003-09-03 DW. Last DW has got a setting manager interface that simplifies the manual code adding. ===== Empty message ===== :!: From 3.1 release, message supports the wiki syntax, so it's fully customizable. Don't use html code. You can show a custom message in place of the menu tree if it can not be rendered (i.e namespace doesn't exist): ''/conf/local.php'' for [[.:indexmenu#Dokuwiki 2003-09-03]]: $conf['plugin_indexmenu']['empty_msg']="Sorry,no menu for {{ns}}"; //write your message here **//%%{{ns}}%%//** is an alias for the requested namespace. One useful empty message is $conf['plugin_indexmenu']['empty_msg']="
" This makes the empty indexmenu look like a list (and therefore look closer in style to non-empty indexmenus). ===== Deny indexmenu to no-admins ===== It prevents no-admin users to insert indexmenu trees, removing every indexmenu syntax in the page. It affects only the edit mode, so that no-admin users are still able to view indexmenu tree in a page edited by admins. ===== Other options ===== You can install new icon themes for javascript indexmenu, share your own theme and check for plugin updates in the admin panel. ====== Javascript themes ====== The javascript tree menu is based on [[http://www.destroydrop.com/javascripts/tree/|dTree]] code and is called with the //**js**// option. without //**theme**// option, javascript indexmenu will use the default theme. Inside the Admin panel there is the option to download js themes from my site, and to share your own themes, sending them to me. To download themes directly into your dokuwiki server, you need that indexmenu images directory is writeable by web user. Anyway, you can download themes into your pc form the ''download'' link, and then install manually. ===== Theme tutorial ===== You can create custom themes for every index rendered with the [[http://www.destroydrop.com/javascripts/tree/|dTree]] menu. Simply create a subdirectory, for example ''mytheme'', inside ''indexmenu/images''. Put inside it your icons following the ''default'' theme scheme. Main icons are: ^Icon ^Type ^ |base.gif|Root Folder | |folderopen.gif|Open folder without url link| |folder.gif|Closed folder without url link| |folderhopen.gif|Open folder with url link (headpage)| |folderh.gif|Closed folder with url link (headpage)| |page.gif|Page| Other secondary but needed icons are: ^Icon ^ |plus.gif| |minus.gif| |nolines_plus.gif| |nolines_minus.gif| |minusbottom.gif| |plusbottom.gif| |join.gif| |joinbottom.gif| |line.gif| |empty.gif| Use your theme with //**js#mytheme**// syntax. You can also customize a theme style by creating its [[.:indexmenu#Custom theme css style|own style]]. The default icons file format is gif, but png and jpg are also recongnized. To use them in place of gif, you have to name your theme directory with the appropriate image extension. For example: Mytheme.png/base.png. ===== The context menu ===== An action menu is displayed when using the context mouse menu click (the right one in many cases). On Opera you can use the CTRL+left click to display it. When in editing mode, by default an "Insert as DWlink" item menu is added to the menu in order to insert the node Dokuwiki link in your editing box. A different context menu is loaded depending on anonymous, authenticated or admin users. You can fully customize those menus by editing these files in the 'the indexmenu/jsmenu' directory: ^File ^Loaded by^ |"menu.js" |anonymous user| |"usrmenu.js" |authenticated user| |"admmenu.js" |admin user((see [[config:superuser]]))| To prevent to load the context menu, simply remove the indexmenu_contextmenu variable declared in the above menu files. **How to write utf8 chars, like èåäö, in the context menu file?** A solution is to encode them yourself: Find your char at http://unicode.coeurlumiere.com, replace the last zero of the left code by the character in the upper row and prepend the result with \u : ie \u00E3 for 'ã' ====== Css Style ====== You can edit the [[http://samuele.netsons.org/dokuwiki/doku.php?id=dokuwiki:plugins:indexmenu:source:style|style.css]] in order to globally customizing the tree menus style. Some styles are: ^Tag ^Comment ^Mode ^ |a.nodeFdUrl|Namespace with url link (headpage)|js| |a.node |Namespace without url link|js| |a.nodeUrl|Page|js| |a.nodeSel |Previuos selected page or headpage highlight|js| |a.navSel |Current page highlight|js| |a.indexmenu_idx_head|link style of a namespace with url (headpage)|nojs| |a.indexmenu_idx|link style of a namespace without url|nojs| |.indexmenu_arrow| The scrolling arrow area|js| |.indexmenu_toc| The toc-preview area|js| ===== Custom theme css style ===== If you want to apply a different style from the global one to a js theme, you need to create a style.css file like this inside the theme directory you want customize and use its name as subclass. /*Custom style for the thread theme*/ .dtree .thread{ font-family: Comic Sans MS; } .dtree .thread a.navSel { background-color: #000; color: #fff } ====== Faq and Notes ====== ===== How to get rid of the 'Indexmenu sort number' info blob? ===== I'm trying to use the ''msort'' feature of indexmenu and it is working as expected except for one side-effect: on any page where the ''{indexmenu_n}}'' option is defined I see a blue "Info" bar with something like "Indexmenu sort number: 2" at the top of the wiki page. The browser is Mozilla Firefox 2.0.0.12. The problem does not occur on IE 6. Also it doesn't appear on the latest version you've got installed on the test site. FYI I'm using dokuwiki version 2007-06-26b with Monobook 07202007 template. I've tried [en|dis]abling debugging using ''$conf['allowdebug'] = 0;'' to no avail. Any suggestions? --- SSMC Feb-18-2008 > Sorry, but i forgot to add its explanation in this wiki. The sort message is displayed **only** to wiki admins and it's useful to check your pages order. Anyway, you can disable it also for admins by unchecking the indexmenu show_sort option in the [[plugin:config|Configuration manager]]. --- //[[samuele@netsons.org|Samuele Tognini]] 2008-02-18 19:30// >> Thanks! That explains the on-again-off-again observations using different ids. I didn't make the connection though as I have some local browsers with auto-login as an admin for working. Thanks again. --- SSMC ===== Way to Set Different Defaults for Common Parameters ===== These new sort options (tsort, msort, nsort) are fantastic! Just wondering if there is a way to change the defaults, so that if nothing else is specified, a certain set of sort parameters are used automatically. For example, we have a wiki where we will **always** use the msort tsort nsort options together (in every instance of indexmenu). So instead of defining something like: {{indexmenu>.|msort tsort nsort}} 100 times, we could just say: {{indexmenu>.}} This would make things easier for rookie editors, and ensure consistency. Just curious if it's feasible in some way. Cheers! ---//[[ryan.jake@gmail.com|Ryan Jacobs]] 2008-03-01// > Currently there is no way to set these defaults. To force them (but then there will be no way to unset them), you should hack the 'syntax/indexmenu.php' handle function: $match = substr($match,12,-2); + $match .= ' msort tsort nsort'; --- //[[samuele@netsons.org|Samuele Tognini]] 2008-03-03 23:44// >>Thanks, that's exactly the kind of detail I was looking for. I know it's a "hack", but in some circumstances consistency will be more important than heaps of options for every instance of indexmenu. >> >>Thanks! ---//[[ryan.jake@gmail.com|Ryan Jacobs]] 2008-03-04// ===== Indexmenu id conflict ===== I have in my sidebar the following code {{indexmenu>..#1| js navbar id#random }} and i get after saving this message: Indexmenu id conflict Whats wrong???? The IE also dosen't remember tree state after open a page With firefox it works > Id conflict happens when there are two indexmenu tree with the same id in a web page. If you're using only one indexmenu with the below syntax then it could be a cache issue. Have you tried with the [[.:indexmenu#The tree is not displayed]] steps? Let's continue this discussion here but, please, next time report bugs in the appropriate [[.:indexmenu#bug]] section. --- //[[samuele@netsons.org|Samuele Tognini]] 2008-02-20 17:33// > I forgot to say that this obviously happens when you are editing your site sidebar page, too. In this case you get the same indexmenu object in both page and sidebar and the conflict is detected. --- //[[samuele@netsons.org|Samuele Tognini]] 2008-02-25 13:05// >> Thank's. I have tried it with [[.:indexmenu#The tree is not displayed]], but with IE indexmenu dosen't remember the tree state after open a page. The theme shows a open directory with the minus but all the tree's are still closed ---//[[w.stoiber@lenzing.com|Werner Stoiber]] 2008-03-07 14:20// >>> Could you try the [[.:indexmenu#development]] release (after installed, purge the cache following [[.:indexmenu#The tree is not displayed]] steps)? If nothing change, could you send me you site url so i can test it? If it's not public accessible, a screenshot could help. --- //[[samuele@netsons.org|Samuele Tognini]] 2008-03-07 18:34// >>>> I've tryed the [[.:indexmenu#development]] release. with the same result. I've sent you the screenshot with mail. Thanks Werner ---//[[w.stoiber@lenzing.com|Werner Stoiber]] 2008-03-19 12:45// ===== Can I sort the tree nodes (filename or page heading or creation time)? ===== Yes, with the tsort,dsort or msort [[.:indexmenu#syntax]] options. ===== How can I activate the indexmenu as sidebar for every page? ===== >I would like to have the indexmenu on the left side (similar to the default "table of contents" on the right). On [[http://samuele.netsons.org/dokuwiki/doku.php?id=playground:playground|Samuel's Playground-Page]] is a very fine example of what I mean. I mean the box on the left-side with the title "dokuwiki". When I view the source-code it is
Where do I have to edit my stylesheets to activate this on each page? 2007-02-06 10:51 CEST(Austria) Mark >>Indexmenu itself does not provide sidebars, but you need a template that supports it. You can find them in [[:Template]] page. I suggest you to look for a template that uses a page as sidebar, so that indexmenu loading will be faster thanks to dokuwiki cache. Mine is the artic template. --- //[[samuele@netsons.org|Samuele Tognini]] 2007-02-06 11:58// >>>\\ do you mean arctic (because I found no "artic")? >>>>\\ Yes :-) >>>>>\\ ok, thanks a lot, now it works; I used [[http://wiki.jalakai.co.uk/dokuwiki/doku.php/start| sidebar template]] and the I created a page called "sidebar" # my page "sidebar" has only this entry: {{indexmenu>.|js#kde.png navbar}} # in conf/local.php # I added the entry $conf['template'] = 'sidebar'; I use the kde-theme; it looks really great! 2007-02-07-09:48 CEST (Austria) markjackson Question from Jen: Is there any way to create this sidebar functionality for only part of a wiki site? In other words, I only own a particular directory/namespace and would like to use the indexmenu sidebar, but I cannot change the global conf/local.php. >Sorry but you can't, at least only through indexmenu, because it does not provide sidebar functionality. Sidebars are provided by templates, and only administrator can manage them.--- //[[samuele@netsons.org|Samuele Tognini]] 2007-04-04 11:45// One more question? Where does the sidebar page go? Thanks, Jen > It depends on template. For example, the arctic template lets admin to choose any wanted dokuwiki page as sidebar. ===== undefined method syntax_plugin_indexmenu::getConf() ===== 2007-02-05-07:44 CEST\\ I have installed indexmenu, but everytime I want to use it there is the following error:\\ Fatal error: Call to undefined method syntax_plugin_indexmenu::getConf() in //dokuwiki/lib/plugins/indexmenu/syntax.php on line 143\\ any solutions or ideas? [[markjackson@gmx.at | Mark Jackson]] > What dokuwiki version have you installed? Look at [[.:indexmenu#dokuwiki_2003-09-03]] indexmenu release (no more developped) for old versions. >>\\ thanks for this pointer! I had the version 2006-03-09e; now I installed 2006-11-06 and it works!\\ 2007-02-05 10:34 CEST Mark ===== The tree is not displayed ===== Or nojs tree is displayed in place of js one. Or you can not see any new release feature reported in changelog. Follows these instructions: -To have installed an indexmenu release compatible with your dokuwiki version as described in [[indexmenu#how to install]]. -To have the last indexmenu version installed. For example check that its date is the same of [[.:indexmenu#changelog]] last release through the info button in plugin manager. -To have used a correct [[.:indexmenu#syntax]]. -To have purged your browser cache. With firefox should be sufficient a reload of the indexmenu page by holding down the SHIFT key. :!: This is an important step. -To have purged server cache by a [[:devel:caching#purging_the_cache|purge=true]] request.:!: This is an important step. -To have purged css and javascript server cache by temporary disabling the dokuwiki whole cache. Set to 0 the [[config:cachetime]] config and reload indexmenu page. Then you can set it to its previuos value. If problem still persists, please, report the bug with details of your configuration in [[.:indexmenu#bugs]] section. **Note: Make sure to save the page. The JS tree will not if you only preview the page (at least for me)** I can't reproduce this bug, for me indexmenu works on preview too. One reason could be the firefox bug that i wrote about in the [[.:indexmenu#bugs]] section. Could you check the javascript console for errors? --- //[[samuele@netsons.org|Samuele Tognini]] 2007-03-09 16:46// ===== The tree is not updated ===== | :!:From indexmenu [[.:indexmenu#changelog|v3.3]], the tree is always immediately updated. So you have not to worry to use %%~~NOCACHE~~%% instruction, it's unuseful and slows down the page loading.| But in older versions when the requested main namespace is not the root, then internal dokuwiki caching mechanism implies that the rendered tree and the namespaces titles could not be updated when you modify a page or create a new one inside that namespace until the server cache is purged. To purge cache either wait for the automatic [[config:cachetime|purge cache time]] expiration or force it through a [[:devel:caching#purging_the_cache|purge=true]] request on the page that contains the indexmenu tree. You also might try the [[:syntax#control_macros|~~NOCACHE~~]] instruction to completly disable a specified page cache, so that you have no more to worry about purging cache. But pay attention that it could slow down the overall loading process of the page depending on the number of tree nodes. ===== Js does not remember its previous state ===== Every //**js**// indexmenu has an id (randomly generated by default) used by cookies to remember the current tree state (the selected, open and closed nodes). When the page cache expires or is purged, these informations are reset because a new cookie(and consequently a new id) is generated. This is not a problem because cache purge is not frequent, but if indexmenu is called inside an uncached page or directly inside php code, everytime user loads the page, indexmenu behaviour is to not remember is previous state just like when ''nocookie'' is defined. In this case, the solution is to force a permanent id through the //**[[.:indexmenu#syntax|id]]**// option. Id can be any number or the string "page". The last option is used in rare case, because it will generate an id based on the current page. It's important to have unique ids in your site because two menus with the same id will interfere one each other when user open or close nodes. ===== I don't like the tree sliding arrow ===== Create your own arrow in gif format with an image editor, then override the default one in ''dokuwiki/lib/plugins/indexmenu/images/scrollleft.gif''. Change the height and width of the .indexmenu_arrow property in the [[.:indexmenu#Css Style]] according to the size of your image. You could need a browser cache purging. ===== About ACLs ===== |:!:You could need to set corretly the [[.:indexmenu#Acl cache]] option in order to correctly avoid displaying of denied pages.| |:!: The [[config:sneaky_index]] option is not configured by dokuwiki **2007-06-26b** and previous releases. For them, the indexmenu works as it did until the [[.:indexmenu#changlelog|v4.0]] release, which means **enabled**. To **disable** it, manually add the variable in your ''conf/local.conf'':$conf['sneaky_index'] = 0;| Indexmenu tree behaviour depends on the [[config:sneaky_index]] option, which means: * **Enabled**: if namespace is denied, it stops its recursive search on that namespace branch even there are authorized pages or namespaces below it. * **Disabled**: Indexmenu doesn't stop its recursive search and it could show denied namespaces (**NOT** pages). In both cases, unauthorized pages are never showed. There are also some issues [[.:indexmenu#About empty namespaces]] that should be readed. Example: +-Mysite (ns) (allowed) +-private (ns) (denied) +-ppublic (ns) (allowed) -ppstart (page) (allowed) -pstart (page) (denied) +-public (ns) (allowed) -linux (page) (allowed) +-public2 (ns) (allowed) -secret (page) (denied) -start (page) (allowed) -start2 (page) (denied) **Enabled** will display: +-Mysite (dir) +-public (dir) -linux (page) +-public2 (dir **displayed only in case of any sort option**) -X (empty/unauthorized icon **displayed only in case of any sort option**) -start (page) **Disabled** will display: +-Mysite (dir) +-private (dir) +-ppublic (dir) -ppstart (page) +-public (ns) -linux (page) +-public2 (dir **displayed only in case of any sort option**) -X (empty/unauthorized icon **displayed only in case of any sort option**) -start (page) ===== About empty namespaces ===== Empty namespace can occur when: * All its pages was deleted. Dokuwiki never does really remove empty namespaces as it stores them as file system directories. * All its pages and namespaces are skipped by [[.:indexmenu#skip index]] or [[.:indexmenu#skip files]] options. * All its pages and namespaces are denied to users by [[acls]] settings. In presence of an empty namespaces, indexmenu will show a node child icon, rappresenting an empty page, when any of the [[.:indexmenu#syntax]] sort options are used or when the [[.:indexmenu#syntax|max]] option is configured and the node has to retrieve its childs through the ajax request. Why do you need a sort option to correctly hide empty namespaces? Because the sort option calling replaces the faster, but less featured, core douwiki search with the slower, but more featured, indexmenu search. ===== About RSS ===== |Only for 2006-03-09 dokuwiki version. Not needed in the 2006-11-06 version.| To avoid indexmenu javascript code in rss feed in order to get it readable, edit the ''dokuwiki/feed.php'' file at line ''217'', inside "cleanDesc" function, and add this line: //remove TOC + $desc = preg_replace("!
.*?
!s",'{{indexmenu code}}',$desc); $desc = preg_replace('!
.*?(
\n
)!s','',$desc ===== Languages ===== At this moment only English (a not very good english) and Italian are supported, but i'll be glad if you'll want translate indexmenu in your own language and send it to me, with [[.:indexmenu#how_to_install|darcs]] or simply via email. Strings to translate are in ''indexmenu/lang/en/lang.php'' and ''indexmenu/lang/en/settings.php''. ===== I'm using "useheading" but the tree displays namespace and page names rather than headings ===== The text used for the nodes in the tree is retrieved from DokuWiki's [[:metadata]] store. DokuWiki uses a background process triggered by a webbug to updating this metadata.((See [[:indexer]].)) If you added wiki pages/namespaces via the filesystem (rather than creating them in DokuWiki,) and that page/namespace has never been viewed, the metadata will not have been generated. ====== Changelog ====== |:!: You could need to purge your browser and server cache after upgrading it, following these [[.:indexmenu#The tree is not displayed|instructions]]. The full changelog can be viewed at my [[http://samuele.netsons.org/dokuwiki/doku.php?id=dokuwiki:plugins:indexmenu#changelog|indexmenu]] page. | * **2008-04-12 Version 4.3**: * New Feature: Different js [[plugin:indexmenu#the_context_menu|context menus]] for anonymous, authenticated and admin user. * Bug: Dokuwiki RC2008-04-11 compatible. * Bug: Context menu should now support all userewrite and useslash DW config options. * Bug: Fixed msort to work with nsort when in non-js mode. * **2008-03-10 Version 4.2**: * Bug: Fixed loop with nsort option. Thanks to Thomas Binder. * Bug: Do not display empty namespace icon for empty headpages. * Bug: Fixed navbar not working with max option and a main namespace different from root. * Bug: Context menu "New page here" item creates the right page for headpages. * **2008-02-16 Version 4.1**: * New Feature: Indexmenu tree behaviour depends on the [[config:sneaky_index]] option. More info in the [[.:indexmenu#about ACLs]] section. Please read carefully the note about dokuwiki versions that do not support it. * New Feature: Fixed some issues with Acls and empty namespaces. More info in the section [[.:indexmenu#about empty namespaces]]. * New Feature: Added the "Search in this namespace" option in the contextmenu. Thanks to Herman Huitema. * Bug: Fixed broken js tree with dokuwiki search engine when node contains an highlighted word. * Bugs: Fixed broken toolbar element when the dokuwiki js compact option is on. * Bug: Single quote in dokuwiki config [[config:title]] breaks js tree when [[.:indexmenu#Namespaces title and link|headpage]] option is not configured. * Changes: Minor contextmenu styling changes. * **2007-10-26 Version 4.0**: * New Feature: Added a customizable [[.:indexmenu#The context menu|context menu]] (right click mouse) for pages/namespaces common actions. * New Feature: Added nsort option in order to sorts namespaces according to tsort/dsort/msort options. * Bugs: Fixed a xhtml compatibility bug with msort and max option. * Changes: Automatically scroll navbar menu to fit the current page. * Changes: Support for repository custom themes. * **2007-08-30 Version 3.9**: * New Feature: Added options to sort by title, date and by custom metadata. Infos in the [[.:indexmenu#syntax]] section. Metadata sorting idea was "stolen" from [[.:fullindex]] plugin so thanks to the its author. * New Feature: Added the %%{{indexmenu_n>N}}%% syntax to set a custom number used by metadata sorting. Infos in the [[.:indexmenu#syntax]] section. * New Feature: Support for custom css styles based on theme. Infos in the [[.:indexmenu#Custom theme css style]] section. An example is in the thread theme on the indexmenu repository. * Changes: Added more options to the indexmenu toolbar in edit mode. * Changes: Changed the scrolling tree style and usability. It does not anymore scroll automatically when node gets focus. * **2007-07-11 Version 3.8**: * Bug: Solved bugs when using url rewriting. * Bug: Solved a bug in the css width property of toc preview div. * **2007-07-07 Version 3.7**: * Bug: Navbar did not work in ie6/7 with max option on. * Bug: The js tree was wrong with headpages off. * **2007-07-05 Version 3.6**: * New Feature: Added max option to load nodes from ajax. This will significantly speed up the index in sites with an high amount of pages. * Changes: Old max option renamed to maxjs. ====== Ideas and Todo ====== * Use indexmenu to display media and directory contents like a tree. * Use indexmenu to move pages and namespaces. It would save a lot of time when tidying the wiki up. ====== Bugs ====== | You can report bugs here (please,read the [[.:indexmenu#faq and notes]] section before) but you can also contact me via email (and any feedback will be well-accepted).Solved Bugs are moved in [[.:indexmenu:oldbugs]] discussion page.| ===== No Menue tree ===== I updated to the new dokuwiki release 2008-05-05. I cleared the cache etc. as mentioned above. All config values are standard. The menue tree will not be displayed -- just a plain text list will appear. > Could you try the [[plugin:indexmenu#development]] release and let me know? Samuele >> Yes, the development Version works just fine. Thanks and keep up the good work! ===== Firefox JS Cache Bug ===== It seems that a severe [[https://bugzilla.mozilla.org/show_bug.cgi?id=355567|bug]] of firefox, under some circumstances, corrupts cached javascript files so that a no-js tree is displayed in place of tree one. Purging browser cache solves it. Other browsers are not affected by this bug. ===== Namespace Separator ===== indexmenu uses a colon as a namespace separator, but on my Windows-Server Dokuwiki only works correctly with a slash as a separator. Is it possible anyway, to change the namespace separator in indexmenu? --Thomas >Do you mean the url namespace separator? Last version should work with it, but you need first to activate the url rewriting in the dokuwiki configuration. The variables are [[config:userewrite]] and [[config:useslash]]. >> Yes, I mean the url namespace separator ;-) rewriting is activated and also useslash. But I handled the rewriting by ".htaccess". If I set it to "DokuWiki" also indexmenu handles the url. But I want to use htaccess, cause of nicer URLs. Is this possible anyway? --Thomas >>>DW userewrite option has also the "htaccess" value. Does not it work (don't forget to set the sepchar)? A workaround is to change these settings in the indexmenu syntax.php as you need: $out .= "$js_name.config.urlbase='".wl()."';\n"; $out .= "$js_name.config.sepchar='".idfilter(':')."';\n"; >>>Feel free to email me to get support. ===== Link to root main page in private wiki ===== Hi I have a private wiki (root namespace acl is none), although start and sidebar pages have read permissions for @ALL, so anonymous users can also watch the main page and the sidebar (i have removed the index menu and inserted this page in the left bar). Then when an anonymous user or authenticated user access the main page (i.e http://dokuwiki.aquiline.es or http://dokuwiki.aquiline.es/inicio, start page is called inicio), they can see the content, but the text for the root namespace in the indexmenu has no link. Is this a bug? You can watch this at http://dokuwiki.aquiline.es Regards --- //[[okelet@gmail.com|Juan]] 2008/04/24 22:44// >What are your [[plugin:indexmenu#namespaces_title_and_link]], [[config:startpage]], [[plugin:indexmenu#skip_file]] and [[config:hidepages]] options? --- //[[samuele@netsons.org|Samuele Tognini]] 2008/04/25 00:37// >> Hi >> >> * headpage (namespaces_title_and_link) -> :start:, :same:, :inside: >> * start -> inicio >> * skip_file -> /sidebar.txt/ >> * hidepages -> (none) >> >> Regards >> >> --- //[[okelet@gmail.com|Juan]] 2008/04/25 02:14// >>>Uhm, those settings are ok and i can't reproduce the bug. When you logged as administrator, is the root link created? What's your acls (from conf/acl.auth.php)?. >>>> Hi >>>> >>>> When i login as administrator, the root of the tree is the title of the "inicio" page of the root namespace (correct); when i am not logged in >>>> or logged with an user other than administrator, the root of the tree has the text of the >>>> [[http://www.dokuwiki.org/wiki:config#title | wiki name]], and it is not linked. This is my acl file: >>>> >>>> * @ALL 0 >>>> inicio @ALL 1 >>>> sidebar @ALL 1 >>>> general:* @usuarios 2 >>>> publico:* @ALL 1 >>>> sistemas:* @sistemas 8 >>>> >>>> Regards and thanks for your help. >>>> >>>>> It should be solved in the development release. --- //[[samuele@netsons.org|Samuele Tognini]] 2008/04/26 12:49// >>>>>> Hi >>>>>> >>>>>> The development release fixes this bug, confirmed. Thank you very much for your help and your attention. >>>>>> >>>>>> --- //[[okelet@gmail.com|Juan]] 2008/04/26 15:07// >>>>>> ====== Discussion ====== Please, use the [[.:indexmenu:discussion]] page for feature request and general discussion.