You are viewing a plain text version of this content. The canonical link for it is here.
Posted to docs-dev@perl.apache.org by Stas Bekman <st...@stason.org> on 2002/01/24 19:41:10 UTC
new functionality added
While you guys were working hard on the design of the new site I've
added a few more functions to the site/DocSet. I've just released
DocSet-0.09 here: http://apache.org/~stas/DocSet-0.09.tar.gz
I've also synced its version with the one distributed with modperl-docs
cvs rep.
Here is the new version of the site:
http://www.apache.org/~stas/modperl-site/index.html
New:
- a bunch of problems fixed (like, highlighted 'Documentation' on the
entrance page)
- added 'stitle' attribute that is used in menu and bread-crumb, in
addition to the normal long 'title' (templates adjusted) I've used it so
far only in src/config.cfg and src/stats/config.cfg. So the homepage
title problem is solved now.
- the docset descriptions are presented on the index pages now
- the pod files now can provide their descriptions for the index pages
automagically (via =head1 DESCRIPTION section), e.g. see:
http://www.apache.org/~stas/modperl-site/docs/2.0/api/index.html
- now every document has a PDF version (before that there were only
pdf's of the docsets), so now you can download a pdf of a single
document or the whole set as one doc.
- finally I've added a scan for PDF and SOURCE files, I'm gzipping them.
I haven't used any of the nice pdf widgets yet, just a crude text.
The downside is that now a gzipped version of the release, is 5.6MB!
I couldn't build it on perl.apache.org yet, since it doesn't have
ps2pdf, so I had to upload it from my machine to show you the demo.
- TOC is showing up now under every <hX> not only <h1>.
- using a more portable page modification timestamp e.g. is 01/03 Jan 3
or Mar 1?
- perfect the modification control, now only if at least one of the
items in the docset (chapters, files, docsets, config file) was
modified the docset will be rebuilt, otherwise it'll be skipped,
making the partial rebuild/updates much faster.
==> this should make the work with DocSet a much nicer experience
Also notice that docset supports hidden documents. e.g. we have:
http://www.apache.org/~stas/modperl-site/404.html
which is processed normally and once reached user can proceed like from
any normal page. But there is not a single page that links to 404.html,
as it's used for broken links. You can hide a complete tree and still
have it linking to the rest of the site.
and of course you can link to an existing objects that shouldn't be
processed, e.g. if you need to drop in a PDF doc, which you don't have a
POD/HTML source too.
Comments are welcome.
_____________________________________________________________________
Stas Bekman JAm_pH -- Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide http://perl.apache.org/guide
mailto:stas@stason.org http://ticketmaster.com http://apacheweek.com
http://singlesheaven.com http://perl.apache.org http://perlmonth.com/
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org
Re: new functionality added
Posted by Thomas Klausner <do...@zsi.at>.
Hi!
On Fri, Jan 25, 2002 at 03:09:20AM +0800, Stas Bekman wrote:
> BTW, did you try to grabbing any of the PDF files? (Look for [PDF] links
> under the Table of Contents section (not the fancy icons, didn't
> integrate these yet). Does it display the doc immediately, or do you
> have to save it first, ungzip and then view? I think I used to be able
> to click on pdf.gz link and get it immediately viewed, for some reason
> this doesn't work anymore. Anyone?
I got a download window with Mozilla (but I guess I just didn't configure
the MIME-Type), and Opera decompressed the file and opend it in the browser
(so I see the PDF source code, not the rendered version).
Then, I usually hate programs starting by themselves, so my system might not
be configured "correctly"
--
D_OMM +----> http://domm.zsi.at <-----+
O_xyderkes | neu: Arbeitsplatz |
M_echanen | http://domm.zsi.at/d/d162.html |
M_asteuei +--------------------------------+
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org
Re: new functionality added
Posted by Stas Bekman <st...@stason.org>.
Stas Bekman wrote:
> Philip Mak wrote:
>
>> On Fri, Jan 25, 2002 at 02:41:10AM +0800, Stas Bekman wrote:
>>
>>> Here is the new version of the site:
>>> http://www.apache.org/~stas/modperl-site/index.html
>>>
>>
>> One thing I noticed on this page:
>>
>> http://www.apache.org/~stas/modperl-site/stories/index.html
>>
>> The "Extraordinaire Technologie" menu option is clickable and just
>> leads back to the exact same page. I think that in this sort of case,
>> it should not be clickable in order to avoid confusion.
>
> Good catch, will be fixed.
I've first fixed it, but than reverted it back. I'm not sure which
solution is the best.
The thing is that the top level menu, provides the access to the first
sub level. So if you are deep down the 'documentation' tree clicking on
the menu's 'Documentation' button will bring you to the root of the
documentation. In addition to the breadcrumb. I think many people will
try clicking on this entry. What do you think?
The fix is very simply, but I'm not sure if we want this to be fixed.
_____________________________________________________________________
Stas Bekman JAm_pH -- Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide http://perl.apache.org/guide
mailto:stas@stason.org http://ticketmaster.com http://apacheweek.com
http://singlesheaven.com http://perl.apache.org http://perlmonth.com/
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org
Re: new functionality added
Posted by Stas Bekman <st...@stason.org>.
Philip Mak wrote:
> On Fri, Jan 25, 2002 at 11:40:21AM +0800, Stas Bekman wrote:
>
>>Philip Mak wrote:
>>
>>
>>>There was an error opening this document. File does not begin with
>>>'%PDF-'.
>>>
>>>I'm guessing that Acrobat Reader was called correctly, but it was
>>>given the .pdf.gz instead of the .pdf.
>>>
>>The same here. The browser is configured to open .pdf files in acroread
>>or xpdf, but it also strips .gz and supposed to uncompress it first.
>>Could be a problem of acroread, not being able to read stream.
>>
>>BTW, can you please try this one:
>>http://perl.apache.org/guide/#download
>>Does it behave the same? At least it does for me.
>>
>
> Ouch, that took a few minutes to download... (I'm on a modem)
oops, sorry about that.
> Yes, I have the same problem. "There was an error opening this
> document. File does not begin with '%PDF-'."
So it's OK, it downloads the file, calls the pdf reader but doesn't
uncompress it. If you save the file, and ungzip it it's fine.
Thanks Philip!
_____________________________________________________________________
Stas Bekman JAm_pH -- Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide http://perl.apache.org/guide
mailto:stas@stason.org http://ticketmaster.com http://apacheweek.com
http://singlesheaven.com http://perl.apache.org http://perlmonth.com/
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org
Re: new functionality added
Posted by Philip Mak <pm...@animeglobe.com>.
On Fri, Jan 25, 2002 at 11:40:21AM +0800, Stas Bekman wrote:
> Philip Mak wrote:
>
> >There was an error opening this document. File does not begin with
> >'%PDF-'.
> >
> >I'm guessing that Acrobat Reader was called correctly, but it was
> >given the .pdf.gz instead of the .pdf.
>
> The same here. The browser is configured to open .pdf files in acroread
> or xpdf, but it also strips .gz and supposed to uncompress it first.
> Could be a problem of acroread, not being able to read stream.
>
> BTW, can you please try this one:
> http://perl.apache.org/guide/#download
> Does it behave the same? At least it does for me.
Ouch, that took a few minutes to download... (I'm on a modem)
Yes, I have the same problem. "There was an error opening this
document. File does not begin with '%PDF-'."
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org
Re: new functionality added
Posted by Stas Bekman <st...@stason.org>.
Philip Mak wrote:
> On Fri, Jan 25, 2002 at 03:09:20AM +0800, Stas Bekman wrote:
>
>>BTW, did you try to grabbing any of the PDF files? (Look for [PDF] links
>> under the Table of Contents section (not the fancy icons, didn't
>>integrate these yet). Does it display the doc immediately, or do you
>>have to save it first, ungzip and then view? I think I used to be able
>>to click on pdf.gz link and get it immediately viewed, for some reason
>>this doesn't work anymore. Anyone?
>>
>
> I just tried the PDF link from
> http://www.apache.org/~stas/modperl-site/index.html in Opera 6.0 under
> Windows 98. Acrobat Reader opens up automatically, but then it says:
>
> There was an error opening this document. File does not begin with
> '%PDF-'.
>
> I'm guessing that Acrobat Reader was called correctly, but it was
> given the .pdf.gz instead of the .pdf.
The same here. The browser is configured to open .pdf files in acroread
or xpdf, but it also strips .gz and supposed to uncompress it first.
Could be a problem of acroread, not being able to read stream.
BTW, can you please try this one:
http://perl.apache.org/guide/#download
Does it behave the same? At least it does for me.
_____________________________________________________________________
Stas Bekman JAm_pH -- Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide http://perl.apache.org/guide
mailto:stas@stason.org http://ticketmaster.com http://apacheweek.com
http://singlesheaven.com http://perl.apache.org http://perlmonth.com/
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org
Re: new functionality added
Posted by Philip Mak <pm...@animeglobe.com>.
On Fri, Jan 25, 2002 at 03:09:20AM +0800, Stas Bekman wrote:
> BTW, did you try to grabbing any of the PDF files? (Look for [PDF] links
> under the Table of Contents section (not the fancy icons, didn't
> integrate these yet). Does it display the doc immediately, or do you
> have to save it first, ungzip and then view? I think I used to be able
> to click on pdf.gz link and get it immediately viewed, for some reason
> this doesn't work anymore. Anyone?
I just tried the PDF link from
http://www.apache.org/~stas/modperl-site/index.html in Opera 6.0 under
Windows 98. Acrobat Reader opens up automatically, but then it says:
There was an error opening this document. File does not begin with
'%PDF-'.
I'm guessing that Acrobat Reader was called correctly, but it was
given the .pdf.gz instead of the .pdf.
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org
Re: new functionality added
Posted by Stas Bekman <st...@stason.org>.
Philip Mak wrote:
> On Fri, Jan 25, 2002 at 02:41:10AM +0800, Stas Bekman wrote:
>
>>Here is the new version of the site:
>>http://www.apache.org/~stas/modperl-site/index.html
>>
>
> One thing I noticed on this page:
>
> http://www.apache.org/~stas/modperl-site/stories/index.html
>
> The "Extraordinaire Technologie" menu option is clickable and just
> leads back to the exact same page. I think that in this sort of case,
> it should not be clickable in order to avoid confusion.
Good catch, will be fixed.
> On my sites (using Apache::ASP), I do <my:a href> instead of <a href>,
> where &my::a is a function that checks whether the href attribute is
> linking to the same URL as the current page; if it is, then it doesn't
> print the <a href> tag.
>
> Also on that page, the part that says "By Lincoln Stein, Doug
> MacEachern" (under the "Writing Apache Modules with Perl and C")
> overflows the white area. See attached screenshot. This is in Opera
> 6.0 under Windows 98.
Ouch, shouldn't it wrap the text??? Dear design gurus, what's wrong with
this particular bug?
Thanks Philip.
BTW, did you try to grabbing any of the PDF files? (Look for [PDF] links
under the Table of Contents section (not the fancy icons, didn't
integrate these yet). Does it display the doc immediately, or do you
have to save it first, ungzip and then view? I think I used to be able
to click on pdf.gz link and get it immediately viewed, for some reason
this doesn't work anymore. Anyone?
_____________________________________________________________________
Stas Bekman JAm_pH -- Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide http://perl.apache.org/guide
mailto:stas@stason.org http://ticketmaster.com http://apacheweek.com
http://singlesheaven.com http://perl.apache.org http://perlmonth.com/
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org
Re: new functionality added
Posted by Philip Mak <pm...@animeglobe.com>.
On Fri, Jan 25, 2002 at 02:41:10AM +0800, Stas Bekman wrote:
> Here is the new version of the site:
> http://www.apache.org/~stas/modperl-site/index.html
One thing I noticed on this page:
http://www.apache.org/~stas/modperl-site/stories/index.html
The "Extraordinaire Technologie" menu option is clickable and just
leads back to the exact same page. I think that in this sort of case,
it should not be clickable in order to avoid confusion.
On my sites (using Apache::ASP), I do <my:a href> instead of <a href>,
where &my::a is a function that checks whether the href attribute is
linking to the same URL as the current page; if it is, then it doesn't
print the <a href> tag.
Also on that page, the part that says "By Lincoln Stein, Doug
MacEachern" (under the "Writing Apache Modules with Perl and C")
overflows the white area. See attached screenshot. This is in Opera
6.0 under Windows 98.
Re: new functionality added
Posted by allan <la...@inet.uni2.dk>.
> Here is the new version of the site:
> http://www.apache.org/~stas/modperl-site/index.html
>
> New:
>
> - a bunch of problems fixed (like, highlighted 'Documentation' on the
> entrance page)
+1
> - added 'stitle' attribute that is used in menu and bread-crumb, in
> addition to the normal long 'title' (templates adjusted) I've used it so
> far only in src/config.cfg and src/stats/config.cfg. So the homepage
> title problem is solved now.
+1
> - the docset descriptions are presented on the index pages now
+1
> - the pod files now can provide their descriptions for the index pages
> automagically (via =head1 DESCRIPTION section), e.g. see:
> http://www.apache.org/~stas/modperl-site/docs/2.0/api/index.html
+1
> - now every document has a PDF version (before that there were only
> pdf's of the docsets), so now you can download a pdf of a single
> document or the whole set as one doc.
+1
> - TOC is showing up now under every <hX> not only <h1>.
> - using a more portable page modification timestamp e.g. is 01/03 Jan 3
> or Mar 1?
+1
,/allan
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org
Re: new functionality added
Posted by Stas Bekman <st...@stason.org>.
Thomas Klausner wrote:
>>- now every document has a PDF version (before that there were only
>>pdf's of the docsets), so now you can download a pdf of a single
>>document or the whole set as one doc.
>>
> +1
>
> I was allready wondering how to get a PDF of the whole guide...
As I replied to Thomas enquiry you need to run bin/build -df (-f added)
to get the pdf rendered. pdfs rendering is a very slow operation, so by
default we don't want it, and use it only for production.
>>Also notice that docset supports hidden documents. e.g. we have:
>>
> Great, so we can add a "How this site is done" page without it showing up in
> the main NavBar
yup :) and we can link to it from the tail widget.
>>Comments are welcome.
>>
> No Problems installing and building the new version.
> Only one thing: There are no tests ... At the last YAOC::Europe, Michael G.
> Schwern gave a rather amusing and convincing talk to actually /use/ them.
> But - as everybody knows, but denies to confess - writing tests sort of
> sucks.
I don't deny it, I write lots of tests where I can, e.g. see the work on
mod_perl 2.0 and the huge guide on how to write tests :)
http://www.apache.org/~stas/modperl-site/docs/2.0/devel/testing/testing.html
And I've been to Schwern's talk at the last OSC.
But, for this kind of app (DocSet) it's very hard to write tests since
it's not a set of functions but a whole engine that generates something
in the end. If any of you are willing to help me with this it'd be
fantastic. So far the only test I have is running the DocSet on the
example directory in the DocSet distro.
I guess what you could do is to generate a sample and compare it against
a known correctly rendered output. Similar to what template toolkit
tests do, but on the big scale.
_____________________________________________________________________
Stas Bekman JAm_pH -- Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide http://perl.apache.org/guide
mailto:stas@stason.org http://ticketmaster.com http://apacheweek.com
http://singlesheaven.com http://perl.apache.org http://perlmonth.com/
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org
Re: new functionality added
Posted by Thomas Klausner <do...@zsi.at>.
Hi!
On Fri, Jan 25, 2002 at 02:41:10AM +0800, Stas Bekman wrote:
> - the docset descriptions are presented on the index pages now
+1
> - now every document has a PDF version (before that there were only
> pdf's of the docsets), so now you can download a pdf of a single
> document or the whole set as one doc.
+1
I was allready wondering how to get a PDF of the whole guide...
> Also notice that docset supports hidden documents. e.g. we have:
Great, so we can add a "How this site is done" page without it showing up in
the main NavBar
> Comments are welcome.
No Problems installing and building the new version.
Only one thing: There are no tests ... At the last YAOC::Europe, Michael G.
Schwern gave a rather amusing and convincing talk to actually /use/ them.
But - as everybody knows, but denies to confess - writing tests sort of
sucks.
--
D_OMM +----> http://domm.zsi.at <-----+
O_xyderkes | neu: Arbeitsplatz |
M_echanen | http://domm.zsi.at/d/d162.html |
M_asteuei +--------------------------------+
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org
Re: new functionality added
Posted by Thomas Klausner <do...@zsi.at>.
Hi!
On Fri, Jan 25, 2002 at 03:22:37AM +0800, Stas Bekman wrote:
> Also I've used smaller images for the book ads, to make the ads stand
> out less.
+1
--
D_OMM +----> http://domm.zsi.at <-----+
O_xyderkes | neu: Arbeitsplatz |
M_echanen | http://domm.zsi.at/d/d162.html |
M_asteuei +--------------------------------+
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org
Re: new functionality added
Posted by Stas Bekman <st...@stason.org>.
Also I've used smaller images for the book ads, to make the ads stand
out less.
--
_____________________________________________________________________
Stas Bekman JAm_pH -- Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide http://perl.apache.org/guide
mailto:stas@stason.org http://ticketmaster.com http://apacheweek.com
http://singlesheaven.com http://perl.apache.org http://perlmonth.com/
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org