[documentation] [Documentation feature] Improve readability of variables lists
webchick
drupal-docs at drupal.org
Fri Jan 19 04:57:52 UTC 2007
Issue status update for
http://drupal.org/node/110666
Post a follow up:
http://drupal.org/project/comments/add/110666
Project: Documentation
Version: <none>
Component: Admin Guide
Category: feature requests
Priority: normal
Assigned to: Anonymous
Reported by: pnm
Updated by: webchick
-Status: patch (code needs review)
+Status: fixed
+ freaking 1!! This is one of those head-slapper, "totally obvious once
someone points it out to you" things. Not only is it more legible, it's
also more semantically correct.
I updated the ULs to DLs on block, box, comment, node, and page
.tpl.php pages. The CSS changes I'm going to have to run past Steven; I
could include them in the page, but I'd have to update the input format
to "Full HTML" and then no one but site admins could edit...
webchick
Previous comments:
------------------------------------------------------------------------
Fri, 19 Jan 2007 00:20:15 +0000 : pnm
Attachment: http://drupal.org/files/issues/11816.html (40.18 KB)
The *Available variables* lists, like the one at
http://drupal.org/node/11816 , are difficult to scan visually. The
variable names are interspersed with wrapped multi-line definitions and
are not set out with formatting.
I'd suggest converting the bulleted lists to definition lists and
styling the variable names in bold.
I'm attaching replacement markup for the list in
http://drupal.org/node/11816 , additional CSS, and an HTML file that
should demonstrate the finished presentation I'm suggesting.
------------------------------------------------------------------------
Fri, 19 Jan 2007 00:21:21 +0000 : pnm
Attachment: http://drupal.org/files/issues/style_0.css (97 bytes)
Additional CSS.
------------------------------------------------------------------------
Fri, 19 Jan 2007 00:22:32 +0000 : pnm
Attachment: http://drupal.org/files/issues/11816.snip.txt (974 bytes)
Snip for http://drupal.org/node/11816 body
More information about the documentation
mailing list