====== Header3 Plugin ======

---- plugin ----
description: Allows markup syntax in the header and keeps your linebreaks like you entered them in the editscreen
author     : Max Westen
email      : max@dlmax.org
type       : syntax, renderer
lastupdate : 2016-02-02
compatible : Adora Belle
depends    : 
conflicts  : include, tcycle
similar    : header2, xbr, linebreak, wikiformatstyling
tags       : syntax, headings, typography

downloadurl: https://github.com/mwesten/dokuwiki-plugin-header3/zipball/master
bugtracker : https://github.com/mwesten/dokuwiki-plugin-header3/issues
sourcerepo : https://github.com/mwesten/dokuwiki-plugin-header3/
donationurl: 

screenshot_img : 
----

:!: **This plugin (and [[plugin:header2|the plugin Header2]]) became unavailable** due to a technical reason ([[https://forum.dokuwiki.org/thread/16109|See this conversation]]).  You can consider using [[plugin:wikiformatstyling|Wiki-Style Script]] instead.

===== Description =====

This plugin enables the preservation of line breaks from the raw wiki text through to the html output and allows links and other markup in headers/headlines.

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

===== Installation and Usage =====

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

:!: After installation, **set '[[config:renderer_xhtml]]' to "Header3" in the configuration manager.**

:!: The TOC is rendered by metadata renderer instead of xhtml renderer in general 'show' action. However in 'preview' mode the TOC is rendered by xhtml renderer. So in //few// situations you'll find the TOC different in preview and in show mode. (mostly it doesn't happen since metedata renderer renders 'abstract' for the article and what it does is to have all markups parsed except no html tags)

===== Discussion =====

==== Alternative of using renderer ====

This renderer is just a hack to overwrite "private" attribute of the xhtml renderer.

==== TOC link empty ====

If you use a link with empty label (2nd parameter), you might get the title lost in the TOC. For example:
  [[:start|]]

To avoid this problem, __do not use an empty label__ (i.e. no label or non-blank label are ok). The followings are OK:

  [[:start]]
  [[:start|Start]]

This is due to a problem in the core metadata renderer in and before //dokuwiki-2010-11-07a “Anteater”//, which is already reported [[bug>2144|here]].

==== Conflicts ====

After activating this plugin and changing the xhtml renderer to header2 all my instances of the include plugin using "section" no longer work..the whole page is shown instead. Upon deactivating this plugin, the include works again. - Andy 2011/01/24

Conflict with [[tcycle]] because of Header3's renderer include br-tags between pairs of a-tags and tCycle try to switch css display:none/block on it, so an animation would have a pauses, equals to measures, choosed in tCycle syntax options.

==== How to make it work with DokuWiki version 2014-09-29a "Hrun" and above ====

I've found one provisional solution that worked for me! - //Guenther, Oct. 10th, 2014//

Change in DokuWiki's XHTML-Renderer /inc/parser/xhtml.php some methods from 'protected' to 'public':

Line 30: protected $sectionedits = array();\\
change to: public $sectionedits = array();

Line 43: protected $lastlevel = 0;\\
change to: public $lastlevel = 0;

Line 45: protected $node = array(0, 0, 0, 0, 0);\\
change to: public $node = array(0, 0, 0, 0, 0);

**PS**. [[plugin:xbr]] preserves (though only single) linebreaks; use it instead.