Frames Free API Doc

I don't know about everyone else, but frames in web pages
mess with my
head.

 

Is there a version of the API documentation floating around
that doesn't
use frames?

Can I build one from source? If so, how?

 

Thanks,

-jason

 

Jason Brackins | Web UI Developer 

jason.brackinsredfin.com <mailto:jason.brackinsredfin.com>  

 

You betcha. Just use perldoc. Browse into
/path/to/bricolage/lib and
find the module you're interested in, and then just do
something like
this, for example:

$ perldoc Bric/Biz/Asset/Business/Story.pm 

Personally, perldoc messes with my head more than frames
ever could, and
I lovelovelove the web version at bricolage.cc. But that's
just me.

Hope this helps,

Bret


On Tue, 2008-02-26 at 16:40 -0800, Jason Brackins wrote:
> I don't know about everyone else, but frames in web
pages mess with my
> head.
> 
>  
> 
> Is there a version of the API documentation floating
around that doesn't
> use frames?
> 
> Can I build one from source? If so, how?
> 
>  
> 
> Thanks,
> 
> -jason
> 
>  
> 
> Jason Brackins | Web UI Developer 
> 
> jason.brackinsredfin.com <mailto:jason.brackinsredfin.com>  
> 
>  
> 
-- 
Bret Dawson
Producer
Pectopah Productions Inc.
(416) 895-7635
bretpectopah.com
www.pectopah.com

That helps some. 

But the web version at bricolage.cc/docs/current/api looks
like it was
generated too. With some sort of pod2html tool or something.
(Could it
be http://perldoc
.perl.org/pod2html.html?) 

What I would _really_ like is to run that tool with a
--no-frames option
(or how ever it works). I'd put the output in the htdocs on
my laptop
and have easy browsing docs wherever I go. 

Thanks,
-jason

-----Original Message-----
From: Bret Dawson [mailto:bretpectopah.com] 
Sent: Tuesday, February 26, 2008 4:59 PM
To: userslists.bricolage.cc
Subject: Re: Frames Free API Doc

You betcha. Just use perldoc. Browse into
/path/to/bricolage/lib and
find the module you're interested in, and then just do
something like
this, for example:

$ perldoc Bric/Biz/Asset/Business/Story.pm 

Personally, perldoc messes with my head more than frames
ever could, and
I lovelovelove the web version at bricolage.cc. But that's
just me.

Hope this helps,

Bret


On Tue, 2008-02-26 at 16:40 -0800, Jason Brackins wrote:
> I don't know about everyone else, but frames in web
pages mess with my
> head.
> 
>  
> 
> Is there a version of the API documentation floating
around that
doesn't
> use frames?
> 
> Can I build one from source? If so, how?
> 
>  
> 
> Thanks,
> 
> -jason
> 
>  
> 
> Jason Brackins | Web UI Developer 
> 
> jason.brackinsredfin.com <mailto:jason.brackinsredfin.com>  
> 
>  
> 
-- 
Bret Dawson
Producer
Pectopah Productions Inc.
(416) 895-7635
bretpectopah.com
www.pectopah.com

On Tue, 26 Feb 2008, Jason Brackins wrote:
> But the web version at bricolage.cc/docs/current/api
looks like it was
> generated too. With some sort of pod2html tool or
something. (Could it
> be http://perldoc
.perl.org/pod2html.html?)

David made a script called `pod_browser` that generates it.
That is PodBrowser at this SVN repository:
https://svn.
bricolage.cc/distutils/trunk
(specifically
https://svn.bricolage.cc/distutils/trunk/PodB
rowser/bin/pod_browser
)
See also this thread from September:
http://marc.info/?l=bricolage-devel&m=11888
8254209275&w=2


> What I would _really_ like is to run that tool with a
--no-frames option
> (or how ever it works). I'd put the output in the
htdocs on my laptop
> and have easy browsing docs wherever I go.

Good luck.