Wikipedia:Manual of Style/Layout: Difference between revisions
m →Standard appendices: horrible, horrible typos. |
→Lead section: briefly say what is most important to know |
||
| Line 16: | Line 16: | ||
The subject of the article should be mentioned in '''bold text''' (<code><nowiki>'''subject'''</nowiki></code>) at a natural place, preferably in the first sentence. If the article is about a work of art, literature or an album, note that the first mention of the subject should be both '''''bold and italic''''' (<code><nowiki>'''''subject'''''</nowiki></code>). |
The subject of the article should be mentioned in '''bold text''' (<code><nowiki>'''subject'''</nowiki></code>) at a natural place, preferably in the first sentence. If the article is about a work of art, literature or an album, note that the first mention of the subject should be both '''''bold and italic''''' (<code><nowiki>'''''subject'''''</nowiki></code>). |
||
Normally, the first paragraph clearly |
Normally, the first paragraph summarizes the most important points of the article. It should clearly explain the subject so that the reader is prepared for the greater level of detail and the qualifications and nuances that follow. If further introductory material is needed before the first section, this can be covered in subsequent paragraphs. Introductions to biographical articles commonly double as summaries, listing the best-known achievements of the subject. Keep in mind that for many users this is all they will read, so the most important information should be included. Avoid links in the summary--users should be encouraged to read the summary, and the article, before jumping elsewhere. In addition the colored highlighting of the links may mislead some users into thinking these are especially important points. |
||
===First paragraph=== |
===First paragraph=== |
||
Revision as of 20:27, 12 July 2006
 | This guideline is a part of the English Wikipedia's Manual of Style. It is a generally accepted standard that editors should attempt to follow, though it is best treated with common sense, and occasional exceptions may apply. Any substantive edit to this page should reflect consensus. When in doubt, discuss first on the talk page. |
