public inbox for [email protected]  
help / color / mirror / Atom feed
BUG #1414: DOC - pl/Perl hash tags missing
9+ messages / 5 participants
[nested] [flat]

* BUG #1414: DOC - pl/Perl hash tags missing
@ 2005-01-19 17:25  Mike Blackwell <[email protected]>
  0 siblings, 2 replies; 9+ messages in thread

From: Mike Blackwell @ 2005-01-19 17:25 UTC (permalink / raw)
  To: [email protected]


The following bug has been logged online:

Bug reference:      1414
Logged by:          Mike Blackwell
Email address:      [email protected]
PostgreSQL version: 8.0.0
Operating system:   N/A
Description:        DOC - pl/Perl hash tags missing
Details: 

In the pl/Perl section of the 8.0.0 manual, as viewed on the postgresql.org
web site, all perl code hash tags seem to be missing.  i.e. 

$hashref->

displays as 

$hashref->



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

* Re: [BUGS] BUG #1414: DOC - pl/Perl hash tags missing
@ 2005-01-20 20:47  Tom Lane <[email protected]>
  parent: Mike Blackwell <[email protected]>
  1 sibling, 0 replies; 9+ messages in thread

From: Tom Lane @ 2005-01-20 20:47 UTC (permalink / raw)
  To: Mike Blackwell <[email protected]>; +Cc: [email protected]; pgsql-docs; [email protected]

"Mike Blackwell" <[email protected]> writes:
> In the pl/Perl section of the 8.0.0 manual, as viewed on the postgresql.org
> web site, all perl code hash tags seem to be missing.  i.e. 

Yeah, I see the same; but it's not in the devel docs.  Compare
	http://www.postgresql.org/docs/8.0/static/plperl.html
	http://developer.postgresql.org/docs/postgres/plperl.html
and look for instance at the empcomp() function about halfway down
the page:
    return $emp-> + $emp->;
vs
    return $emp->{basesalary} + $emp->{bonus};

Any theories what's wrong here?

			regards, tom lane



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

* Re: [DOCS] [BUGS] BUG #1414: DOC - pl/Perl hash tags missing
@ 2005-01-20 21:11  Magnus Hagander <[email protected]>
  0 siblings, 1 reply; 9+ messages in thread

From: Magnus Hagander @ 2005-01-20 21:11 UTC (permalink / raw)
  To: Tom Lane <[email protected]>; Mike Blackwell <[email protected]>; +Cc: pgsql-docs; [email protected]

>> In the pl/Perl section of the 8.0.0 manual, as viewed on the 
>postgresql.org
>> web site, all perl code hash tags seem to be missing.  i.e. 
>
>Yeah, I see the same; but it's not in the devel docs.  Compare
>	http://www.postgresql.org/docs/8.0/static/plperl.html
>	http://developer.postgresql.org/docs/postgres/plperl.html
>and look for instance at the empcomp() function about halfway down
>the page:
>    return $emp-> + $emp->;
>vs
>    return $emp->{basesalary} + $emp->{bonus};
>
>Any theories what's wrong here?

Going out on a line a bit here - and someone who've worked with teh
system probably knows for sure but... It looks like {} is used as the
template placeholder in the templating system on the website.

It would seem to me that the fix would be as simple as to set
$removeUnknownVariables to false when parsing the docs template, but I'm
far from sure at that. And I have no way to test it. And it might break
something else. End of disclaimers.

Anyway. If it helped one of the web guys in the right direction
(assuming it was right), then there was some point to this post ;-)

//Magnus



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

* Re: [DOCS] [BUGS] BUG #1414: DOC - pl/Perl hash tags missing
@ 2005-01-20 21:23  Tom Lane <[email protected]>
  parent: Magnus Hagander <[email protected]>
  0 siblings, 1 reply; 9+ messages in thread

From: Tom Lane @ 2005-01-20 21:23 UTC (permalink / raw)
  To: Magnus Hagander <[email protected]>; +Cc: Mike Blackwell <[email protected]>; pgsql-docs; [email protected]

