Starfleet Logistics:Manual of Style/Layout

Jump to navigation Jump to search
File:Starfleet Logistics layout sample medium.png
Sample article layout (click on image for larger view)

This guide presents the typical layout of Starfleet Logistics 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 Help:Editing; and for guidance on writing style, see Manual of Style.

Order of article elements[edit source]

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. Short description
    2. Hatnotes
    3. Deletion/Protection tags (CSD, PROD, AFD, PP notices)
    4. Maintenance / dispute tags
    5. English variety and date style
    6. Infoboxes
    7. Foreign character warning boxes
    8. Images
    9. Navigational boxes (header navboxes)
  2. Body
    1. Lead section (also called the introduction)
    2. Table of contents
    3. Content
  3. Appendices[1]
    1. Works or publications (for biographies only)
    2. See also
    3. Notes and references (this can be two sections in some citation systems)
    4. Further reading
    5. External links[2]
  4. Bottom matter
    1. Succession boxes and geography boxes
    2. Other navigation templates (footer navboxes)[3] (navbars above {{Portal bar}})
    3. Geographical coordinates (if not in Infobox) or {{coord missing}}
    4. Authority control templates (taxonbar above Authority control)
    5. {{Featured list}}, {{Featured article}} and {{Good article}} (where appropriate for article status)
    6. Defaultsort
    7. Categories[4]
    8. Stub templates

Body sections[edit source]

File:Starfleet Logistics layout sample bodies.png
Body sections appear after the lead and table of contents (click on image for larger view).

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. The names and orders of section headings are often determined by the relevant WikiProject, although articles should still follow good organizational and writing principles regarding sections and paragraphs.

Headings and sections[edit source]

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, and is never appropriate within the body of articles. Sections start at the 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 be consecutive, such that they do not skip levels from sections to sub-subsections; the exact methodology is part of the Accessibility guideline.[5] 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. When changing or removing a heading, consider adding an anchor template with the original heading name to provide for incoming external links and wikilinks (preferably using {{subst:anchor}} rather than using {{anchor}} directly—see MOS:RENAMESECTION).

Names and orders for section headings[edit source]

Because of the diversity of subjects it covers, Starfleet Logistics has no general standard or guideline regarding the names or order of section headings within the body of an article. The usual practice is to name and order sections based on the precedent of similar articles. Contributors should follow the consensus model to establish an order.

If a section is named inappropriately you may also use the {{Rename section}} template.

Section templates and summary style[edit source]

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, in Starfleet Logistics's "hatnote" style.

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), or at the foot of the section that introduces the material for which these templates provide additional information. You can use one of the following templates to generate these links:

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

For example, to generate a "See also" link to the article on Starfleet Logistics:How to edit a page, type {{See also|Starfleet Logistics:How to edit a page}}, which will generate:

Paragraphs[edit source]

Sections usually consist of paragraphs of running prose. Between paragraphs—as between sections—there should be only a single blank line. First lines are not indented. Bullet points should not be used in the lead of an article, and should not be used in the body unless for breaking up a mass of text, particularly if the topic requires significant effort to comprehend. 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 MOS:LISTGAP).

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 instead.

Standard appendices and footers[edit source]

Headings[edit source]

When appendix sections are used, they should appear at the bottom of an article, with ==level 2 headings==,[6] 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[edit source]

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.[7] "Works" or "Publications" should be plural, even if it lists only a single item.[8]

"See also" section[edit source]

Contents: A bulleted list of internal links to related Starfleet Logistics articles. Consider using {{Columns-list}} or {{Div col}} if the list is lengthy. The list should be sorted either logically, chronologically, or alphabetically. One purpose of "See also" links is to enable readers to explore tangentially related topics; however, articles linked should be related to the topic of the article. 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:

  • Everyman – made a similar achievement on April 4, 2005
  • Ischemia – restriction in blood supply

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 such as 1740 Batavia massacre and Mary, Queen of Scots include this section.

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.[9]

The Manual of Style for medicine-related articles advises against such a section.

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

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

Notes and references[edit source]

File:Starfleet Logistics layout sample Notes References.png
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 or in parenthetical references in the body
  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 reasonable section title that they choose.[10] 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.[8]

Further reading[edit source]

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 or full citations that were used to create the article content. Any links to external websites included under "Further reading" are subject to the guidelines described at Starfleet Logistics:External links.

External links[edit source]

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.[8] Depending on the nature of the link contents, this section may be accompanied or replaced by a "Further reading" section.

Links to sister projects[edit source]

