DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma;
	h=mime-version:in-reply-to:references:date:message-id:subject:from:to
	:cc:content-type:content-transfer-encoding;
	b=VNr88m5gAp5me//dW3o2V5ID79ZCyXl0WOaXZfd/BN7waClpcJvHIc8cXA3m86dTuv
	MBtKm1diT8rHpEHb54Hym9LHl/K8Xy2VNtMUHAShzpkFdCBqxSA1rw9/83ojesUt+/DT
	BtHiM7XmjKU3A7j4GGfH1wrBCsrA/A+w9FExY=
MIME-Version: 1.0
In-Reply-To: <1302719688.11858.2.camel@vanquo.pezone.net>
References: <BANLkTi=C=-zur9gxi75o45Mq38dBsf4Bvw@mail.gmail.com>
	<1302719688.11858.2.camel@vanquo.pezone.net>
Date: Wed, 13 Apr 2011 20:20:23 +0100
Message-ID: <BANLkTi=v1122ExwLLkhuZL+_wfs1HEVk5g@mail.gmail.com>
Subject: Re: Proposal: syntax highlight in html manual
From: Daniele Varrazzo <daniele.varrazzo@gmail.com>
To: Peter Eisentraut <peter_e@gmx.net>
Cc: pgsql-docs@postgresql.org
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable

On Wed, Apr 13, 2011 at 7:34 PM, Peter Eisentraut <peter_e@gmx.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. =A0Then 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