====== topbarsyntax Plugin ======

---- plugin ----
description: Delivers horizontal/vertical, css based menu on DokuWiki page wherever you want to have it
author     : Taggic 
email      : Taggic@t-online.de
type       : syntax
lastupdate : 2016-06-02
compatible : 2011-05-25, Greebo, Hogfather
depends    : 
conflicts  : 
similar    : 
tags       : css, menu, template

downloadurl: https://github.com/Taggic/topbarsyntax/zipball/master
bugtracker : https://github.com/Taggic/topbarsyntax/issues
sourcerepo : https://github.com/Taggic/topbarsyntax
donationurl: 
----

===== Intro =====

The top bar syntax plugin was developed to illustrate the behaiviour caused by the instructions of an article [[http://www.fristercons.de/fcon/doku.php?id=tips:tips_topbar|How to integrate the CSS Menu into a template]]. \\ The initial code base was taken from the related function of Michael Kliers [[template:simple|template_simple]].

To see the plugin in action please visit: [[http://www.fristercons.de/fcon/doku.php?id=topbarsyntax:descr|fcon- examples]].FIXME

===== Installation =====

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

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

Please be aware that this is a **plugin** and not the template integration as described within the mentioned article !

There are two parameters. The first defines the width of the menu. There are all css compatible width values allowed (like px, %, em). 

The second parameter configures the menu orientation (h = horizontal, vl = vertical, left sided, vr = vertical, right sided). The vertical menu has the possibility of displaying text right/left beside it due to css is set to float:left/right.

As explained for the template integration, you have to create (and maintain) the link list of your navigation. Therfore store a text file to the pages-root folder of your DokuWiki. The menu items are unordered list items followed by the internal dokuwiki link (all as DW-syntax). There it is necessary to enter an empty line between the level one to tell the php-code that a new menu tab item to be created. If you want to have different menues for namespaces, then create a //topbar.txt// file within the namespace. If the syntax is called it will look at first into current namespace for the //topbar.txt// file. If there is no such file it will look into pages-root directory and takes that one.

===== Syntax =====

__**horizntal menu bar syntax, valid expressions**__
<code>
- a horizontal menu of 850px width
{{topbarsyntax>850px,h}}%%  

- a horizontal menu of 100% width
{{topbarsyntax>,h}}%%  
</code>

__**vertical menu bar syntax, valid expressions**__
<code>
- a vertical, left sided menu of 12em width and auto height
{{topbarsyntax>12em,vl}}

- a vertical, right sided menu, with css defined width and auto height
{{topbarsyntax>,vr}}

</code>

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

Finally you have to create the link list of your navigation. Therfore store a text file to the pages-root folder of your DokuWiki. The menu items are unordered list items followed by the internal dokuwiki link (all as DW-syntax). There it is necessary to enter an empty line between the level one to tell the php-code that a new menu tab item to be created. For the fcon page this would look similar to following:
<file txt topbar.txt>
  * [[:start|Home]]

  * Plugins
    * Issue Tracker
      * [[issuetracker:descr|Description]]
      * [[issuetracker:report|Report an Issue]]
      * [[issuetracker:issuelist|Issue List]]
    * Training  
      * [[training:start|Overview]]
      * [[training:authors|Author Training]]
      * [[training:admins|Admin Training]] 
    * NEWS System  
      * [[news:how_to_set-up|Description]]
      * [[news:news|News]]
      * [[news:writenews|Write News]]
</file>

//[also CSS style tips]//

===== Development =====

//[downloadable blocks, development comments]//

=== Change Log ===

{{rss>https://github.com/Taggic/topbarsyntax/commits/master.atom date}}

=== Known Bugs and Issues ===

  * Fatal error: Declaration of syntax_plugin_topbarsyntax::handle''($match, $state, $pos, Doku_Handler &$handler) must be compatible with dokuwiki\Extension\SyntaxPlugin::handle($match, $state, $pos, Doku_Handler $handler)''
    * **Solution:** Edit the file __Syntax.php__ then change
      * __Line 45 from__:
        * ''    function handle($match, $state, $pos, Doku_Handler $handler) {''
      * in
        * ''function handle($match, $state, $pos, Doku_Handler &$handler) {''
      * __Line 59 from__:
        * ''function render($mode, Doku_Renderer $renderer, $data) {''
          * in
        * ''function render($mode, Doku_Renderer &$renderer, $data) {''
          *  or try viceversa --- [[user>florious|florious]] //2022-01-17 01:30//
=== ToDo/Wish List ===

//[developers roadmap]//

===== FAQ =====

//[discussions should ideally be deleted and turned into FAQ entries along the way]//

===== Sites using this Plugin =====

You got this plugin up and running? You have got a demo page? Put a link here! \\ 
Feel free to add yours here:
  * [[http://www.fristercons.de/fcon/doku.php?id=topbarsyntax:descr|fcon - TopBar example]]

===== Discussion =====

Please use only the DokuWiki Forum for discussion and [[http://www.fristercons.de/fcon/doku.php?id=topbarsyntax:descr#development|TopBarMenu reports]] to raise yourissues. You can mention it here but this page is not regularily tracked 
and if something is solved it will be cleaned from this page (better to use the forum due to automated notifications).