Difference between revisions of "UniWiki:Manual of Style/Layout"

From EVE University Wiki
Jump to: navigation, search
Line 40: Line 40:
 
Headings introduce sections and subsections, clarify articles by breaking up text, organize content, and populate the [[Wikipedia:WP:TOC|table of contents]]. Very short or very long sections and subsections in an article look cluttered and inhibit the flow of the prose. Short paragraphs and single sentences generally do not warrant their own subheading.
 
Headings introduce sections and subsections, clarify articles by breaking up text, organize content, and populate the [[Wikipedia:WP:TOC|table of contents]]. Very short or very long sections and subsections in an article look cluttered and inhibit the flow of the prose. Short paragraphs and single sentences generally do not warrant their own subheading.
  
−
Headings follow a six-level hierarchy, starting at 1 and ending at 6. The level of the heading is defined by the number of equal signs on either side of the title. Heading 1 (<code>=Heading&nbsp;1=</code>) is automatically generated as the title of the article. Sections start at the first (<code>=Heading&nbsp;1=</code>) or second level (<code>==Heading&nbsp;2==</code>), with subsections at the third level (<code>===Heading&nbsp;3===</code>), and additional levels of subsections at the fourth level (<code>====Heading&nbsp;4====</code>), fifth level, and sixth level. Sections should generally be consecutive, such that they do not skip levels from sections to sub-subsections; the exact methodology is part of the [[UniWiki:Manual of Style/Accessibility|Accessibility]] guideline.<ref>For example, skipping heading levels, such as jumping from <code>==Heading&nbsp;2==</code> to <code>====Heading&nbsp;4====</code> without <code>===Heading&nbsp;3===</code> in the middle, violates [[Wikipedia:Accessibility]] as it reduces usability for readers on screen readers who use heading levels to navigate pages.</ref> It can, however, be permissible to skip specifically from Heading 1 to Heading 3 in cases where multiple, short subsections using Heading 2 would unnecessarily break up the page.
+
Headings follow a six-level hierarchy, starting at 1 and ending at 6. The level of the heading is defined by the number of equal signs on either side of the title. Heading 1 (<code>=Heading&nbsp;1=</code>) is automatically generated as the title of the article. Sections start at the first (<code>=Heading&nbsp;1=</code>) or second level (<code>==Heading&nbsp;2==</code>), with subsections at the third level (<code>===Heading&nbsp;3===</code>), and additional levels of subsections at the fourth level (<code>====Heading&nbsp;4====</code>), fifth level, and sixth level. Sections should generally be consecutive, such that they do not skip levels from sections to sub-subsections; the exact methodology is part of the [[UniWiki:Manual of Style/Accessibility|Accessibility]] guideline.<ref>For example, skipping heading levels, such as jumping from <code>==Heading&nbsp;2==</code> to <code>====Heading&nbsp;4====</code> without <code>===Heading&nbsp;3===</code> in the middle, violates [[UniWiki:Manual of Style/Accessibility|UniWiki:Accessibility]] as it reduces usability for readers on screen readers who use heading levels to navigate pages.</ref> It can, however, be permissible to skip specifically from Heading 1 to Heading 3 in cases where multiple, short subsections using Heading 2 would unnecessarily break up the page.
  
 
Between sections, there should be a ''single'' blank line; multiple blank lines in the edit window create too much white space in the article. There is no need to include a blank line between a heading and sub-heading.
 
Between sections, there should be a ''single'' blank line; multiple blank lines in the edit window create too much white space in the article. There is no need to include a blank line between a heading and sub-heading.

Revision as of 22:56, 22 December 2016

This page is a part of the UniWiki's Manual of Style. It is a general guideline intended to harmonize article style across the UniWiki, though it is best treated with common sense, and exceptions may apply. Any substantive edit to this page should be approved by the Wiki Manager. When in doubt, discuss first on the talk page.

This guide presents the typical layout of UniWiki articles, which includes the sections an article usually has, ordering of sections, and formatting styles for various elements of an article.

For advice on the use of wiki markup, see Wikipedia:Editing; and for guidance on writing style, see UniWiki Manual of Style.

Order of article elements

See also: UniWiki:Manual of Style#Section headings

