Template:Infobox Graduate Council/doc: Difference between revisions

Goodws2 (talk | contribs)
Attempting to make docs for this template
 
Goodws2 (talk | contribs)
Written /doc in the style of the default Infobox /doc
Line 1: Line 1:
== Usage ==
{{Documentation subpage}}


This template is used for branches and constituent bodies of Rensselaer Polytechnic Institute Student Government.
This template displays an informational infobox for a Graduate Council or one of its organizational branches.


=== Example ===
It is based on the general-purpose {{Infobox}} metatemplate and organizes information about the council's identity, classification, leadership, membership, and external resources.


<pre>
== Usage ==
{{Student Government branch
| name = Student Senate
| logo = Student Senate logo.svg
| current_session = [[Student Senate (2026–2027)|2026–2027]]
| aka = Senate
| branch = Legislative
| jurisdiction = Union-wide
| established = 1969
| presiding = [[John Smith]]
| vice_presiding = [[Jane Smith]]
| secretary = [[Alex Jones]]
| treasurer = [[Taylor Brown]]
| voting_members = 25
| undergrad_members = 20
| grad_members = 5
| nonvoting_members = 3
| term_length = One year
| meeting_place = Rensselaer Union
| meeting_schedule = Thursdays at 7:00 PM
| website = https://example.com
| constitution = [[Rensselaer Union Constitution]], Article X
}}
</pre>


== Parameters ==
<syntaxhighlight lang="wikitext">
{{Infobox Graduate Council
| branch_name =
| image_file =
| logo_size =
| aka_list =
| established_year =
| current_session_hyperlink =


; name
| branch_type = | branch_jurisdiction_type = | term_limits_number =
: The full name of the student government body. This parameter is required.


; logo
| president_name = | vice_president_name = | secretary_name = | treasurer_name =
: The filename of the organization's logo.


; logo_size
| voting_members_list = | non_voting_members_list = | term_length_duration =
: Optional size of the logo. Defaults to 280px.


; current_session
| website_hyperlink = | constitution_hyperlink = | bylaws_hyperlink = }} </syntaxhighlight>
: Link to the organization's current session.


; aka
== Parameters ==
: Alternative or former names.


; status
=== Identity ===
: Current status of the organization. Use <code>active</code>, <code>inactive</code>, or <code>defunct</code>.


; branch
{| class="wikitable" ! Parameter ! Description
: Branch of student government, such as Legislative, Executive, or Judicial.


; jurisdiction
! Example
: The constituency or area represented, such as Undergraduate, Graduate, or Union-wide.
<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]]
}


; term_limits
=== Classification ===
: Limits on the number of terms an individual may serve.


; established
{| class="wikitable" ! Parameter ! Description
: Year or date the organization was established.


; disbanded
! Example
: Year or date the organization was disbanded. Leave blank for current organizations.
<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
}


; preceded_by
=== Leadership ===
: Organization that preceded this organization.


; succeeded_by
{| class="wikitable" ! Parameter ! Description
: Organization that succeeded this organization.


; presiding
! Example
: Current presiding officer, such as President, Grand Marshal, or Judicial Chair.
<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
}


; vice_presiding
=== Membership and Structure ===
: Current vice or deputy presiding officer.


; secretary
{| class="wikitable" ! Parameter ! Description
: Current secretary.


; treasurer
! Example
: Current treasurer.
<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
}


; voting_members
=== External Information ===
: Number or description of voting members.


; undergrad_members
{| class="wikitable" ! Parameter ! Description
: Number or description of undergraduate voting members.


; grad_members
! Example
: Number or description of graduate voting members.
<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]]
}


; other_members
== Example ==
: Number or description of other voting members.


