Difference between revisions of "QBWiki:Style Guide"

From QBWiki
Jump to navigation Jump to search
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
=General=
+
==General==
Both <nowiki>[[square braces]]</nowiki> and <nowiki>'''triple quotes'''</nowiki> work to bold the subject of a page - though some older pages use square braces, triple quotes is likely simpler.
+
*Here is a link to the page on formatting on MediaWiki, the platform that the QBWiki runs on: [https://www.mediawiki.org/wiki/Help:Formatting Help:Formatting]. Be sure to flip through this if you expect to be doing more involved work.
  
Categories should appear at the bottom of the page. The [[:Template:c|c]] template is a shorthand for writing categories.
+
*Both <nowiki>[[square braces]]</nowiki> and <nowiki>'''triple quotes'''</nowiki> work to bold the subject of a page - though some older pages use square braces, triple quotes is likely simpler and will work even if the phrase being bolded does not link to the page being edited.
  
=Player pages=
+
*Categories should appear at the bottom of the page with line breaks to allow them to be read more easily. [[:Template:c|c template]] is a shorthand for writing categories.
==Infobox==
 
In general, most players should have infoboxes (opt-out). The [[:Template:ib|ib]] template provides a convenient shorthand.
 
  
==Years active==
+
*Whenever possible, references to forum posts should be added in as <nowiki><ref>references</ref></nowiki> rather than external links. A clean format is as follows:
 +
:<pre><ref>[forums link "Name of post"] by [[forum user]] » time stamp</ref></pre>
 +
:This is easily achieved by copying the header of a post from the title to the attribution, removing the "Post" text that comes from copying the icon and the newline, and wrapping the title in a braces and the user in double braces.
 +
 
 +
*The information used in this reference can be obtained by simply copy-pasting the header of the post in question and removing the "Post" text that appears due to the tooltip of the link icon.
 +
 
 +
==Player pages==
 +
{{ib|Example player
 +
|schoolcur=[[Black Hills State University]] (2015-current)
 +
|schoolpast=[[Ball State]] (2010-2015)
 +
|highschool=[[Thomas Jefferson (MO)]] (2009-2010), [[Thomas Jefferson (VA)]] (2006-2009)
 +
}}
 +
Player pages should summarize a player's time as a player, as a writer, and as a member of the community. They should provide sufficient information that someone can know when and where they were active and should have links to any relevant and useful information (e.g. stats). The goal is that a user should be able to visit any given player's page on the wiki and find (or at least be directed to) what they want to know about them.
 +
 
 +
The most straightforward way to gather the information needed to write someone's page is to visit a page compiling past stats (i.e. NAQT's player pages or [[HDWhite]]) and do a search of the forums to see what projects they've worked on.
 +
 
 +
===Infobox===
 +
The infobox can hold most of the information which should be on a page. The presence of the infobox often makes some of the text of an article redundant, but it should still be as complete as possible.  In general, infoboxes should be given on an opt-out basis - most player pages should have one. The [[:Template:ib|ib template]] provides a convenient shorthand.
 +
 
 +
===Years active===
 
Players should have all their years active at a given institution listed in their infobox. This should include all years the player was active - for instance, if a player played for their school from the fall of 2018 to the spring of 2021, their infobox should say (2018-2021).
 
Players should have all their years active at a given institution listed in their infobox. This should include all years the player was active - for instance, if a player played for their school from the fall of 2018 to the spring of 2021, their infobox should say (2018-2021).
  
Line 15: Line 32:
 
The [[:Template:active|active]], [[:Template:activehs|activehs]], and [[:Template:activems|activems]] templates are useful shorthands.
 
The [[:Template:active|active]], [[:Template:activehs|activehs]], and [[:Template:activems|activems]] templates are useful shorthands.
  
