Help:Contents

From ArgeoWiki

Jump to: navigation, search

Contents

[edit]

ArgeoWiki editing rules

[edit]

General

[edit]

Project page

Each development project has a main page simply named after it (e.g. DjAccount).

This page will be the main entry point for people interested in the application. It succinctly describes the main features of the current stable version of the application, and provide all related high level links (such as the related category on WordPress).

It also clearly identifies and links to the current supported stable versions, as well as to the current development stream (that is, the next stable version, see version page below).

A project page must declare first a template Template:Development Project Header. For example: 

{{Development Project Header
|projectType = Application
|projectName = DjAccount
|versionUnderDevelopment = 0.4
|mostRecentStableVersion = 0.2
|projectLead = Mbaudier
}}

This implicitly adds it to a Category with the same name as the project (e.g.: Category:DjAccount), which is itself a subcategory of Category:Development Projects.

[edit]

Version page

Each stable version (even minor version numbers) has a version page, named <project name> v<major>.<minor> (e.g. DjAccount v0.2)

It provides links to the related code and tasks/bugs, as well as to related announcements, etc.

  • if this version is the next to be released (development stream), it contains:
    • the road map of the release
    • the specifications (and related discussions)
    • the design (and related discussions)
  • if this version has already been released (maintenance stream), this page clearly indicates what is the latest maintenance release.

If the requirements and design require dedicated pages, they should be named as follow: <project name> v<major.version> Requirements (e.g. DjAccount v0.2 Requirements) <project name> v<major.version> Design (e.g. DjAccount v0.2 Design)

A version page must declare the template Template:Project Version Header. For example: 

{{Project Version Header
|projectName = DjAccount
|version = 0.2
|status = Development
|firstReleaseDate = mid June 2007
|roadMap = #Road Map
|requirements = _Requirements
|design = _Design
}}

The roadMap, requirements and design arguments will be used to link with the related content. If it is internal to the version page, a '#' should be used. If it is in an external page (see conventions above) a '_' should be used (which is equivalent to a space).

Status can be either Planned, Development, Maintenance or Deprecated.

[edit]

Other pages related to a project or a version

In order to ease navigation it is good to add the following templates at the beginning of pages:

  • related to a version, [[Template::Project Version Page Header]]. For example: 
{{Project Version Page Header
| projectName=DjAccount
| version=0.2
}}
  • related to a project but no specific version, [[Template::Development Project Page Header]]. For example: 
{{Development Project Page Header
| projectName=DjAccount
}}
[edit]

Third party software page

A third party page aggregates knowledge about a given thrid party library or application. It should contains a first level section == Useful links == listing links to documentation, forums, etc. When you have spent a hard time finding the relevant information on a given software, think of listing the links there.

A third party page must declare a template Template:Third Party Software Header. For example: 

{{Third Party Software Header
| softwareName = MediaWiki 
| webSite = http://www.mediawiki.org 
}}

This implicitly adds it to Category:Third Party Software.

[edit]

How to use a Wiki in general

Consult the User's Guide for information on using the wiki software.

You may also be interested in the MediaWiki third party page on ArgeoWiki.

Retrieved from "http://www.argeo.org/mediawiki/index.php/Help:Contents"
Personal tools