[[PageOutline(2-5,Contents,pullout)]]

= List of non-existent wiki pages that are linked to

== Description

This macro 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.

To use this macro, add the following to the wiki page that you want to investigate non-existent wiki pages from:

`[[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 
[report:9?COMPONENT=WantedPagesMacro here].

If you have any issues, create a 
[/newticket?component=WantedPagesMacro new ticket].

[[TicketQuery(component=WantedPagesMacro&group=type,format=progress)]]

== Download

Download the zipped source for [export:wantedpagesmacro/0.11 0.11] or [export:wantedpagesmacro/trunk 1.0+].

The plugin is also available on [pypi:TracWantedPages PyPI].

== Source

You can check out WantedPagesMacro from [/svn/wantedpagesmacro here] using Subversion, or [source:wantedpagesmacro browse the source] with Trac.

== Installation

You must have setuptools installed. 

Run the following commands in the source directory:
{{{#!sh
python setup.py bdist_egg
cp dist/*.egg /path/to/projenv/plugins
}}}

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

You also have to enable it in the `trac.ini` file:
{{{#!ini
[components]
wantedpages.* = enabled
}}}

== Recent Changes

[[ChangeLog(wantedpagesmacro, 3)]]

== Author/Contributors

'''Author:''' [wiki:jfrancis] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''