::The "2016 means 2015-2016 academic year" convention was definitely a formal rule on the wiki at some point, though it appears not to have survived one of the site transitions. I'm not married to it and if the final decision is to go the other way, that's what I'll use, but the older way seems to make sense for a few reasons and I'd like to have at least some discussion before everyone starts changing things to the new format:
+
===Affiliations===
::*Academic years are what we care about because that is what quizbowl, an activity dependent on high school and college enrollment, is based on. The fact that someone was in school and played in 2015-2016 is important for establishing that person's timeframe; whether they played any tournaments in the calendar months of fall 2015 specifically is not, and finding this information in order to report dates accurately may be difficult or impossible for some people whose years of participation are otherwise known.
+
Schools that a player has played/coached for should be included as categories on their page, embedded into their infoboxes, and mentioned in the lede of the article. The preference is to include affiliation categories alongside other categories at the bottom of the page, rather than in the infobox next to their years played.
::**In line with the above, reporting that, e.g., someone who played exclusively fall tournaments in the 2017-2018 academic year ended their career in "2017" creates an ambiguous situation as to which and how many academic years they played in, which again seems to be the thing we actually care about in recording these years at all.
+
 
::*Other activities whose seasons span multiple calendar years use agreed-upon single-year conventions for simplicity's sake. For example, the NFL season that began in September 2019 and concluded with the Super Bowl in February 2020 is called the "2019 NFL season," and a player who retired in that year is said to have played "through 2019" even if they participated in games in January 2020. The team that is playing in the NBA Finals this week against Milwaukee is the "2021 Phoenix Suns" even though their regular season started in December 2020.
+
==Schools that have changed names==
::*Because this was a site convention in the past, many page titles and text references follow it already, most notably the various pages for things like "2019 Stanford" and most of the choices about which "players active in..." categories to use. It's more realistic to get people to use the existing plurality convention in the future than to expect anyone to actually go back and change thousands of references to the new style, and we should try to keep things consistent. [[User:Matt Weiner|Matt Weiner]] ([[User talk:Matt Weiner|talk]]) 12:06, 4 July 2021 (CDT)
+
 
 +
To eliminate confusion and a multiplication of unnecessary redirects or duplicate pages, refer to schools that have undergone a one-to-one name change by their current name in most contexts. E.g., "[[Truman State]]" instead of "Northeast Missouri State University," or "Staunton High School" instead of "Robert E. Lee High School," even when talking about a tournament from before the name change. Use in-text explanations or footnotes to clarify as needed.
 +
 
 +
There may be situations when it makes more sense to use the old name, especially when recounting a primary narrative from a contemporary source, or when the situation is more complicated than a single institution changing its name (e.g. when assigning institutional history from a high school that has since closed and merged into another school). The above should be taken as a general guideline and not an ironclad rule; the principle of maintaining clarity, avoiding the creation of duplicate pages such as "1991 Truman State" and "1991 Northeast Missouri State," and simply explaining the situation somewhere on the page is what is important, and there may be different ways to achieve this goal in different situations.
 +
 
 +
== Other recommendations ==
 +
Don't make lists of "current club members" or similar. They get out-of-date quickly and are rarely maintained. If you want to do something like this, here are some slightly better ideas:
 +
* Link to your school's all-time roster page on [[NAQT]]'s website. You can find that page via NAQT's [https://www.naqt.com/stats/school/ search tool].
 +
* Label the list "2022–2023 Roster" or something like that. It will eventually become irrelevant if not maintained, but that's a little bit better than it being outright incorrect.
 +
 
 +
Avoid phrases like "Pat Smith is a current junior at Central High School", as they are likely to get out-of-date. Something like "Pat Smith is a member of the class of 2024 at Central High School" works a bit better.

Revision as of 00:19, 4 February 2023