A simple article should have at least a lead section and references. As editors add complexity where required, the elements (such as sections and templates) that are used typically appear in the following order, although they would not all appear in the same article at the same time:

  1. Before the lead section
    1. Hatnotes
    2. Deletion/Protection tags
    3. Infoboxes
    4. Images
    5. Navigational boxes (header navboxes)
  2. Body
    1. Lead section (also called the introduction)
    2. Table of contents
    3. Content
  3. Appendices
    1. See also
    2. Notes and references (this can be two sections when appropriate)
    3. Further reading
    4. External links
  4. Bottom matter
    1. Navigation templates (footer navboxes)
    2. Defaultsort
    3. Categories[1]

Body sections

Further information: UniWiki:Manual of Style § Article titles, heading, and sections

Articles longer than a stub are generally divided into sections, and sections over a certain length are generally divided into paragraphs; these divisions enhance the readability of the article. Articles should follow good organizational and writing principles regarding sections and paragraphs.

Headings and sections

Further information: UniWiki:Manual of Style § Section headings

Headings introduce sections and subsections, clarify articles by breaking up text, organize content, and populate the table of contents. Very short or very long sections and subsections in an article look cluttered and inhibit the flow of the prose. Short paragraphs and single sentences generally do not warrant their own subheading.

Headings follow a six-level hierarchy, starting at 1 and ending at 6. The level of the heading is defined by the number of equal signs on either side of the title. Heading 1 (=Heading 1=) is automatically generated as the title of the article. Sections start at the first (=Heading 1=) or second level (==Heading 2==), with subsections at the third level (===Heading 3===), and additional levels of subsections at the fourth level (====Heading 4====), fifth level, and sixth level. Sections should generally be consecutive, such that they do not skip levels from sections to sub-subsections; the exact methodology is part of the Accessibility guideline.[2] It can, however, be permissible to skip specifically from Heading 1 to Heading 3 in cases where multiple, short subsections using Heading 2 would unnecessarily break up the page.

Between sections, there should be a single blank line; multiple blank lines in the edit window create too much white space in the article. There is no need to include a blank line between a heading and sub-heading.

Names and orders for section headings

The UniWiki has no general standards or guidelines for what section headings are expected in the bodies of articles or what order they should take, because the diversity of presentation in various UniWiki subjects is too great. The usual practice is to name and order sections based on the precedent of some article which seems similar.

Section templates and summary style

When a section is a summary of another article that provides a full exposition of the section, a link to that article should appear immediately under the section heading. You can use the {{Main}} template to generate a "Main article" link.

If one or more articles provide further information or additional details (rather than a full exposition, see above), references to such articles may be placed immediately after the section heading for that section, provided this does not duplicate a wikilink in the text. These additional references should be grouped along with the {{Main}} template (if there is one), for easy selection by the reader, rather than being scattered throughout the text of a section. You can use the following template to generate these links:

  • {{See also}} – this generates a "See also" link

For example, to generate a "See also" link to the article on UniWiki:Manual of Style, type {{See also|UniWiki:Manual of Style}}, which will generate:

See also: UniWiki:Manual of Style

Paragraphs

See also: Wikipedia:Paragraphs

Sections usually consist of paragraphs of running prose. Between paragraphs—as between sections—there should be a single blank line and the first line of each paragraph is not indented. Bullet points should be minimized in the body and lead of the article, if they are used at all; however, a bulleted list may be useful to break up what would otherwise be a large, grey mass of text, particularly if the topic requires significant effort on the part of readers. However, bulleted lists are typical in the reference and further-reading sections towards the end of the article. Bullet points are usually not separated by blank lines, as that causes an accessibility issue (See: Lists.)

The number of single-sentence paragraphs should be minimized, since they can inhibit the flow of the text; by the same token, paragraphs that exceed a certain length become hard to read. Short paragraphs and single sentences generally do not warrant their own subheading; in such circumstances, it may be preferable to use bullet points.

Standard appendices and footers

For the list and order of common appendices and footers, see § Order of article elements

Headings

When appendix sections are used, they should appear at the bottom of an article, with ==level 2 headings==,[3] followed by the various footers. When it is useful to sub-divide these sections (for example, to separate a list of magazine articles from a list of books), this should be done using level 3 headings (===Books===) instead of definition list headings (;Books), as explained in the accessibility guidelines.

Works or publications

Template:Further

Contents: A bulleted list, usually ordered chronologically, of the works created by the subject of the article.

Title: Many different titles are used, depending on the subject matter. "Works" is preferred when the list includes items that are not written publications (e.g. music, films, paintings, choreography, or architectural designs), or if multiple types of works are included. "Bibliography", "Discography", or "Filmography" are occasionally used where appropriate; however, "Bibliography" is discouraged because it is not clear whether it is limited to the works of the subject of the article.[4] "Works" or "Publications" should be plural, even if it lists only a single item.[5]

