Wiki Templates: Difference between revisions

From Open Source Ecology
Jump to navigation Jump to search
(Undo revision 243846 by Marcin (talk))
 
(35 intermediate revisions by 3 users not shown)
Line 1: Line 1:
=Outline of Wiki Templates=
=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


Page Title should be ''Machine Name'', where official ''Names'' are found at http://opensourceecology.org/gvcs.php, and the icons are found in [http://openpario.mime.oregonstate.edu/documents/1016 this GIMP file]
=About=
Templates can be a powerful way to display complex information in a well-formatted way simply by invoking a template by name. Templates can have parameters passed into them, such that a whole bunch of information can be passed into a template. Also, templates can seed a bunch of links in the form of other wiki pages. Thus, for example, seeding an entire taxonomy for product development can be done by invoking a template, as is done in a simple way with {{ToolTemplate|ToolName=This Tool}}.


Machine Page Template: (one page for every machine)
For example, an infobox with pictures can be created which displays a custom images and other content automatically. The requirement is a naming convention where assets are called by their correct name into the template.


Bold links to:
#Basics of how to use templates is found at Mediawiki - [https://www.mediawiki.org/wiki/Help:Templates]
*'''Development Page Template'''
##To use a template, use <nowiki>{{templatename}}</nowiki> in the edit window.
*'''Instructional Page Template'''
##To edit a template, go to Template:templatename in the namespace (address bar)
*'''User Manual Page Template'''
#Using Magic Words - [https://www.mediawiki.org/wiki/Help:Magic_words]
#Example - see <nowiki>{{Template:GVCS Header}}</nowiki> by viewing Template:GVCS Header in the namespace. This is a nested template that uses a Magic Word - BASEPAGENAME which acts as it indicates
#Formatting
##First level is Wikitext - [https://en.wikipedia.org/wiki/Help:Wikitext]
##Second, you can use HTML elements - [https://en.wikipedia.org/wiki/HTML_element] or HTML in wikitext - [https://en.wikipedia.org/wiki/Help:HTML_in_wikitext]
##You can also use CSS -
##Wikitext for tables - [https://en.wikipedia.org/wiki/Help:Table]


Followed by:
=Templates in Active Use=
*See [[Templates]]
=Deprecated Templates=
=Proposed Templates=
==Annotated Images==
'''Why the template is useful and sample usage'''


*Product Icon - Isaiah's icon
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.
*Status Headline - few words on where it is (such as completed, design completed, which prototype number, etc.)
*Problem Statement - may be taken from [[Proposal 2012]]
*Performance Analysis vs. Industry Standards (data viz)
*Cost Analysis vs. Industry Standards
*Conceptual Diagram - graphic of working concept
*Product Ecology - show how it fits with other products of [[Product Ecologies]]
*Demo Video
*Demo Photos
*Design Rationale - main decisions for instantiation and how they relate to [[OSE Specifications]]
*Status Chart - infographic showing percent completed, funded, Step of [[GVCS_Development_Template]] (references development template)


=Development Page Template=
[[File:Example of Annotated Image.png|800px]]
Then there is the [[GVCS_Development_Template]] for technical development.


=Instructional Page Template=
'''How to use it'''


This should cover everything required to replicate a machine. May have some overlap with Product Page
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>


*Design Rationale
'''Where to download and install it'''
*Conceptual Diagram
*Bill of Materials (with weblinks to sources)
*Demo Video (could include animation of CEB press from Blender, or real footage)
*Demo Photos
*Instructional Video (A to Z on the Fabrication)
*Functional/Block Diagram - explaining further details, if any, not covered in Conceptual Diagram; explanations of key mechanisms
*3d CAD file (metal fabrication), 2d fabrication drawings (metal), 2d electronics design file to build circuit boards, wiring diagram,
*Machine-readable CAM files
*2d Exploded Part Diagram
*Computer Software Control Code for Automated Devices, or any other software
*Hydraulic Circuit Diagram, or any other supporting diagrams
*Calculations (for scaling purposes)


=User Manual Template=
*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


*How it Works?
*[[Templates]]
*Why it Works?
*Operation Procedures
*Safety
*Maintenance
*Troubleshooting, Repair


Why it works = (to be inspired look at bicyclying science, david gordon wilson)
=Links=
 
*[[Templates in Mediawiki]]
[[Category:Standards]][[Category:Templates]]

Latest revision as of 00:55, 5 February 2021

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

Templates can be a powerful way to display complex information in a well-formatted way simply by invoking a template by name. Templates can have parameters passed into them, such that a whole bunch of information can be passed into a template. Also, templates can seed a bunch of links in the form of other wiki pages. Thus, for example, seeding an entire taxonomy for product development can be done by invoking a template, as is done in a simple way with

This Tool
   Home  |  Research & Development  |  Bill of Materials  |  Manufacturing Instructions  |  User's Manual  |  User Reviews    This Tool.png

.

For example, an infobox with pictures can be created which displays a custom images and other content automatically. The requirement is a naming convention where assets are called by their correct name into the template.

  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
  4. Formatting
    1. First level is Wikitext - [3]
    2. Second, you can use HTML elements - [4] or HTML in wikitext - [5]
    3. You can also use CSS -
    4. Wikitext for tables - [6]

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

Links

Retrieved from "https://wiki.opensourceecology.org/index.php?title=Wiki_Templates&oldid=243847"