Template:Flashcard/doc

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 = 
 * front sound = 
 * front image =
 * image caption = 
 * back = 
 * back sound = 
 * hint = 
 * notes = 
 * theme = 


 * 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 = ) 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
 </tt>

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

Minimal
Front and back only:

 </tt>

gives:

Image on Front:

 </tt>

gives:

image caption included:

 </tt>

gives:

image with front and no caption:

 </tt>

gives:

image with caption and front:

 </tt>

gives:

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

 </tt>

gives:

Front and back only with notes:

 </tt>

gives:

Mandarin
Using all the parameters listed below:  </tt>

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

using themes:

 </tt>

 </tt>

Japanese
Please improve:

Suggestions

 * Extend to include:
 * clever functionality to change what goes on front (e.g. front is = pinyin</tt>)
 * 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 = ...</tt> (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 = ...</tt> (Chinese)
 * simplified = ...</tt> (Chinese)
 * kanji = ...</tt> (Japanese)
 * <tt>hiragana = ...</tt> (Japanese)
 * <tt>katakana = ...</tt> (Japanese)
 * <tt>rōmaji = ...</tt> (Japanese)
 * Extendable.