Template talk:Note

From Valve Developer Community
Jump to: navigation, search

That is this template supposed to be for? I've written the old BLACK notes whenever it said "Note:", but now when it's a different color, I'll use it very rarely because it will get all the attention on a page, like saying "Important!". --Andreasen 10:13, 31 Mar 2006 (PST)

We're talking about the note template here. I don't like the red color either, I'd prefer it was black. Jupix 10:29, 31 Mar 2006 (PST)

History

When the HTML SDK documentation was created (and even farther back, in the Hammer documentation), we added note callouts to bring important elements of the documentation to the attention of the reader that weren't quite as severe as a "warning". The original formatting for note callouts, fairly common in software documentation, was like this:

Note: A note about the relevant feature goes here.

This formatting was transferred to the wiki site from the original HTML version. It was later made into this template, then recently modified to the state it is today. --JeffLane 14:11, 4 Apr 2006 (PDT)

So which one do you prefer, the black one or the red one? Jupix 14:16, 4 Apr 2006 (PDT)
If we are looking for consistency in the wiki "outfit", then we have to choose the red - it is the one that's used in the preview warning as well.
Personally, I'd prefer the black + intent though. Blue is a no-go because it looks like a link. Green connects it to a wrong meaning. --Vaarscha 15:22, 4 Apr 2006 (PDT)
But is the note supposed to be a warning? That's the question. You assumed it was intended as one, but why did you assume that about a simple note? A note can be used as a parathesis too. If you want a warning, there is a warning template now too for that. ...or is that warning template for something else? --Andreasen 15:45, 4 Apr 2006 (PDT)
No, it's not supposed to be a warning, just information important enough to warrant a special acknowledgment. Template:Warning is for more severe notes, where failure to read the information can cause serious problems or loss of data. Neither should be overused or the visual hierarchy becomes meaningless. I added icons to the templates to help clarify.

Direct Link

I'm curious, I haven't seen any direct links on any of the WikiMedia's templates as they can sometimes be a PITA during a site upgrades. What was the reasoning for making the image link direct? --brandished 14:38, 1 Jan 2009 (PST)

It removes the annoyance and distraction of having such a small, decorative image clickable, and also reduces HTML cruft. --TomEdwards 15:08, 1 Jan 2009 (PST)