pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
Another small patch...
4+ messages / 3 participants
[nested] [flat]

* Another small patch...
@ 2007-10-06 17:02  Guillaume Lelarge <guillaume@lelarge.info>
  0 siblings, 1 reply; 4+ messages in thread

From: Guillaume Lelarge @ 2007-10-06 17:02 UTC (permalink / raw)
  To: pgsql-docs

... this time, for maintenance.sgml.

Regards.


-- 
Guillaume.
 http://www.postgresqlfr.org
 http://dalibo.com

Attachments:

docmaintenance.patch (text/x-patch, 389B) download Index: doc/src/sgml/maintenance.sgml =================================================================== RCS file: /projects/cvsroot/pgsql/doc/src/sgml/maintenance.sgml,v retrieving revision 1.82 diff -r1.82 maintenance.sgml 63c63 < linkend="sql-vacuum"> command has to run on a regular basis for several --- > linkend="sql-vacuum">) command has to run on a regular basis for several
^ permalink raw reply [nested|flat] 4+ messages in thread

* Re: Another small patch...
@ 2007-10-06 17:48  Alvaro Herrera <alvherre@commandprompt.com>
  parent: Guillaume Lelarge <guillaume@lelarge.info>
  0 siblings, 1 reply; 4+ messages in thread

From: Alvaro Herrera @ 2007-10-06 17:48 UTC (permalink / raw)
  To: Guillaume Lelarge <guillaume@lelarge.info>; +Cc: pgsql-docs

Guillaume Lelarge wrote:
> ... this time, for maintenance.sgml.

Applied, thanks.  I'm wondering whether this should be

    <para>
!    <productname>PostgreSQL</productname>'s
!    <xref linkend="sql-vacuum" endterm="sql-vacuum-title"> command has to run on
!    a regular basis for several reasons:

instead.  I didn't try to compile it so maybe the output is not OK.

-- 
Alvaro Herrera                               http://www.PlanetPostgreSQL.org/
"The only difference is that Saddam would kill you on private, where the
Americans will kill you in public" (Mohammad Saleh, 39, a building contractor)



^ permalink  raw  reply  [nested|flat] 4+ messages in thread

* Re: Another small patch...
@ 2007-10-06 17:58  Alvaro Herrera <alvherre@commandprompt.com>
  parent: Alvaro Herrera <alvherre@commandprompt.com>
  0 siblings, 1 reply; 4+ messages in thread

From: Alvaro Herrera @ 2007-10-06 17:58 UTC (permalink / raw)
  To: Guillaume Lelarge <guillaume@lelarge.info>; +Cc: pgsql-docs

Alvaro Herrera wrote:
> Guillaume Lelarge wrote:
> > ... this time, for maintenance.sgml.
> 
> Applied, thanks.  I'm wondering whether this should be
> 
>     <para>
> !    <productname>PostgreSQL</productname>'s
> !    <xref linkend="sql-vacuum" endterm="sql-vacuum-title"> command has to run on
> !    a regular basis for several reasons:
> 
> instead.  I didn't try to compile it so maybe the output is not OK.

OK, I need opinions on this issue.  We currently have output that looks
like

"PostgreSQL's Vacuum (/Section 10.4.2/) command has to run ..."
(the part between // is a clickable link)

but with the patch above, it would show up as 
"PostgreSQL's /Vacuum/ command has to run ..."

Is there a preferred way to link?  I notice there is plenty of usage of
both forms.

I wonder what does printed output look like?  Does it just just lose the
reference?

-- 
Alvaro Herrera                          Developer, http://www.PostgreSQL.org/
Al principio era UNIX, y UNIX habló y dijo: "Hello world\n".
No dijo "Hello New Jersey\n", ni "Hello USA\n".



^ permalink  raw  reply  [nested|flat] 4+ messages in thread

* Re: Another small patch...
@ 2007-10-06 18:33  Tom Lane <tgl@sss.pgh.pa.us>
  parent: Alvaro Herrera <alvherre@commandprompt.com>
  0 siblings, 0 replies; 4+ messages in thread

From: Tom Lane @ 2007-10-06 18:33 UTC (permalink / raw)
  To: Alvaro Herrera <alvherre@commandprompt.com>; +Cc: Guillaume Lelarge <guillaume@lelarge.info>; pgsql-docs

Alvaro Herrera <alvherre@commandprompt.com> writes:
> OK, I need opinions on this issue.  We currently have output that looks
> like

> "PostgreSQL's Vacuum (/Section 10.4.2/) command has to run ..."
> (the part between // is a clickable link)

> but with the patch above, it would show up as 
> "PostgreSQL's /Vacuum/ command has to run ..."

> Is there a preferred way to link?

I'd vote for the latter, at least in cases like this.  I think here
you're just providing a courtesy link that you don't expect people
to follow all that often, and so minimizing its visual impact is
a good thing.

			regards, tom lane



^ permalink  raw  reply  [nested|flat] 4+ messages in thread


end of thread, other threads:[~2007-10-06 18:33 UTC | newest]

Thread overview: 4+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2007-10-06 17:02 Another small patch... Guillaume Lelarge <guillaume@lelarge.info>
2007-10-06 17:48 ` Alvaro Herrera <alvherre@commandprompt.com>
2007-10-06 17:58   ` Alvaro Herrera <alvherre@commandprompt.com>
2007-10-06 18:33     ` Tom Lane <tgl@sss.pgh.pa.us>

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox