Template:S-roy/doc

This template creates a header to be used with succession boxes for royal families.

Without parameter
The template defaults to Royal titles if no parameter is given. In the following table, the first column contains the header and the second column shows the template call used to create it.



With parameter
The format is, where parameter is replaced by one of the parameter names shown in the following table. The first column displays the header and the second column contains the parameter name.


 * ae


 * an


 * al


 * at-hu


 * be


 * bg


 * bn


 * br


 * bt


 * cf


 * cm


 * cn


 * de


 * dk


 * eg


 * ei


 * en


 * es


 * et


 * fr


 * gb


 * ge


 * gr


 * hw


 * id


 * in


 * ir


 * iq


 * it


 * jp


 * kr


 * la


 * li


 * ls


 * lu


 * mc


 * mn


 * mx


 * my


 * nl


 * no


 * np


 * nv


 * om


 * pe


 * pt


 * qa


 * ro


 * ru


 * rw


 * sa


 * sc


 * se


 * sm


 * sz


 * th


 * to


 * tr


 * ug


 * uk


 * vn


 * yu

Example
From the Elizabeth II of the United Kingdom article: 

Former background colors

 * 1) Royal titles – #DDCCFF – created 16 April 2007
 * 2) Royal titles – #ADB3FF – changed 10 June 2007
 * 3) Royal titles – #A9CBFF – changed 10 June 2007
 * 4) Royal titles – #A9ADFF – changed 10 June 2007
 * 5) Royal titles – #D7C5FF – changed 10 June 2007
 * 6) Royal titles – #0093FF – changed 11 June 2007
 * 7) Royal titles – font color #EBFFFA – changed 17 June 2007
 * 8) Royal titles – font color #FFFFFF – changed 9 July 2007
 * 9) Royal titles – #97CADD – changed 25 July 2007
 * 10) Royal titles – font color removed – changed 25 July 2007
 * 11) Royal titles – #87CEEB – changed 27 July 2007
 * 12) Royal titles – #65BCFF – current as of 27 July 2007