Another small patch...

Started by Guillaume Lelargeover 18 years ago4 messagesdocs
Jump to latest
#1Guillaume Lelarge
guillaume@lelarge.info

... this time, for maintenance.sgml.

Regards.

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

Attachments:

docmaintenance.patchtext/x-patch; name=docmaintenance.patchDownload+1-1
#2Alvaro Herrera
alvherre@2ndquadrant.com
In reply to: Guillaume Lelarge (#1)
Re: Another small patch...

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)

#3Alvaro Herrera
alvherre@2ndquadrant.com
In reply to: Alvaro Herrera (#2)
Re: Another small patch...

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".

#4Tom Lane
tgl@sss.pgh.pa.us
In reply to: Alvaro Herrera (#3)
Re: Another small patch...

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