Template:MalayRoyalHouse/doc
This is a documentation subpage for Template:MalayRoyalHouse. It may contain usage information, categories and other content that is not part of the original template page. |
Documentation for Template:MalayRoyalHouse
[edit]This template is used to display succession information for Malaysian royalty, including Sultans and Yang di-Pertuan Agong. It supports up to three terms each for both Sultan and Agong roles, allowing for detailed historical records.
Parameters
[edit]General
[edit]- house_name: The name of the royal house (e.g., House of Jamalullail).
- dynasty_name: Specific dynasty or kingdom if it differs from house_name (e.g., Selangor).
Sultan Terms
[edit]This template supports up to three Sultan terms. Each term has its own set of parameters:
- sultan_predecessorX: Name of the predecessor for each Sultan term (replace "X" with term number 1, 2, or 3).
- sultan_titleX: Title used by the ruler during this term (defaults to "Sultan" if not specified).
- sultan_yearsX_start: Start year of the Sultan’s term.
- sultan_yearsX_end: End year of the Sultan’s term. Use "present" if the term is ongoing.
- sultan_successorX: Name of the successor for each Sultan term.
Yang di-Pertuan Agong Terms
[edit]This template supports up to three Agong terms, using similar parameters:
- agong_predecessorX: Name of the predecessor for each Agong term.
- agong_titleX: Title used during this term (defaults to "Yang di-Pertuan Agong").
- agong_yearsX_start: Start year of the Agong’s term.
- agong_yearsX_end: End year of the Agong’s term. Use "present" if the term is ongoing.
- agong_successorX: Name of the successor for each Agong term.
Example Usage
[edit]This is a sample usage that includes both Sultan and Yang di-Pertuan Agong terms for a ruler who served multiple terms:
{{MalayRoyalHouse
| house_name = House of Jamalullail
| dynasty_name = Selangor
| sultan_predecessor1 = Hisamuddin Alam Shah
| sultan_title1 = Sultan
| sultan_years1_start = 1960
| sultan_years1_end = 1965
| sultan_successor1 = Ismail Nasiruddin Shah
| sultan_predecessor2 = Unknown
| sultan_title2 = Sultan
| sultan_years2_start = 1970
| sultan_years2_end = 1975
| sultan_successor2 = Unknown
| agong_predecessor1 = Tuanku Abdul Rahman
| agong_title1 = Yang di-Pertuan Agong
| agong_years1_start = 1960
| agong_years1_end = 1965
| agong_successor1 = Sultan Ismail Nasiruddin Shah
}}
FAQ for Template:MalayRoyalHouse
[edit]What is the purpose of this template?
[edit]This template is designed to display succession information for Malaysian royalty, such as Sultans and Yang di-Pertuan Agong, with support for up to three terms for each role.
How do I indicate if the position was "established" or "abolished"?
[edit]- To show that a position was newly established, set `sultan_predecessorX = established`.
- If a position ended, set `sultan_successorX = abolished`. These will display as "Position Established" and "Position Abolished" in the template.
Can I specify multiple terms for the same ruler?
[edit]Yes, this template supports up to three terms each for both Sultan and Yang di-Pertuan Agong roles. Use the following parameter sets for each term:
- First Term: `sultan_predecessor1`, `sultan_title1`, `sultan_years1_start`, `sultan_years1_end`, `sultan_successor1`
- Second Term: `sultan_predecessor2`, `sultan_title2`, `sultan_years2_start`, `sultan_years2_end`, `sultan_successor2`
- Third Term: `sultan_predecessor3`, `sultan_title3`, `sultan_years3_start`, `sultan_years3_end`, `sultan_successor3`
Use a similar structure for the Yang di-Pertuan Agong terms, replacing `sultan_` with `agong_`.
What happens if I leave some fields blank?
[edit]Any empty fields will display default values like "Unknown" or "present" (for ongoing terms). For example:
- Leaving `sultan_predecessor1` blank will result in "Unknown" being displayed as the predecessor.
How do I handle a term that is still ongoing?
[edit]Set the end date parameter to "present". For example:
- `sultan_years1_end = present`
This will display "present" as the end date for an ongoing term.
Can I include a custom title or regnal name?
[edit]Yes, you can customize the title for each term by specifying the `sultan_titleX` or `agong_titleX` parameter. For example:
- `sultan_title1 = Raja`
- `agong_title1 = Supreme King`
If no custom title is provided, it defaults to "Sultan" for Sultan terms and "Yang di-Pertuan Agong" for Agong terms.
Why is there a "dynasty_name" parameter?
[edit]Use `dynasty_name` to specify a dynasty or region if it differs from `house_name`. This allows the template to show specific distinctions, such as rulers from a house overseeing different dynasties.
For further assistance, refer to the documentation page.
Notes
[edit]- To indicate a newly established position, set `sultan_predecessorX = established`.
- To indicate an abolished position, set `sultan_successorX = abolished`.
- The template uses default values like "Unknown" if fields are left blank.
For more details, see the FAQ page.