Template:Infobox Graduate Council/doc: Difference between revisions
Attempting to make docs for this template |
Written /doc in the style of the default Infobox /doc |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | |||
This template | This template displays an informational infobox for a Graduate Council or one of its organizational branches. | ||
It is based on the general-purpose {{Infobox}} metatemplate and organizes information about the council's identity, classification, leadership, membership, and external resources. | |||
== Usage == | |||
== | <syntaxhighlight lang="wikitext"> | ||
{{Infobox Graduate Council | |||
| branch_name = | |||
| image_file = | |||
| logo_size = | |||
| aka_list = | |||
| established_year = | |||
| current_session_hyperlink = | |||
| branch_type = | branch_jurisdiction_type = | term_limits_number = | |||
| president_name = | vice_president_name = | secretary_name = | treasurer_name = | |||
| voting_members_list = | non_voting_members_list = | term_length_duration = | |||
| website_hyperlink = | constitution_hyperlink = | bylaws_hyperlink = }} </syntaxhighlight> | |||
== Parameters == | |||
=== Identity === | |||
{| class="wikitable" ! Parameter ! Description | |||
! Example | |||
<code>branch_name</code> | |||
Official name displayed at the top of the infobox. | |||
Graduate Council | |||
- | |||
<code>image_file</code> | |||
Logo or image representing the council. Use a file name or supported image syntax. | |||
CouncilLogo.png | |||
- | |||
<code>logo_size</code> | |||
Controls the displayed image size. Defaults to 280px. | |||
200px | |||
- | |||
<code>aka_list</code> | |||
Alternative names, abbreviations, or other known names. | |||
GC; Graduate Student Council | |||
- | |||
<code>established_year</code> | |||
Year the council was established. | |||
2020 | |||
- | |||
<code>current_session_hyperlink</code> | |||
Link or text identifying the current council session. | |||
[[Graduate Council/2026–2027]] | |||
} | |||
=== Classification === | |||
{| class="wikitable" ! Parameter ! Description | |||
! Example | |||
<code>branch_type</code> | |||
Type or organizational classification of the council. | |||
Legislative | |||
- | |||
<code>branch_jurisdiction_type</code> | |||
Organization, constituency, or jurisdiction the council represents. | |||
Graduate Student Association | |||
- | |||
<code>term_limits_number</code> | |||
Number of terms an individual may serve. | |||
Two consecutive terms | |||
} | |||
=== Leadership === | |||
{| class="wikitable" ! Parameter ! Description | |||
! Example | |||
<code>president_name</code> | |||
Name of the current president. | |||
Jane Smith | |||
- | |||
<code>vice_president_name</code> | |||
Name of the current vice president. | |||
John Smith | |||
- | |||
<code>secretary_name</code> | |||
Name of the current secretary. | |||
Alex Smith | |||
- | |||
<code>treasurer_name</code> | |||
Name of the current treasurer. | |||
Taylor Smith | |||
} | |||
=== Membership and Structure === | |||
{| class="wikitable" ! Parameter ! Description | |||
! Example | |||
<code>voting_members_list</code> | |||
List of voting members or voting membership positions. | |||
Department representatives | |||
- | |||
<code>non_voting_members_list</code> | |||
List of non-voting members or ex-officio positions. | |||
Faculty advisors | |||
- | |||
<code>term_length_duration</code> | |||
Duration of an individual member's term. | |||
One academic year | |||
} | |||
=== External Information === | |||
{| class="wikitable" ! Parameter ! Description | |||
! Example | |||
: | <code>website_hyperlink</code> | ||
Official website of the council. | |||
[https://example.edu Graduate Council] | |||
- | |||
<code>constitution_hyperlink</code> | |||
Link to the council's constitution. | |||
[[Graduate Council Constitution]] | |||
- | |||
<code>bylaws_hyperlink</code> | |||
Link to the council's bylaws. | |||
[[Graduate Council Bylaws]] | |||
} | |||
== Example == | |||
<syntaxhighlight lang="wikitext"> | |||
: | {{Infobox Graduate Council | ||
| branch_name = Graduate Council | |||
| aka_list = GC | |||
| established_year = 2020 | |||
| current_session_hyperlink = [[Graduate Council/2026–2027]] | |||
| branch_type = Legislative | |||
| branch_jurisdiction_type = Graduate Student Association | |||
| term_limits_number = Two consecutive terms | |||
| president_name = Jane Smith | |||
| vice_president_name = John Smith | |||
| secretary_name = Alex Smith | |||
| treasurer_name = Taylor Smith | |||
| voting_members_list = Department representatives | |||
| non_voting_members_list = Faculty advisors | |||
| term_length_duration = One academic year | |||
| website_hyperlink = [https://example.edu Graduate Council] | |||
| constitution_hyperlink = [[Graduate Council Constitution]] | |||
| bylaws_hyperlink = [[Graduate Council Bylaws]] | |||
}} | |||
</syntaxhighlight> | |||
== Notes == | |||
All parameters are optional in the current implementation. | |||
: | The logo defaults to a width of 280px if <code>logo_size</code> is not specified. | ||
Links may be supplied using standard MediaWiki link syntax. | |||
The infobox uses the shared <code>Module:Infobox</code> and <code>Module:InfoboxImage</code> Lua modules. | |||
== TemplateData == | |||
<templatedata> | <templatedata> | ||
{ | { | ||
"description": "An informational infobox for a Graduate Council or one of its organizational branches.", | |||
"params": { | |||
"branch_name": { | |||
"label": "Branch name", | |||
"description": "Official name displayed at the top of the infobox.", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"image_file": { | |||
"label": "Image file", | |||
"description": "Logo or image representing the council.", | |||
"type": "wiki-file-name", | |||
"suggested": true | |||
}, | |||
"logo_size": { | |||
"label": "Logo size", | |||
"description": "Displayed image size. Defaults to 280px.", | |||
"type": "string", | |||
"default": "280px" | |||
}, | |||
"aka_list": { | |||
"label": "Also known as", | |||
"description": "Alternative names or abbreviations.", | |||
"type": "content" | |||
}, | |||
"established_year": { | |||
"label": "Established", | |||
"description": "Year the council was established.", | |||
"type": "string" | |||
}, | |||
"current_session_hyperlink": { | |||
"label": "Current session", | |||
"description": "Link or text identifying the current council session.", | |||
"type": "wiki-page-name" | |||
}, | |||
"branch_type": { | |||
"label": "Branch", | |||
"description": "Type or organizational classification of the council.", | |||
"type": "string" | |||
}, | |||
"branch_jurisdiction_type": { | |||
"label": "Jurisdiction", | |||
"description": "Organization, constituency, or jurisdiction represented.", | |||
"type": "string" | |||
}, | |||
"term_limits_number": { | |||
"label": "Term limits", | |||
"description": "Number of terms an individual may serve.", | |||
"type": "string" | |||
}, | |||
"president_name": { | |||
"label": "President", | |||
"description": "Name of the current president.", | |||
"type": "string" | |||
}, | |||
"vice_president_name": { | |||
"label": "Vice president", | |||
"description": "Name of the current vice president.", | |||
"type": "string" | |||
}, | |||
"secretary_name": { | |||
"label": "Secretary", | |||
"description": "Name of the current secretary.", | |||
"type": "string" | |||
}, | |||
"treasurer_name": { | |||
"label": "Treasurer", | |||
"description": "Name of the current treasurer.", | |||
"type": "string" | |||
}, | |||
"voting_members_list": { | |||
"label": "Voting members", | |||
"description": "List of voting members or positions.", | |||
"type": "content" | |||
}, | |||
"non_voting_members_list": { | |||
"label": "Non-voting members", | |||
"description": "List of non-voting members or ex-officio positions.", | |||
"type": "content" | |||
}, | |||
"term_length_duration": { | |||
"label": "Length of term", | |||
"description": "Duration of an individual member's term.", | |||
"type": "string" | |||
}, | |||
"website_hyperlink": { | |||
"label": "Website", | |||
"description": "Official council website.", | |||
"type": "url" | |||
}, | |||
"constitution_hyperlink": { | |||
"label": "Constitution", | |||
"description": "Link to the council constitution.", | |||
"type": "wiki-page-name" | |||
}, | |||
"bylaws_hyperlink": { | |||
"label": "Bylaws", | |||
"description": "Link to the council bylaws.", | |||
"type": "wiki-page-name" | |||
} | |||
}, | |||
"paramOrder": [ | |||
"branch_name", | |||
"image_file", | |||
"logo_size", | |||
"aka_list", | |||
"established_year", | |||
"current_session_hyperlink", | |||
"branch_type", | |||
"branch_jurisdiction_type", | |||
"term_limits_number", | |||
"president_name", | |||
"vice_president_name", | |||
"secretary_name", | |||
"treasurer_name", | |||
"voting_members_list", | |||
"non_voting_members_list", | |||
"term_length_duration", | |||
"website_hyperlink", | |||
"constitution_hyperlink", | |||
"bylaws_hyperlink" | |||
] | |||
} | } | ||
</templatedata> | </templatedata> | ||
<includeonly>[[Category:Graduate Council templates]]</includeonly> | |||
Revision as of 14:47, 10 November 2026
| icon | This is a documentation subpage for Template:Terminate sentence It may contain usage information, categories and other content that is not part of the original template page. |
This template displays an informational infobox for a Graduate Council or one of its organizational branches.
It is based on the general-purpose metatemplate and organizes information about the council's identity, classification, leadership, membership, and external resources.
Usage
<syntaxhighlight lang="wikitext">
| Classification | |
|---|---|
| Leadership | |
| Membership | |
| External Information |
</syntaxhighlight>
Parameters
Identity
| Example
Classification
| ||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|