TitleIndex (optionally) does not show pages shipped with Trac

[TJ <support@…>]

I wanted to have TitleIndex on the front page of my Trac but didn't want the clutter of listing all the pages that are shipped with it.

I've created a patch for class TitleIndexMacro to achieve my aims. There's an additional parameter ignore. When set to 1 TitleIndex will not list the built-in pages. E.g.

[[TitleIndex(format=group,ignore=1)]]

If ignore=0 or is omitted then it lists all pages.

[TJ <support@…>]

TitleIndex optionally ignores built-in pages

[cboos]

Well, that's an useful feature, but I don't think your current implementation is suitable (e.g. ignoring all 'Inter*' files). A better approach would be to explicitly ignore all pages in the list of known help pages.

But have a look at TracDev/Proposals/NewHelp branch. I think this won't even be necessary once we switch to this.

[osimons]

'Cluttering' of the wiki by help pages is a major reason for NewHelp. Moving this to 0.12 - currently the target for this branch.

[osimons]

Hmm. Batch update of milestones? Moving back to 0.12.

[marek.lukacs@…]

Omit pages equals to or starting with world listed in colon separated list

[marek.lukacs@…]

I did it in different way. I added new options to TitleIndex macro: omit=colon:separated:list:of:words and omitstartswith=colon:separated:list:of:words.

For omitting pages shipped with trac I use:

[[TitleIndex(omit=CamelCase:PageTemplates:RecentChanges:SandBox:TitleIndex,omitstartswith=Inter:Trac:Wiki)]]

[cboos]

Hm, why not just have include/exclude fnmatch patterns?

e.g. your example:

[[TitleIndex(include=*,exclude=Inter*:Trac*:Wiki*:CamelCase:PageTemplates:RecentChanges:SandBox:TitleIndex,)]]

Other examples:

• replacing startswith (or is it prefix? I never know ;-))

  [[TitleIndex(include=TracDev/*)]]
  

• listing only first sub-level:

  [[TitleIndex(include=TracDev/*,exclude=TracDev/*/*)]]
  

[rblank]

Nice ideas. I'll implement them, but after 0.12.

[mark.m.mcmahon@…]

Patch to allow extra filtering in the TitleIndex macro

[mark.m.mcmahon@…]

I also liked include and exclude more than omit as they seem more consistent.

I have coded it up, and it seems to work well - I added a few tests also (included in the patch).

[rblank]

Nice patch, thanks!

[rblank]

Simplified patch committed in [10025]. The changes were the following:

• Changed the semantics so that a missing include argument means "all pages", and exclude takes precedence over include. This is consistent with the examples in comment:7.
• The case-sensitiveness of the fnmatch.filter() function depends on the OS, so two tests were failing here (on Linux). I used fnmatchcase() instead, which is always case-sensitive.
• Made the filtering use a more "functional" style.

[cboos]

The TitleIndex page could use this, for example with an explicit list of the default wiki pages: first as exclude to show the site specific pages, then in a second call, with include, to show the help pages.

[geroleinemann@…]

The parameters "include" and "exclude" are documented on "http://trac.edgewall.org/wiki/WikiMacros" for v.0.12, but not available in the tag/distribution v0.12 (but on the trunk, ready for v0.13).

[mail@…]

I was hit by the issue mentioned in comment 17. It would be great to have r10025 applied to 0.12.3 it works without a problem on my installation.