UtterAccess HomeUtterAccess Wiki

Welcome Guest ( Log In | Register )

Custom Search
Edit Discussion
> Help:Disambiguation    
Disambiguation (Help)


This page describes the concept and usage of dismbiguation pages within the UA Wiki.

See these HowTo articles for basic, step by step instructions for working with Disambiguation:


Contents

Overview (Concept)

Disambiguation within a wiki refers to the process of separating and sorting individual pages that would share the same name. Pages that fall within this category will have a notification box at the head of the page which indentifies that the page is part of a group of other pages with similar names. This informs the reader that other pages exist, indicating that the page they're on may or may not be the one desired. The notification list provides navigation to other similarly named pages.

Snapshot Example:

Image:NotifDisambig.gif This page is part of a Disambiguation Group. If this is not the page you were looking for, please check the list below.
StackA Programming Collection method with FI/LO sequencing
Stack (Class)An example Stack class
Stack (Memory)An application or OS method of memory handling



Overview (Technique)

The notification box which is displayed at the top of the page (referred to as a Disambiguation Link, or dablink) is based on a special page which contains the information to be shown. This special page (referred to as a Disambiguation Page, or dabpage) is transcluded (that is, pulled from a separate source and shown in the target page) into the dablink.

A Disambiguation Group (or dabgroup) is a series of pages which share similar names and are included in the dabpage/dablink. There exists one dabpage for each dabgroup. The dabpage itself is edited for new pages being added to the pariticular group. As the dabpage is updated, so will all of the pages within the group that link to it. This provides a single edit point for links displayed on multiple pages.

Additionally, two categories exist for disambiguation page tracking. The dabpages category maintains a list of all Disambiguation Pages (the one's being included in individual pages), and each page which is part of a dabgroup is part of the Disambiguated Pages category.

Template Overview

These three templates are used in with Disambiguation:

The process of creating and displaying a dabpage and it's relative links involve a few template calls. The final display is a table of page links and descriptions wrapped in a Notification Box. For ease of use, templates have been created for calling the dabpages, as well as for creating the table structure in the dabpage. For instance, the {{GetDAB}} template is the only requirement on the target page to show the list of links and descriptions. For the dabpage itself, rather than writing out all of the table and category markup for each new page, the {{DABTable}} template provides a basic table structure and categories, and the {{DABEntry}} provides individual link and description entries.

The How To Create a New Disambiguation Page article shows examples of these templates in use.


Naming Guidelines

Naming for disambiguation is a major concern. Aside from the naming requirements for the dabpages themselves, the titles of the content pages should also be considered.

Base Names

Each disambiguation group should have one default article, which is termed the Base Article. The title of the Base Article is the Base Name, which is also used as the dabapage name, prefixed with dab:.

When faced with choosing names for one or more articles, the Base Article should be the article that is the most directly related to a conceptual MS Access content entry. Most disambiguation requirements will come from the conflict between Article entries, Function Library entries and Class Library entries. In such cases, the Article entry holds precedence on having the Base Name, as it will be the choice which is most likely to correspond to a conceptual MS Access related entry.

If two or more pages within the Articles category must be disambiguated, the choice for the Base Article should be the article that has a better categorization of conceptual MS Access related content.

The Base Name should not contain a Subname. For example, Page Title rather than Page Title (Article), and the Base Article should always be the first article in the disambiguation list.

Page Subnames

Secondary pages, those that are not a Base Article, should contain a Subname. The Subname should be a one-word identifier to make it unique from other pages in the disambiguation group, and it should be enclosed in a set of parentheses. For example, a secondary page whose title would otherwise be Stack which resides in the Class Library would be titled Stack (Class).

Common Subpage names are listed below:

Source Example Name
Function Library PageName (Function)
Class Library PageName (Class)
Code Archive PageName (CA)

Subpage names need not be limited to the above list, however.

Disambiguation Page Naming

Naming of Disambiguation Pages (the pages that hold the list and get included into each target page) should always be the Base Name, prefixed with dab:

For example, the disambiguation page name for the Stack disambiguation group would be dab:Stack
Retrieved from "http://www.utteraccess.com/wiki/Help:Disambiguation"
Edit Discussion
Custom Search
Thank you for your support!
This page has been accessed 6,289 times.  This page was last modified 14:59, 12 January 2012 by Jack Leach. Contributions by Glenn Lloyd  Disclaimers