UtterAccess HomeUtterAccess Wiki

Welcome Guest ( Log In | Register )

Edit Discussion
> Article Layout Guidelines    
Article Layout Guidelines


Related Content:
    Article Layout Guidelines (Compact)
    Article Layout Examples
    
UA Wiki Guidelines

The Layout Guide gives information concerning article layouts to maintain consistency across the Articles section of the UA Wiki. This article defines recommended practices concerning Article Header sections, Table of Contents, and Body and Section formatting. This is intended to be the definitive resource for the layout of Article content in the UA Wiki.



Contents

Header Section

The Header Section of an article (sometimes referred to as the Lead Section) is the introductory text and/or notifications that appear before the Table of Contents. In most cases, the Header Section is considerably shorter than the actual content of the page. The ideal is to provide an overview of the page's context and status.


Content Type

SeeAlso: Help:Content Type Templates, Content Type Templates (Template Subcategory)

Each type of content within the UA Wiki falls under a Content Type category. Content Types are implemented by placing one of the Content Type Templates as the first peice of markup in any page. For Articles, this is defined as simply "Article", and is implementated by placing the {{Article}} template call as the first content in the page's markup.

The purpose of the Content Type Templates are the same among the collection: they provide standard markup inclusion, formatting, categorization and/or other practices required for content consistency. For most Content Types, this includes the basic Categories which the Content will be placed and a Title for the page. Additional functions of the Content Type Template may vary widely among differing types of content.

Additional categorization may be applied through the use of the Content Type Template. Please see the help file noted in the above SeeAlso list for details.


Disambiguation Links

Main Article: Help:Disambiguation
SeeAlso: Create A New Disambiguation Page (HowTo), Add Your Page to an Existing Disambiguation Page (HowTo)

Applicable Disambiguation Links (dablinks) should be the first visible content in the article, where applicable. This informs the reader that there are other articles with the same name.

Disambiguation is the act of separating two or more entities who's names are the same. Disambiguation within the UA Wiki allows a reader to realize that the page they are on may not be the one they expected, if there are others with the same or very similar names.

Disambiguation is based on groups of pages. Each page in a particular group will have a list of other pages within the same group. For details on implementing a Disambiguation Page or Group, please refer to the help files referenced in the above SeeAlso links.

Image:QuestionSmall.gif Q: This looks pretty complicated... do I need it?
A: No. At least, not in the vast majority of cases. However, if it does require it and you do not supply it, a moderator or peer will be happy to include it for you

Page Notifications

Main Article: Page Notifications

Page Notifications are notification boxes or other displays that inform the user of any notable status of the article. Page Notifications should immediately follow any applicable Disambiguation Links for the article. Examples may include notifications for pages Under Construction, Requiring Review, General Cleanup an so on.

Some Page Notifications may automatically include the page in certain categories. For instance, the "Incomplete" notification will additionally place the article within the Content Requiring Completion category's Table of Contents.

For a complete list of available Page Notifications and their usage, see the Page Notifications link in the above Main Page reference.

Most of the Page Notifications are derived from the {{CoreNotificationBox}} template. Customized notifications can be created using the flexible CoreNotificationBox.

Page Notifications are intended for use primarily in the Header section of pages.


Related Content

Following any applicable Page Notifications, there should be a list of closely related content, if applicable. Use the RelatedContent template to insert formatted links into your article.

Links placed in the Related Content template should be links related to the content of the entire article, rather than things that are related to one section of the content or another.

While the syntax of the RelatedContent template allows you to display alternative text for the link, it is recommended to use the full page name rather than alternate text.


Introductory Text

The introductory text of the article should be a consice synopsis of the article, without getting into details regarding the subject matter. With the exception of Stubs, all articles should include an introductory text. Intro text should be limited to a couple of short paragraphs at most.


Table of Contents

The TOC will appear automatically for pages having more than three headings. The greater majority of articles will not require any special TOC handling. See Help:Table of Contents for more information.


Summary

The Header Section will contain the following content, as applicable:

{{Article}}
{{GetDAB|dab:pagename}}<!-- disambiguation linking -->

<!-- Page Notifications here, for example: -->
{{Incomplete|This page has an Incomplete notification}}

{{RelatedContent|
|[[Link 1]]
|[[Link 2]]
}}
Image:QuestionSmall.gif Q: What are those <!-- --> things?
A: In markup languanges (HTML, XML, Wiki Markup), these are comments. Anything contained within these tags are not processed by the parser.



Body Section

The Body section of an article is where the core content is. The Body should always contain at least one heading (this helps separate the Header and Body sections).


Heading Guidelines

Headings are used to separate and nest article content. While the UA Wiki Markup allows for the use of headings 1 through 6, for readability purposes it's recommended that top-level headings are implemented using H2 (== Top Level Heading ==) and nested successively. Headings 2, 3 and 4 are common in the UA Wiki, where relatively large articles may make use of headings 5 or 6. The use of Heading 1 is recommended only when the nested content of the page is deep enough to warrant it.

= Heading 1 =
== Heading 2 ==
=== Heading 3 ===
==== Heading 4 ====
===== Heading 5 =====
====== Heading 6 ======

Heading Spacing

When starting a new section heading, please include only one space between the previous content and the header, and one space between the header and the following content. An example:

...lacus arcu, molestie id sagittis ut, suscipit sollicitudin tellus. Curabitur orci felis, ultricies sit amet imperdiet in, tincidunt non nunc. Nullam ligula urna, commodo at interdum a, malesuada faucibus lectus. In hac habitasse platea dictumst.

=== New Heading ===

Aenean fringilla sodales massa sed tristique. Phasellus iaculis dui eu ante ullamcorper malesuada. Quisque condimentum enim sed mauris vestibulum et ullamcorper nisl fermentum. Nam sit amet libero magna...

If the heading is a level one or two, include a line break on the line before the heading. This helps space the larger text of these two headings with the previous content (this can be omitted for the first heading of the article):

...lacus arcu, molestie id sagittis ut, suscipit sollicitudin tellus. Curabitur orci felis, ultricies sit amet imperdiet in, tincidunt non nunc. Nullam ligula urna, commodo at interdum a, malesuada faucibus lectus. In hac habitasse platea dictumst.

<br>
== Headings 1 or 2 ==

Aenean fringilla sodales massa sed tristique. Phasellus iaculis dui eu ante ullamcorper malesuada. Quisque condimentum enim sed mauris vestibulum et ullamcorper nisl fermentum. Nam sit amet libero magna...

Heading Text & Naming

Text content in the header should remain brief, preferably a few words or short phrase rather than a sentence-like structure. This helps keep the articles looking clean. It should be made a priority to keep the heading text short enough to avoid wrap, as no font height compensation is given during the wrap, most often resulting in very undesirable results.

Additionally, headings automatically create anchors with the same ID as the heading text. Short, descriptive heading texts will make anchors easier to utilize.


Precautions for Editing Headings

Anchors (and thus Headings) may be referenced from within the page, the entire wiki, or any external source, so we can never be sure what links may rely on that anchor. If you feel a header text must be edited, please be sure to include a custom anchor with the original text as an ID, as described in the anchors help page. This will ensure that no links are broken.

Including Heading Notes

See Also: Heading Notes Templates

There may be situations where authors will put notifications of some sort that pertain to a particular section. Examples would be See Also templates, Main Page links or SectionContentForthcoming notifications.

Heading Notes should be placed after the heading itself, but before the heading text. For example:

== New Heading ==

{{Main|Main Page Link}}
{{SectionContentForthcoming}}
Aenean fringilla sodales massa sed tristique. Phasellus iaculis dui eu ante ullamcorper malesuada. Quisque condimentum enim sed mauris vestibulum et ullamcorper nisl fermentum. Nam sit amet libero magna...
Edit Discussion
Thank you for your support!
This page has been accessed 18,294 times.  This page was last modified 23:53, 19 January 2012 by Jack Leach.   Disclaimers