"See also" section

Template:Shortcut Template:For

See also: Wikipedia:Manual of Style/Embedded lists#See also lists

Contents: A bulleted list, preferably alphabetized, of internal links to related Wikipedia articles. Consider using {{Columns-list}} or {{Div col}} if the list is lengthy. The links in the "See also" section might be only indirectly related to the topic of the article because one purpose of "See also" links is to enable readers to explore tangentially related topics.

Editors should provide a brief annotation when a link's relevance is not immediately apparent, when the meaning of the term may not be generally known, or when the term is ambiguous. For example:

Whether a link belongs in the "See also" section is ultimately a matter of editorial judgment and common sense. The links in the "See also" section should be relevant, should reflect the links that would be present in a comprehensive article on the topic, and should be limited to a reasonable number. It is also not mandatory, as many high-quality and comprehensive articles do not have a "See also" section, although some featured articles like 1740 Batavia massacre and Mary, Queen of Scots include this section.

Template:Shortcut

The "See also" section should not link to pages that do not exist (red links) nor to disambiguation pages (unless used for further disambiguation in a disambiguation page). As a general rule, the "See also" section should not repeat links that appear in the article's body or its navigation boxes.

Other internal links: {{Portal}} and {{Wikipedia books}} links are usually placed in this section.

Title: The most common title for this section is "See also".

Notes and references

Template:Shortcut

For how to generate and format these sections, see Help:Footnotes and Wikipedia:Citing sources, particularly "How to create the list of citations".
Notes and References appear after See also (click on image for larger view).

Contents: This section, or series of sections, may contain any or all of the following:

  1. Explanatory footnotes that give information which is too detailed or awkward to be in the body of the article,
  2. Citation footnotes (either short citations or full citations) that connect specific material in the article with specific sources,
  3. Full citations to sources, if short citations are used in the footnotes
  4. General references (full bibliographic citations to sources that were consulted in writing the article but that are not explicitly connected to any specific material in the article)

Editors may use any citation method they choose.

If there are both citation footnotes and explanatory footnotes, then they may be combined in a single section, or separated using the grouped footnotes function. General references and other full citations may similarly be either combined or separated (e.g. "References" and "General references"). There may therefore be one, two, three or four sections in all.

It is most common for only citation footnotes to be used, and therefore it is most common for only one section to be needed. Usually, if the sections are separated, then explanatory footnotes are listed first, short citations or other footnoted citations are next, and any full citations or general references are listed last.

Title: Editors may use any section title that they choose.[6] The most frequent choice is "References"; other articles use "Notes", "Footnotes", or "Works cited" (in diminishing order of popularity) for this material.

Several alternate titles ("Sources", "Citations", "Bibliography") may also be used, although each is questionable in some contexts: "Sources" may be confused with source code in computer-related articles, product purchase locations, river origins, journalism sourcing, etc.; "Citations" may be confused with official awards or a summons to court; "Bibliography" may be confused with the complete list of printed works by the subject of a biography ("Works" or "Publications").

If multiple sections are wanted, then some possibilities include:

  • For a list of explanatory footnotes or shortened citation footnotes: "Notes", "Endnotes", or "Footnotes"
  • For a list of full citations or general references: "References" or "Works cited"

With the exception of "Bibliography", the heading should be plural even if it lists only a single item.[5]

Further reading

Template:Shortcut

Contents: An optional bulleted list, usually alphabetized, of a reasonable number of publications that would help interested readers learn more about the article subject. Editors may include brief annotations. Publications listed in Further reading are cited in the same citation style used by the rest of the article. The Further reading section should not duplicate the content of the External links section, and should normally not duplicate the content of the References section, unless the References section is too long for a reader to use as part of a general reading list. This section is not intended as a repository for general references that were used to create the article content. Any links to external websites included under Further reading are subject to the guidelines described at Wikipedia:External links.

External links

Template:Shortcut Template:Main article

Contents: A bulleted list of recommended relevant websites, each accompanied by a short description. These hyperlinks should not appear in the article's body text, nor should links used as references normally be duplicated in this section. "External links" should be plural, even if it lists only a single item.[5] This section may be replaced by a "Further reading" section.

Links to sister projects

Template:Main article

Links to Wikimedia sister projects and {{Spoken Wikipedia}} should generally appear in "External links", not under "See also". Two exceptions are Wiktionary and Wikisource links that may even be linked inline (e.g. to an unusual word or the text of a document being discussed).