General

  • Here is a link to the page on formatting on MediaWiki, the platform that the QBWiki runs on: Help:Formatting. Be sure to flip through this if you expect to be doing more involved work.
  • Both [[square braces]] and '''triple quotes''' work to bold the subject of a page - though some older pages use square braces, triple quotes is likely simpler and will work even if the phrase being bolded does not link to the page being edited.
  • Categories should appear at the bottom of the page with line breaks to allow them to be read more easily. c template is a shorthand for writing categories.
  • Whenever possible, references to forum posts should be added in as <ref>references</ref> rather than external links. A clean format is as follows:
<ref>[forums link "Name of post"] by [[forum user]] » time stamp</ref>
This is easily achieved by copying the header of a post from the title to the attribution, removing the "Post" text that comes from copying the icon and the newline, and wrapping the title in a braces and the user in double braces.
  • The information used in this reference can be obtained by simply copy-pasting the header of the post in question and removing the "Post" text that appears due to the tooltip of the link icon.

Player pages

Example player
Current college Black Hills State University (2015-current)
Past colleges Ball State (2010-2015)
High school Thomas Jefferson (MO) (2009-2010), Thomas Jefferson (VA) (2006-2009)
Stats HDWhite • NAQT

Player pages should summarize a player's time as a player, as a writer, and as a member of the community. They should provide sufficient information that someone can know when and where they were active and should have links to any relevant and useful information (e.g. stats). The goal is that a user should be able to visit any given player's page on the wiki and find (or at least be directed to) what they want to know about them.

The most straightforward way to gather the information needed to write someone's page is to visit a page compiling past stats (i.e. NAQT's player pages or HDWhite) and do a search of the forums to see what projects they've worked on.

Infobox

The infobox can hold most of the information which should be on a page. The presence of the infobox often makes some of the text of an article redundant, but it should still be as complete as possible. In general, infoboxes should be given on an opt-out basis - most player pages should have one. The ib template provides a convenient shorthand.

Years active

Players should have all their years active at a given institution listed in their infobox. This should include all years the player was active - for instance, if a player played for their school from the fall of 2018 to the spring of 2021, their infobox should say (2018-2021).

The "(highschool/middleschool) Player active in (year)" categories should be used as well. The year specified by this template is the end of the competition year, so the "Player active in 2014" categories indicates that a player was active in the 2013-2014 competition year. This distinction is outlined in each of the category pages.

The active, activehs, and activems templates are useful shorthands.

Affiliations

Schools that a player has played/coached for should be included as categories on their page, embedded into their infoboxes, and mentioned in the lede of the article. The preference is to include affiliation categories alongside other categories at the bottom of the page, rather than in the infobox next to their years played.

Schools that have changed names

To eliminate confusion and a multiplication of unnecessary redirects or duplicate pages, refer to schools that have undergone a one-to-one name change by their current name in most contexts. E.g., "Truman State" instead of "Northeast Missouri State University," or "Staunton High School" instead of "Robert E. Lee High School," even when talking about a tournament from before the name change. Use in-text explanations or footnotes to clarify as needed.

There may be situations when it makes more sense to use the old name, especially when recounting a primary narrative from a contemporary source, or when the situation is more complicated than a single institution changing its name (e.g. when assigning institutional history from a high school that has since closed and merged into another school). The above should be taken as a general guideline and not an ironclad rule; the principle of maintaining clarity, avoiding the creation of duplicate pages such as "1991 Truman State" and "1991 Northeast Missouri State," and simply explaining the situation somewhere on the page is what is important, and there may be different ways to achieve this goal in different situations.

Other recommendations

Don't make lists of "current club members" or similar. They get out-of-date quickly and are rarely maintained. If you want to do something like this, here are some slightly better ideas:

  • Link to your school's all-time roster page on NAQT's website. You can find that page via NAQT's search tool.
  • Label the list "2022–2023 Roster" or something like that. It will eventually become irrelevant if not maintained, but that's a little bit better than it being outright incorrect.

Avoid phrases like "Pat Smith is a current junior at Central High School", as they are likely to get out-of-date. Something like "Pat Smith is a member of the class of 2024 at Central High School" works a bit better.