summaryrefslogtreecommitdiff
path: root/doc/todo/pedigree_plugin.mdwn
blob: 8214385d24c4c2f0876ca7fd7b8c43f5d534fefc (plain)

After realizing (thanks to [[Allow_TITLE_to_include_part_of_the_path_in_addition_to_the_basename]]) that I needed some kind of "parentlinks on steroids", I wrote a new plugin, called pedigree.

This plugin provides a bunch of loops that one can use in his/her HTML::Template's to iterate over all or a subset of a page's parents. Inside these loops, half a dozen variables are made available, in addition to PAGE and URL that are already provided by parentlinks.

Amongst many possibilities, one can e.g. simply use this plugin to give every parent link a different class= attribute, depending either on its depth in the path leading to the current page, or on its distance to it.

The code and documentation (including simple and complex usage examples) are in the 'pedigree' Git branch in this repo:

git://repo.or.cz/ikiwiki/intrigeri.git

Seems there is also a gitweb.

Ok, I'll take a look. BTW, could you allow user joey on repo.or.cz push access to the main ikiwiki repo you set up there? --[[Joey]]

I did not. The main ikiwiki repo on repo.or.cz seems to have been been setup by johannes.schindelin@gmx.de ; mine is what they call a "fork" (but it's not, obviously).

Any opinions on the idea/design/implementation?

Seems that there should be a more generic way to do PEDIGREE_BUT_ROOT and PEDIGREE_BUT_TWO_OLDEST (also is_second_ancestor, is_grand_mother etc). One way would be to include in PEDIGREE a set of values like depth_1, depth_2, etc. The one corresponding to the absdepth would be true. This would allow a template like this:

<TMPL_LOOP NAME="PEDIGREE">
  <TMPL_IF NAME="depth_1">
    </TMPL_ELSE>
    <TMPL_IF NAME="depth_2">
    </TMPL_ELSE>
      <TMPL_VAR PAGE> /* only showing pages 2 levels deep */
    </TMPL_IF>
  </TMPL_IF>
</TMPL_LOOP>

The only missing information would be reldepth, but in the above example the author of that template knows that it's absdepth - 1 (Things would be a lot nicer if HTML::Template had equality tests!)

Since this would make it more generic and also fix your one documented bug, I can see no reason not to do it. ;-) --[[Joey]]

Thanks for your comments. I'll answer soon. (Grrr, I really need to find a way to edit this wiki offline, every minute online costs bucks to me, my old modem gently weeps, and I hate webbrowsers.) -- intrigeri

(I'll try never to rebase this branch, but writing this plugin has been a pretext for me to start learning Git, so...)

To finish with, it seems no plugin bundled with ikiwiki uses the current parentlinks implementation, so one could event think of moving it from the core to this plugin (which should then be enabled by default, since the default templates do use parentlinks ;).

I think that moving parentlinks out to a plugin is a good idea. However, if it's done, I think the plugin should be named parentlinks, and should continue to use the same template variables as are used now, to avoid needing to change custom templates. Pedigree is a quite nice name, but renaming it to parentlinks seems to be the way to go to me. --[[Joey]]

Agreed. -- intrigeri