From: | Daniele Varrazzo <daniele(dot)varrazzo(at)gmail(dot)com> |
---|---|
To: | Peter Eisentraut <peter_e(at)gmx(dot)net> |
Cc: | pgsql-docs(at)postgresql(dot)org |
Subject: | Re: Proposal: syntax highlight in html manual |
Date: | 2011-04-13 19:20:23 |
Message-ID: | BANLkTi=v1122ExwLLkhuZL+_wfs1HEVk5g@mail.gmail.com |
Views: | Raw Message | Whole Thread | Download mbox | Resend email |
Thread: | |
Lists: | pgsql-docs |
On Wed, Apr 13, 2011 at 7:34 PM, Peter Eisentraut <peter_e(at)gmx(dot)net> wrote:
> On ons, 2011-04-13 at 11:31 +0100, Daniele Varrazzo wrote:
>> If there is, I think the rendering should be performed as a
>> post-processing step on the html output and should be a totally
>> optional phase: we may do it for the website but have the docs
>> generation not to fail if the tools (python, pygments) are missing.
>> There would be the need to tag every snippet in the docs with the
>> correct language: I think the correct way is to use the "role"
>> attribute in the docbook tags generating the snippets (screen,
>> programlisting, synopsis...): its value can be propagated to the html
>> (e.g. as a css class) using a suitable docbook configuration (see
>> <http://www.sagehill.net/docbookxsl/HtmlCustomEx.html#CustomClassValues>,
>> albeit a test I've done in that direction failed - but I'm completely
>> clueless about debugging the docbooc tool chain).
>
> I guess the verdict is that we shouldn't do it by default, but what we
> could do anyway is language tag the code as you describe. Then users
> could either hook in client-side Javascript to do the highlighting or
> whoever wants to can produce an alternative colorful pygments-based
> version.
Fine for me, the motivation for not wanting highlight in the official
docs are pretty solid. If you fancy implementing the role to class
propagation I may complete the tagging and provide patches for the
sgml, but I expect it to be pretty much everything.
Regards,
-- Daniele
From | Date | Subject | |
---|---|---|---|
Next Message | Robert Haas | 2011-04-14 18:37:26 | Re: [HACKERS] Uppercase SGML entity declarations |
Previous Message | Peter Eisentraut | 2011-04-13 18:34:48 | Re: Proposal: syntax highlight in html manual |