"Magnus Hagander" <[email protected]> writes:
> Going out on a line a bit here - and someone who've worked with teh
> system probably knows for sure but... It looks like {} is used as the
> template placeholder in the templating system on the website.

> It would seem to me that the fix would be as simple as to set
> $removeUnknownVariables to false when parsing the docs template, but I'm
> far from sure at that. And I have no way to test it. And it might break
> something else. End of disclaimers.

If the docs template is applying any substitution whatsoever to the
documentation HTML files, it's broken.  I don't think the above fix
is appropriate --- what if the docs contain {foo} where foo does match
some variable known to the substituter?

			regards, tom lane



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

* Re: [DOCS] [BUGS] BUG #1414: DOC - pl/Perl hash tags missing
@ 2005-01-20 21:36  Magnus Hagander <[email protected]>
  0 siblings, 0 replies; 9+ messages in thread

From: Magnus Hagander @ 2005-01-20 21:36 UTC (permalink / raw)
  To: Alexey Borzov <[email protected]>; +Cc: Tom Lane <[email protected]>; Mike Blackwell <[email protected]>; pgsql-docs; [email protected]

>> Going out on a line a bit here - and someone who've worked with teh
>> system probably knows for sure but... It looks like {} is used as the
>> template placeholder in the templating system on the website.
>
>Yes, that's exactly the case...

Ahh, I'm not totally PHP illiterate,...


>> It would seem to me that the fix would be as simple as to set
>> $removeUnknownVariables to false when parsing the docs 
>template, but I'm
>> far from sure at that. And I have no way to test it. And it 
>might break
>> something else. End of disclaimers.
>
>The clean solution would be to use
>$tpl->setOption('preserve_data', true);
>
>In this case there will be no problems even if a known 
>placeholder appears in 
>the docs.

... though as expected, I don't know the template system ;-)


>Sorry, cannot fix it myself right now, don't want to checkout 
>the website code 
>as there is a sh*tload of PDF docs in there.

Um. There should be no problem checking out just a subdir, no? Just do
cvs -d :pserver:[email protected]:/usr/local/cvsroot/pgweb
co portal/system

or whatever dir it is you need (or a single file should work too). 
You don't want to use anoncvs if you're going to commit, of course. I
don't know which format CVSROOTs are used on gborg for authenticated
access.

//Magnus




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

* Re: [DOCS] [BUGS] BUG #1414: DOC - pl/Perl hash tags missing
@ 2005-01-20 21:51  Alvaro Herrera <[email protected]>
  parent: Tom Lane <[email protected]>
  0 siblings, 0 replies; 9+ messages in thread

From: Alvaro Herrera @ 2005-01-20 21:51 UTC (permalink / raw)
  To: Tom Lane <[email protected]>; +Cc: Magnus Hagander <[email protected]>; Mike Blackwell <[email protected]>; pgsql-docs; [email protected]

On Thu, Jan 20, 2005 at 04:23:16PM -0500, Tom Lane wrote:
> "Magnus Hagander" <[email protected]> writes:
> > Going out on a line a bit here - and someone who've worked with teh
> > system probably knows for sure but... It looks like {} is used as the
> > template placeholder in the templating system on the website.
> 
> > It would seem to me that the fix would be as simple as to set
> > $removeUnknownVariables to false when parsing the docs template, but I'm
> > far from sure at that. And I have no way to test it. And it might break
> > something else. End of disclaimers.
> 
> If the docs template is applying any substitution whatsoever to the
> documentation HTML files, it's broken.  I don't think the above fix
> is appropriate --- what if the docs contain {foo} where foo does match
> some variable known to the substituter?

Probably the solution is to use some sort of template escaping, like
{literal} in PHP's smarty.  Not sure what the site is using.

-- 
Alvaro Herrera (<alvherre[@]dcc.uchile.cl>)
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] 9+ messages in thread

* Re: BUG #1414: DOC - pl/Perl hash tags missing
@ 2005-01-22 23:01  Bruce Momjian <[email protected]>
  parent: Mike Blackwell <[email protected]>
  1 sibling, 1 reply; 9+ messages in thread

