Usage

 @@TopicIndex("<selector>"[, "<regex>|<property name>"[, "<namespace">]])@@

The selector must have one of the values "Title" or "Property". This specifies whether the TopicIndexBehavior filters the titles (i.e., WikiTopic names) or WikiProperty.

If the selector is "Title":

• The second parameter is optional. When specified, the list will be filtered to only those topics whose names match the regular expression specified as the property's value.

If the selector is "Property":

• The second parameter is required and filters the list on the property name specified in this parameter's value.
• The specified property's value will be displayed in the resulting list.

Also, the second parameter must be specified in order to use the namespace parameter. See the Discussion below.

The namespace parameter is always optional and specifies the WikiNamespace to search and index.

Notes

Topic names beginning with an "_" are always excluded, regardless of any parameter specifications.

Examples

Also see Working Examples, below.

List all topic names for all namespaces:

 @@TopicIndex("Title")@@

List all topic names containg the word "Page" for all namespaces:

 @@TopicIndex("Title", "Page")@@

List all topic names ending with the word "Page" for all namespaces:

 @@TopicIndex("Title", "Page$")@@

List all topic names for a namespace called "FlexWiki.Formatting":

 @@TopicIndex("Title", ".*", "FlexWiki.Formatting")@@

List all topic names with a "Question" property for all namespaces:

 @@TopicIndex("Property", "Question")@@

List all topic names with a "PleaseReview" property for a namespace called "FlexWiki.Formatting":

 @@TopicIndex("Property", "PleaseReview", "FlexWiki.Formatting")@@

Information for developers

This change is checked-in to the GotDotNet Workspace.

Changed files:

• FlexWikiEngine.csproj
• BehaviorInterpreter.cs

New files:

• TopicIndexBehavior.cs

No new tests were created for this behavior.

Discussion

With regard to the second parameter when performing a "Title" search, there's a slight issue with the regex options available. The "ParseParams" method of the "BehaviorInterpreter" class mangles parameters which include a backslash character, which is of course a common character in regex patterns. This behavior is still useful even with that limitation: I was still able to perform most of the filters I would normally want. If anyone can take a look at fixing the parameter parsing, though, it would be an improvement. -- RyanLaNeve

It would be nice to format multi-paragraph property values (using colon-bracket) so they don't go all weird in the list it creates. -- MarkMiller

AnswerMe - How do I generate an index of all the names NOT ending in, say "Index"? I think the RE (.*($<!Index)$) does it, but not in TopicIndex.... Or, let's say, index with everything but endings of (Index | TOC | Footer)? Thanks in advance. -- YarkoT

How do I create a Index, that shows the topics in my namespace that was modified today? -- PradeepKumar

I'd like to be able to add a property to a number of pages:

 Project: Q1, West, Q3

and then have the TopicIndex (or similar) give me a list of the pages that contain a property:

 @ @ TopicIndex("Property", "Project", "West") @ @

What I should get is a listing of the titles of the pages that have that property in it.

When a topic has spaces in its name, the links generated do not seem to function correctly. (Another good reason to make sure your users are making topics with WikiWords!) -- AJHenderson

Working Examples

Because these examples produce lengthy ouput and WikiBehaviors take longer for the ASP.NET to serve, examples are on separate pages.

TopicIndexBehaviorExampleSiteIndex by KorbyParnell

 @@TopicIndex("Title")@@

TopicIndexBehaviorExampleTopicsWithProperty

 @@TopicIndex("Property", "Summary")@@