Re: Proposal: syntax highlight in html manual

On 13 April 2011 17:14, Kevin Grittner <Kevin(dot)Grittner(at)wicourts(dot)gov> wrote:
> Daniele Varrazzo <daniele(dot)varrazzo(at)gmail(dot)com> wrote:
>
>> - http://pgmp.projects.postgresql.org/highlight/psql.html
>> - http://pgmp.projects.postgresql.org/highlight/postgres.html
>>
>> Is there any interest in applying highlighted syntax to the html
>> rendering of the manual?
>
> When using an editor I like some color highlighting, as long as I
> can control the colors.  Documentation is very different, especially
> since the user probably wouldn't have any control over the colors.
> The examples in the links above are very hard for me to read, and
> definitely *not* something I would want in the documentation.
>
> There might be room to do something limited and subtle, like maybe
> making comments a dark gray while other text is black or possibly
> making computer-generated output very dark blue versus black for
> user input.  It should be subtle enough not to draw attention to it,
> but rather to give subtle cues.  If the display screams "HEY! LOOK
> HERE!" about anything, it's just wrong.
>
> Overall, I'm dubious about whether it would be worth the effort,
> even if you can come up with a scheme which people like.

If we had any sort of syntax highlighting in the docs, I'd only expect
keywords in bold, and everything else regular. No colour changes.
Saying that, it would then interfere with examples that have
emphasised text, such as here:
http://www.postgresql.org/docs/9.0/static/ddl-constraints.html#DDL-CONSTRAINTS-FK

And even if it didn't, I don't think it brings enough benefit to
warrant implementation.

--
Thom Brown
Twitter: @darkixion
IRC (freenode): dark_ixion
Registered Linux user: #516935

EnterpriseDB UK: http://www.enterprisedb.com
The Enterprise PostgreSQL Company