Jump to content

Template:WikiProject California/doc

From Wikipedia, the free encyclopedia

Usage

[edit]

This template {{WikiProject California}} adds articles to one or more subcategories of Category:WikiProject California and is a self-reference. Please add it to talk pages of relevant articles and non-article pages.

This template should be transcluded as {{WikiProject California}} and not substituted {{subst:}} because it employs conditional code. Transclusion also allows easy updating of all the WikiProject's talk pages without having to edit thousands of pages individually. For examples of how the template will appear under various parameter scenarios, please see Template:WikiProject California/Example.

The template also employs several optional data field parameters as described below. The full syntax is as follows:

{{WikiProject California
 | class              =
 | importance         =
 | auto               =
 | autoi              =
 | category           =
 | listas             =
 | attention          =
 | unref              =
 | needs-infobox      =
 | imageneeded        =
 | imagedetails       =
 | in                 =
 | mapneeded          =
 | mapdetails         =
 | mapin              =
 | selected-article   =
 | selected-picture   =
 | selected-biography =
 | selected-panorama  =
 | past-collaboration =
}}

Parameters legend

[edit]
  • class – valid values are listed in the custom class mask. 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.
  • 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
  • autoi – set |autoi=yes if it is for the use of bots and indicates that the article has been automatically prioritized.
  • 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.
  • 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 Gray Davis, use |listas=Davis, Gray so that the talk page will show up in the D's and not the G'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.
  • 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.
  • unref – set |unref=yes if the page needs additional references or inline citations. Leave blank or delete if not.
  • 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.
  • imageneeded – set |imageneeded=yes to request that a photograph, map, drawing, diagram, equation, or other image be added to the page. Leave blank or delete if not.
  • imagedetails – This free-form parameter can be used in conjunction with the imageneeded parameter to add specific details about the images being requested. For example, |imagedetails=Please add a live-action shot to this sports article will add the following to the template display: "An editor suggests the following: Please add a live-action shot to this sports article."
  • in – Used in conjunction with the |imageneeded=yes parameter to place the image request into a specific location, such as a California county. For example, |in=Los Angeles County, California will place the article talk page into Category:Wikipedia requested photographs in Los Angeles County, California. Leave blank or delete if not.
  • mapneeded – set |mapneeded=yes to request that a map be added to the page. Leave blank or delete if not.
  • mapin – Used in conjunction with the |mapneeded=yes parameter to place the map request into a specific location, such as a California county. For example, |in=Los Angeles County, California will place the article talk page into Category:Wikipedia requested maps in Los Angeles County, California. Leave blank or delete if not.
  • mapdetails – This free-form parameter can be used in conjunction with the |mapneeded= parameter to add specific details about the images being requested. For example, |mapdetails=Please add a map to this city article will add the following to the template display: "An editor suggests the following: Please add a map to this city article."
  • selected-article – set |selected-article=yes if the article is selected on the California portal.
  • selected-picture – set |selected-picture=yes if the picture is selected on the California portal.
  • selected-biography – set |selected-biography=yes if the biography is selected on the California portal.
  • selected-panorama – set |selected-panorama=yes if the panorama is selected on the California portal.
  • past-collaboration – Enter Month Year (e.g., |past-collaboration=February 2007) if the page previously was selected as the WikiProject's collaboration of the week/month. Leave blank or delete if not.

Notes

[edit]

To avoid needlessly cluttering up talk pages, it is usually appropriate to remove any unused parameters from the template. A common initial configuration for the template to copy/paste into the talk page of the article being assessed includes the following basic parameters:

{{WikiProject California|class=|importance=|imageneeded=|in=|unref=}}

Task forces

[edit]

The task force parameters are as follows:

 | sfba                          = yes
 | sfba-importance               =

 | la                            = yes
 | la-importance                 =

 | southerncalifornia            = yes
 | southerncalifornia-importance =

 | inland-empire                 = yes
 | inland-empire-importance      = 

 | calstate                      = yes
 | calstate-importance           =

Parameter aliases

