Template:NewDYKnomination/doc

From Wikipedia, the free encyclopedia

This template is used on subpages of Template:Did you know nominations to nominate articles for the Did you know? section of the Main Page.

Instructions for nominating[edit]

Base template

Type in your article name into the box below, and click on the blue button to create your nomination.


This will open an edit box with the following template:

{{subst:NewDYKnomination
 | article       = {{subst:str right|{{subst:PAGENAME}}|25}} 
 |    article2   = 
 | status        = new / expanded / mainspace / redirect / GA
 | hook          = ... that ...? <small>Source: "You are strongly encouraged to quote the source text supporting each hook" (and [link] the source, or cite it briefly without using citation templates)</small>
 | ALT1          = ... that ...? <small>Source: "You are strongly encouraged to quote the source text supporting each hook" (and [link] the source, or cite it briefly without using citation templates)</small>
 | author        = 
 |    author2    = 
 | image         = 
 |    caption    = 
 | comment       = 
 | reviewed      = 
}}
You may wish to open this page in a separate browser tab so that you can read this guide while you are editing.
articles

Add the names of the articles you are nominating. You can skip this step if you are only nominating one article, and its name is the same as the one you typed into the input box above.

Add the name of the first article (no wiki formatting) to the parameter called |article=. For example:

 | article = French Revolution

If you are nominating more than one article, add the others to |article2=, |article3=, etc. Example:

 | article2 = Maximilien Robespierre
 | article3 = Guillotine
 | article4 = Cake
hook

Add the hook to the parameter called |hook=, following the hook guidelines at WP:DYK#The hook. Remember to begin the hook with "... that", to end it with a question mark, and to link the article title within the hook and make it bold. If you will be using an image with the hook, don't forget to put ''(pictured)'' in it. Example:

 | hook = ... that a lot of people died during the '''[[French Revolution]]''' ''(pictured)''?
status
If you created this article from scratch, make |status=new. If you expanded it from an existing article, make |status=expanded. If you newly source and expand a completely unsourced BLP, make |status=BLP expanded. If you moved it from non-mainspace to mainspace, make |status=moved. If the article passed a Good Article review, make |status=GA. If you converted the page to an article from a redirect or a disambiguation page, use |status=redirect.
contributors

Add the names of the editors who contributed to the article being nominated for DYK. You can skip this step if you are the main contributor, and there are no other contributors that need to be credited.

In the parameter called |author= add the name of the article's primary author (whoever did the work that's being nominated for DYK—either the person who originally created the article, or the one who expanded it recently). Type out the username in plain text with no formatting; do not use ~~~~. Example:

 | author = Jimbo Wales

Just like the article names, you can add more than one author if several people collaborated, using |author2=, |author3=, etc.

If you are nominating an article of which you are not an |author=, don't worry. The template knows that you are the nominator; you don't have to fill in anything extra.
image

If you are not nominating an image to go with your hook, skip this section.

If you are nominating an image, put its filename in |image=. Do note use File:, Image:, or any attributes like thumb and 100px, just use the bare filename, like this:

 | image = Prise de la Bastille.jpg

After that, add an appropriate caption in the |caption= parameter. This supplies both the tooltip (the text that appears when a reader leaves his mouse over the image for a moment) and the alt-text (the text that is used by screen readers or is shown to readers whose browser cannot display the image). It should be a physical description of the contents of the image, not a comment about the image. Please review WP:ALT to see the guidelines for how alt-text should be written.

Overall, the code for the image nomination should look something like this:

 | image = Prise de la Bastille.jpg
 | caption = A painting depicting the storming of the Bastille, 1789
comments

If you have any additional comments or explanation to add (such as "the source of the hook fact can be found on page 12"), add them in the |comment= field. If not, leave that field blank.

 | comment = Article created in my userspace on May 12, moved to mainspace on June 3.
review

