[drupal-docs] Good stuff: clearly written docs

Steven Wittens steven at acko.net
Sat Apr 23 04:58:16 UTC 2005


> Just checked.  Much easier to read.  The faint blue highlight is 
> definitely a nice touch (you could even go a shade or two darker).

Well there are really two uses of <code>... when used for multiple lines 
of text, a separate code box is created. When used for a single piece of 
text, it is used inline and only the font was changed. Often however the 
inline use was also used to emphasise bits of text, and the background 
helps with that.

Which kinds of text to include in <code> is of course something up for 
discussion ;). If needed I can create some more specific styles / 
classes for use in documentation, though I don't think we'll need those 
much in Drupal. A common example is to give keyboard key names a 3D 
button look.

There is also a slight problem with tables in the documentation, in that 
table rows require alternating "dark" "light" classes to appear striped. 
I'll see if I can write a striping filter which does this automatically 
for tables inside content.

Steven Wittens



More information about the drupal-docs mailing list