[edit]
  • The parameter |los-angeles= is recognised as an alias for |la=. If both |la= and |los-angeles= are present, |los-angeles= is ignored.
  • The parameter |los-angeles-importance= is recognised as an alias for |la-importance=. If both |la-importance= and |los-angeles-importance= are present, |los-angeles-importance= is ignored.
  • The parameter |socal= is recognised as an alias for |southerncalifornia=. If both |southerncalifornia= and |socal= are present, |socal= is ignored.
  • The parameter |socal-importance= is recognised as an alias for |southerncalifornia-importance=. If both |southerncalifornia-importance= and |socal-importance= are present, |socal-importance= is ignored.
  • The parameter |csu= is recognised as an alias for |calstate=. If both |calstate= and |csu= are present, |csu= is ignored.
  • The parameter |csu-importance= is recognised as an alias for |calstate-importance=. If both |calstate-importance= and |csu-importance= are present, |csu-importance= is ignored.

TemplateData

[edit]
TemplateData
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:WikiProject California in articles based on its TemplateData.

TemplateData for WikiProject California

The template should be added to an item's talk page to indicates that its subject falls within the scope of WikiProject California (or one of the task forces within it), causing the page to be added to the project's tracking categories and the project banner to be displayed on its talk page

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Quality assessment classclass

Page quality assessment class (or page type, if non-article), , set to one of: ['FA', 'A', 'GA', 'B', 'C', 'Start', 'Stub', 'FL', 'List', 'FM', 'File', 'Draft', 'Category', 'Disambig', 'Portal', 'Redirect', 'Template', 'Project', 'NA']

Suggested values
FA A GA B C Start Stub FL List FM File Draft Category Disambig Portal Redirect Template Project NA
Example
Start
Linesuggested
Priority levelimportance

Priority for project members to improve the page, set to one of: ['Top', 'High', 'Mid', 'Low', 'NA']

Suggested values
Top High Mid Low NA
Example
Mid
Linesuggested
Quality auto-assessment methodauto

Determines the method to be used when the quality class is set by a bot, set to one of: ['inherit', 'length', 'stub', 'yes', 'no']

Suggested values
inherit length stub yes no
Example
yes
Lineoptional
Importance auto-assessedautoi

Indicates that the current importance value was assessed by a bot, if later changed by a user this parameter should be unset, set to one of: ['yes', 'no']

Default
no
Example
yes
Auto value
yes
Booleanoptional
Add to project categoriescategory

Controls the automatic addition of the page into the project's tracking categories, defaults to 'yes' (the 'no' setting is usually needed only for demos and testing pages), set to one of: ['yes', 'no']

Default
yes
Example
no
Auto value
yes
Booleanoptional
Set page DEFAULTSORTlistas

The page will be sorted in lists and categories by this value instead of by its actual name

Example
Donnell, Bobby
Lineoptional
Needs urgent attentionattention

Flags the page as requiring immediate attention when set to: ['yes']

Example
yes
Auto value
yes
Booleanoptional
Lacks referencesunref

Indicates that the article is grossly under-referenced when set to: ['yes']

Example
yes
Auto value
yes
Booleanoptional
Infobox missingneeds-infobox

Adds the page to a list of those that should display an infobox but currently lack one (so project members can address the issue more promptly) when set to: ['yes']

Example
yes
Auto value
yes
Booleanoptional
Needs imageimageneeded

Adds the page to a list of requested images for project members to photograph or scan and upload for inclusion when set to: ['yes']

Example
yes
Auto value
yes
Booleanoptional
Image request descriptionimagedetails

Details the desired image in the requested images list, in the event the need could be ambiguous

Example
A photo of the City Hall façade wide enough to show its location between the Justice Hall and Public Works building
Stringoptional
Requested image locationin

