> documentation enough.... what is everyone exactly looking for?!
I'm actually rather surprised you don't know what I'm looking for. You
must have learned from (a) book(s) originally and never sat down with
a copy of the core files and tried to figure it out from scratch.
If I were going to report it as a "bug" in their documentation, the
steps to reproduce the issue would be:
1) download the core files for FB3
2) open the fbx_circuits.cfm template
3) realize that there are no instructions
That template is required by the framework and it doesn't work "out of
the box", you _must_ put something in it, but from reading through the
core files, _what_ needs to go there is a mystery. I know (more or
less) what needs to go in that template : at least, I can make it work
from scratch. When you know what that is, it's not very complicated,
and I think the instructions wouldn't take more than about 10 minutes
or so to write, which is what I find surprising about it.
Oddly enough, that template actually has a fusedoc in it.
Unfortunately the fusedoc doesn't provide any useful information.
Actually even before getting to the fbx_circuits.cfm there's nothing
in the fb3 core files like a readme.txt, etc. to tell you the
fbx_circuits.cfm needs to be configured, so there's a bit of research
and/or trial and error to get even to that point.
Again -- I mean this as no disrespect to Hal and the rest of the folks
behind the framework. It's just an area of weakness, like we all have
in our work.
I have noticed that the folks behind Mach-II have done a good job of
providing readme's which explain the core files downloads. (Though
from the website it's not obvious what the difference is between the
core files and the application skeleton. I personally would have
included the application skeleton in a subdirectory of the core files,
but that's pretty much a style decision.)
Actually the doc's in the Mach-II downloads are a good comparison to
see what I think is missing from the FB3 download.
I certainly don't think there's a need to go to the extreme that the
onTap framework is taken for documentation, wherein, large amounts of
web-ready documentation have been bundled with the core files.
Actually the documentation is a sample application in its own right
and is designed to be extended by additional 3rd-party libraries,
"plug-ins" and other components.
s. isaac dealey 214-823-9345
team macromedia volunteer http://www.macromedia.com/go/team
chief architect, tapestry cms http://products.turnkey.to
onTap is open source http://www.turnkey.to/ontap
> _____
> From: Jim Davis [mailto:[EMAIL PROTECTED]
> Sent: Thursday, December 11, 2003 6:26 PM
> To: CF-Talk
> Subject: RE: fusebox
> That's been a problem for a lot of frameworks - and for
> FuseBox since the
> beginning: incredibly smart guys building incredibly cool
> tools who have a
> complete, innate inability to explain anything to anyone.
> ;^)
> Jim Davis
> _____
> From: S. Isaac Dealey [mailto:[EMAIL PROTECTED]
> Sent: Thursday, December 11, 2003 5:44 PM
> To: CF-Talk
> Subject: RE: fusebox
>> Hi,
>> I suppose the lack of documentation does tend to put
>> people off a bit, but I
>> don't fuss too much about buying the books. They are
>> worth
>> the small price
>> and the guys that bring us Fusebox can't do everything
>> for
>> free... people
>> have to eat ya know. I seem to remember everyone
>> recommending CFWACK as
>> "the" resource back in the day. :) The Techspedition
>> books
>> are pretty much
>> the same caliber of resource for Fusebox.
> Incidentaly, I hope my comments aren't seen as a
> disrespect to the
> guys who bring us the Fusebox framework. We all have areas
> where our
> work is either beautiful or in some way incomplete or
> problematic. I
> just feel like the documentation from fusebox.org at this
> point is a
> real weakness and that someone (who is really immaterial)
> should take
> the time to sit down and produce some basic "step 1) this
> is how to
> write an fbx_circuits.cfm" (or take it from another site
> that has a
> free tutorial) that will go in their core files download.
> I understand
> the info is likely available elsewhere for free also, i.e.
> techspedition, the forums, etc. but some basic info I
> think really
> needs to be "up-front" and right now that's missing from
> the core
> files. I haven't looked at FB4 yet, so I can't comment on
> documenation
> for the new version.
> Of course I always welcome criticism of my own
> documentation as well
> -- if you read through my blog, there've been several
> cases of my
> documentation for the onTap framework needing correction
> for one
> reason or another and I always try to get those cleared up
> ASAP when I
> find them or when someone points them out.
> s. isaac dealey 214-823-9345
> team macromedia volunteer
> http://www.macromedia.com/go/team
> chief architect, tapestry cms http://products.turnkey.to
> onTap is open source http://www.turnkey.to/ontap
> _____
> _____
>
[Todays Threads] [This Message] [Subscription] [Fast Unsubscribe] [User Settings]
