Changes between Version 26 and Version 27 of WantedPagesMacro


Ignore:
Timestamp:
Sep 23, 2016, 7:32:08 PM (8 years ago)
Author:
figaro
Comment:

Moved example to functional description

Legend:

Unmodified
Added
Removed
Modified
  • WantedPagesMacro

    v26 v27  
    77Lists 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.
    88
    9 For example, '''MyPageAbc''' is a link to '''!MyPageAbc''', which does not exist. For more examples, see below.
     9For example, '''MyPageAbc''' is a link to '''!MyPageAbc''', which does not exist.
     10
     11`[[WantedPages]]` lists all wiki pages that are linked to, but do not exist.
     12
     13`[[WantedPages(show_referrers)]]` does the same thing, but also lists the pages that contain the broken links.
     14
     15`[[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)]]`.
     16
     17Note that the regex matches all or part of the name.
     18
     19More options:
     20 filter:: alias for ignored_referrers
     21 filtertype:: flags whether filter option is inclusive or exclusive, with values `inclusive` or `exclusive` (is also default value for backward compatibility)
     22
     23Examples:
     24- ignore all pages that contain 'Trac' in their name:
     25  * `[[WantedPages(show_referrers, ignored_referrers=Trac)]]`
     26  * `[[WantedPages(show_referrers, ignored_referrers=Trac, filtertype=exclusive)]]`
     27  * `[[WantedPages(show_referrers, filter=Trac)]]`
     28  * `[[WantedPages(show_referrers, filter=Trac, filtertype=exclusive)]]`
     29- only show pages that contain 'Trac' in their name:
     30  * `[[WantedPages(show_referrers, ignored_referrers=Trac, filtertype=inclusive)]]`
     31  * `[[WantedPages(show_referrers, filter=Trac, filtertype=inclusive)]]`
    1032
    1133== Bugs/Feature Requests
     
    4567}}}
    4668
    47 == Example
    48 
    49 `[[WantedPages]]` lists all wiki pages that are linked to, but do not exist.
    50 
    51 `[[WantedPages(show_referrers)]]` does the same thing, but also lists the pages that contain the broken links.
    52 
    53 `[[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)]]`.
    54 
    55 Note that the regex matches all or part of the name.
    56 
    57 More options:
    58  filter:: alias for ignored_referrers
    59  filtertype:: flags whether filter option is inclusive or exclusive, with values `inclusive` or `exclusive` (is also default value for backward compatibility)
    60 
    61 Examples:
    62 - ignore all pages that contain 'Trac' in their name:
    63   * `[[WantedPages(show_referrers, ignored_referrers=Trac)]]`
    64   * `[[WantedPages(show_referrers, ignored_referrers=Trac, filtertype=exclusive)]]`
    65   * `[[WantedPages(show_referrers, filter=Trac)]]`
    66   * `[[WantedPages(show_referrers, filter=Trac, filtertype=exclusive)]]`
    67 - only show pages that contain 'Trac' in their name:
    68   * `[[WantedPages(show_referrers, ignored_referrers=Trac, filtertype=inclusive)]]`
    69   * `[[WantedPages(show_referrers, filter=Trac, filtertype=inclusive)]]`
    70 
    7169== Recent Changes
    7270