perl-docs-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Stas Bekman <s...@stason.org>
Subject Re: Link problems
Date Wed, 03 Apr 2002 02:24:17 GMT
Per Einar Ellefsen wrote:

>>> But I don't think we should wait for it being acknowledged though. I 
>>> feel that many Pod parsers are somewhat broken, and don't all seem to 
>>> be following the spec. If we need a feature, it won't hurt anyone to 
>>> include it. Of course, the best would be to have it in the spec, but 
>>> right now I'm more worried about what we can do with our site versus 
>>> what would be the right thing.
>>
>>
>> It's not that bad right now, it's just that the real link is displayed 
>> as a title,
>> so it's not nice. It's more or less working.
> 
> 
> I don't understand what you mean...Using URLs inside L<> clearly doesn't 
> work, we get the linked item in italics and that's it.. As for relative 
> links (which aren't auto-detected by the parser) it's even worse.

I didn't mean using L<> for URIs, you simply say: http://foo.com/bar and 
it gets linked. Of course this doesn't work for relative links.

>> The thing is that the documentation is distributed with the sources too.
>> Try to check out modperl-2.0 and you will see that modperl-2.0/docs is 
>> the same as modperl-docs/src/docs/2.0. So people will try to read the 
>> pod files with perldoc and pod2man, and using extended pod will cause 
>> problems.
>>
>> The distribution in the source was made to avoid the duplication and 
>> having
>> all the docs in one place.
>> Again this is not a showstopper, we can try to push for a new markup 
>> for perlpodspec, not sure if we will be lucky to push it into 5.8 
>> before it goes live. (of course I realize that it still won't work for 
>> older perls)
> 
> 
> I understand. We should try to keep new features out of documentation 
> that is distributed elsewhere (that means keeping it out of the 2.0 
> user's guide for a while), but that we could use it in the general site 
> pages (which includes the guide which will unlikely reside on user 
> computers and even less likely reside there in source form).

we cannot. the 2.0 documentation is about to take over the 1.0 
documentation,
most likely that you will need these features in 2.0 docs too.


__________________________________________________________________
Stas Bekman            JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/     mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org   http://ticketmaster.com


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


Mime
View raw message