Template:Infobox Graduate Council/doc: Difference between revisions

Goodws2 (talk | contribs)
m Add default variable names
Goodws2 (talk | contribs)
Attempting to fix formatting for the Graduate Council /doc. I think we need another extension enabled for Template data so that the Infoboxes don't just have a bunch of undefined parameters.
 
Line 38: Line 38:


! Example
! Example
<code>branch_name</code>
; <code>branch_name</code>
Official name displayed at the top of the infobox.
; 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 ===
; <code>image_file</code>
; Logo or image representing the council. Use a file name or supported image syntax.


{| class="wikitable" ! Parameter ! Description
; <code>logo_size</code>
; Controls the displayed image size. Defaults to 280px.


! Example
; <code>aka_list</code>
<code>branch_type</code>
; Alternative names, abbreviations, or other known names.
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 ===
; <code>established_year</code>
; Year the council was established.


{| class="wikitable" ! Parameter ! Description
; <code>current_session_hyperlink</code>
; Link or text identifying the current council session.


! Example
; <code>branch_type</code>
<code>president_name</code>
; Type or organizational classification of the council.
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 ===
; <code>branch_jurisdiction_type</code>
; Organization, constituency, or jurisdiction the council represents.


{| class="wikitable" ! Parameter ! Description
; <code>term_limits_number</code>
; Number of terms an individual may serve.


! Example
; <code>president_name</code>
<code>voting_members_list</code>
; Name of the current president.
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 ===
; <code>vice_president_name</code>
; Name of the current vice president.


{| class="wikitable" ! Parameter ! Description
; <code>secretary_name</code>
; Name of the current secretary.


! Example
; <code>treasurer_name</code>
<code>website_hyperlink</code>
; Name of the current treasurer.
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 ==
; <code>voting_members_list</code>
; List of voting members or voting membership positions.


<syntaxhighlight lang="wikitext">
; <code>non_voting_members_list</code>
{{Infobox Graduate Council
; List of non-voting members or ex-officio positions.
| branch_name = Graduate Council
 
| aka_list = GC
; <code>term_length_duration</code>
| established_year = 2020
; Duration of an individual member's term.
| current_session_hyperlink = [[Graduate Council/2026–2027]]
 
| branch_type = Legislative
; <code>website_hyperlink</code>
| branch_jurisdiction_type = Graduate Student Association
; Official website of the council.
| term_limits_number = Two consecutive terms
 
| president_name = Jane Smith
; <code>constitution_hyperlink</code>
| vice_president_name = John Smith
; Link to the Union's constitution passage for its power.
| secretary_name = Alex Smith
 
| treasurer_name = Taylor Smith
; <code>bylaws_hyperlink</code>
| voting_members_list = Department representatives
; Link to the council's bylaws.
| 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 ==
== Notes ==


All parameters are optional in the current implementation.
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 ==
Line 206: Line 135:
"current_session_hyperlink": {
"current_session_hyperlink": {
"label": "Current session",
"label": "Current session",
"description": "Link or text identifying the current council session.",
"description": "Link to the current council session.",
"type": "wiki-page-name"
"type": "wiki-page-name"
},
},
Line 266: Line 195:
"constitution_hyperlink": {
"constitution_hyperlink": {
"label": "Constitution",
"label": "Constitution",
"description": "Link to the council constitution.",
"description": "Link to the Union constitution derived powers.",
"type": "wiki-page-name"
"type": "string"
},
},
"bylaws_hyperlink": {
"bylaws_hyperlink": {