Template:Cards/doc

From MOASSpedia
Jump to navigation Jump to search

Basic

Rank

52-card deck

Card ranks from Standard 52-card deck:

56-card deck

Card ranks from 56-card deck[1]:

  • {{Cards|kn}} or {{Cards|n}} = Kn (Knight, standard 56-card deck)
  • {{Cards|1}} = 1 (standard 56-card deck)
  • {{Cards|11}} = 11 (nonstandard 56-card deck)

Joker

You may use "r" (red) or "b" (black) suit:

  • {{Cards|Jkrr}} = Jkr(red)
  • {{Cards|Jkrb}} = Jkr(black)

Or maybe use the parameters "rank_name" and "suit_name" (details see below, the "Advanced usage" section) to get a full name:

  • {{Cards|Jkrr|rank_name=full|suit_name=full}} = Joker (red)
  • {{Cards|Jkrb|rank_name=full|suit_name=full}} = Joker (black)

? card

Symbols that indicate any or unknown card rank:

Customized card

Actually any string will be allowed to be shown as a "card", e.g.: {{Cards|Cd}} = C, {{Cards|Vs}} = V, {{Cards|€h}} = , {{Cards|勾c}} =

If one of "s", "h", "d", "c", "r", "b" in lower or upper case, and ♠, ♥, ♦, ♣ is at the end, it will be thought as a suit. A "&" symbol can be used to escape, as: {{Cards|R&}} = R, {{Cards|Joker&}} = Joker, {{Cards|♥♥&}} = ♥♥

The first letter of "a", "k", "q", "kn", "j", "jkr" and "x" will be capitalized. To prevent it, put them in a <span></span>: {{Cards|<span>k</span>s}} = k

Suit

Compound use

  • {{Cards|Ac|Kd|Ts|2h}} or {{Cards|A♣|K♦|10♠|2♥}} = A K 10 2
  • Card ranks without suit: {{Cards|A|K|T|2}} = A K 10 2
  • Stand-alone suit symbols: {{Cards|c|d|s|h}} or {{Cards|♣|♦|♠|♥}} =    

Other note

Predefined strings: "a", "k", "q", "kn", "j", "jkr", "x", and "s", "h", "d", "c", "r", "b", are case insensitive when parsed.

The number of the basic, non-named parameters (for cards) should be from 1 to 15.

Advanced usage

Description of all parameters

{{Cards
| <!-- first card's rank and/or suit,
as described above in the "Basic" section -->
| <!-- second card --><!--
... 15 max. -->
| separator      = 
| sortable       = <!-- "yes" or anything else -->
| rank_name      = <!-- "full" or anything else -->
| suit_name      = <!-- "full" or "letter" or anything else -->
| hand_style     = 
| spades_color   = 
| hearts_color   = 
| diamonds_color = 
| clubs_color    = 
| boldface       = <!-- "yes" or "no" -->
| card_style     = <!--
| use_image      = -->
}}
Clk
to
sort
Q
K
10
?
1
A
Jkr
2
9
5
11
Kn
J
Clk
to
sort
(black)
(red)
Click
to
sort
10
J
4
J
Jkr(black)
J
A
Jkr(red)
K
J
J(red)
J
Click to sort
10 10
J J
4 Jkr(black)
Jack of heartJack of heart
J Jkr(red)
4 7
J K(black)
7 4
J Kn
J
Jack 6
Jack Jack(black)
J J
K A
K 3

