Skip to content

Wiki Style Guide

Jody Garnett edited this page Feb 3, 2026 · 4 revisions

See documentation guide:

The main documentation uses markdown, allowing wiki content to be used to prototype content.

wiki page names and linking

When page names are simple they directly work as a link, or you can provide your own link text:

[[My Page]] [please check out my new page](My Page)

Please keep page names simple to avoid punctuation. Punctuation is converted to to - when linking - so these are the same:

[[Page Name]] [[page-name]]

Thanks!

wiki images

To manage images, information to the right to clone the wiki locally.

git clone https://github.com/geonetwork/doc.wiki.git cd doc.wiki

You can then manage images and files associated with each page:

git add images/logo.png git commit -m "added logo" git push 

And use the image in markdown content:

![Alt text](images/logo.png) 

Alt text

Preferred Terminology

See documentation guide terminology conventions:

  • GeoNetwork (check capitalisation - use |project_name| variable)
  • Metadata Catalog
  • Catalog Home Page
  • Sub-Portal

Formatting

See documentation guide markdown:

  • References to UI elements such as the sign-in button should be in bold to differentiate them from the surrounding text
Markdown Directive
**strong** gui label, menu selection
`monospace` text input, item selection
*emphasis* figure (caption)
***strong-emphasis*** application, command
monospace-strong file

Clone this wiki locally