UniWiki:Manual of Style/Lists

From EVE University Wiki
Jump to: navigation, search
This page is about lists in UniWiki articles. For other information about lists, see Wikipedia:Lists.
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.

Lists are commonly used on the UniWiki to organize information. Lists may be found within the body of a prose article or as a stand-alone article. This guideline explains when and how to use lists appropriately.

Types of lists

A list can stand alone as a self-contained page, or it can be embedded in an article.

Stand-alone list articles

See also: Wikipedia:Stand-alone lists

List articles are encyclopedia pages consisting of a lead section followed by a list (which may or may not be divided by headings). The items on these lists include links to articles in a particular subject area and may include additional information about the listed items. The titles of stand-alone lists typically begin with the type of list it is (List of, Index of, etc.), followed by the article's subject; like: List of vegetable oils. They can be organised alphabetically, by subject classification or by topics in a flat or hierarchical structure.

The title and bullet style, or vertical style, is common for stand-alone lists. These UniWiki articles follow the Wikipedia:Stand-alone lists style guideline.

Embedded lists

Main article: Wikipedia:Manual of Style/Embedded lists

Embedded lists are lists used within articles to present information that supplements the article's prose content. Wikipedia also uses several types of standard appendices, usually in list format, including "See also", "References", and "External links" sections, as well as navigational templates.

Purposes of lists

Further information: Wikipedia:Stand-alone lists#Selection criteria

Lists have three main purposes:

Information

The list may be a valuable information source. This is particularly the case for a structured list. Examples would include lists organized chronologically, grouped by theme, or annotated lists.

Navigation

Lists which contain internally linked terms (i.e., wikilinks) serve, in aggregate, as natural tables of contents and indexes of the UniWiki. Users without a specific research goal in mind might find the articles listed in articles' see also sections useful. Lists are also provided in portals to assist in navigating their subjects, and lists are often placed in articles via the use of series boxes and other navigational templates.

Users with a specific research goal, described in one or two words, are likely to find the UniWiki's search box useful.

Development

Some lists are useful for UniWiki development purposes. The lists of related topics give an indication of the state of the UniWiki, the articles that have been written, and the articles that have yet to be written. However, as the UniWiki is optimized for readers over editors, any lists which exist primarily for development or maintenance purposes (such as a list that consists entirely of red links and does not serve an informational purpose; especially a list of missing topics) should be in either the project or user space, not the main space.

Lists and categories

See also: Wikipedia:Categories, lists, and navigation templates

Redundancy of lists and categories is beneficial because the two formats work together; the principle is covered in the guideline Wikipedia:Categories, lists, and navigation templates. Like categories, lists can be used for keeping track of changes in the listed pages, using the Related Changes feature. Unlike a category, a list also allows detection of deletion of its entries, and, more generally, a history of its contents is available; lists also permit a large number of entries to appear on a single page.

List naming

For more details on this topic, see Wikipedia:Stand-alone lists#Naming conventions.

For a stand-alone list, the list's title is the page name. For an embedded list, the list's title is usually a section title (for instance, Latin Empire#Latin Emperors of Constantinople, 1204-1261), but it can be shorter. The list title should not be misleading and should normally not include abbreviations. Additionally, an overly precise list title can be less useful and can make the list difficult to find; the precise inclusion criteria for the list should be spelled out in the lead section (see below), not the title. For instance, words like complete and notable are normally excluded from list titles. Instead, the lead makes clear whether the list is complete or whether it is limited to widely-known or notable members (i.e., those that merit articles). Note that the word "famous" is considered an unnecessary "peacock" embellishment and should not be used.

List layout

Lead section or paragraph

The contents of an article that is a stand-alone list should be clear. If the title does not make clear what the list includes, then the list's lead section should do so. Don't leave readers confused about the list's inclusion criteria or have editors guessing as to what may be added to the list.

However short or schematic a list description, "neutral point of view" applies, including:

It should not be asserted that the most popular view or some sort of intermediate view among the different views is the correct one.

Lead sections and paragraphs should also not go counter to the recommendations of the Self-references to avoid guideline.

Lead sections in stand-alone lists

Further information: Wikipedia:Stand-alone lists#Selection criteria

Stand-alone lists should always include a lead section just as other articles do.

Wikipedia:Featured list criteria recommends that "[a list] has an engaging lead section that introduces the subject and defines the scope and inclusion criteria of the list".

Furthermore, non-obvious characteristics of a list, such as those regarding the list's structure, should be explained in its lead section (e.g., List of compositions by Franz Schubert by genre) or in a separate introductory section (e.g., List of compositions by Johann Sebastian Bach#Listing Bach's compositions).