Links to Wikimedia sister projects and {{Spoken Starfleet Logistics}} should generally appear in "External links", not under "See also". If the article has no "External links" section, then place sister links at the top of the last section in the article. Two exceptions: Wiktionary and Wikisource links may be linked inline (e.g. to an unusual word or the text of a document being discussed).

More precisely, box-type templates such as {{Commons category}} 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 {{Commons category-inline}} in the "External links" section, so that links to sister projects appear as list items, like this:

Navigation templates[edit source]

Contents: Navigation templates and footer navboxes, such as succession boxes and geography boxes (for example, {{Geographic location}}). Most navboxes do not appear in printed versions of Starfleet Logistics articles.[11]

Specialized layout[edit source]

Stand-alone lists and talk pages have their own layout designs.

Certain topics have Manual of Style pages that include layout advice, including:

Some WikiProjects have advice pages that include layout recommendations. You can find those pages at Category:WikiProject style advice.

Formatting[edit source]

Images[edit source]

Each image should ideally be located in the section to which it is most relevant, and most should carry an explanatory caption. An image that would otherwise overwhelm the text space available within a 1024×768 window should generally be formatted as described in relevant formatting guidelines (e.g., SF:IMAGESIZE, MOS:IMGSIZE, Help:Pictures#Panoramas). Try to harmonize the sizes of images on a given page in order to maintain visual coherence.

If "stacked" images in one section spill over into the next section at 1024×768 screen resolution, there may be too many images in that section. If an article overall has so many images that they lengthen the page beyond the length of the text itself, you can use a gallery; or you can 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 available when the article is expanded. See Starfleet Logistics:Image use policy § Image galleries for further information on galleries.

Use |upright=scaling factor to adjust images sizes; for example, |upright=1.3 displays an image 30% larger than the default, and |upright=0.60 displays it 40% smaller. Lead images should usually be no larger than |upright=1.35.

Avoid referring to images as being to the left, right, above, or below, because image placement varies with platform (especially mobile platforms) and screen size, and is meaningless to people using screen readers; instead, use captions to identify images.

Horizontal rule[edit source]

Horizontal rules are sometimes used in some special circumstances, such as inside {{sidebar}} template derivatives, but not in regular article prose.

See also[edit source]

Other project pages[edit source]

Footnotes[edit source]

  1. ^ This sequence has been in place since at least December 2003 (when "See also" was called "Related topics"). See, for example, Starfleet Logistics:Perennial proposals § Changes to standard appendices. The original rationale for this ordering is that, with the exception of "Works", sections which contain material outside Starfleet Logistics (including "Further reading" and "External links") should come after sections that contain Starfleet Logistics material (including "See also") to help keep the distinction clear. The sections containing notes and references often contain both kinds of material and, consequently, appear after the "See also" section (if any) and before the "Further reading" section (if any). Whatever the validity of the original rationale, there is now the additional factor that readers have come to expect the appendices to appear in this order.
  2. ^ There are several reasons why this section should appear as the last appendix section. So many articles have the "External links" section at the end that many people expect that. Some "External links" and "References" (or "Footnotes", etc.) sections are quite long, and when the name of the section is not visible on the screen, it could cause problems if someone meant to delete an external link, and deleted a reference citation instead. Keeping the "External links" last is also helpful to editors who patrol external links.
  3. ^ Rationale for placing navboxes at the end of the article.
  4. ^ 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. Another is that certain bots and scripts are set up to expect the categories, stubs and interlanguage links to appear in that order, and will reposition them if they don't. Therefore, any manual attempt to change the order is futile unless the bots and scripts are also altered.
  5. ^ For example, skipping heading levels, such as jumping from ==Heading 2== to ====Heading 4==== without ===Heading 3=== in the middle, violates Starfleet Logistics:Accessibility as it reduces usability for readers on screen readers who use heading levels to navigate pages.
  6. ^ Syntax:
    ==See also==
    * [[Starfleet Logistics:How to edit a page]]
    * [[Starfleet Logistics:Manual of Style]]
    

    Which produces:

    See also
  7. ^ Rationale for discouraging the use of "Bibliography."
  8. ^ a b c For further information, see Starfleet Logistics:External links § External links section.
  9. ^ The community has rejected past proposals to do away with this "rule". See, for example, this RfC.
  10. ^ One reason this guide does not standardize section headings for citations and explanatory notes is that Starfleet Logistics draws editors from many disciplines (history, English, science, etc.), each with its own note and reference section naming convention (or conventions). For more, see Starfleet Logistics:Perennial proposals § Changes to standard appendices, § Establish a house citation style and Template:Cnote2/example.
  11. ^ The rationale for not printing navigation boxes is that these templates contain wikilinks that are of no use to print readers. 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.