Help:How to use templates

From AWF-Wiki
(Difference between revisions)
Jump to: navigation, search
({{SITENAME}}-logo)
("info"-box)
 
(38 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
 
==Available templates for your work==
 
==Available templates for your work==
  
Here is an overview about some templates you can use in {{SITENAME}}. We will have more in future for different purposes, but these will be enough to start. You always see the Wiki-Syntax you have to write above the example. Some of these templates make the articles including them also to be categorized autimatically.
+
Here is an overview about some templates you can use in {{SITENAME}}. We will have more in future for different purposes, but these will be enough to start. You always see the Wiki-Syntax you have to write above the example. Some of these templates make the articles including them also to be categorized automatically. If you like to try out first, please use the [[sandbox]] (Shift + click open a separate window)!
  
===Attention===
+
==="attention"===
<nowiki>{{attention}}</nowiki>
+
<code><nowiki>{{attention}}</nowiki></code>
 
{{attention}}
 
{{attention}}
  
  
To include any text you write <nowiki>{{attention | this is my very special text}}</nowiki>
+
To include any text you write:
 +
<code><nowiki>
 +
{{attention
 +
|text=this is my very special text
 +
}}</nowiki>
 +
</code>
 
{{attention
 
{{attention
 
|text=this is my very special text
 
|text=this is my very special text
Line 16: Line 20:
  
 
==="formulahelp"===
 
==="formulahelp"===
<nowiki>{{formulahelp}}</nowiki>
+
<code><nowiki>{{formulahelp}}</nowiki></code>
 +
 
 
If you use this template the article will automatically be categorized as "Needed TeX-help". You can browse for this category in "special pages"  
 
If you use this template the article will automatically be categorized as "Needed TeX-help". You can browse for this category in "special pages"  
 
{{formulahelp}}
 
{{formulahelp}}
Line 22: Line 27:
  
 
==="improve"===
 
==="improve"===
<nowiki>{{improve}}</nowiki>
+
<code><nowiki>{{improve}}</nowiki></code>
 
{{improve}}
 
{{improve}}
  
  
==="under construction===
+
==="references"===
<nowiki>{{construction}}</nowiki>
+
<code><nowiki>{{references}}</nowiki></code>
 +
{{references}}
 +
 
 +
 
 +
==="under construction"===
 +
<code><nowiki>{{construction}}</nowiki></code>
 +
 
 +
If you use this template the article will automatically be categorized as "Under construction". You can browse for this category in "special pages"
 
{{construction}}
 
{{construction}}
  
  
 
==="info"-box===
 
==="info"-box===
<nowiki>{{info}}</nowiki>
+
<code><nowiki>{{info}}</nowiki></code>
 
{{info}}
 
{{info}}
  
You can add both: the message (e.g. "Excample" or "Tipp") and the text inside the box.
+
You can add both: the message (e.g. "Example" or "Tipp") and the text inside the box.
  
<nowiki>
+
<code><nowiki>
 
{{info | message=Tipp | text=here you have much space for you very personal tipps!}}
 
{{info | message=Tipp | text=here you have much space for you very personal tipps!}}
</nowiki>
+
</nowiki></code>
  
 
{{info
 
{{info
Line 46: Line 58:
 
}}
 
}}
  
 +
 +
A similar template for exercises:
 +
 +
{{Exercise
 +
|message=Exercise 01
 +
|text=Testexercise
 +
}}
  
 
==={{SITENAME}}-logo===
 
==={{SITENAME}}-logo===
<nowiki>{{FSW}} or {{FSWr}}</nowiki>
+
<code><nowiki>{{FSW}} or {{FSWr}}</nowiki></code>
 
will include our logo (r for align=right) that is a TeX formula:
 
will include our logo (r for align=right) that is a TeX formula:
  
 
{{FSW}}
 
{{FSW}}
 +
 +
 +
===Conventions===
 +
We need some conventions for use in software tutorials. Some recent examples will be added soon.
 +
 +
*Here a button: <nowiki>{{Button|text=close}}</nowiki> that will look like this: {{Button|text=close}}
 +
 +
*Type <nowiki>{{key|text=Enter}}</nowiki> to symbolize a key like this: {{key|text=Enter}}
 +
 +
*And <nowiki>{{Mitem|text=Layer → Vector → Add vector layer}}</nowiki> for a this menu item: {{Mitem|text=Layer → Vector → Add vector layer}}
 +
 +
*And here is a tool typed <nowiki>{{tool|text=Zoom in}}</nowiki> {{tool|text=Zoom in}}
 +
 +
{{attention|text=the “button” template can only be displayed in firefox. We should create a different one, or encourage people to use firefox in the introduction of tutorials}}
 +
 +
[[Category:Help]]

Latest revision as of 13:58, 20 October 2010

Contents

[edit] Available templates for your work

Here is an overview about some templates you can use in AWF-Wiki. We will have more in future for different purposes, but these will be enough to start. You always see the Wiki-Syntax you have to write above the example. Some of these templates make the articles including them also to be categorized automatically. If you like to try out first, please use the sandbox (Shift + click open a separate window)!

[edit] "attention"

{{attention}}

Attention.png Attention!: 

{{{text}}}


To include any text you write: {{attention |text=this is my very special text }}

Attention.png Attention!: 

this is my very special text


[edit] "formulahelp"

{{formulahelp}}

If you use this template the article will automatically be categorized as "Needed TeX-help". You can browse for this category in "special pages"

formulahelp.png Help!: 

Please help to code this formula in TeX (<math> </math>)! An example should be provided here in form of an image or textcoded.


[edit] "improve"

{{improve}}

Attention.png Attention!: 

This article must be enhanced to meet the AWF-Wiki quality standards! Please visit the Discussion Page of this article for details!
Help to improve this article about How to use templates if you can!


[edit] "references"

{{references}}

Ref.png References!: 

Please provide more references for the article How to use templates to meet the AWF-Wiki quality standards! Please visit the Diskussion Page of this article for details! Help to improve this article if you can!


[edit] "under construction"

{{construction}}

If you use this template the article will automatically be categorized as "Under construction". You can browse for this category in "special pages"

Construction.png sorry: 

This section is still under construction! This article was last modified on 10/20/2010. If you have comments please use the Discussion page or contribute to the article!


[edit] "info"-box

{{info}}

info.png {{{message}}}
{{{text}}}

You can add both: the message (e.g. "Example" or "Tipp") and the text inside the box.

{{info | message=Tipp | text=here you have much space for you very personal tipps!}}


info.png Tipp
here you have much space for you very personal tipps!


A similar template for exercises:


Exercise.png Exercise 01: Testexercise

[edit]

{{FSW}} or {{FSWr}} will include our logo (r for align=right) that is a TeX formula:


<math>\frac {\left [ \left [\mathbf{AWF}\right ] \right ]}{ Wiki }\,</math>


[edit] Conventions

We need some conventions for use in software tutorials. Some recent examples will be added soon.

  • Here a button: {{Button|text=close}} that will look like this: close
  • Type {{key|text=Enter}} to symbolize a key like this: Enter
  • And {{Mitem|text=Layer → Vector → Add vector layer}} for a this menu item: Layer → Vector → Add vector layer
  • And here is a tool typed {{tool|text=Zoom in}} Zoom in


Attention.png Attention!: 

the “button” template can only be displayed in firefox. We should create a different one, or encourage people to use firefox in the introduction of tutorials

Personal tools
Namespaces

Variants
Actions
Navigation
Development
Toolbox