Template:WikiProject Romance/doc

This is a documentation subpage for Template:WikiProject Romance.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 2,800 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

The {{WikiProject Romance}} project banner template should be added (not subst:ed) to the talk page of every article within the scope of the project. While the template does not require any additional parameters, it has a number of optional ones that add various extra features to the banner. Transclusion also allows easy updating of all the Project's talk pages without having to edit hundreds of pages.

This template employs intricate features of template syntax.

You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.
You can conduct experiments, and should test all major changes, in either , the general template sandbox, or your user space before changing anything here.

Usage

The full syntax is as follows:

Romance C‑class High‑importance

Lua error in mw.title.lua at line 346: bad argument #2 to 'title.new' (unrecognized namespace name 'Portal').This article is within the scope of WikiProject Romance, an attempt to build a comprehensive and detailed guide to fictional romance in literature and romantic fiction writers. If you would like to participate, you can edit one of the articles mentioned below, or visit the project page, where you can join the project and contribute to the general Project discussion to talk over new ideas and suggestions.Romancewikipedia:WikiProject RomanceTemplate:WikiProject Romanceromance articles

C This article has been rated as C-class on Wikipedia's content assessment scale.

High This article has been rated as High-importance on the project's importance scale.

More information:
/
	This article has been automatically rated by a bot or other tool because one or more other projects use this class. Please ensure the assessment is correct before removing the `\|auto=` parameter.
	This article has been marked as needing immediate attention.
	This article has been marked as needing an infobox.
	This page has been marked as needing an image.

This WikiProject banner template uses Module:WikiProject banner, a meta-template for easily creating and maintaining project banners. Please report any errors or feature requests to Module talk:WikiProject banner. Information or warnings about the template are below:

The 4 notes in this template will automatically collapse if more than 2 of them are activated. To change this setting, set or update the |COLLAPSED= parameter.
This project banner specifies a non-existent assessment page Wikipedia:WikiProject Romance/Assessment. Please update or remove the |ASSESSMENT_LINK= parameter to fix this problem.
This banner template includes a link to Portal:Literature, but this portal does not exist - you may have defined |PORTAL= incorrectly or the portal may have been deleted.
Automatic parameter checking is enabled. Create the tracking category to track invalid parameters.

</syntaxhighlight>

Optional parameters

attention – set |attention=yes if the article needs immediate attention from experienced editors. Use only if another parameter does not cover the need for attention; this should be used sparingly. It is strongly encouraged to also add a section to the talk page explaining what needs attention.
- This parameter populates Category:Romance articles needing attention.
class – valid values are fa, a, ga, b, c, start, stub, fl, list, na (case-insensitive). See the project's quality scale for details. Setting an explicit value of NA is rarely necessary; for this, either leave |class= blank or omit the parameter.
importance – valid values are: top, high, mid, low, na (case-insensitive). See the project's importance scale for details. Setting an explicit value of NA is rarely necessary; for this, either leave |importance= blank or omit the parameter.
listas – This parameter, which is the equivalent of the DEFAULTSORT sortkey that should be placed on all biographical articles, is a sortkey for the article talk page (e.g. for Nora Roberts, use |listas=Roberts, Nora so that the talk page will show up in the R's and not the N's of the various assessment and administrative categories). This is important because it is one source used by those who set DEFAULTSORT on the article; consider also setting the DEFAULTSORT for the article when setting this parameter. For more information about this, please see Wikipedia:Categorization of people § Ordering names in a category.
If the article is using {{WikiProject banner shell}} then it is preferable to add |listas= to that template instead of a project banner template. Putting the parameter on more than one template is not required.
needs-infobox – set |needs-infobox=yes if the article needs an infobox. Remember that infoboxes are not suitable for all articles, and can overwhelm short articles.
- This parameter populates Category:Romance articles needing infoboxes.
needs-image – set |needs-image=yes to mark the page as needing an image.
- This parameter populates Category:Wikipedia requested images of Romance.
auto – This parameter is for the use of bots and indicates that the article has been automatically rated:
- |auto=length – based on the length of the article
- |auto=inherit – because one or more other projects use this class
- |auto=yes (or |auto=stub), in conjunction with |class=stub – as Stub-Class because it uses a stub template
  - Use of the above values (or value combinations) with this parameter populates Category:Automatically assessed romance articles.
category – set |category=no if, and only if, a banner is being used for demonstration or testing purposes, to prevent unnecessary or undesirable categorization. Otherwise, omit this parameter.

Aliases

The parameter |needs-photo= is recognised as an alias for |needs-image=. If both |needs-image= and |needs-photo= are present, |needs-photo= is ignored.

To avoid needlessly cluttering up talk pages, it is usually appropriate to remove any unused parameters from the template.