Beefy Boxes and Bandwidth Generously Provided by pair Networks
P is for Practical
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??

I tend to agree with fever. I'm dyslexic and I find coloured text much harder to read than simple well spaced text. Plus coloured text is expensive to print in colour and when printed in B&W it looses contrast when compared with plain B&W text.

I've tried lots of syntax highlighting tools for code, HTML and XML, and I often find I think it's cool and better than plain unadorned text, until I use it, then I prefer light text (one of only a few colours) on a dark background.

The various societies for dyslexia, blind/partial sighted and reading/learning problems, all have guidelines (often conflicting I might add), but they tend to suggest simple high contrast colours well spaced.

While I accept that you can do what you want on your own when you work on code, when you present it, indeed when you present anything, it's all about clear simple presentation. The same rules that make an article or presentation good apply to anything, code or not.

For example:


--
ajt

In reply to Re: Re: Documenting code by ajt
in thread Documenting code by traveler

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others perusing the Monastery: (7)
As of 2024-04-24 01:49 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found