Template:Flashcard/doc

From WikiEducator
Jump to: navigation, search

Documentation for Template:flashcard:

Purpose

Enable easy creation of flashcards for language learning (though usable for other purposes with a bit of imagination).

Usage

This template is quite new (November 2009) and has not been extensively tested. There might be some changes coming soon (see suggestions below).

The initial design was for Mandarin Chinese which requires many options but the template can be used for other languages too (simply use only the options you need).

Parameters

Parameters front and back are enough for many applications. They take the main text of the front and back of the flashcard respectively.

For various languages, the following parameters are available (they may be mixed freely):

  • General
    • front = <word or phrase for front of the card>
    • front sound = <name of media (sound) file>
    • front image = <name of image file>
    • image caption = <image caption for front image>
    • back = <word or phrase on the front translated>
    • back sound = <name of media (sound) file for the foreign pronunciation>
    • hint = <a text hint for mouse hover over front of the card>
    • notes = <notes on the flashcard to explain meaning, etc. >
    • theme = <name of theme e.g. blues, smart, etc. from Template:Box Theme Attribute>
  • For Chinese:
    • traditional
    • simplified
    • pinyin
    • wade-giles
    • yale
    • bopomofo
    • radical
    • number of strokes
    • stroke order
  • For Japanese:
    • kanji
    • hiragana
    • katakana
    • rōmaji
    • romanisation

Known Issues

  • While the hint text (from hint = <hint text>) is correct over the front text, the hint text over a front image incorrectly matches the image caption (instead of hint). See Suggestions below.

Syntax

{{flashcard
  |front = <word or phrase for front of the card>
  |front sound = <name of media (sound) file> 
  |back = <word or phrase on the front translated>
  |back sound = <name of media (sound) file for the foreign pronunciation> 
  |simplified = <simplified character (if applicable) or simple explanation> 
  |pinyin = <pinyin phonetic - only relevant for Mandarin Chinese>
  |wade-giles = <Wade-Giles phonetic - only relevant for Mandarin Chinese>
  |yale = <Yale phonetic - only relevant for Mandarin Chinese>
  |bopomofo = <bopomofo phonetic - only relevant for Mandarin Chinese>
  |radical = <radical character>
  |number of strokes = 7
  |stroke order = <animated image file name>
  |notes = <notes on the flashcard to explain meaning etc. >
  |theme = <theme name> 
}}

The theme names are defined in Template:Box Theme Attribute and include those illustrated here.

Examples

Minimal

Front and back only: 


 {{flashcard
  |front = Good day
  |back = Bon jour
  }}

gives:

Image on Front: 


 {{flashcard
  |front image = Banana Fruit.JPG
  |back = Banana
  }}

gives:

image caption included: 


 {{flashcard
  |front image = Banana Fruit.JPG
  |image caption = banane mûre
  |back = Banana
  }}

gives:

image with front and no caption: 


 {{flashcard
  |front = la banane
  |front image = Banana Fruit.JPG
  |back = Banana
  }}

gives:


image with caption and front: 


 {{flashcard
  |front = la banane
  |front image = Banana Fruit.JPG
  |image caption = banane mûre
  |back = Banana
  }}

gives:

image with caption and front and hint (mouseover text - not image yet??): 


 {{flashcard
  |front = la banane
  |front image = Banana Fruit.JPG
  |hint = fruit jaune recourbé
  |image caption = banane mûre
  |back = Banana
  }}

gives:


Front and back only with notes: 


 {{flashcard
  |front = Good day
  |back = Bon jour
  |notes = A greeting
  }}

gives:

Mandarin

Using all the parameters listed below: 


 {{flashcard
 |front = 你
 |front sound = Zh-n%C7%90.ogg
 |hint = not me
 |back = You
 |back sound = En-us-you.ogg
 |simplified = simplified character (if exists) goes here
 |pinyin = Ni3
 |wade-giles = ni<sup>3</sup>
 |yale = ni-3
 |bopomofo = ㄋㄧˇ
 |radical = 人
 |number of strokes = 7
 |stroke order= 你-order.gif
 |notes = e.g. clarify if there is ambiguity ...
 }}

gives the following (try it - click on 'show'):

using themes: 


 {{flashcard
 |theme=blues
 |front=你
 |front sound= Zh-n%C7%90.ogg
 |hint = not me
 |back=You
 |back sound=En-us-you.ogg
 |simplified= simplified character (if exists) goes here
 |pinyin=Ni3
 |wade-giles=ni<sup>3</sup>
 |yale=ni-3
 |bopomofo=ㄋㄧˇ
 |radical=人
 |number of strokes = 7
 |stroke order=你-order.gif
 |notes = e.g. clarify if there is ambiguity ...
 }}


 {{flashcard
 |theme=goldy
 |front=你
 |front sound= Zh-n%C7%90.ogg
 |hint = not me
 |back=You
 |back sound=En-us-you.ogg
 |simplified= simplified character (if exists) goes here
 |pinyin=Ni3
 |wade-giles=ni<sup>3</sup>
 |yale=ni-3
 |bopomofo=ㄋㄧˇ
 |radical=人
 |number of strokes = 7
 |stroke order=你-order.gif
 |notes = e.g. clarify if there is ambiguity ...
 }}

Japanese

Please improve: 

{{flashcard
|theme = sandy
|front = マージャン
|front sound = En-us-you.ogg
|hint = please add hint?
|back = mahjong
|back sound =E n-us-you.ogg
|romaji = mājan
|kanji = 麻雀
|romanisation = májiàng
|notes = Mahjong is a board game.
Please correct sound files etc. 
and add a suitable hint to this flash card. Thanks :-)
}}


Suggestions

  • Extend to include:
    • clever functionality to change what goes on front (e.g. front is = pinyin)
      • i.e. if "card front = <one of the other parameters>" then make it so, etc.
  • Change default hint in image caption - rather add image caption = ... (done) - hint can be mouse over text "hint" (if not image).
  • Multilingual extension - e.g. front shows a word and selection of languages to pick for translation, etc.
  • Fix the examples on this page e.g. supply correct sound files.
  • There might be a clever way to generate Chinese flashcards such that the creator would just specify the character and which answers to display on the other side ... see Wikipedia's templates for Chinese (e.g.Template:Zh and Template:Stroke order).
  • ... please add ...

Features

Includes various options for learning specific languages. Use the ones you need:

  • General:
    • front in base language (English in this case)
    • front image - to include an image on the front of the flashcard
    • traditional and simplified characters
    • phonetic representations
    • explanation (notes)
    • radical
    • stroke count
    • stroke order
    • example sentence(s) - can be placed in notes
    • theme
    • hint - if defines the hint text appears if mouse hovered over the front which will have a dotted underline.
  • Example parameters:
    • traditional = ... (Chinese)
    • simplified = ... (Chinese)
    • kanji = ... (Japanese)
    • hiragana = ... (Japanese)
    • katakana = ... (Japanese)
    • rōmaji = ... (Japanese)
  • Extendable.
Retrieved from "https://wikieducator.org/index.php?title=Template:Flashcard/doc&oldid=634187"