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 2001/12/28 04:51:50 UTC

a new local download widget next to TOC

I think I need a new widget that ideally should go to the right top 
corner next to the toc. Something like that.

----------------------------------
table of contents  | PDF (100KB) |
...                | SRC (20KB)  |
   ...              ---------------
   ...
...
   ...
----------------------------------

This is an *optional* box that will appear on documentation pages with a 
link to the doc's PDF, source .pod and may be other things as well. call 
it 'local download'.

I think that's the best place to put it.

Issues:
  - not sure whether to use some small icons to indicate PDF/SRC/etc, 
but I do want to specify the file size. So suggestions are welcome.
  - if you agree with me that this is the right location, I think we 
have no choice but use a table here.

alternatively this can be yet another bar, but I think it'd be a waste 
of space and not very consistent since not all pages will have this bar.

What do you think?

_____________________________________________________________________
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: a new local download widget next to TOC

Posted by Stas Bekman <st...@stason.org>.
Thomas Klausner wrote:

> Hi!
> 
> On Fri, Dec 28, 2001 at 11:37:56AM -0000, Jonathan M. Hollin wrote:
> 
>>::   - not sure whether to use some small icons to indicate 
>>:: PDF/SRC/etc, 
>>:: but I do want to specify the file size. So suggestions are welcome.
>>
> I'd go for small Icons (PNG) plus file size


PNG? What about browsers that don't support PNG or crash when they see 
one? Netscape 4 comes to mind. (not sure which versions)


>>::   - if you agree with me that this is the right location, I think we 
>>:: have no choice but use a table here.
>>
> There are uses for tables, after all :->
> 
> Have you allready done some DocSet-thing to make this widget? If I got it
> right, then this widget should only be displayed if the src is a POD file?
> How can you detect this with DocSet/TT ?


It's going to happen in two passes, first generate HTMLs than PDFs than 
scan HTML pages for <!-- PDF link --> and see if there is a 
corresponding PDF file. If there is this <!-- --> gets replaced with a 
link to a file and its size, if not it just gets removed. So for now. 
Just put into a template a hardcoded widget with a link to whatever and 
whichever size. Once the widget looks the way we want we <!-- --> it. 
WHen the feature is implmented this will just start working.


> BTW, maybe we could use some sort of filename/path checking to relace the
> title on the first page ("Home") with something more meaningful ("welcome to
> mod_perl"..). The hack I tried (replacing "Home" with something else in all
> files) did't really work out, because obviously "Home" is used in some other
> documents...

I think this can be solved on the source level. In the config files, we 
simply provide two titles. One normal title for a page display and 
another shorter/different version for navigation bar.

But I've heard many people didn't like 'Welcome to mod_perl' as a title 
for the front page. Should it be 'Welcome to World Domination HQ'? :)


_____________________________________________________________________
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: a new local download widget next to TOC

Posted by Thomas Klausner <do...@zsi.at>.
Hi!

On Fri, Dec 28, 2001 at 11:37:56AM -0000, Jonathan M. Hollin wrote:
> ::   - not sure whether to use some small icons to indicate 
> :: PDF/SRC/etc, 
> :: but I do want to specify the file size. So suggestions are welcome.
I'd go for small Icons (PNG) plus file size

> ::   - if you agree with me that this is the right location, I think we 
> :: have no choice but use a table here.
There are uses for tables, after all :->

Have you allready done some DocSet-thing to make this widget? If I got it
right, then this widget should only be displayed if the src is a POD file?
How can you detect this with DocSet/TT ?
BTW, maybe we could use some sort of filename/path checking to relace the
title on the first page ("Home") with something more meaningful ("welcome to
mod_perl"..). The hack I tried (replacing "Home" with something else in all
files) did't really work out, because obviously "Home" is used in some other
documents...

-- 
 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: a new local download widget next to TOC

Posted by Stas Bekman <st...@stason.org>.
Jonathan M. Hollin wrote:

> :: I think I need a new widget that ideally should go to the right top 
> :: corner next to the toc. Something like that.
> :: 
> :: ----------------------------------
> :: table of contents  | PDF (100KB) |
> :: ...                | SRC (20KB)  |
> ::    ...              ---------------
> ::    ...
> :: ...
> ::    ...
> :: ----------------------------------
> :: 
> :: This is an *optional* box that will appear on documentation 
> :: pages with a 
> :: link to the doc's PDF, source .pod and may be other things 
> :: as well. call 
> :: it 'local download'.
> :: 
> :: I think that's the best place to put it.
> :: 
> :: Issues:
> ::   - not sure whether to use some small icons to indicate 
> :: PDF/SRC/etc, 
> :: but I do want to specify the file size. So suggestions are welcome.
> ::   - if you agree with me that this is the right location, I think we 
> :: have no choice but use a table here.
> 
> +1  This is a great idea.  I'd go with icons, no text whatsoever, put
> the file size in the "alt" tag so that it'll pop up on mouse-over...  I
> have attached a couple of example icons.

They are probably a little bit too small, but I guess it doesn't matter 
for now. (Once we see them in the context it'll be easier to tell).

Also I don't think we should use .gif, I know .pngs aren't supported by 
older browsers, but we should stay away from copyright issues, aren't 
we? If we can.


_____________________________________________________________________
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: a new local download widget next to TOC

Posted by Philip Mak <pm...@animeglobe.com>.
On Fri, 28 Dec 2001, Jonathan M. Hollin wrote:

> +1  This is a great idea.  I'd go with icons, no text whatsoever, put
> the file size in the "alt" tag so that it'll pop up on mouse-over...  I
> have attached a couple of example icons.

Note: Not all browsers display ALT tags. Strictly speaking, the ALT tag is
for use when the image cannot be displayed. For example, in Opera's case,
the ALT tag is only displayed if images are off. However, you can make
mouseover text in Opera by setting the TITLE attribute of the <A> tag.
IE 5 also displays <A TITLE>, although older browsers do not.


---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org


RE: a new local download widget next to TOC

Posted by "Jonathan M. Hollin" <ne...@digital-word.com>.
:: I think I need a new widget that ideally should go to the right top 
:: corner next to the toc. Something like that.
:: 
:: ----------------------------------
:: table of contents  | PDF (100KB) |
:: ...                | SRC (20KB)  |
::    ...              ---------------
::    ...
:: ...
::    ...
:: ----------------------------------
:: 
:: This is an *optional* box that will appear on documentation 
:: pages with a 
:: link to the doc's PDF, source .pod and may be other things 
:: as well. call 
:: it 'local download'.
:: 
:: I think that's the best place to put it.
:: 
:: Issues:
::   - not sure whether to use some small icons to indicate 
:: PDF/SRC/etc, 
:: but I do want to specify the file size. So suggestions are welcome.
::   - if you agree with me that this is the right location, I think we 
:: have no choice but use a table here.

+1  This is a great idea.  I'd go with icons, no text whatsoever, put
the file size in the "alt" tag so that it'll pop up on mouse-over...  I
have attached a couple of example icons.

:: alternatively this can be yet another bar, but I think it'd 
:: be a waste 
:: of space and not very consistent since not all pages will 
:: have this bar.

+1  No more bars.

Jonathan M. Hollin - WYPUG Co-ordinator
West Yorkshire Perl User Group
http://wypug.pm.org/