Item5639: FlexWebListPlugin - subweb(s) documentation and behavior does not match.

Having tried FlexWebListPlugin there is something not matching what the doc says and what the plugin actually does.

The subweb option is misspelled. It should be subwebs. Note the missing s.

Having come over this detail it still makes no sense.

If I specify subwebs="all" then I see all webs and all subwebs. OK.

If I specify subwebs="none" I see all top level webs and no subwebs. OK

If I specify subwebs="Somename" I no longer see the top level webs but only the subwebs of Somename. This makes no sense to me at all. I would expect to see all webs + subwebs of Somename.

Also the doc says the value is "regular expression that subwebs must match to be listed". But again it makes no sense. If I put subwebs="Somename" then I do not see Somename. I see the subwebs of Somename. The doc should probably have stated "regular expression that the parent web must match for its subwebs to be listed".

-- TWiki:Main/KennethLavrsen - 20 May 2008

Could you please provide the full testcases that fail for you, please, together with a comment of what you would have expected to get.

-- TWiki:Main.MichaelDaum - 21 May 2008

I thought I was pretty clear in my description. But OK.

%FLEXWEBLIST{format="$indent * [[$web.WebHome][$name]]$n" subweb="Somename"}% does not work because you are supposed to use subwebs.

Now that we have cleared the problem with the spelling there are the 3 cases

%FLEXWEBLIST{format="$indent * [[$web.WebHome][$name]]$n" subwebs="all"}% displays all webs and all subwebs. OK!

%FLEXWEBLIST{format="$indent * [[$web.WebHome][$name]]$n" subwebs="none"}% displays all webs and no subwebs. Also OK.

%FLEXWEBLIST{format="$indent * [[$web.WebHome][$name]]$n" subwebs="Someweb"}% displays no webs. It displays only the subwebs of the web Someweb. I expect to see all the webs + the subwebs of Someweb. It makes no sense why the value "none" displays all the top webs, but giving the name of the web does not show the top level webs.

If the feature worked as I expected then I could use

%FLEXWEBLIST{format="$indent * [[$web.WebHome][$name]]$n" subwebs="Tasks"}% to produce a left bar menu that displays all webs + the subwebs of current web. That would prevent the left bar from becomming a big mess when you have both many webs and each web have many subwebs. And it would look natural that navigating from web to web would expand the list of subwebs for the current web.

If people are to use FLEXWEBLIST to produce a list of only the subwebs perhaps the webs option should be extended with the value "none" so you can make a

%FLEXWEBLIST{format="$indent * [[$web.WebHome][$name]]$n" web="none" subwebs="Someweb"}%

So to summarize

• Fix the spelling of the "subwebs" either in the doc or in the code.
• Fix the doc for "subwebs" so the text describes correctly what the regex must match. (suggested text above)
• Fix the function of the subwebs feature so there is some consistancy between the values "all" and "none" and "Specificwebname". Ie. list the top level webs when you specify a value in "Subwebs" other than "all" or "none".

-- KennethLavrsen - 21 May 2008

Fixed processing of subwebs parameter.

-- MichaelDaum - 17 Nov 2009