Module:Find templates in use/doc

Usage

This module will scrape a target page for the use of one or more named templates and, by default, return if the named templates were found to be in use.

Optional modifiers, accepting "yes" or "no" (uses Module:Yesno), allow for different search behaviors and return results.

{{#invoke:Find templates in use|main
| page      = <!-- required; "Example" or "Draft:Example" -->
| templates = <!-- required; "Short description" or "Use British English#Use mdy dates" -->
| inactive  = <!-- "yes" to override the default "no" -->
| nestled   = <!-- "yes" to override the default "no" -->
| params    = <!-- "yes" to override the default "no" -->
| all       = <!-- "yes" to override the default "no" -->
}}

page and templates

: alarming messages will be returned if:

• a value is not provided for |page=
• the provided value is not an existing page
• the page has no content (after inactive content is discarded unless |inactive=yes is set)
• a value is not provided for |templates=

|templates= may be a # delimited list of template names.

One template named and found

{{#invoke:Find templates in use|main
| page      = Draft:Example
| templates = Short description
}}

{
  ["Short description"] = true
}

Three templates named and found

{{#invoke:Find templates in use|main
| page      = Draft:Example
| templates = Short description#Hatnote#Replace
}}

{
  ["Hatnote"] = true,
  ["Replace"] = true,
  ["Short description"] = true
}

Three templates named but only one found

{{#invoke:Find templates in use|main
| page      = Draft:Example
| templates = Short description#Hatsune#Necklace
}}

{
  ["Short description"] = true
}

inactive

By default this module will ignore templates that are rendered inactive by being:

• commented out: <!--{{Example}}-->
• tagged such that expansion is prevented, e.g. {{Ex<nowiki/>ample}}

Set |inactive=yes to include these inactive templates in the results.

nestled

By default this module will ignore templates nestled in the parameters of other templates.

Set |nestled=yes to include nestled templates in the results.

Looking for {{lorem ipsum}}

{{#invoke:Find templates in use|main
| page      = Draft:Example
| templates = Lorem ipsum
}}

{}

Finding {{lorem ipsum}}

{{#invoke:Find templates in use|main
| page      = Draft:Example
| templates = Lorem ipsum
| nestled   = yes
}}

{
  ["Lorem ipsum"] = true,
}

params

By default this module will return only the existence of the templates it is tasked to find.

Set |params=yes to include the parameter content of each named template found in the results.

{{#invoke:Find templates in use|main
| page      = Draft:Example
| templates = Lorem ipsum
| nestled   = yes
| params    = yes
}}

{
  ["Lorem ipsum"] = {
    "2",
    "link=yes"
  }
}

all

By default this module will return only the first named template found.

Set |all=yes to include all of each named template found.

Without params

{{#invoke:Find templates in use|main
| page      = Draft:Example
| templates = Lorem ipsum
| nestled   = yes
| all       = yes
}}

{
  ["Lorem ipsum"] = 8
}

With params

{{#invoke:Find templates in use|main
| page      = Draft:Example
| templates = Lorem ipsum
| nestled   = yes
| params    = yes
| all       = yes
}}

{
  ["Lorem ipsum"] = {
    {
      "2",
      "link=yes"
    },
    {
      "1"
    },
    {
      "2",
      "link=no"
    },
    {
      "1"
    },
    {
      "2",
      "link=no"
    },
    {
      "1"
    },
    {
      "2",
      "link=no"
    },
    {
      "1"
    }
  }
}

All params and uses of multiple nestled templates

{{#invoke:Find templates in use|main
| page      = Draft:Example
| templates = Short description#Hatnote#Replace#Lorem ipsum
| nestled   = yes
| params    = yes
| all       = yes
}}

{
  ["Hatnote"] = {
    {
      "This is an '''example draft''' created via the [[WP:Articles for creation|Articles for creation]] process."
    }
  },
  ["Lorem ipsum"] = {
    {
      "2",
      "link=yes"
    },
    {
      "1"
    },
    {
      "2",
      "link=no"
    },
    {
      "1"
    },
    {
      "2",
      "link=no"
    },
    {
      "1"
    },
    {
      "2",
      "link=no"
    },
    {
      "1"
    }
  },
  ["Replace"] = {
    {
      "{{Lorem ipsum|2|link=yes}}",
      ".",
      ".<ref name=\"lipsum\">{{Lorem ipsum|1}}</ref>",
      "count=1"
    },
    {
      "{{Lorem ipsum|2|link=no}}",
      "",
      ".<ref name=\"lipsum\">{{Lorem ipsum|1}}</ref>",
      "count=1"
    },
    {
      "{{Lorem ipsum|2|link=no}}",
      "",
      ".<ref name=\"lipsum\">{{Lorem ipsum|1}}</ref>",
      "count=1"
    },
    {
      "{{Lorem ipsum|2|link=no}}",
      "",
      ".<ref name=\"lipsum\">{{Lorem ipsum|1}}</ref>",
      "count=1"
    },
  },
  ["Short description"] = {
    {
      "Example draft page"
    }
  }
}

Alarming messages

Alarming messages will be returned if:

• a |page= is not supplied
  • the page has no content (includes not existing)
  • |inactive=no (default) and the page has no active content
• there are no |templates= to search for

Category:Module documentation pages