Help talk:Templates: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
Line 6: Line 6:


:Makes sense to me. --[[User:Loudslappingsounds|Loudslappingsounds]] ([[User talk:Loudslappingsounds|talk]]) 23:21, 15 September 2021 (PDT)
:Makes sense to me. --[[User:Loudslappingsounds|Loudslappingsounds]] ([[User talk:Loudslappingsounds|talk]]) 23:21, 15 September 2021 (PDT)
== When to Use What, Where? ==
most templates' documentation explains the mechanics of their usage pretty well, and most of the ones without documentation are pretty easy to figure out. what's less transparent, however, is ''how'' they should be used.<br>
for example, I know how [[Template:Note]] works, 'cuz its documentation is quite clear. [[Template:ModernNote]] lacks documentation, but it's not hard to put two and two together. what ''is'' hard is knowing what the difference in purpose is.
*when should I use the "Modern" note templates, and when should I use the standard ones?
another example is [[:Category:Top icon templates|topicon templates]]. I see them pretty often on Source 2-related pages, but nowhere else (though I then went and made some and have since been adding them where I thought they belonged). one especially confusing bit is that the [[Dota 2|game]] pages [[Half-Life: Alyx|themselves]] don't seem to have the topicons, and neither do entity pages.
*where should topicons be used?
**should they be used in relevant category and template pages?
***or should they only be used in relevant category pages that function much like normal pages (e.g., [[:Category:Level Design]]?)
**should they be used in relevant entity pages?
**should they be used on game/mod pages?
similarly, I'm unclear as to when game link templates should be used, especially ones like [[:Category:Game icons|Game icons]], [[Template:Game link]] (or {{tlx|new icon|2}}), and [[Template:Game name]] (or {{tlx|new icon|4}}). I get the impression that {{tl|Game name}} holds more importance than {{tl|Game link}}, and both are used (as with most links) primarily to introduce things, but I'm not entirely sure. I see the icons used a lot by themselves, but I often find this somewhat frustratingly vague, as some things have the same icons (e.g., {{hl}} and {{hls}}).<br>
relatedly, I'm somewhat unclear as to when titles/names should be italicized, put in quotation marks, or left bare. (I'm guessing {{tl|Game name}} exempts it from any of these, but that aside…) I know that generally, names of works of fiction are supposed to be italicized (e.g., ''Portal 2'' or ''Trollhunters''); meanwhile, sections of such works are supposed to be quoted (e.g., "The Fall" or "Becoming: Part 1"), as are titles when italics are difficult/impossible. One gray area, though, is mods.
*when should {{tl|Game link}}, {{tl|Game name}}, game icons, quoted names, and italicized names be used in comparison to each other?
**should {{tl|Game link}} and {{tl|Game name}} be used primarily to "introduce" games to a topic, the same way as with any topic relevant to an article?
**is {{tl|Game name}} supposed to be used for games considered more important to the topic? if so, what counts as "more important?"
***predecessor games?
***sequel games?
***games in which the page topic is present (when it isn't present in all games)?
***games in which the paragraph topic is present?
***games in which a specific bug/quirk/whatever is present?
**do mod names (as in, modifications to a game, as opposed to modifications to Source) get italicized, quoted, or neither? (e.g., is [[Dissonance]], "[[Dissonance]]," [[Dissonance|"Dissonance,"]] or ''[[Dissonance]]'' preferable?)
*when should {{tlx|Game name|icon{{=}}0}}/{{tlx|new icon|3}} (e.g., {{portal2|3}}), "bare" icons (e.g., {{portal2}}), and "bare" links (e.g., [[Portal 2]]) be used?
**are "bare" icons supposed to be used before the first paragraph of a page pertinent to a specific game (as on [[Hard Light]] and most entity pages)?
***are they the preferred form of game mention in inline note templates, like {{tl|Bug}}?
**are iconless Game Names only supposed to be used when a "bare" icon precedes the paragraph (as in the same examples)? or are there other use cases?
**are "bare" links never supposed to be used for games/mods, since they should always have stylization/italics/quotes?
I know this is a lot. this website should probably have a style guide for this. I'd be willing to write it, but if I knew the answers to these questions, then uhh I wouldn't be asking them.

Revision as of 17:48, 20 May 2022

Should I add redirects with translated names to translated templates?

Note.pngNote:Post is quoted from Valve Developer Community talk:About page.

So like for instance if a chinese person wanted to use Template:Confirm:zh-cn, it would likely be annoying to use it, as they would need to either copy paste english text or use an english keyboard to type in {{confirm:zh-cn}}, which not all chinese people want to do. If there was a template redirect page named simply Template:确认 that redirected to Template:Confirm:zh-cn, then chinese people would only have to type in {{确认}} to use the chinese confirm template.

In my opinion this would make it easier for chinese people to insert chinese templates. Right? - Amicdict (talk) 16:23, 15 September 2021 (PDT)

Makes sense to me. --Loudslappingsounds (talk) 23:21, 15 September 2021 (PDT)

When to Use What, Where?

most templates' documentation explains the mechanics of their usage pretty well, and most of the ones without documentation are pretty easy to figure out. what's less transparent, however, is how they should be used.
for example, I know how Template:Note works, 'cuz its documentation is quite clear. Template:ModernNote lacks documentation, but it's not hard to put two and two together. what is hard is knowing what the difference in purpose is.

  • when should I use the "Modern" note templates, and when should I use the standard ones?

another example is topicon templates. I see them pretty often on Source 2-related pages, but nowhere else (though I then went and made some and have since been adding them where I thought they belonged). one especially confusing bit is that the game pages themselves don't seem to have the topicons, and neither do entity pages.

  • where should topicons be used?
    • should they be used in relevant category and template pages?
      • or should they only be used in relevant category pages that function much like normal pages (e.g., Category:Level Design?)
    • should they be used in relevant entity pages?
    • should they be used on game/mod pages?

similarly, I'm unclear as to when game link templates should be used, especially ones like Game icons, Template:Game link (or {{new icon|2}}), and Template:Game name (or {{new icon|4}}). I get the impression that {{Game name}} holds more importance than {{Game link}}, and both are used (as with most links) primarily to introduce things, but I'm not entirely sure. I see the icons used a lot by themselves, but I often find this somewhat frustratingly vague, as some things have the same icons (e.g., Half-Life and Half-Life: Source).
relatedly, I'm somewhat unclear as to when titles/names should be italicized, put in quotation marks, or left bare. (I'm guessing {{Game name}} exempts it from any of these, but that aside…) I know that generally, names of works of fiction are supposed to be italicized (e.g., Portal 2 or Trollhunters); meanwhile, sections of such works are supposed to be quoted (e.g., "The Fall" or "Becoming: Part 1"), as are titles when italics are difficult/impossible. One gray area, though, is mods.

  • when should {{Game link}}, {{Game name}}, game icons, quoted names, and italicized names be used in comparison to each other?
    • should {{Game link}} and {{Game name}} be used primarily to "introduce" games to a topic, the same way as with any topic relevant to an article?
    • is {{Game name}} supposed to be used for games considered more important to the topic? if so, what counts as "more important?"
      • predecessor games?
      • sequel games?
      • games in which the page topic is present (when it isn't present in all games)?
      • games in which the paragraph topic is present?
      • games in which a specific bug/quirk/whatever is present?
    • do mod names (as in, modifications to a game, as opposed to modifications to Source) get italicized, quoted, or neither? (e.g., is Dissonance, "Dissonance," "Dissonance," or Dissonance preferable?)
  • when should {{Game name|icon=0}}/{{new icon|3}} (e.g., Portal 2), "bare" icons (e.g., Portal 2), and "bare" links (e.g., Portal 2) be used?
    • are "bare" icons supposed to be used before the first paragraph of a page pertinent to a specific game (as on Hard Light and most entity pages)?
      • are they the preferred form of game mention in inline note templates, like {{Bug}}?
    • are iconless Game Names only supposed to be used when a "bare" icon precedes the paragraph (as in the same examples)? or are there other use cases?
    • are "bare" links never supposed to be used for games/mods, since they should always have stylization/italics/quotes?

I know this is a lot. this website should probably have a style guide for this. I'd be willing to write it, but if I knew the answers to these questions, then uhh I wouldn't be asking them.