DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:topbarsyntax

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:topbarsyntax [2011-10-30 18:15] – [Syntax] 93.199.213.104plugin:topbarsyntax [2023-03-29 23:21] (current) Aleksandr
Line 1: Line 1:
 ====== topbarsyntax Plugin ====== ====== topbarsyntax Plugin ======
----- pluginnews ---- +
-headline: Plugins by same author +
-style: sameauthor +
-----+
 ---- plugin ---- ---- plugin ----
-description: delivers horizontal/vertical, css based menu on dw page wherever you want to have it+description: Delivers horizontal/vertical, css based menu on DokuWiki page wherever you want to have it
 author     : Taggic  author     : Taggic 
 email      : Taggic@t-online.de email      : Taggic@t-online.de
 type       : syntax type       : syntax
-lastupdate : 2011-10-30 +lastupdate : 2016-06-02 
-compatible : 2011-05-25+compatible : 2011-05-25, Greebo, Hogfather
 depends    :  depends    : 
 conflicts  conflicts 
 similar    :  similar    : 
-tags       : css menu, simple template+tags       : cssmenu, template
  
 downloadurl: https://github.com/Taggic/topbarsyntax/zipball/master downloadurl: https://github.com/Taggic/topbarsyntax/zipball/master
Line 23: Line 20:
  
 ===== Intro ===== ===== 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 Miachael Kliers [[template:simple|template_simple]]. 
  
-To see the plugin in action please visit: [[http://www.fristercons.de/fcon/doku.php?id=tips:tips_topbar|fcon- examples]].+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 ===== ===== Installation =====
  
-Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
  
 ===== Examples/Usage ===== ===== Examples/Usage =====
Line 38: Line 35:
 There are two parameters. The first defines the width of the menu. There are all css compatible width values allowed (like px, %, em).  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, = vertical). The vertical menu has the possibility of displaying text right beside it due to css is set to float:left.+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. 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 ===== ===== Syntax =====
 +
 __**horizntal menu bar syntax, valid expressions**__ __**horizntal menu bar syntax, valid expressions**__
 <code> <code>
-- a vertical menu of 850em width +- a horizontal menu of 850px width 
-{{topbarsyntax>850em,h}}%%  +{{topbarsyntax>850px,h}}%%  
  
-- a vertical menu of 100% width+- a horizontal menu of 100% width
 {{topbarsyntax>,h}}%%   {{topbarsyntax>,h}}%%  
 </code> </code>
Line 54: Line 52:
 __**vertical menu bar syntax, valid expressions**__ __**vertical menu bar syntax, valid expressions**__
 <code> <code>
-- a vertical menu of 12em width and auto height +- a vertical, left sided menu of 12em width and auto height 
-{{topbarsyntax>12em,v}}+{{topbarsyntax>12em,vl}}
  
-- a vertical menu, with css defined width and auto height +- a vertical, right sided menu, with css defined width and auto height 
-{{topbarsyntax>,v}}+{{topbarsyntax>,vr}} 
 + 
 +</code>
  
-- a vertical menu, with css defined width and auto height 
-{{topbarsyntax>}} 
-</code>  
 ===== Configuration and Settings ===== ===== 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]// //[also CSS style tips]//
Line 73: Line 89:
 === Change Log === === Change Log ===
  
-{{rss>http://github.com/feeds/Taggic/commits/topbarsyntax/master date}}+{{rss>https://github.com/Taggic/topbarsyntax/commits/master.atom date}}
  
 === Known Bugs and Issues === === Known Bugs and Issues ===
  
-  * currently none +  * 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 === === ToDo/Wish List ===
  
Line 87: Line 112:
 //[discussions should ideally be deleted and turned into FAQ entries along the way]// //[discussions should ideally be deleted and turned into FAQ entries along the way]//
  
-===== Discussion ===== +===== Sites using this Plugin =====
- +
-Please use only the DokuWiki Forum for discussion and git to raise issues. 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). +
  
 +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).
plugin/topbarsyntax.1319994959.txt.gz · Last modified: 2011-10-30 18:15 by 93.199.213.104

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki