Help:Template:Voweltable: Difference between revisions

From FrathWiki
Jump to navigationJump to search
m (Less confusing)
m (Typo -- wordordero?)
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
<includeonly>{{Templatehelpnote}}</includeonly>
<includeonly>{{Templatehelpnote}}</includeonly>
<noinclude>[[{{PAGENAME}}]]</noinclude>
== What is it for? ==


This template helps you make a table showing the vowels of your language.
In order the template uses [http://meta.wikimedia.org/wiki/Help:Template#Parameters named parameters]; this means more typing, but with 38 parameters which all should be optional it is the only way to make the template manageable &mdash; and easier than coding the whole table yourself each time.
== How does it work? ==
In order to get this:
{{Voweltable| caption = Swedish dialect vowel spellings | i = i | y = y | I = î ''or'' ê | e = e | 2 = ö | 8\ =  &mdash; u | u\ = (u) | 8 = û | E = ä | & = (â) | a = â | &\ = (ô) | 3\ = ô | u = o | o = å | Q = a | A = (a) | @ = (e)}}
you enter this:
<nowiki>{{Voweltable| caption = Swedish dialect vowel spellings | i = i | y = y | I = î ''or'' ê | e = e | 2 = ö | 8\ =  &mdash; u | u\ = (u) | 8 = û | E = ä | & = (â) | a = â | &\ = (ô) | 3\ = ô | u = o | o = å | Q = a | A = (a) | @ = (e)}}</nowiki>
Where each <code>|</code> marks the beginning of a parameter definition of the form <code>''parameter name'' = ''parameter value''</code>.
In order to make the template call clearer you can format it for example like this:
<nowiki>{{Voweltable| caption = Swedish dialect vowel spellings |=
| i = i | y = y  | I = î ''or'' ê | e = e |=
| 2 = ö | 8\ =  &mdash; u | u\ = (u) | 8 = û |=
| E = ä | & = (â) | a = â | &\ = (ô) | 3\ = ô |=
| u = o |  o = å  | Q = a | A = (a)  | @ = (e)}}</nowiki>
Everything from a <code>|=</code> up to the next <code>|</code> is 'invisible' to the wiki engine{{ref|invisible}}, so you can put newlines, comments etc. there.
You may also put any amount of optional whitespace on either side of a <code>|</code> or <code>=</code>.
A parameter value may not contain any <code>|</code> (use {{code|&amp;#124;}} in the value instead! {{-)}}){{ref|equalsign}}
All parameters are optional <!-- in the sense that -->
== Parameter names key ==
{{Voweltable|=
{{Voweltable|=
  | width = 100%  |=
  | width = 100%  |=
Line 46: Line 81:
  | Q    = <tt>Q</tt>    &#61; {{BIGIPA|ɒ}}  |=
  | Q    = <tt>Q</tt>    &#61; {{BIGIPA|ɒ}}  |=
}}
}}
== Notes ==
# {{Note|invisible}} Actually a definition a 'nameless named variable' which doesn't get used in the template.
# {{Note|equalsign}} And a parameter name may not contain any <code>=</code>. Not a problem to us as long as we use a [[CXS]] syllabic consonant  transcription as a parameter name! {{-)}}

Latest revision as of 12:38, 15 November 2006

Template:Voweltable

What is it for?

This template helps you make a table showing the vowels of your language.

In order the template uses named parameters; this means more typing, but with 38 parameters which all should be optional it is the only way to make the template manageable — and easier than coding the whole table yourself each time.

How does it work?

In order to get this:

  1. REDIRECT Template:Full voweltable

you enter this:

{{Voweltable| caption = Swedish dialect vowel spellings | i = i | y = y | I = î ''or'' ê | e = e | 2 = ö | 8\ =  — u | u\ = (u) | 8 = û | E = ä | & = (â) | a = â | &\ = (ô) | 3\ = ô | u = o | o = å | Q = a | A = (a) | @ = (e)}}

Where each | marks the beginning of a parameter definition of the form parameter name = parameter value.

In order to make the template call clearer you can format it for example like this:

{{Voweltable| caption = Swedish dialect vowel spellings |= 
 | i = i | y = y   | I = î ''or'' ê | e = e |= 
 | 2 = ö | 8\ =  — u | u\ = (u) | 8 = û |= 
 | E = ä | & = (â) | a = â | &\ = (ô) | 3\ = ô |=
 | u = o |  o = å  | Q = a | A = (a)  | @ = (e)}}

Everything from a |= up to the next | is 'invisible' to the wiki engine[1], so you can put newlines, comments etc. there.

You may also put any amount of optional whitespace on either side of a | or =.

A parameter value may not contain any | (use &#124;

in the value instead! )[2]

All parameters are optional

Parameter names key

  1. REDIRECT Template:Full voweltable

Notes

  1. ^  Actually a definition a 'nameless named variable' which doesn't get used in the template.
  2. ^  And a parameter name may not contain any =. Not a problem to us as long as we use a CXS syllabic consonant transcription as a parameter name!