Module:Television episode short description/doc
 | This is a documentation subpage for Module:Television episode short description. It may contain usage information, categories and other content that is not part of the original module page. |
 | This module depends on the following other modules: |
 | This Lua module is used on approximately 18,000 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them. |
Module:Television episode short description extracts data from a television episode article's Template:Infobox television episode and creates a relevant short description based on the data available.
This module implements the {{Television episode short description}} template.
Usage
[edit]{{#invoke:Television episode short description|getShortDescription}}
Parameter list
[edit]The parameter names use a corresponding parameter from Template:Infobox television episode to fill in the data. They are listed below.
| Parameter | Corresponding infobox parameter | Description |
|---|---|---|
series_name
|
series
|
The TV series name. |
episode_num
|
episode
|
The episode's number. |
season_num
|
season
|
The season's number. |
season_num_uk
|
series_no
|
The season's number if using the British "series" term. |
not_dab
|
same name | Set if the TV series name has parentheses as part of its name. |
special
|
same name | Setting to "yes" will set the description as a "special episode". Any other value will replace the word "special" with the one entered. For example |special=recap will set the text to "recap episode".
|
limited
|
same name | Set if the series is a single season series, such as miniseries or limited series and does not need a season number as part of the description. |
Examples
[edit]Issues
[edit]- If an article does not show the short description with the data from the infobox, make sure you entered the parameter names correctly in the infobox.
Tracking categories
[edit]- Category:Television episode articles with short description with no series name (0)
- Category:Television episode articles with short description with no season number (1,357)
- Category:Television episode articles with short description with no episode number (14)
- Category:Television episode articles with short description for single episodes (16,557)
- Category:Television episode articles with short description for multi-part episodes (328)
- Category:Television episode articles with short description and disambiguated page names (8,293)
- Category:Pages using Television episode short description with unknown parameters (0)
See also
[edit]- Template:Television episode short description
- Module:Extract short description
- Module:Television episode disambiguation description
- Template:Television episode disambiguation description