Dashboard > uDig > Home > Procedures > Wiki Guidelines
uDig
Wiki Guidelines
Added by Jive , last edited by Jody Garnett on Oct 16, 2007  (view change)
Labels: 
(None)

Welcome to the wiki, if you are reading this page you are a rare individual:

  • you have an interest in updating the uDig documentation
  • and you are reading directions before jumping in

So to start with - thank you for your help.

The uDig website is divided into several spaces:

Space Website Blogs
UDIG Udig project website uDig news and events
OWS3 OWS-3 GeoDSS project Prokect news and events
     
Space Help Blogs
DEV Developer documentation n/a
EN User Guide n/a
DE German translation n/a
ES Spanish translation n/a
FR French translation n/a
NL Dutch translation n/a

(For a live list go to Browse Spaces)

We have divided the documentation into two categories categories:

  • Website - top level website with news and annoucements
  • Help - site used to export out content as an eclipse help plugin

Here are a few short cuts to get you going:

The wiki also plays host to other useful information including design discussions.

Guideines for writing Help

For the help spaces very strict writing guidelines are in order (see Home.
Please limit image with to 600 pixels so end users can safely print out help contents.

Use of pages and Links

Link early link ofen, and the pages will come. Feel free to link to pages that don't exist yet, or to terms a reader may not know.

Create a page for each commonly used term, so that writing of content can flow a bit better.

Compare & Contrast:

The design of the [GCE] was influenced by the [WMS] specification.

To:

The design of the [GCE|Symbols, Terms and Definitions#GCE] was
influenced by the [WMS|Symbols, Terms and Definitions#WMS] specification.

The way to make this manageable is to have [EN:Glossary] as the parent page. The Gloassary page will link to all is childern using a Macro. If you want to go the extra mile you can provide a more specific parent page like OGC Specifications, GIS Terms, Definitions and we can have a information heirachy.

Use of Attachments

The confluence system allows the use of images:

  1. Upload the picutre as an attachment
  2. Refer to it: !my-image.png!

Use of Export

Export to PDF and html work. The series of check boxes used to specify each page is a bit clunky but life will go on.

There are explicit directions on Home for exporting out help pages.

Powered by a free Atlassian Confluence Open Source Project License granted to uDig. Evaluate Confluence today.
Powered by Atlassian Confluence 2.7.1, the Enterprise Wiki. Bug/feature request - Atlassian news - Contact administrators
User-friendly Desktop Internet GIS