Help:Page structure - Revision history

Ianh: Be more explicit

2009-10-22T16:59:58Z

Be more explicit

Ianh: a bit more

2009-05-24T10:58:28Z

a bit more

Ianh: Extract common intro

2009-05-16T21:19:01Z

Extract common intro

Ianh: Links

2009-05-16T21:07:43Z

Links

Ianh: Headings for the tail links

2009-05-15T20:33:53Z

Headings for the tail links

Ianh: Some thoughts about page structure

2009-05-13T18:56:38Z

Some thoughts about page structure

New page

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

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.

Part of this is to adopt a reasonable [[Help:Page names|page name convention]].

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.

@@ Line 10: / Line 10: @@
 ** Do not overload the main text with links which leave the wiki.
 * Tail
-** Add any general links at the end of the page with a heading such as '''More''' (or '''Links''' or '''See also''').
+** 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 *).
+** The links should be a bulleted list (lines start with a *, without any blank lines between).
-==More==
+== More ==
 {{HelpGuidelines}}

@@ Line 1: / Line 1: @@
 General [[Help:Guidelines|guidelines]] on '''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.
+* Top
-* Introduce the page with a simple overview or provide a link "up" to a more general page within the same subject area.
+** 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.
-* Do not overload the main text with links which leave the wiki.
+** For a large page - introduce the page with a simple overview
-* Add any links to web sites elsewhere, at the end of the page with a heading such as '''More''' or '''Links''' or '''See also'''.
+** If the page is one of a set - provide a link to the more general page.
 ==More==
 {{HelpGuidelines}}

← Older revision		Revision as of 21:19, 16 May 2009
Line 1:		Line 1:
	General [[Help:Guidelines\|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.
−
−	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.
−
−	~~Part of this is to adopt a reasonable [[Help:Page names\|page name convention]].~~
−
−	~~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.		* 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.

@@ 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.
@@ Line 13: / Line 13: @@
 * 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'''.