; nonvoting_members
<syntaxhighlight lang="wikitext">
: Number or description of non-voting members.
{{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>


; term_length
== Notes ==
: Length of the term served by members.


; meeting_place
All parameters are optional in the current implementation.
: Location where the organization meets.
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.


; meeting_schedule
== TemplateData ==
: Regular meeting schedule.
 
; website
: Official website of the organization.
 
; constitution
: Constitution, bylaws, or other governing document establishing the organization's authority.


<templatedata>
<templatedata>
{
{
"params": {
"description": "An informational infobox for a Graduate Council or one of its organizational branches.",
"name": {
"params": {
"label": "Name",
"branch_name": {
"description": "Full name of the student government body.",
"label": "Branch name",
"required": true,
"description": "Official name displayed at the top of the infobox.",
"type": "string"
"type": "string",
},
"suggested": true
"logo": {
},
"label": "Logo",
"image_file": {
"description": "Filename of the organization's logo.",
"label": "Image file",
"type": "wiki-file-name"
"description": "Logo or image representing the council.",
},
"type": "wiki-file-name",
"logo_size": {
"suggested": true
"label": "Logo size",
},
"description": "Optional size of the logo.",
"logo_size": {
"default": "280px",
"label": "Logo size",
"type": "string"
"description": "Displayed image size. Defaults to 280px.",
},
"type": "string",
"current_session": {
"default": "280px"
"label": "Current session",
},
"description": "Link to the organization's current session.",
"aka_list": {
"type": "wiki-page-name"
"label": "Also known as",
},
"description": "Alternative names or abbreviations.",
"aka": {
"type": "content"
"label": "Also known as",
},
"description": "Alternative or former names.",
"established_year": {
"type": "string"
"label": "Established",
},
"description": "Year the council was established.",
"status": {
"type": "string"
"label": "Status",
},
"description": "Current status of the organization.",
"current_session_hyperlink": {
"type": "string",
"label": "Current session",
"suggestedvalues": [
"description": "Link or text identifying the current council session.",
"active",
"type": "wiki-page-name"
"inactive",
},
"defunct"
"branch_type": {
]
"label": "Branch",
},
"description": "Type or organizational classification of the council.",
"branch": {
"type": "string"
"label": "Branch",
},
"description": "Branch of student government.",
"branch_jurisdiction_type": {
"type": "string"
"label": "Jurisdiction",
},
"description": "Organization, constituency, or jurisdiction represented.",
"jurisdiction": {
"type": "string"
"label": "Jurisdiction",
},
"description": "Constituency or area represented.",
"term_limits_number": {
"type": "string"
"label": "Term limits",
},
"description": "Number of terms an individual may serve.",
"term_limits": {
"type": "string"
"label": "Term limits",
},
"description": "Limits on the number of terms an individual may serve.",
"president_name": {
"type": "string"
"label": "President",
},
"description": "Name of the current president.",
"established": {
"type": "string"
"label": "Established",
},
"description": "Year or date the organization was established.",
"vice_president_name": {
"type": "string"
"label": "Vice president",
},
"description": "Name of the current vice president.",
"disbanded": {
"type": "string"
"label": "Disbanded",
},
"description": "Year or date the organization was disbanded.",
"secretary_name": {
"type": "string"
"label": "Secretary",
},
"description": "Name of the current secretary.",
"preceded_by": {
"type": "string"
"label": "Preceded by",
},
"description": "Organization that preceded this organization.",
"treasurer_name": {
"type": "wiki-page-name"
"label": "Treasurer",
},
"description": "Name of the current treasurer.",
"succeeded_by": {
"type": "string"
"label": "Succeeded by",
},
"description": "Organization that succeeded this organization.",
"voting_members_list": {
"type": "wiki-page-name"
"label": "Voting members",
},
"description": "List of voting members or positions.",
"presiding": {
"type": "content"
"label": "Presiding officer",
},
"description": "Current presiding officer.",
"non_voting_members_list": {
"type": "wiki-page-name"
"label": "Non-voting members",
},
"description": "List of non-voting members or ex-officio positions.",
"vice_presiding": {
"type": "content"
"label": "Vice presiding officer",
},
"description": "Current vice or deputy presiding officer.",
"term_length_duration": {
"type": "wiki-page-name"
"label": "Length of term",
},
"description": "Duration of an individual member's term.",
"secretary": {
"type": "string"
"label": "Secretary",
},
"description": "Current secretary.",
"website_hyperlink": {
"type": "wiki-page-name"
"label": "Website",
},
"description": "Official council website.",
"treasurer": {
"type": "url"
"label": "Treasurer",
},
"description": "Current treasurer.",
"constitution_hyperlink": {
"type": "wiki-page-name"
"label": "Constitution",
},
"description": "Link to the council constitution.",
"voting_members": {
"type": "wiki-page-name"
"label": "Voting members",
},
"description": "Number or description of voting members.",
"bylaws_hyperlink": {
"type": "string"
"label": "Bylaws",
},
"description": "Link to the council bylaws.",
"undergrad_members": {
"type": "wiki-page-name"
"label": "Undergraduate members",
}
"description": "Number or description of undergraduate voting members.",
},
"type": "string"
"paramOrder": [
},
"branch_name",
"grad_members": {
"image_file",
"label": "Graduate members",
"logo_size",
"description": "Number or description of graduate voting members.",
"aka_list",
"type": "string"
"established_year",
},
"current_session_hyperlink",
"other_members": {
"branch_type",
"label": "Other members",
"branch_jurisdiction_type",
"description": "Number or description of other voting members.",
"term_limits_number",
"type": "string"
"president_name",
},
"vice_president_name",
"nonvoting_members": {
"secretary_name",
"label": "Non-voting members",
"treasurer_name",
"description": "Number or description of non-voting members.",
"voting_members_list",
"type": "string"
"non_voting_members_list",
},
"term_length_duration",
"term_length": {
"website_hyperlink",
"label": "Length of term",
"constitution_hyperlink",
"description": "Length of the member's term.",
"bylaws_hyperlink"
"type": "string"
]
},
"meeting_place": {
"label": "Meeting place",
"description": "Location where the organization meets.",
"type": "string"
},
"meeting_schedule": {
"label": "Meeting schedule",
"description": "Regular meeting schedule.",
"type": "string"
},
"website": {
"label": "Website",
"description": "Official website of the organization.",
"type": "url"
},
"constitution": {
"label": "Constitutional basis",
"description": "Constitution, bylaws, or other governing document establishing the organization's authority.",
"type": "string"
}
},
"description": "Infobox for RPI Student Government branches and constituent bodies.",
"format": "block"
}
}
</templatedata>
</templatedata>
<includeonly>[[Category:Graduate Council templates]]</includeonly>