Jump to content

Special:Badtitle/NS90:Talk:Typographical Guidelines/Disagree with bold+italic and code tag guidelines

From KDE UserBase Wiki
Revision as of 02:10, 2 December 2011 by Skierpage (talk | contribs) (New thread: Disagree with bold+italic and code tag guidelines)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Only italic for replaceable and variable text

Use this combination [Bold and Italic Text] for replaceable or variable text.

I think that's overkill, it draws wayyy too much attention. Just use italics for variable and replaceable text, that's the convention used by O'Reilly books and most web sites. (The semantic HTML tag for variable text is <var> — enter your User Name. Note how it's just italic, not italic+bold.)

extend code tag to end of entry

Surely the <code> tag must extend over all the bits you type in, otherwise it's incoherent. The examples given are wrong.

current (2011-12-01)
type ssh username@domain.name in Konsole
better, it's all stuff you enter
type ssh username@domain.name in Konsole
best (don't overstyle, variable text just in italic)
type ssh username@domain.name in Konsole

kbd tag, not code, for user input

Besides, the correct tag for things you must type is the <kbd> tag. From the HTML 2.0 spec at w3.org, "The KBD element indicates text typed by a user." <code> should be for bits of config files, sample output, etc. Let's try kbd:

test using kbd tag instead
type ssh username@domain.name in Konsole

The steps to get there from here are:

  1. Style kbd to have the same yellow background as current code and the input template.
  2. Change these guidelines, start using <kbd> for user input, and over time convert markup for text entry in existing wiki pages to it.
  3. Change the <code> tag to have the same violet-gray background as the output template.