Re: Proposal: syntax highlight in html manual - Mailing list pgsql-docs

From Tom Lane
Subject Re: Proposal: syntax highlight in html manual
Date
Msg-id 4947.1302706922@sss.pgh.pa.us
Whole thread Raw
In response to Proposal: syntax highlight in html manual  (Daniele Varrazzo <daniele.varrazzo@gmail.com>)
Responses Re: Proposal: syntax highlight in html manual  (Susanne Ebrecht <susanne@2ndQuadrant.com>)
List pgsql-docs
Daniele Varrazzo <daniele.varrazzo@gmail.com> writes:
> when I wrote the docs for the GMP extension
> (http://pgmp.projects.postgresql.org/) I started improving the syntax
> highlight produced by pygments
> (https://bitbucket.org/dvarrazzo/pygments-postgres) for the PostgreSQL
> SQL dialect. I've also added specific lexers for PL/pgSQL and
> interactive psql sessions. The lexer handles all the PG constructs,
> has a list of keywords and datatypes parsed from the docs, and can
> also dispatch the content of a $$ string to a different lexer based on
> a related LANGUAGE keyword nearby (e.g. highlighting a PL/Python
> function using the Python lexer). Here you can see the result on the
> "regression document" I am using to develop the lexer:

> - 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?

FWIW, there are very few things in the world that I hate more than
randomly multicolored text.  Almost always, some of it is unreadable
in a particular viewing context because of poor contrast.  And as
often as not, the stuff that does stand out isn't the most important
parts of the text.

So no, this isn't a direction I want to see the Postgres documentation
take.

            regards, tom lane

pgsql-docs by date:

Previous
From: Daniele Varrazzo
Date:
Subject: Proposal: syntax highlight in html manual
Next
From: Susanne Ebrecht
Date:
Subject: Re: Proposal: syntax highlight in html manual