Difference between revisions of "Help:Page structure"

From THCCwiki
Jump to navigation Jump to search
m (Headings for the tail links)
m (Be more explicit)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
General guidelines on '''page structure'''.
+
General [[Help:Guidelines|guidelines]] on '''page structure'''.
  
The advantage of the wiki is that it is not rigid - it allows anybody to create pages on any subject. However, the contents of the wiki are visible to everybody - not just members of the club. This means that we need some basic standards to allow the wiki to be as useful as possible.
+
* Top
 +
** Start the page with a one sentence statement of what the page is - highlighting the main term if it is the same as the page name.
 +
** For a large page - introduce the page with a simple overview
 +
** If the page is one of a set - provide a link to the more general page.
 +
* Body
 +
** Include links to other wiki pages.
 +
** Add a link on the first reference, but not the rest.
 +
** Do not overload the main text with links which leave the wiki.
 +
* Tail
 +
** Add any links at the end of the page with the heading '''More''' (with 2 = signs).
 +
** Have links within the wiki first, then any links to web sites elsewhere.
 +
** External links should probably be left raw (without square brackets), but can be followed with some explanatory text.
 +
** The links should be a bulleted list (lines start with a *, without any blank lines between).
  
One of the main concepts of a wiki is that the pages should be complete in themselves - each page says something about what it is for and does not assume that a visitor arrives at the page via any specific route. This means that somebody finding the page via a search engine can understand what the page is for and the context in which it exists.
+
== More ==
  
Part of this is to adopt a reasonable [[Help:Page names|page name convention]].
+
{{HelpGuidelines}}
 
 
Part of this is to adopt a common style of page structure.
 
 
 
* Start the page with a one sentence statement of what the page is - highlighting the main term if it is the same as the page name.
 
* Introduce the page with a simple overview or provide a link "up" to a more general page within the same subject area.
 
* Do not overload the main text with links which leave the wiki.
 
* Add any links to web sites elsewhere, at the end of the page with a heading such as '''More''' or '''Links''' or '''See also'''.
 

Latest revision as of 16:59, 22 October 2009

General guidelines on page structure.

  • Top
    • Start the page with a one sentence statement of what the page is - highlighting the main term if it is the same as the page name.
    • For a large page - introduce the page with a simple overview
    • If the page is one of a set - provide a link to the more general page.
  • Body
    • Include links to other wiki pages.
    • Add a link on the first reference, but not the rest.
    • Do not overload the main text with links which leave the wiki.
  • Tail
    • Add any links at the end of the page with the heading More (with 2 = signs).
    • Have links within the wiki first, then any links to web sites elsewhere.
    • External links should probably be left raw (without square brackets), but can be followed with some explanatory text.
    • The links should be a bulleted list (lines start with a *, without any blank lines between).

More

Guidelines Bullet.gif Page names Bullet.gif Page structure Bullet.gif User pages Bullet.gif Sub pages Bullet.gif