From: Bruce Momjian @ 2005-01-22 23:01 UTC (permalink / raw)
  To: Mike Blackwell <[email protected]>; +Cc: [email protected]

Mike Blackwell wrote:
> 
> The following bug has been logged online:
> 
> Bug reference:      1414
> Logged by:          Mike Blackwell
> Email address:      [email protected]
> PostgreSQL version: 8.0.0
> Operating system:   N/A
> Description:        DOC - pl/Perl hash tags missing
> Details: 
> 
> In the pl/Perl section of the 8.0.0 manual, as viewed on the postgresql.org
> web site, all perl code hash tags seem to be missing.  i.e. 

I have fixed this.  We now just need someone to rebuild the docs for
8.0.  The developers page will show the CVS version where this is fixed.

Thanks for the report.

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  [email protected]               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073



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

* Re: BUG #1414: DOC - pl/Perl hash tags missing
@ 2005-01-23 00:40  Tom Lane <[email protected]>
  parent: Bruce Momjian <[email protected]>
  0 siblings, 1 reply; 9+ messages in thread

From: Tom Lane @ 2005-01-23 00:40 UTC (permalink / raw)
  To: Bruce Momjian <[email protected]>; +Cc: Mike Blackwell <[email protected]>; [email protected]

Bruce Momjian <[email protected]> writes:
> Mike Blackwell wrote:
>> In the pl/Perl section of the 8.0.0 manual, as viewed on the postgresql.org
>> web site, all perl code hash tags seem to be missing.  i.e. 

> I have fixed this.  We now just need someone to rebuild the docs for
> 8.0.  The developers page will show the CVS version where this is fixed.

Didn't you read the rest of the thread?  The problem was incorrect
filtering of the docs by the webpage template, not anything wrong with
the SGML.

The > to &gt; changes you made are no doubt good for cleanliness' sake,
but they were not necessary and there is no urgent reason to rebuild
anything.

			regards, tom lane



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

* Re: BUG #1414: DOC - pl/Perl hash tags missing
@ 2005-01-23 00:41  Bruce Momjian <[email protected]>
  parent: Tom Lane <[email protected]>
  0 siblings, 0 replies; 9+ messages in thread

From: Bruce Momjian @ 2005-01-23 00:41 UTC (permalink / raw)
  To: Tom Lane <[email protected]>; +Cc: Mike Blackwell <[email protected]>; [email protected]

Tom Lane wrote:
> Bruce Momjian <[email protected]> writes:
> > Mike Blackwell wrote:
> >> In the pl/Perl section of the 8.0.0 manual, as viewed on the postgresql.org
> >> web site, all perl code hash tags seem to be missing.  i.e. 
> 
> > I have fixed this.  We now just need someone to rebuild the docs for
> > 8.0.  The developers page will show the CVS version where this is fixed.
> 
> Didn't you read the rest of the thread?  The problem was incorrect
> filtering of the docs by the webpage template, not anything wrong with
> the SGML.
> 
> The > to &gt; changes you made are no doubt good for cleanliness' sake,
> but they were not necessary and there is no urgent reason to rebuild
> anything.

OK.  Thanks.

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  [email protected]               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073




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


end of thread, other threads:[~2005-01-23 00:41 UTC | newest]

Thread overview: 9+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2005-01-19 17:25 BUG #1414: DOC - pl/Perl hash tags missing Mike Blackwell <[email protected]>
2005-01-20 20:47 ` Tom Lane <[email protected]>
2005-01-22 23:01 ` Bruce Momjian <[email protected]>
2005-01-23 00:40   ` Tom Lane <[email protected]>
2005-01-23 00:41     ` Bruce Momjian <[email protected]>
2005-01-20 21:11 Re: [DOCS] [BUGS] BUG #1414: DOC - pl/Perl hash tags missing Magnus Hagander <[email protected]>
2005-01-20 21:23 ` Tom Lane <[email protected]>
2005-01-20 21:51   ` Alvaro Herrera <[email protected]>
2005-01-20 21:36 Re: [DOCS] [BUGS] BUG #1414: DOC - pl/Perl hash tags missing Magnus Hagander <[email protected]>

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