Specifies the location of the object to be photographed, typically given as 'This County, State', set to one of: ['Alameda County, California', 'Alpine County, California', 'Amador County, California', 'Butte County, California', 'Calaveras County, California', 'Colusa County, California', 'Contra Costa County, California', 'Del Note County, California', 'El Dorado County, California', 'Fresno County, California', 'Glenn County, California', 'Humboldt County, California', 'Imperial County, California', 'Inyo County, California', 'Kern County, California', 'Kings County, California', 'Lake County, California', 'Lassen County, California', 'Los Angeles County, California', 'Madera County, California', 'Marin County, California', 'Mariposa County, California', 'Mendocino County, California', 'Merced County, California', 'Modoc County, California', 'Mono County, California', 'Monterey County, California', 'Napa County, California', 'Nevada County, California', 'Orange County, California', 'Placer County, California', 'Plumas County, California', 'Riverside County, California', 'Sacramento County, California', 'San Benito County, California', 'San Bernardino County, California', 'San Diego County, California', 'San Francisco', 'San Joaquin County, California', 'San Luis Obispo County, California', 'San Mateo County, California', 'Santa Barbara County, California', 'Santa Clara County, California', 'Santa Cruz County, California', 'Shasta County, California', 'Sierra County, California', 'Siskiyou County, California', 'Solano County, California', 'Sonoma County, California', 'Stanislaus County, California', 'Sutter County, California', 'Tehama County, California', 'Trinity County, California', 'Tulare County, California', 'Tuolumne County, California', 'Ventura County, California', 'Yolo County, California', 'Yuba County, California', '']

Suggested values
Alameda County, California Alpine County, California Amador County, California Butte County, California Calaveras County, California Colusa County, California Contra Costa County, California Del Note County, California El Dorado County, California Fresno County, California Glenn County, California Humboldt County, California Imperial County, California Inyo County, California Kern County, California Kings County, California Lake County, California Lassen County, California Los Angeles County, California Madera County, California Marin County, California Mariposa County, California Mendocino County, California Merced County, California Modoc County, California Mono County, California Monterey County, California Napa County, California Nevada County, California Orange County, California Placer County, California Plumas County, California Riverside County, California Sacramento County, California San Benito County, California San Bernardino County, California San Diego County, California San Francisco San Joaquin County, California San Luis Obispo County, California San Mateo County, California Santa Barbara County, California Santa Clara County, California Santa Cruz County, California Shasta County, California Sierra County, California Siskiyou County, California Solano County, California Sonoma County, California Stanislaus County, California Sutter County, California Tehama County, California Trinity County, California Tulare County, California Tuolumne County, California Ventura County, California Yolo County, California Yuba County, California
Example
Mendocino County, California
Lineoptional
Needs mapmapneeded

Adds the page to a list of those that should display an map but currently lack one (so project members can address the issue more promptly) when set to: ['yes']

Example
yes
Auto value
yes
Booleanoptional
Map request descriptionmapdetails

Details the need in the requested maps list, in the event it could be ambiguous

Example
A map showing the school district's present boundaries superimposed over the city limits, with markers for current and former school sites
Stringoptional
Requested map locationmapin

Specifies the object to be depicted on the map, typically given as 'This County, State', set to one of: ['Alameda County, California', 'Alpine County, California', 'Amador County, California', 'Butte County, California', 'Calaveras County, California', 'Colusa County, California', 'Contra Costa County, California', 'Del Note County, California', 'El Dorado County, California', 'Fresno County, California', 'Glenn County, California', 'Humboldt County, California', 'Imperial County, California', 'Inyo County, California', 'Kern County, California', 'Kings County, California', 'Lake County, California', 'Lassen County, California', 'Los Angeles County, California', 'Madera County, California', 'Marin County, California', 'Mariposa County, California', 'Mendocino County, California', 'Merced County, California', 'Modoc County, California', 'Mono County, California', 'Monterey County, California', 'Napa County, California', 'Nevada County, California', 'Orange County, California', 'Placer County, California', 'Plumas County, California', 'Riverside County, California', 'Sacramento County, California', 'San Benito County, California', 'San Bernardino County, California', 'San Diego County, California', 'the San Francisco Bay Area', 'San Joaquin County, California', 'San Luis Obispo County, California', 'San Mateo County, California', 'Santa Barbara County, California', 'Santa Clara County, California', 'Santa Cruz County, California', 'Shasta County, California', 'Sierra County, California', 'Siskiyou County, California', 'Solano County, California', 'Sonoma County, California', 'Stanislaus County, California', 'Sutter County, California', 'Tehama County, California', 'Trinity County, California', 'Tulare County, California', 'Tuolumne County, California', 'Ventura County, California', 'Yolo County, California', 'Yuba County, California', '']

