It's better when it's simple

User Tools

Site Tools


xbr Plugin

Compatible with DokuWiki

  • 2022-07-31 "Igor" unknown
  • 2020-07-29 "Hogfather" yes
  • 2018-04-22 "Greebo" yes
  • 2017-02-19 "Frusterick Manners" yes

plugin Replacement renderer, preserves line breaks present in raw wiki data

Last updated on
Conflicts with
ckgedit, highlightjs

Similar to header3, linebreak

Tagged with typography


This plugin enables the preservation of line breaks from the raw wiki text through to the html output. It is a replacement for the standard DokuWiki XHTML renderer, as such to use it you must set the renderer_xhtml setting to the plugin's name, 'xbr'. For simplicity's sake the plugin uses all of the standard renderers routines with the exception of plain character output, where it uses its own routine to replace new lines with the HTML element, <br />.

Note, the plugin does not preserve multiple consecutive line breaks, but it will preserve single line breaks.

Also see the linebreak plugin.

Download and Installation

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

After installation set the renderer_xhtml configuration setting (via your wiki's admin panel) to 'xbr'.

Revision History

  • 2008-06-30 — include Danny Lin's suggestions and move code to GitHub
  • 2008-11-11 — installable packages and darcs versions prepared. No changes.
  • 2008-08-13 — released


Does not work with Release 2014-09-29b “Hrun”
Test with success with Release 2014-09-29d “Hrun”.
This plugin has no dedicated section in the configuration manager. You need to change the renderer_xhtml parameter in advanced settings.
I'm not the author but changed compatibility to OK in this page.

To Do (feature requests)

  • ~~LINEBREAK~~ / ~~NOLINEBREAK~~ directives support would be extremely helpful.

Discussion / Requests for help

How shall I use this plugin (I'm using DokuWiki Release 2015-08-10a), shouldn't it be automatic ?
I'm just asking, because the problem is still the same before/after the plugin installation :
* 1 linebreak : Doesn't work, texte continues on the same line.
* 2 linebreaks : Works but display 2 linebreaks (DokuWiki default style).
AUTO-UPDATE (SOLVED) : Advanced parameter has to be set ☛ “renderer_xhtml” : XBR Plugin (extension)
This is working on 2017-02-19 “Frusterick Manners”, but I don't know how to change it above.
I'm upgrading to Greebo from Hrun and this plugin is not working properly. We have hundreds of pages utilizing the formatting provided by this plugin so hopefully someone can help with updating to current Dokuwiki version.
Randy Whitaker 2019-05-07 19:36
Nevermind the above comment. In Configuration Settings, under “Advanced”, there is an option to change the “renderer_xhtml” variable to “XBR”, which put this plugin in gear and it's working great on Greebo now. I read this in comments above 4 or 5 times before finally realizing what it's talking about.
Randy Whitaker 2019-05-07 19:39

2020-07-29 “Hogfather”

Has anyone tested the XBR Plugin successfully on 2020-07-29 “Hogfather”? — fgeierst 2020-10-29 14:59
Yes, it works fine. — Florin C. 2022-03-27 15:52
plugin/xbr.txt · Last modified: 2022-03-27 15:53 by florious

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