Template:NCES Private School ID/doc

This template is designed to allow quick standardized inline references citing the National Center for Education Statistics Private School Universe Survey (PSS) website to be created for articles containing statistics about private schools in the United States. The PSS website contains enrollment numbers, faculty head-counts and other statistics for most schools in the US. It is envisioned that this data will be particularly suited for use in an {{Infobox school}}.

In its most common usage, this will produce text of the School ID as both a direct hyperlink to the NCES webpage for the school and an inline reference.

Restrictions

• This should be used ONLY for private US schools. See {{NCES School ID}} for a similar template for public (government funded) schools.
• DO NOT use subst: with this template! The url created internally could theoretically change. If it does, it is hoped that the url that this template defines can be updated, thus updating the links effortlessly in perhaps thousands of articles. If you use subst, your article will have to be edited by hand or live on with a dead link!
• By default the reference name is "nces_psch", therefore use this template only once in an article unless you supply different ref_name parameters for additional uses.

Usage

On a page needing the reference:

• Lookup the school statistics by going to Search for Private Schools. After submitting the search, click on the link for the individual school to get the school's statistics page.
• Note some information:
  • The "NCES School ID".
  • The name of the school as shown at NCES. This is often slightly different than the actual name of the school. The name shown should NOT influence the name you have chosen to use in your article!
  • You may also wish to note any statistics that the NCES site has that would be of interest.
• In your article, where the id number would go, enter {{NCES Private School ID|<the ID number>|school_name=<School name at NCES site>|access_date={{subst:#time: M j, Y}}}}.
• SAVE the article!
• Edit the article again.
• You will now have the ID number with an associated reference called "nces_psch". The reference has been fleshed out to a full web citation for you!
• Since you now have the named reference, for any of the interesting statistics from the NCES data used in your article, you may simply tag them with <ref name="nces_psch" /> and you have them fully cited!
• As with any article using references, remember to add <references /> or {{reflist}} at the bottom of your article.

Parameters

• 1st parameter (unnamed): mandatory is the "NCES School ID" and is mandatory.
• school_name: mandatory This is the name of the school as listed at the NCES database. This is needed to make the citation correct.
• access_date: mandatory The date used in the cite reference.
• do_not_render: If present with a value, will suppress the school ID as the text in front of the reference. If this is done, then your text immediately before the brackets is where the reference will go.
• do_not_show_link: If present with a value, will suppress the school ID as a direct link to the NCES data page. If do_not_render is in effect, this is ignored.
• ref_name: If supplied, will override the default of "nces_psch" as the reference name.

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:NCES Private School ID in articles based on its TemplateData.

TemplateData for NCES Private School ID

No description.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
School ID	1	Numeric code of the private school ID.	String	required
School name	school_name	Name of the school as listed in the NCES database.	String	required
Access date	access_date	Date used in the cite reference.	String	required
do_not_render	do_not_render	If used, suppresses the private school ID as the text in front of the reference and places the reference at the text immediately before the brackets.	Unknown	optional
do_not_show_link	do_not_show_link	If used, will suppress a direct link to the NCES data page. Ignored if do_not_render is in effect.	Unknown	optional
ref name	ref_name	If used, will override the default ref name of "nces_psch" with the supplied text.	String	optional

See also

• Template:NCES School ID, for US public schools
• Template:NCES District ID