Lists should not be used to create content forks between a topic that has a separate Wikipedia article (e.g., "republic") and a list complementary to that topic (e.g., "List of republics").

Lead paragraphs in embedded lists

Embedded lists should have a lead paragraph in cases where the title is ambiguous or when the list has non-obvious characteristics.

Organization

Although lists may be organized in different ways, they must always be organized. The most basic form of organization is alphabetical or numerical (such as List of Star Wars starfighters), though if items have specific dates a chronological format is sometimes preferable (List of Belarusian Prime Ministers). When using a more complex form of organization, (by origin, by use, by type, etc.), the criteria for categorization must be clear and consistent. Just as a reader or editor could easily assume that the headings A, B, C would be followed by D (rather than 1903), more complex systems should be just as explicit. If a list of Australians in international prisons contains the headings Argentina and Cambodia (organization by country), it would be inappropriate for an editor to add the heading Drug trafficking (organization by offense). If a list entry logically belongs in two or more categories (e.g., an Australian in an Argentine prison for drug trafficking), this suggests that the list categorization might be flawed, and should be re-examined.

Lists should never contain Unsorted or Miscellaneous headings, as all items worthy of inclusion in the list can be sorted by some criteria, although it is entirely possible that the formatting of the list would need to be revamped to include all appropriate items. Not-yet-sorted items may be included on the list's talk page while their categorization is determined.

Adding individual items to a list

Further information: Wikipedia:Stand-alone lists#Selection criteria

Lists, whether they are stand-alone lists (also called list articles) or embedded lists, are encyclopedic content just as paragraph-only articles or sections are. Although the format of a list might require less detail per topic, UniWiki policies and procedures apply equally to both a list of similar things as well as to any related article to which an individual thing on the list might be linked.

It is important to be bold in adding or editing items on a list, but also to balance boldness with being thoughtful, a balance which all content policies are aimed at helping editors achieve. Edits of uncertain quality can be first discussed on the talk page for feedback from other editors.

When reliable sources disagree, the policy of keeping a neutral point of view requires that we describe competing views without endorsing any in particular. Simply present what the various sources say, giving each side its due weight through coverage balanced according to the prominence of each viewpoint in the published, reliable sources.

When adding to a stand-alone list with links to other articles, follow the established format when adding your item, and then see if you can a link that item to an article focusing on that item's topic. If so, then consider if the list's format allows room for all the details of competing views in the list item or if those details should only be covered in the linked, main article on the topic. Either way, make sure to add them to the main article if they are not already there.

List styles

See also: Wikipedia:Help:List and UniWiki:Manual of Style#Bulleted and numbered lists

There are several ways of presenting lists on the UniWiki.

Bulleted lists

As a matter of style, list items should be formatted consistently in either sentence case or lower case. They should not have final punctuation unless they consist of complete sentences.

This style is appropriate for long lists, or lists of entries which consist of both a link and explanatory text. Also, it is appropriate when the article already has several titles or subtitles.

The Title provides a direct edit point, if one enables section editing. It also enables the automatic table of contents system to detect the list. It is not required, however.

