Wiki Templates

From Open Source Ecology
Revision as of 00:51, 17 September 2019 by Marcin (talk | contribs) (→‎About)
Jump to navigation Jump to search

Meta

  • Please document all templates that are in use on the wiki on this page.
  • Please document:
  • Why the template is useful and sample usage
  • How to use it
  • Where to download it
  • How to install it

About

  1. Basics of how to use templates is found at Mediawiki - [1]
    1. To use a template, use {{templatename}} in the edit window.
    2. To edit a template, go to Template:templatename in the namespace (address bar)
  2. Using Magic Words - [2]
  3. Example - see {{Template:GVCS Header}} by viewing Template:GVCS Header in the namespace. This is a nested template that uses a Magic Word - BASEPAGENAME which acts as it indicates

Templates in Active Use

Deprecated Templates

Proposed Templates

Annotated Images

Why the template is useful and sample usage

Annotated Images allows to create an annotation inside an image. This visual way of communication can be beneficial in pointing out or commenting on specific modules/parts of a design and at the same time create a link to those specific modules/parts. This will enhance the clarity of the wiki towards developers and end-users.

Example of Annotated Image.png

How to use it

Annotated images can be used by embedding the following code in the editing section. The template allows to change the font sizes, colors, width and the amount and locations of annotations within the image

{{Annotated image 4
| caption =
| header =
| header_align =
| header_background =
| alt =
| image =
| align =
| image-width =
| image-left =
| image-top =
| width =
| height =
| annot-font-size =
| annot-text-align =
| icon = <!--none-->
| frameless = <!--true-->
| annotations =
{{Annotation|<!--X-->|<!--Y-->|<!--Wikilink-->}}
{{Annotation|<!--X-->|<!--Y-->|<!--Wikilink-->}}
{{Annotation|<!--X-->|<!--Y-->|<!--Wikilink-->}}
}}

Where to download and install it