Suggested values
Alameda County, California Alpine County, California Amador County, California Butte County, California Calaveras County, California Colusa County, California Contra Costa County, California Del Note County, California El Dorado County, California Fresno County, California Glenn County, California Humboldt County, California Imperial County, California Inyo County, California Kern County, California Kings County, California Lake County, California Lassen County, California Los Angeles County, California Madera County, California Marin County, California Mariposa County, California Mendocino County, California Merced County, California Modoc County, California Mono County, California Monterey County, California Napa County, California Nevada County, California Orange County, California Placer County, California Plumas County, California Riverside County, California Sacramento County, California San Benito County, California San Bernardino County, California San Diego County, California the San Francisco Bay Area San Joaquin County, California San Luis Obispo County, California San Mateo County, California Santa Barbara County, California Santa Clara County, California Santa Cruz County, California Shasta County, California Sierra County, California Siskiyou County, California Solano County, California Sonoma County, California Stanislaus County, California Sutter County, California Tehama County, California Trinity County, California Tulare County, California Tuolumne County, California Ventura County, California Yolo County, California Yuba County, California
Example
Sonoma County, California
Lineoptional
Bay Area Task Forcesfba

Assigns the page to the San Francisco Bay Area Task Force when set to: ['yes']

Example
yes
Auto value
yes
Booleanoptional
Bay Area TF Prioritysfba-importance

Priority level of the page for attention from the San Francisco Bay Area Task Force, set to one of: ['Top', 'High', 'Mid', 'Low', 'NA']

Suggested values
Top High Mid Low NA
Example
Mid
Lineoptional
L.A. Task Forcela los-angeles

Assigns the page to the Los Angeles Task Force when set to: ['yes']

Example
yes
Auto value
yes
Booleanoptional
L.A. TF Priorityla-importance los-angeles-importance

Priority level of the page for attention from the Los Angeles Task Force, set to one of: ['Top', 'High', 'Mid', 'Low', 'NA']

Suggested values
Top High Mid Low NA
Example
Mid
Lineoptional
SoCal Task Forcesoutherncalifornia socal

Assigns the page to the Southern California Task Force when set to: ['yes']

Example
yes
Auto value
yes
Booleanoptional
SoCal TF Prioritysoutherncalifornia-importance socal-importance

Priority level of the page for attention from the Southern California Task Force, set to one of: ['Top', 'High', 'Mid', 'Low', 'NA']

Suggested values
Top High Mid Low NA
Example
Low
Lineoptional
Inland Empire Task Forceinland-empire

Assigns the page to the Inland Empire Task Force when set to: ['yes']

Example
yes
Auto value
yes
Booleanoptional
Inland Empire TF Priorityinland-empire-importance

Priority level of the page for attention from the Inland Empire Task Force, set to one of: ['Top', 'High', 'Mid', 'Low', 'NA']

Suggested values
Top High Mid Low NA
Example
Mid
Lineoptional
CalStateU Task Forcecalstate csu

Assigns the page to the California State University Task Force when set to: ['yes']

Example
yes
Auto value
yes
Booleanoptional
CalStateU TF Prioritycalstate-importance csu-importance

Priority level of the page for attention from the California State University Task Force, set to one of: ['Top', 'High', 'Mid', 'Low', 'NA']

Suggested values
Top High Mid Low NA
Example
Low
Lineoptional
Portal featured articleselected-article

Indicates that the article has been selected for the rotating Featured Article box on the California Portal when set to: ['yes']

Example
yes
Auto value
yes
Booleanoptional
Portal featured imageselected-picture

Indicates that the file has been selected to appear in the Featured Image box on the California Portal when set to: ['yes']

Example
yes
Auto value
yes
Booleanoptional
Portal featured biographyselected-biography

Indicates that the page has been selected to appear in the Featured Biography box on the California Portal when set to: ['yes']

Example
yes
Auto value
yes
Booleanoptional
Portal featured panoramaselected-panorama

Indicates that the file has been selected to appear in the Featured Panorama box on the California Portal when set to: ['yes']

Example
yes
Auto value
yes
Booleanoptional
Most recent collaborationpast-collaboration

Records the last time a page was selected by the project as the "Collaboration of the Week/Month," in the format 'Month Year'

Example
August 2021
Lineoptional