In particular, do not double-space the lines of the list by leaving blank lines or extra HTML <br> tags after them. Doing this actually produces three lists with one item each! This can adversely affect machine-readability of the content if a continuous list is expected.[1] Moreover in certain web browsers, the extra white-space between one singular list and the next can have a visually jarring effect.

To float pictures to the right of the list, one should put the image markup before the first item in most cases.

Inserting the image markup as a separate line within the list once again will split it into two half-lists.

Should the length of the list items or the topical relevance of said image discourage display at the top corner, consider placing it after the asterisk of the first list-item it illustrates to avoid breaking continuity of the unordered list (<ul>...</ul>) element.

Note: Avoid floating images to the left of a list as this disrupts the indentation of the bullet-points, making the hierarchy of list-items more difficult for readers to ascertain.

Numbered lists

Similar to the above, use a # symbol to obtain a numbered list:

Wikitext HTML Appearance
== Title of list ==
# Example 1
# Example 2
# Example 3

Title of list

  1. Example 1
  2. Example 2
  3. Example 3
Title of list
  1. Example 1
  2. Example 2
  3. Example 3

Blank lines between items of an ordered list will not only cause the same problems as in the previous example, but will also restart the numbering at "1". This cannot be fixed without complex wiki markup (defeating ease-of-editing expectations), so double-spacing should always be avoided in numbered lists.

Tables

Although the use of tables to display lists is discouraged—because they provide low-quality accessibility and have a more complex notation that hinders editing—there are some instances where they can be useful, such as when three or more columns are required. See UniWiki:Manual of Style/Tables.

Horizontal lists

In situations such as infoboxes, a single-line list may be useful—in this case:

List type
entry one, entry two, entry three
Heading 1 Heading 2
List with commas Entry 1, entry 2, entry 3

Note the capitalization of only the first word in this list (but words that are normally capitalized would still be capitalized). This applies regardless of the separator used between the list type and the entries themselves—whether it is a comma or an infobox divider.

Bulleted and numbered lists

  • Do not use lists if a passage is read easily as plain paragraphs.
  • Use proper wikimarkup- or template-based list code (see also Wikipedia:Help:List).
  • Do not leave blank lines between items in a bulleted or numbered list unless there is a reason to do so, since this causes the Wiki software to interpret each item as beginning a new list.
  • Use numbers rather than bullets only if any of the following apply:
    • A need to refer to the elements by number may arise.
    • The sequence of the items is critical.
    • The numbering has some independent meaning, for example in a listing of musical tracks.
  • Use the same grammatical form for all elements in a list, and do not mix sentences and sentence fragments as elements.
    • When the elements are complete sentences, each one is formatted with sentence case (i.e. the initial letter is capitalized) and a final period.
    • When the elements are sentence fragments, the list is typically introduced by a lead fragment ending with a colon. When these elements are titles of works, they retain the original capitalization of the titles. Other elements are formatted consistently in either sentence case or lower case. No final punctuation is used.

Pro and con lists

See also: Wikipedia:Pro and con lists

These are lists of arguments for and against a particular contention or position. They include lists of Advantages and disadvantages of a technology or proposal (such as Wi-Fi) and lists of Criticisms and defenses of a political position or other view, such as libertarianism or evolution. Pro and con lists can encapsulate or bracket neutrality problems in an article by creating separate spaces in which different points of view can be expressed. An alternative method is to thread different points of view into running prose.

Either method needs careful judgment as to whether and how it should be used. In particular, pro and con lists can fragment the presentation of facts, create a binary structure where a more nuanced treatment of the spectrum of facts is preferable, encourage oversimplification, and require readers to jump back and forth between the two sides of the list.

See also

Notes

  1. ^ Blank lines cause particular problems for users of screen readers. A badly formatted example would be read out loud like this: "List of 1 items: Example 1, list end. List of 1 items: Example 2, list end. List of 1 items: Example 3, list end." Improper formatting can more than triple the length of time it takes to read the list.