If applicable, list the article that you reviewed, in accordance with the review requirement. Please provide the article name, or note that you still have to conduct a review.

 | reviewed = I still have to review another nomination and will post this here once it's done.
alternate hooks

If you have only one hook to suggest for your nomination, skip this step. But if you want to suggest more than one hook, you can put addition hooks in the fields |ALT1=, |ALT2=, etc.

 | ALT1 = ... that millions of high school students learn about the '''[[French Revolution]]''' ''(pictured)'' every year?
nominate

Now the template in the edit window should be nicely filled up. Mine looks something like this:

{{subst:NewDYKnomination
 | article         = French Revolution
 |    article2     = 
 | status          = expanded
 | hook            = ... that a lot of people died during the '''[[French Revolution]]''' ''(pictured)''?
 | ALT1            = ... that millions of high school students learn about the '''[[French Revolution]]''' ''(pictured)'' every year?
 | author          = Jimbo Wales
 |    author2      = 
 | image           = Prise de la Bastille.jpg
 |    caption      = A painting depicting the storming of the Bastille, 1789
 | comment         = Please save this nomination for a couple days so it can be on the main page for April Fools' Day!
 | reviewed        = Everlost (novel)
}}

(Your nomination does not necessarily need to have so many fields filled in. I just purposely filled in a lot to illustrate all of them.)

When you are ready, save the page. It should look something like this:


French Revolution

A painting depicting the storming of the Bastille, 1789

  • ALT1:... that millions of high school students learn about the French Revolution (pictured) every year?
  • Reviewed: Everlost (novel)
  • Comment: Please save this nomination for a couple days so it can be on the main page for April Fools Day!

5x expanded by Jimbo Wales (talk). Nominated by Mr. Stradivarius (talk) at 05:58, 1 April 2015 (UTC).

Usage[edit]

{{subst:NewDYKnomination
 | article       = {{subst:str right|{{subst:PAGENAME}}|25}} 
 |    article2   = 
 | status        = new / expanded / mainspace / redirect / GA
 | hook          = ... that ...? Source: "You are strongly encouraged to quote the source text supporting each hook" (and [link] the source, or cite it briefly without using citation templates)
 | ALT1          = ... that ...? Source: "You are strongly encouraged to quote the source text supporting each hook" (and [link] the source, or cite it briefly without using citation templates)
 | author        = 
 |    author2    = 
 | image         = 
 |    caption    = 
 | comment       = 
 | reviewed      = 
}}

All parameters are optional. The |author= parameter defaults to the nominator if the parameter is not present, and the |article= parameter defaults to the name of the current subpage. There is no need to sign with ~~~~ at the end of the template; that is done automatically.

Examples[edit]

  1. New Article, self nom: {{subst:NewDYKnom | article= | hook=... that ? | status=new }}
  2. Expansion, self nom: {{subst:NewDYKnom| article= | hook=... that ? | status=expanded }}
  3. New Article by someone else: {{subst:NewDYKnom | article= | hook=... that ? | status=new | author=}}
  4. Moved to mainspace: {{subst:NewDYKnom | article= | hook=... that ? | status=moved }}
  5. Converted to an article: {{subst:NewDYKnom | article= | hook=... that ? | status=converted }}
  6. Nom with comments or image: {{subst:NewDYKnom|article=|hook=... that ?|status=|author=|image=|caption=|comment=}}
  7. Nom with a sound file: {{subst:NewDYKnom|article=|hook=... that ?|status=|author=|sound=Example.ogg|soundcaption=Very brief}}
  8. Nom with a video file: {{subst:NewDYKnom|article=|hook=... that ?|status=|author=|video=Example.ogg|videocaption=Very brief}}

Parameters[edit]