| Manual of Style (MoS) |
|---|
The Wikipedia Guide to Layout is an annotated, working example of some of the basics of laying out an article. It is a summary of what some articles look like. For more complicated articles, you may wish to copy the markup of an existing article that appears to have an appropriate structure.
This guide is not about how to use wiki markup (see Help:Editing for that); nor is it about style (see Wikipedia:Manual of Style for that).
Lead section
Unless an article is very short, it should start with a lead section consisting of one or more introductory paragraphs. The lead is shown above the table of contents (for pages with more than three headings). The appropriate lead length depends on the length of the article, but should be no longer than three paragraphs. The lead should not be explicitly entitled == Introduction == or any equivalent header.
The subject of the article should be mentioned in bold text ('''subject''') at a natural place, preferably in the first sentence. If the article is about a work of art, literature or an album, note that the first mention of the subject should be both bold and italic ('''''subject''''').
Normally, the first paragraph summarizes the most important points of the article. It should clearly explain the subject so that the reader is prepared for the greater level of detail and the qualifications and nuances that follow. If further introductory material is needed before the first section, this can be covered in subsequent paragraphs. Introductions to biographical articles commonly double as summaries, listing the best-known achievements of the subject. Keep in mind that for many users this is all they will read, so the most important information should be included. Avoid links in the summary--users should be encouraged to read the summary, and the article, before jumping elsewhere. In addition the colored highlighting of the links may mislead some users into thinking these are especially important points.
First paragraph
The title or subject should almost always be part of the first sentence or elsewhere in the first paragraph.
- The Pythagorean theorem is named after and attributed to the 6th century BC Greek philosopher and mathematician Pythagoras
The '''Pythagorean theorem''' is named after and attributed to the [[6th century BC]] Greek philosopher and mathematician [[Pythagoras]]
- Tom and Jerry — Pairing of names from Pierce Egan's Life in London
'''Tom and Jerry''' — Pairing of names from [[Pierce Egan]]'s ''Life in London''
If the subject of the article has more than one name, each new form of the name should be in bold on its first appearance.
'''Sodium hydroxide''' ([[sodium|Na]][[oxygen|O]][[hydrogen|H]]), also known as '''caustic soda''' or '''lye'''....
If an article's title has a parenthetical disambiguator, it should not be included in the bold text.
- Cream (food) should start with "Cream is a dairy product...", not "Cream (food) is a dairy product...".
Make the context clear in the first few words.
- In quantum physics, the Heisenberg uncertainty principle...
In [[quantum physics]], the '''Heisenberg uncertainty principle'''...
Avoid links in the bold title words, and avoid circular definitions. However, most words describing titles should be linked to more detail.
- Buddhist meditation, meditation used in the practice of Buddhism, "includes any method of meditation that has Enlightenment as its ultimate aim." (Kamalashila 1996)
'''Buddhist meditation''', [[meditation]] used in the practice of [[Buddhism]], "includes any method of meditation that has Enlightenment as its ultimate aim." (Kamalashila 1996)
"See also" line at top
A "see also" line is sometimes put at the beginning, to link to an article about another meaning of the word, or in the case of a link that many readers are likely to follow instead of reading the article. Do not make this initial "see also" a section. In such cases, the line should be italicized and indented using templates. A horizontal line should not be placed under this line.
Links
Adding square brackets ([[...]]) around a word or phrase is an important part of Wikifying articles. This links significant words to a corresponding article that contains information that will help the reader to understand the original article. For example, an article might mention 'pancakes' without explaining what they are, although a brief phrase explaining the term might be more appropriate in many instances. An article about laser beams might provide helpful background material when mentioned in passing. It is important to follow the links that you have added and check that they lead to the right page. For advice about what to link and what not to link, see Wikipedia:Make only links relevant to the context, Wikipedia:Manual of Style (links)#Internal links and Wikipedia:Manual of Style (dates and numbers)#Date formatting. Useful links that are not mentioned in the prose paragraphs can be added to the "see also" section.
Body sections
Structure of the article
The number of single-sentence paragraphs should be minimized, since these can inhibit the flow of the text. By the same token, paragraphs become hard to read once they exceed a certain length.
Articles generally comprise prose paragraphs, not bullet points; however, sometimes a bulleted list can break up what would otherwise be an overly large, grey mass of text, particularly if the topic requires significant effort on the part of readers. Bulleted lists should not be overused in the main text, but are typical in the reference and reading sections at the bottom.
Headings help to make an article clearer, and populate the table of contents; see Wikipedia:Section, which users can choose under 'Preferences' to view (the default) or not to view.
Headings are hierarchical, so you should start with == Header == and follow it with === Subheader ===, ==== Subsubheader ====, and so forth. The 'second-level' == Header == is overly large in some browsers, but that can be fixed for individual viewers with a style sheet more easily than a nonhierarchical article structure can be fixed (see help:User style).
Just as for paragraphs, sections and subsections that are very short will make the article look cluttered and inhibit the flow. Short paragraphs and single sentences generally do not warrant their own subheading, and in these circumstances, it may be preferable to use bullet points.
The degree to which subtopics should appear in a single article or be given their own pages is a matter of judgment and of controlling the total length of the article.
Between paragraphs and between sections, there should be only a single blank line. Multiple blank lines unnecessarily lengthen the article and can make it more difficult to read.
If a section is a summary of another article
When a section is a summary of another article, it should have a link before the text (but after the section heading):
{{main|Circumcision and law}}
which produces:
"See also" for one section
If the "See also" refers to a particular section, references to related articles that have not been linked from free links in the text may be placed before the text (but after the section heading):
{{See also|troll|flame}}
which produces:
Note: In short articles without sections, this is equivalent to the top note (above).
Rather than scattering such additional references thoughout the text of a section, they should be grouped together at the beginning of the section for easy selection by the reader:
Images
If the article can be illustrated with pictures, find an appropriate place to position these images and get them from Wikimedia Commons. For more information, see Wikipedia:Picture tutorial and Wikipedia:Images
Templates
You can use the template messages.
Horizontal dividing line
A horizontal dividing line has a conventional use, as a demarcation of division to isolate sections that logically could stand on their own as main sections with a disambiguating category in parentheses: Orion (mythology) and Orion (constellation). Horizontal dividing lines set apart the distinct meanings of a term.
When such sections contain only a few sentences in a single paragraph, this is a good way for readers to find your information. But if your article on a secondary meaning contains more than one paragraph, it may become confusing to the eye.
Note that these lines are not taken into account in the section numbering and TOC. As a result, the explanation of the second meaning of the word is treated as part of the previous section of the text written for the first meaning. To avoid this, use appropriate headers in addition to dividing lines.
In Wikipedia markup, a horizontal line is defined by a line of four dashes ('----').
Standard appendices
Certain optional standard sections should be added at the bottom of an article. There is currently no consensus on whether or not the singular or plural form of the section name should be used, although plural is more common (changing section names breaks permalinks, so it is best not to change already-established article section names). Common appendix sections:
- Quotations (deprecated)
- See also (or Related topics)
- Notes
- References
- Further reading (or Bibliography)
- External links
It is equally valid for "References" or "Further reading" to precede "Notes", however, there should not be another section between "Notes" and "References"
All succession boxes and navigational footers should go at the very end of the article, following "External links" but preceding the categories and interwiki links.
Quotations
Under this header, list any memorable quotations that are appropriate to the subject.
- "Misquotations are the only quotations that are never misquoted." — Hesketh Pearson, Common Misquotations (1934)
This header is largely deprecated. Usually, the most relevant quotes can be placed directly into the article text in order to illustrate the topic, and only a few quotes should ever be part of such a section. Longer lists of quotes are generally moved to Wikiquote and the Quotations section as a whole is replaced with a {{wikiquote}} badge, usually placed at the top of the "External links" section.
See also
Put here, in a bulleted list, other articles in the Wikipedia that are related to this one. A less common practice is to name this section "Related topics". Mostly, topics related to an article should be included within the text of the article as free links. The "See also" section provides an additional list of internal links as a navigational aid, and it should ideally not repeat links already present in the article.
It should be a heading of level 2 so that it appears in the table of contents. For example:
==See also== *[[Wikipedia:Manual of Style]] *[[Wikipedia:How to edit a page]]
Which produces:
Related topics should be grouped by subject area for ease of navigation. Also provide a brief explanatory sentence when the relevance of the added links is not immediately apparent - like so:
- Related person made a similar achievement on April 4, 2005.
Notes
A footnote is a note placed at the bottom of a page of a document that comments on, and may cite a reference for, a part of the main text. The connection between the relevant text and its footnote is often indicated with a number or symbol which is used both after the text fragment and before the footnote. The note following this sentence is one example.[1] Syntax:
According to scientists, the Sun is pretty big.<ref>Miller, E: "The Sun.", page 23. Academic Press, 2005</ref> The Moon, however, is not so big.<ref>Smith, R: "Size of the Moon", Scientific American, 46(78):46</ref>
==Notes==
<!--See http://en.wikipedia.org/wiki/Wikipedia:Footnotes for an explanation of how to generate footnotes using the <ref(erences/)> tags-->
<references/>
References
Put under this header, again in a bulleted list, any books, articles, web pages, et cetera that you used in constructing the article and have referenced (cited) in the article.[1] While not required, using a generic citation template segregates the reference into useful metadata that can be machine-interpreted. Additionally, notes should be added to the end of any reference that may not be self-evident. If you are dealing with controversial issues, it is useful to point out which sites take which stance, and maybe separate the links by proponents and critics. Example:
- "Wikipedia Reaches 1,000,000 Articles". Slashdot. March 1, 2006. Popular tech community mentions Wikipedia milestone.
Bibliography
This section may also be titled "Further reading".
Put under this header, again in a bulleted list, any books, articles, web pages, et cetera that you recommend as further reading, useful background, or sources of further information to readers.[1] This section follows the same formatting rules as the "References" section, but is for references that are not specifically cited in the article but have additional value for the reader who wants to know more about the topic.
When there are more than five references about the article, you may want to include them here so that there is a complete bibliography for users in one place. This makes it easier for users to print out all the references at once. To maintain the integrity of the bibliography, make sure all major titles are there even if they are listed elsewhere.
External links
Put here, in list form, any web sites that you have used or recommend for readers of the article.[1] Unlike wikilinks, which are often used within the article's text, external links are generally limited to the "External links" section. This section follows the same formatting rules as the "References" section.
External links used as references should accordingly be listed in the "References" section. Other links may also be under "Further reading", as suggested in Wikipedia:Citing sources: Further reading/external links.
Links to Sister projects should be under this section.
See also
- Wikipedia:Manual of Style (headings)
- Wikipedia:User preferences help
- Wikipedia:Guide to writing better articles
- Wikipedia:Talk page guidelines shows how to use headings on talk pages
Notes
Since the introduction of <reference/> this section is often named "Footnotes"
- ^ a b c d This is an example footnote. The "Notes" section generally only requires a <references/> tag. This is automatically populated with <ref> notes made throughout the article. See Wikipedia:Footnotes for details about this developing practice. The system of presenting notes (as well as "References," "Further reading," and "External links") in a Wikipedia article may change over time; it is more important to have clarity and consistency in an article than to adhere to any particular system.