Template:Commonscat More precisely, box-type templates such as Template:Tlx shown at right have to be put at the beginning of the last section of the article (which is not necessarily the "External links" section) so that boxes will appear next to, rather than below, the list items. Do not make a section whose sole content is box-type templates.

If box-type templates are not good, either because they result in a long sequence of right-aligned boxes hanging off the bottom of the article, or because there are no external links except sister project ones, then consider using "inline" templates, such as Template:Tlx in the "External links" section, so that links to sister projects appear as list items, like this:

Navigation templates

Template:Shortcut Template:Main article

Contents: Navigation templates and footer navboxes, such as succession boxes and geography boxes (for example, Template:Tlx). Most navboxes do not appear in printed versions of Wikipedia articles.[7]

Formatting

Images

Template:Shortcut Template:Main article

Images should ideally be spread evenly within the article, and relevant to the sections they are located in. All images should also have an explanatory caption. An image that would otherwise overwhelm the available text space on a 800×600 window should be shrunk or formatted as a panorama. It is a good idea to try to maintain visual coherence by aligning the sizes of images and templates on a given page.

When placing images, be careful not to stack too many of them within the lead, or within a single section; if the images in a section spill over into the next section at 1024×768 screen resolution, that may mean that the section is too short or there are too many images in that section. If an article has many images—so many, in fact, that they lengthen the page beyond the length of the text itself—you can use a gallery. Another solution might be to create a page or category combining all of them at Wikimedia Commons and use a relevant template ({{Commons}}, {{Commons category}}, {{Commons-inline}} or {{Commons category-inline}}) to link to it instead, so that further images are readily found and available when the article is expanded. Please see WP:IG for further information on the use of galleries.

As a general rule, images should not be set to a larger fixed size than the 220px default. If an exception to the general rule is warranted, forcing an image size to be either larger or smaller than the 220px default is done by placing a parameter in the image coding in the form |XXXpx. Lead images should usually be no wider than "300px" ("upright=1.35" defaults to that size, but may appear larger or smaller based on the thumbnail width setting in preferences). Larger images should generally be a maximum of 500 pixels tall and 400 pixels wide, so that they can comfortably be displayed on the smallest displays in common use.

Avoid referring to images as being on the left or right. Image placement is different for viewers of the mobile version of Wikipedia, and is meaningless to people having pages read to them by assistive software. Instead, use captions to identify images.

Horizontal rule

Template:Shortcut Horizontal rules—a series of hyphens (----) resulting in a straight line—are deprecated; that is, they are no longer used in articles. Rules were once employed to separate multiple meanings of a single article's name, but this task is now accomplished through disambiguation pages.

Rules can be used to provide separation inside certain templates (for example, {{sidebar}} derivatives), within discussions, or when needed in some other formats.

See also

Specialized layout

Other project pages

Footnotes

  1. ^ While categories are entered on the editing page ahead of stub templates, they appear on the visual page in a separate box after the stub templates. One of the reasons this happens is that every stub template generates a stub category, and those stub categories appear after the "main" categories.
  2. ^ For example, skipping heading levels, such as jumping from ==Heading 2== to ====Heading 4==== without ===Heading 3=== in the middle, violates UniWiki:Accessibility as it reduces usability for readers on screen readers who use heading levels to navigate pages.
  3. ^ Syntax: <source lang="moin" style="color: #000000; background: #FFFFFF; padding: 1em; border: 1px solid #8FBC8F; font-size:111%;">

    See also

    </source>

    Which produces:

    Template:Fake heading

  4. ^ Rationale for discouraging the use of "Bibliography."
  5. ^ a b c See, e.g., Wikipedia:External links#External links section.
  6. ^ One reason this guide does not standardize section headings for citations and explanatory notes is that Wikipedia draws editors from many disciplines (history, English, science, etc.), each with its own note and reference section naming convention (or conventions). For more, see Wikipedia:Perennial proposals#Changes to standard appendices, Wikipedia:Perennial proposals#Establish a house citation style and Template:Cnote2/example.
  7. ^ The rationale for not printing navigation boxes is that these templates contain wikilinks that are of no use to print readers.[1] There are two problems with this rationale: First, other wikilink content does print, for example See also and succession boxes. Second, some navigation boxes contain useful information regarding the relationship of the article to the subjects of related articles.
Retrieved from "https://wiki.eveuniversity.org/index.php?title=UniWiki:Manual_of_Style/Layout&oldid=103495"