Parameter How to use When to use
|article= Title of the article, no [[ ]]. If omitted, defaults to the name of the current subpage. Only if the article name differs from the current subpage name.[further explanation needed]
|article2= May be used if the hook has multiple articles; additional articles can be added with |article3=, |article4=, etc. When nominating multiple articles
|hook= The text of the hook, formatted using wiki markup; it will display exactly as it is written in this field. The article should be wikilinked and should appear in bold. Example: ... that '''[[Hurricane Irma]]''' prompted mass evacuations of [[Florida]]? Always
|author= Username of the article creator or expander, as e.g. JohnEditor, not User:JohnEditor [[User:JohnEditor]], not ~~~~. Use |author2= etc. as needed. You need not be one of the authors to nominate an article; in this case omit yourself. When specifying authors other than yourself
|status= new or expanded or moved or converted Always
|comment= May be used to add details in complicated nominations, or comments such as "Article expanded from redirect" or "See article for other funny pictures."
|reviewed= Title of article you reviewed, no [[ ]]. If the review requirement applies, and you did the review before nominating. (You can leave this blank and do the review later.)
|image= Filename of the image being used, e.g. Example.png, no File: and no [[ ]]. Do not include |right|100px which are added automatically. If an image is included with the nomination.
|caption= Caption to appear under the image, as well as the alt-text to go with the image. This must be included if there is an image. See WP:ALT for guidelines on writing alt-text. See also Template:Main page image/DYK.
|sound= Filename of the sound being used, e.g. Example.ogg, no File: and no [[ ]]. If a sound is included with the nomination.
|soundcaption= The caption to be displayed with the sound – a few words at most.
|video= Filename of the video being used, e.g. Example.ogv, no File: and no [[ ]]. If a video is included with the nomination.
|videocaption= The caption to be displayed with the video – a few words at most.
|ALT1= An alternate hook, formatted like the regular hook. Additional hooks can be added with |ALT2=, |ALT3=, etc. If you are suggesting an alternate hook along with the main hook.

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:NewDYKnomination in articles based on its TemplateData.

TemplateData for NewDYKnomination

Template for new nominations to the "Did You Know" section of the Main Page

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
Article titlearticle

Title of the nominated article in plain text; no [[ ]].

Default
Name of the nomination's subpage
Page nameoptional
Second article titlearticle2

article2, article3, and so on may be used if the hook has multiple articles.

Page nameoptional
Hookhook

The fact to appear on the Main Page; see guidelines at guidelines at WP:DYK#The hook

Auto value
... that ...? <small>Source: "You are strongly encouraged to quote the source text supporting each hook" (and [link] the source, or cite it briefly without using citation templates)</small>
Unbalanced wikitextrequired
Alternative hookALT1

An alternate hook, formatted like the regular hook. Additional hooks can be added with |ALT2=, |ALT3=, etc.

Unbalanced wikitextoptional
Authorauthor

Username of the creator or expander of the article in plain text; no signature or wikilinks.

Userrequired
Statusstatus

Enter "new" if you created this article from scratch, "expanded" if you expanded it from an existing article, "mainspace" if you moved it from non-mainspace to mainspace, "GA" if the article passed a Good Article review, "redirect" if you converted the page to an article from a redirect or a disambiguation page

Suggested values
new expanded mainspace redirect GA
Default
new/expanded
Auto value
Stringrequired
Commentcomment

Optional user comment. May be used to add details in complicated nominations.

Stringsuggested
QPQ reviewreviewed

If you reviewed another article before listing this DYK nomination, put it here. You can leave this blank and do the review later.

Page namesuggested
Imageimage

Bare filename of an optional image for the hook

Filesuggested
Image captioncaption

Caption and alt-text for the image

Stringsuggested
Soundsound

Filename of the sound being used. Use if a sound is included with the nomination.

Fileoptional
Sound captionsoundcaption

Caption to go under the sound player.

Fileoptional
Videovideo

Filename of the video being used. Use if a video is included with the nomination.

Fileoptional
Video captionvideocaption

The caption to be displayed with the video – a few words at most.

Fileoptional