All these parameters are optional.

  • separator: separator that separates every card, default is a non-breaking space (&nbsp;)
  • sortable: may be "yes" or anything else:
    • yes: add a hidden key to indicate the card rank and suit's level to make it sortable in a table; card ranks from highest to lowest: Jkr, A, K, Q, Kn, J, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1, then anything else; suits from highest to lowest: ♠, ♥, ♦, ♣, red, black, then those without suit indicated; note that it can only tell first card's rank, then the second card's rank, ..., it may not reflect the hand's actual value when it includes 2 or more cards
    • Anything else (incl. leaving blank or not presenting this parameter): default, not do it
  • rank_name: "full" or anything else:
    • full: full rank name: "Joker", "Ace", "King", "Queen", "Knight", "Jack", "11", "10", "9", ...
    • Anything else (incl. leaving blank or not presenting this parameter): default, normal abbr. rank name: "Jkr", "A", "K", "Q", "Kn", "J", "11", "10", "9", ...
  • suit_name: "full" or "letter" or anything else:
    • full: full suit name with a space before: " of spade", " of heart", " of diamond", " of club", " (red)", " (black)"; if you use a full suit name, usually you may want to make the card rank name full and make the separator a comma and a space (a non-breaking space "&nbsp;" must be used), that'll be: {{Cards|Ac|Kd|10s|2h|separator=,&nbsp;|rank_name=full|suit_name=full}} = Ace of clubKing of diamond10 of spade2 of heart
    • letter: one letter suit name: "s", "h", "d", "c", "r", "b"
    • Anything else (incl. leaving blank or not presenting this parameter): default, normal suit name: "", "", "", "", "(red)", "(black)"
  • hand_style: CSS style for the hand <b style="" class="pokerhands"></b>
  • spades_color, hearts_color, diamonds_color, clubs_color: color (CSS color value, like "#FFFFFF" or "white") for cards of every suit; default is 2 black and 2 red; with these parameters, you may make it a 4-color deck: {{Cards|Ac|Kd|10s|2h|diamonds_color=blue|clubs_color=green}} = A K 10 2
  • boldface: enables or disables boldface on card font
    • yes: uses bold font to display cards (default setting): A K Q J Jkr
    • no: uses regular font to display cards: A K Q J Jkr
  • card_style: CSS style for every card <span style="" class="playingcards"></span>
  • use_image: (not yet implemented) use images to show the cards

HTML, class names and CSS

The HTML markup produced by this template includes a microformat, it uses rich semantic class names including: "pokerhands", "playingcards", "spades", "hearts", "diamonds", "clubs", "cardranks", "cardsuits", which makes the details parsable by computers.

For example, {{Cards|Ac|10♥|Knd|?|J|s}} generates A 10 Kn ? J , whose HTML markup is:

<!-- sortable hidden key, if needed, is inserted before <b /> and is like:
<span data-sort-value="&140&10&100&30&115&20&000&00&110&00&105&40"></span> -->
<b style="" class="pokerhands"><!-- value of 'hand_style', if exists, is added here inside 'style=""' -->
	<span style="color:black;" class="playingcards clubs"><!-- 'black' will changed to 'clubs_color''s value if defined;
'card_style''s value, if exists, is added here inside 'style=""', and after the color value;
same things apply to below ones -->
		<span class="cardranks">A</span><span class="cardsuits">&clubs;</span>
	</span>&nbsp;<!-- &nbsp; will be replaced by user defined 'separator' if there is one;
same thing applys to below ones -->
	<span style="color:red;" class="playingcards hearts">
		<span class="cardranks">10</span><span class="cardsuits">&hearts;</span>
	</span>&nbsp;
	<span style="color:red;" class="playingcards diamonds">
		<span class="cardranks">Kn</span><span class="cardsuits">&diams;</span>
	</span>&nbsp;
	<span style="" class="playingcards"><!-- 'card_style''s value, if exists, is added here inside 'style=""';
same thing applys to below one -->
		<span class="cardranks">?</span>
	</span>&nbsp;
	<span style="" class="playingcards">
		<span class="cardranks">J</span>
	</span>&nbsp;
	<span style="color:black;" class="playingcards spades">
		<span class="cardsuits">&spades;</span>
	</span>
</b>

Template for playing cards, will automatically color the suits with the standard red/black. To see a typical 4-color deck, copy the following into your user style sheet (Special:MyPage/common.css for the common CSS):

/* Standard four-color deck */
.diamonds { color: blue !important }
.clubs { color: green !important }

Developers' links

See also

Notes

  1. ^ containing in each suit a King, Queen, Knight, and Valet (from the French tarot court)