ImprovedFormatter : Heading Ids

[DotMG]

 http://wikkawiki.org/ImprovedFormatter#hn_Headings_Ids

Related tickets:

• #13
• #20
• #503

[DotMG]

An enhanced version of wakka3callback

[DotMG]

Because formatters/wakka.php is called almost everytime, and because wakka3callback is anyway an afterburner callback, I think that it's better to move its call inside the file handlers/show/show.php

I've tried this scheme, and haven't broken anything.

How do you think?

[DarTar]

I'm not the best person to comment on the formatter, JavaWoman and TormodH can possibly give some feedback?

And shouldn't we merge this ticket with ticket #20 ?

[DotMG]

I think tickets #20 and #498 are related but have not to be merged. #20 is about implementing the method makeId(), but #498 is about using it!

[Nils]

Actually we need a ticket to coordinate for the creation of IDs for 'everything' i.e. forms, headings, etc. Maybe we cshould rename #20 then?

[DarTar]

I think this could be the coordination ticket for the application of the new functionality, whereas #20 the development ticket for the method. Alternatively, we could start a new ticket for extending the current makeID functionality to other page elements.

[DarTar]

JW, feedback welcome on this.

[DarTar]

As a potential extension of this feature, I like the functionality offered by Trac to display section links next to each heading (see for example the ¶ links that appear when you hover on a heading in http://wush.net/trac/wikka/wiki)

[DotMG]

(In [527]) refs #498

A new parameter was added to the Format() method, it is named $format_option. It is a semicolon separated list of strings, and actually, the only parameter defined is 'page', which means we are formatting an entire page, and it involves that closing tags and generating header ids should be done.

The two handlers handlers/show/show.php and handlers/edit/edit.php were just slightly edited to add this new parameter. (Closing tags and generating id are done when previewing in edit.php)

Removed the core parameter named formatter_recursion, which become obsolete.

[DotMG]

Closing this one and linking to #503

[DarTar]

DotMG, JavaWoman - I've never completely understood whether the hn_ prefix is a bug or a feature. Is it really supposed to be hn_ (I don't get what the n stands for) or should n be replaced with the corresponding heading level, e.g. h1_?

[DotMG]

hn_ prefix is a feature. It is really supposed to be hn_. You could consider it as a simple convention to group ids generated for headers. Creating separate group h1_, h2_, ... is just overkill. n is not intended to be replaced with anything else, not materially! It just stands for a number (as you would use hn to indicate h1 thru h6, ignoring the number).

[JavaWoman]

Replying to DarTar: In addition to DotMG's reply: having the ID prefixed with hn_ also means that you can not only link to a fragment with that ID, but that the link will remain valid if someone changes the heading level, because the ID will remain the same! That's why it was designed that way - with fragment linking in mind.

[JavaWoman]

Since headers with hn_ prefixes are working as designed, I'm re-closing this!

[DarTar]

Retargeting to 1.3, this ticket has already been closed in trunk, from which 1.3 will be branched. Consider backporting urgent issues to 1.2.X

[DarTar]

Ported to branches/1.2 in [1493]

[BrianKoontz]

Changed milestone to 1.3.1