Received: from maia.hub.org (maia-3.hub.org [200.46.204.243]) by mail.postgresql.org (Postfix) with ESMTP id C2BDE1337BCC for ; Wed, 13 Apr 2011 13:30:39 -0300 (ADT) Received: from mail.postgresql.org ([200.46.204.86]) by maia.hub.org (mx1.hub.org [200.46.204.243]) (amavisd-maia, port 10024) with ESMTP id 14232-01 for ; Wed, 13 Apr 2011 16:30:20 +0000 (UTC) X-Greylist: from auto-whitelisted by SQLgrey-1.7.6 Received: from smtp1.linux-foundation.org (smtp1.linux-foundation.org [140.211.169.13]) by mail.postgresql.org (Postfix) with ESMTP id 1270A1337B67 for ; Wed, 13 Apr 2011 13:30:19 -0300 (ADT) Received: from mail-qy0-f181.google.com (mail-qy0-f181.google.com [209.85.216.181]) (authenticated bits=0) by smtp1.linux-foundation.org (8.14.2/8.13.5/Debian-3ubuntu1.1) with ESMTP id p3DGTk6O001676 (version=TLSv1/SSLv3 cipher=RC4-SHA bits=128 verify=FAIL) for ; Wed, 13 Apr 2011 09:29:46 -0700 Received: by qyg14 with SMTP id 14so506467qyg.19 for ; Wed, 13 Apr 2011 09:29:45 -0700 (PDT) Received: by 10.229.24.19 with SMTP id t19mr6347242qcb.167.1302711739094; Wed, 13 Apr 2011 09:22:19 -0700 (PDT) MIME-Version: 1.0 Received: by 10.229.183.10 with HTTP; Wed, 13 Apr 2011 09:21:49 -0700 (PDT) In-Reply-To: <4DA585A9020000250003C794@gw.wicourts.gov> References: <4DA585A9020000250003C794@gw.wicourts.gov> From: Thom Brown Date: Wed, 13 Apr 2011 17:21:49 +0100 Message-ID: Subject: Re: Proposal: syntax highlight in html manual To: Kevin Grittner Cc: Daniele Varrazzo , pgsql-docs@postgresql.org Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable X-MIMEDefang-Filter: lf$Revision: 1.188 $ X-Scanned-By: MIMEDefang 2.63 on 140.211.169.13 X-Virus-Scanned: Maia Mailguard 1.0.1 X-Spam-Status: No, hits=-1.9 tagged_above=-5 required=5 tests=BAYES_00=-1.9 X-Spam-Level: X-Archive-Number: 201104/71 X-Sequence-Number: 6642 On 13 April 2011 17:14, Kevin Grittner wrote: > Daniele Varrazzo 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. =A0Documentation 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. =A0It should be subtle enough not to draw attention to it, > but rather to give subtle cues. =A0If 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-CONSTRAI= NTS-FK And even if it didn't, I don't think it brings enough benefit to warrant implementation. --=20 Thom Brown Twitter: @darkixion IRC (freenode): dark_ixion Registered Linux user: #516935 EnterpriseDB UK: http://www.enterprisedb.com The Enterprise PostgreSQL Company