Page Operations
Browse Space| Name | Keyword Index |
|---|---|
| Priority | Medium |
| Complexity | medium to high |
| Author(s) | James Mortimer |
| Description | Create a keyword-based index for the content of pages. |
Background
like an index at the back of a book, the word 'computer' should link to all pages that have the word computer on it
Suggested Usage Example
{keyword-index:groupby=letter|root=CONF:page1|scope=@descendents|output=list|...}
would give you a table such as
A
C
- computer Keyword Index [other page2] [other page3]
Suggested Parameters
| parameters | examples | meaning |
| output | list / wiki / dynamic / table / other? | how to format the output |
| groupby | none / letter | specify grouping options |
| root | @self, @parent, @home, @none | specify the context of the index |
| scope | @self, @ancestors, @space, @all, @descendents, @children | which pages to include in the index, relative to the context |
| include | a page name or text attachment that contains a list of the keywords to include | |
| exclude | a page name or text attachment that contains a list of words to exclude | |
| maxpagesperword | <number>, default=n/s | any words with more than this number of pages are excluded (stop words) |
| minpagesperword | <number>, default=1 | any words with less than this number of paqes are excluded (uninformative words) |
Other Requirements
- a method to specify which words to include or exclude. this might be by word-length, or cherry picking
For example, from a text file attachment
- the dynamic option would show just the list of keywords (grouped by letter). When you hover-over and/or click-on a keyword, a list of the relevant pages are shown in a popup.
Notes
An approximation of this, if you want to specify all keywords as you would in include, can be attained by using something like:
A
C
P
the keyword-index would simplify having to create this complicated index, so you would only have to list the bare-words or just let confluence list all the barewords in its index.