wiki:WantedPagesMacro

Version 27 (modified by figaro, 8 years ago) (diff)

Moved example to functional description

List of non-existent wiki pages that are linked to

Description

Lists all wiki pages that are linked to but not created in wikis, ticket descriptions and ticket comments. That is, when a CamelCase identifier is listed in a wiki page, then a link is created to that page. However, if that page does not exist, then the link exists but the page is not created.

For example, MyPageAbc is a link to MyPageAbc, which does not exist.

[[WantedPages]] lists all wiki pages that are linked to, but do not exist.

[[WantedPages(show_referrers)]] does the same thing, but also lists the pages that contain the broken links.

[[WantedPages(ignored_referrers=<regex>)]] does the same thing, but ignores referring pages that match the regular expression <regex>, eg [[WantedPages(show_referrers,ignored_referrers=^Wiki[HP]|^Trac)]].

Note that the regex matches all or part of the name.

More options:

filter
alias for ignored_referrers
filtertype
flags whether filter option is inclusive or exclusive, with values inclusive or exclusive (is also default value for backward compatibility)

Examples:

  • ignore all pages that contain 'Trac' in their name:
    • [[WantedPages(show_referrers, ignored_referrers=Trac)]]
    • [[WantedPages(show_referrers, ignored_referrers=Trac, filtertype=exclusive)]]
    • [[WantedPages(show_referrers, filter=Trac)]]
    • [[WantedPages(show_referrers, filter=Trac, filtertype=exclusive)]]
  • only show pages that contain 'Trac' in their name:
    • [[WantedPages(show_referrers, ignored_referrers=Trac, filtertype=inclusive)]]
    • [[WantedPages(show_referrers, filter=Trac, filtertype=inclusive)]]

Bugs/Feature Requests

Existing bugs and feature requests for WantedPagesMacro are here.

If you have any issues, create a new ticket.

defect

16 / 17

enhancement

16 / 16

task

4 / 4

Download

Download the zipped source for 0.9 or 0.10 or 0.11/0.12/1.0.

Source

You can check out WantedPagesMacro from here using Subversion, or browse the source with Trac.

Installation

You must have setuptools installed.

Run the following commands in the source directory:

python setup.py bdist_egg
cp dist/*.egg /path/to/projenv/plugins

For more information, see TracPlugins.

You also have to enable it in the trac.ini file:

[components]
wantedpages.* = enabled

Recent Changes

17887 by rjollos on 2020-12-03 05:33:09
TracWantedPages 0.6: Publish version 0.6

Version 0.6 is r17745.

Bump trunk to 0.7.0dev.

Refs #13913, #13860, #12803.

17885 by rjollos on 2020-12-01 13:30:00
TracWantedPages 0.6dev: Fix parsing of anchors in headings

Refs #13913.

17884 by rjollos on 2020-12-01 09:27:44
TracWantedPages 0.6dev: Fix malformed markup resulting in exception

Make fetching of wiki pages more efficient.

Fixes #13913.

(more)

Author/Contributors

Author: jfrancis
Maintainer: Geert
Contributors: