List Info

Thread: Links from reference guide to api




Links from reference guide to api
user name
2008-01-19 16:38:48
Hi,
I think it would be usefull to have links from the different
sections of the
online reference guide to the corresponding sections of the
api
documentation. What do you think?

Jacob
-- 
View this message in context: http://www.nabble.com/Link
s-from-reference-guide-to-api-tp14976119s16154p14976119.html

Sent from the Zend Doc mailing list archive at Nabble.com.


RE: Links from reference guide to api
user name
2008-01-19 17:41:05
I think it's a good idea. This might make for a good section
in the
introduction of each component and possibly referrals where
it makes
sense inline in the documentation. We should consider the
implications
to documentation maintenance when we refer to docs outside
the reference
guide, but I can't think of anything that looks like a real
showstopper
in this case.
Shall I infer that you're volunteering to do this as well?
:P

,Wil

> -----Original Message-----
> From: oetting [mailto:jacoboettinger.dk]
> Sent: Saturday, January 19, 2008 2:39 PM
> To: fw-docslists.zend.com
> Subject: Links from reference guide to api
> 
> 
> Hi,
> I think it would be usefull to have links from the
different sections
> of the
> online reference guide to the corresponding sections of
the api
> documentation. What do you think?
> 
> Jacob
> --
> View this message in context: http://www.nabble.c
om/Links-from-
> reference-guide-to-api-tp14976119s16154p14976119.html
> Sent from the Zend Doc mailing list archive at
Nabble.com.


RE: Links from reference guide to api
user name
2008-01-19 17:53:34
Yes I would like to help with this. It would be great if the
process could be
automated in some way or at least be made in such a way that
if the api
documentation moves the links can be easily updated. This
would help
mitigate the maintenance concerns.

How is the docbook sources turned into what is available at
http://framework
.zend.com/manual/en/ ?



wllm wrote:
> 
> I think it's a good idea. This might make for a good
section in the
> introduction of each component and possibly referrals
where it makes
> sense inline in the documentation. We should consider
the implications
> to documentation maintenance when we refer to docs
outside the reference
> guide, but I can't think of anything that looks like a
real showstopper
> in this case.
> Shall I infer that you're volunteering to do this as
well? :P
> 
> ,Wil
> 
>> -----Original Message-----
>> From: oetting [mailto:jacoboettinger.dk]
>> Sent: Saturday, January 19, 2008 2:39 PM
>> To: fw-docslists.zend.com
>> Subject: Links from reference guide to api
>> 
>> 
>> Hi,
>> I think it would be usefull to have links from the
different sections
>> of the
>> online reference guide to the corresponding
sections of the api
>> documentation. What do you think?
>> 
>> Jacob
>> --
>> View this message in context: http://www.nabble.c
om/Links-from-
>>
reference-guide-to-api-tp14976119s16154p14976119.html
>> Sent from the Zend Doc mailing list archive at
Nabble.com.
> 
> 
> 

-- 
View this message in context: http://www.nabble.com/Link
s-from-reference-guide-to-api-tp14976119s16154p14976745.html

Sent from the Zend Doc mailing list archive at Nabble.com.


[1-3]

about | contact  Other archives ( Real Estate discussion Medical topics )