Wiki Templates: Difference between revisions

From Open Source Ecology
Jump to navigation Jump to search
No edit summary
Line 9: Line 9:
=Templates in Active Use=
=Templates in Active Use=
=Deprecated Templates=
=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.
[[File:Example of Annotated Image.png|800px]]
'''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
<pre>
{{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-->}}
}}
</pre>
'''Where to download and install it'''
*go to: https://www.mediawiki.org/wiki/Special:Export
*type: Template:Annotated_image_4 in the "ad pages manually" box
*press export
*go to: http://opensourceecology.org/wiki/Special:Import
*Import the .xml file


=Links=
*[[Templates]]
*[[Templates]]

Revision as of 18:08, 12 July 2017

Introduction

  • 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

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