Re: Creating documentation
Yes, your right. Although I am the only one on the team. I constantly find myself having to study up on a portion of code I wrote years, or actually even just months ago, because I can't remember what the heck I was thinking. I also find that creating documentation forces me to think through stuff a little better. Also, if something were to happen to me, I would like a resource that my business could turn to that would help keep tings going. But, this is mainly for internal purposes. I guess I should also consider documentation for users, but right now I am more interested in documentation for my own reference. On Sat, Feb 6, 2010 at 5:35 PM, Mike Chabot mcha...@gmail.com wrote: It sounds like you are considering documentation targeted at other programmers on the project team. Is this correct? Identifying the target audience helps determine the programs to use. -Mike Chabot On Sat, Feb 6, 2010 at 6:38 PM, David Mineer min...@gmail.com wrote: I want to be better about creating documentation for the coldfusion apps that I write. I wonder what you all are using? Today I have been searching for options. Two options that I have looked at are google sites and trac. I have been using svn for years for source code control through csvdude and it comes with trac. We also have google sites, which I like, but it is so basic and difficult to use. Trac isn't bad, but I would just like to hear what everyone uses to create documentation. Thanks, -- David Mineer Jr - The critical ingredient is getting off your butt and doing something. It's as simple as that. A lot of people have ideas, but there are few who decide to do something about them now. Not tomorrow. Not next week. But today. The true entrepreneur is a doer. ~| Want to reach the ColdFusion community with something they want? Let them know on the House of Fusion mailing lists Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:330460 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
Creating documentation
I want to be better about creating documentation for the coldfusion apps that I write. I wonder what you all are using? Today I have been searching for options. Two options that I have looked at are google sites and trac. I have been using svn for years for source code control through csvdude and it comes with trac. We also have google sites, which I like, but it is so basic and difficult to use. Trac isn't bad, but I would just like to hear what everyone uses to create documentation. Thanks, -- David Mineer Jr - The critical ingredient is getting off your butt and doing something. It's as simple as that. A lot of people have ideas, but there are few who decide to do something about them now. Not tomorrow. Not next week. But today. The true entrepreneur is a doer. ~| Want to reach the ColdFusion community with something they want? Let them know on the House of Fusion mailing lists Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:330452 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4
Re: Creating documentation
It sounds like you are considering documentation targeted at other programmers on the project team. Is this correct? Identifying the target audience helps determine the programs to use. -Mike Chabot On Sat, Feb 6, 2010 at 6:38 PM, David Mineer min...@gmail.com wrote: I want to be better about creating documentation for the coldfusion apps that I write. I wonder what you all are using? Today I have been searching for options. Two options that I have looked at are google sites and trac. I have been using svn for years for source code control through csvdude and it comes with trac. We also have google sites, which I like, but it is so basic and difficult to use. Trac isn't bad, but I would just like to hear what everyone uses to create documentation. Thanks, -- David Mineer Jr - The critical ingredient is getting off your butt and doing something. It's as simple as that. A lot of people have ideas, but there are few who decide to do something about them now. Not tomorrow. Not next week. But today. The true entrepreneur is a doer. ~| Want to reach the ColdFusion community with something they want? Let them know on the House of Fusion mailing lists Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:330453 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
Re: Creating documentation
I am a big fan of tiddlywiki. It is a single page JS app that you can distribute with your source code that basically runs as a desktop app. Very slick. http://www.tiddlywiki.com/ HTH G! On Sat, Feb 6, 2010 at 6:38 PM, David Mineer min...@gmail.com wrote: I want to be better about creating documentation for the coldfusion apps that I write. I wonder what you all are using? Today I have been searching for options. Two options that I have looked at are google sites and trac. I have been using svn for years for source code control through csvdude and it comes with trac. We also have google sites, which I like, but it is so basic and difficult to use. Trac isn't bad, but I would just like to hear what everyone uses to create documentation. Thanks, -- David Mineer Jr - The critical ingredient is getting off your butt and doing something. It's as simple as that. A lot of people have ideas, but there are few who decide to do something about them now. Not tomorrow. Not next week. But today. The true entrepreneur is a doer. ~| Want to reach the ColdFusion community with something they want? Let them know on the House of Fusion mailing lists Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:330456 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
Re: Generating Documentation CF9
I was testing the tool with a second application structure I have. Hence the /org ~| Want to reach the ColdFusion community with something they want? Let them know on the House of Fusion mailing lists Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:327816 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
Re: Generating Documentation CF9
Well it looks fine, are you sure the expandPath() is resolving to the right place? Mark On Fri, Oct 30, 2009 at 7:52 AM, Jeremy Rottman rottm...@gmail.com wrote: I was testing the tool with a second application structure I have. Hence the /org ~| Want to reach the ColdFusion community with something they want? Let them know on the House of Fusion mailing lists Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:327825 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4
Re: Generating Documentation CF9
I just ran the CS2.0 ColdDoc script i have on CF9. Worked no problems. Mark On Fri, Oct 30, 2009 at 9:32 AM, Mark Mandel mark.man...@gmail.com wrote: Well it looks fine, are you sure the expandPath() is resolving to the right place? Mark On Fri, Oct 30, 2009 at 7:52 AM, Jeremy Rottman rottm...@gmail.comwrote: I was testing the tool with a second application structure I have. Hence the /org ~| Want to reach the ColdFusion community with something they want? Let them know on the House of Fusion mailing lists Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:327826 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
Re: Generating Documentation CF9
I have to have something setup wrong then. When I use the run.cfm below, it generates the documents, but they do not contain any of the information about the cfc's I have written. Here is my run.cfm cfscript colddoc = createObject(component, ColdDoc).init(); base = expandPath(/org); docs = expandPath(docs); colddoc.generate(base, docs, , Media Review .63); /cfscript h1Done!/h1 p a href=/docs/index.htmlView Docs/a /p ~| Want to reach the ColdFusion community with something they want? Let them know on the House of Fusion mailing lists Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:327798 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
Re: Generating Documentation CF9
Well since you told me that your folder structure starts with /com, and you are expandPath()'ing on /org... I'm not surprised ;o) Mark On Thu, Oct 29, 2009 at 3:43 AM, Jeremy Rottman rottm...@gmail.com wrote: I have to have something setup wrong then. When I use the run.cfm below, it generates the documents, but they do not contain any of the information about the cfc's I have written. Here is my run.cfm cfscript colddoc = createObject(component, ColdDoc).init(); base = expandPath(/org); docs = expandPath(docs); colddoc.generate(base, docs, , Media Review .63); /cfscript h1Done!/h1 p a href=/docs/index.htmlView Docs/a /p ~| Want to reach the ColdFusion community with something they want? Let them know on the House of Fusion mailing lists Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:327803 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
Generating Documentation CF9
I have quite a few new cfc's that I have written in cf9's new script style. Prior to publishing code, I used to generate documentation with cfdocs revamped. Since this application is no longer supported I am on the hunt for a new Javadocs style generator that will create my api documentation based on the cfc's and interfaces I provide it. Anyone know if there is a tool out there yet that can parse the new script style cfc's? ~| Want to reach the ColdFusion community with something they want? Let them know on the House of Fusion mailing lists Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:327769 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
Re: Generating Documentation CF9
Javadocs after the first patch? http://www.danvega.org/blog/index.cfm/2009/8/24/ColdFusion-9-setting-attributes-in-cfscript-using-javadoc-syntax ~| Want to reach the ColdFusion community with something they want? Let them know on the House of Fusion mailing lists Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:327775 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4
Re: Generating Documentation CF9
Try ColdDoc, it works with CF9, although you will have to grab the SVN version (I've been really slack about releasing a new version). If works off MetaData, so it doesn't matter *how* you write your CFCs. http://colddoc.riaforge.org/ Mark On Wed, Oct 28, 2009 at 8:23 AM, Tony Bentley t...@tonybentley.com wrote: Javadocs after the first patch? http://www.danvega.org/blog/index.cfm/2009/8/24/ColdFusion-9-setting-attributes-in-cfscript-using-javadoc-syntax ~| Want to reach the ColdFusion community with something they want? Let them know on the House of Fusion mailing lists Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:327776 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
Re: Generating Documentation CF9
Wicked awesome, thanks Mark. ~| Want to reach the ColdFusion community with something they want? Let them know on the House of Fusion mailing lists Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:32 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4
Re: Generating Documentation CF9
Looks like I may have spoken a bit too soon Mark. I am not sure if this issue is related to my directorystructure or if I set something wrong in the run.cfm. Does your tool recursively look at the directories underneath the base directory? Right now my directorystructure looks like this: com model vo cfc1.cfc cfc2.cfc cfc3.cfc dao cfc1.cfc cfc2.cfc cfc3.cfc etc ~| Want to reach the ColdFusion community with something they want? Let them know on the House of Fusion mailing lists Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:327778 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
Re: Generating Documentation CF9
Yep it does. Should be fine. I use ColdDoc to generate the documentation for Transfer: http://docs.transfer-orm.com/html/transferapi/ And I am also using it when developing Narwhal (ColdSpring 2.0) And I've used it on a CF9 project. Mark On Wed, Oct 28, 2009 at 9:12 AM, Jeremy Rottman rottm...@gmail.com wrote: Looks like I may have spoken a bit too soon Mark. I am not sure if this issue is related to my directorystructure or if I set something wrong in the run.cfm. Does your tool recursively look at the directories underneath the base directory? Right now my directorystructure looks like this: com model vo cfc1.cfc cfc2.cfc cfc3.cfc dao cfc1.cfc cfc2.cfc cfc3.cfc etc ~| Want to reach the ColdFusion community with something they want? Let them know on the House of Fusion mailing lists Archive: http://www.houseoffusion.com/groups/cf-talk/message.cfm/messageid:327782 Subscription: http://www.houseoffusion.com/groups/cf-talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
Any Good Documentation on Verity Spyder CF8
Problem getting Verity Spider to work for CF8 Is there any good documentation or a .cfm or .cfc that has been written already. ~| Adobe® ColdFusion® 8 software 8 is the most important and dramatic release to date Get the Free Trial http://ad.doubleclick.net/clk;203748912;27390454;j Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:312355 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
Re: Metadata for code documentation (was RE: SURVEY RESULTS: Is ColdFusion OO?)
On Wednesday 11 Jul 2007, Jaime Metcher wrote: there is no enforceable contract, so cfinterface turns into an elaborate commenting mechanism with a runtime performance penalty. Did you try the CF8 beta yet :-) ? That's the Mona Lisa smiley - I can tell you're thinking something, but I'm not sure what it is. As far as I can tell, there is little to know performance overhead creating a component that implements an interface vs. one that doesn't. -- Tom Chiverton Helping to carefully foster best-of-breed meta-services on: http://thefalken.livejournal.com This email is sent for and on behalf of Halliwells LLP. Halliwells LLP is a limited liability partnership registered in England and Wales under registered number OC307980 whose registered office address is at St James's Court Brown Street Manchester M2 2JF. A list of members is available for inspection at the registered office. Any reference to a partner in relation to Halliwells LLP means a member of Halliwells LLP. Regulated by the Law Society. CONFIDENTIALITY This email is intended only for the use of the addressee named above and may be confidential or legally privileged. If you are not the addressee you must not read it and must not use any information contained in nor copy it nor inform any person other than Halliwells LLP or the addressee of its existence or contents. If you have received this email in error please delete it and notify Halliwells LLP IT Department on 0870 365 8008. For more information about Halliwells LLP visit www.halliwells.com. ~| ColdFusion MX7 and Flex 2 Build sales marketing dashboard RIAâs for your business. Upgrade now http://www.adobe.com/products/coldfusion/flex2?sdid=RVJT Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:283562 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
Re: Metadata for code documentation (was RE: SURVEY RESULTS: Is ColdFusion OO?)
On Wednesday 11 Jul 2007, Jaime Metcher wrote: there is no enforceable contract, so cfinterface turns into an elaborate commenting mechanism with a runtime performance penalty. Did you try the CF8 beta yet :-) ? -- Tom Chiverton Helping to synergistically accelerate sexy e-business on: http://thefalken.livejournal.com This email is sent for and on behalf of Halliwells LLP. Halliwells LLP is a limited liability partnership registered in England and Wales under registered number OC307980 whose registered office address is at St James's Court Brown Street Manchester M2 2JF. A list of members is available for inspection at the registered office. Any reference to a partner in relation to Halliwells LLP means a member of Halliwells LLP. Regulated by the Law Society. CONFIDENTIALITY This email is intended only for the use of the addressee named above and may be confidential or legally privileged. If you are not the addressee you must not read it and must not use any information contained in nor copy it nor inform any person other than Halliwells LLP or the addressee of its existence or contents. If you have received this email in error please delete it and notify Halliwells LLP IT Department on 0870 365 8008. For more information about Halliwells LLP visit www.halliwells.com. ~| Upgrade to Adobe ColdFusion MX7 Experience Flex 2 MX7 integration create powerful cross-platform RIAs http://www.adobe.com/products/coldfusion/flex2/?sdid=RVJQ Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:283443 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4
Re: Metadata for code documentation (was RE: SURVEY RESULTS: Is ColdFusion OO?)
For example, if converting code from typed to untyped for performance reasons, Anyone know of an article that explains this (I'm blissfully unaware of this issue)... I like your thinking. I once wrote a CFC Documentor, for inhouse use, that documents the component in either HTML or Word XML so that we have static documentation to hand to the client. It used the metadata and I toyed with adding custom properties but thought it would only confuse things. A matter of getting a standard together I suppose... Dom On 11/07/07, Jaime Metcher [EMAIL PROTECTED] wrote: -Original Message- From: Tom Chiverton [mailto:[EMAIL PROTECTED] Sent: Tuesday, 10 July 2007 7:16 PM To: CF-Talk Subject: Re: SURVEY RESULTS: Is ColdFusion OO? On Tuesday 10 Jul 2007, Sean Corfield wrote: In ColdFusion, all type checking is done at run time. So if you use interfaces, you will get a *runtime* check, just like all the other checks. And if you screw up, you'll get a runtime error. If you use interfaces, the error just has different text in it (OK, that's a *slight* oversimplification :) I want Interfaces so I can aid other developers intergrating with my code- it explictly codes the contract. I love the idea of documenting the intention - something that can be very obscure using mixins. However, as Sean and Ben Nadel have pointed out, there is no enforceable contract, so cfinterface turns into an elaborate commenting mechanism with a runtime performance penalty. That reminds me of another idea for documenting intention in a structured way that *doesn't* have a performance penalty. I'm certainly not the first person to point this out, but you can add arbitrary attributes to the cfcomponent, cffunction and cfargument tags that then appear in the metadata. I'd love to see the community generate some momentum on a standard set of metadata to aid in code introspection. For example, if converting code from typed to untyped for performance reasons, instead of removing type and returntype attributes, why not change them to _type and _returntype, thus documenting the original intention?. If ducktyping, the _type attribute could read any CFC that implements getID() for example. It would then be simple matter to adapt CF's builtin CFC introspection to read these attributes. Similarly, if you have a function in a superclass like this: cffunction name=doSomething cfthrow Subclass responsibility /cffunction why not add an abstract attribute to document the intention. From there it's not too hard to parse the metadata into XMI and produce a UML diagram, if that's what floats your boat. And I know there's somebody out there (sorry -forgot who you are) who uses cfproperty tags to document composition relationships. This *is* just documentation, *not* an attempt to add Java-style annotations, and isn't necessarily any more accurate than any other documentation. The cool thing is the ability to import it into other tools. Jaime Metcher ~| ColdFusion MX7 and Flex 2 Build sales marketing dashboard RIAâs for your business. Upgrade now http://www.adobe.com/products/coldfusion/flex2?sdid=RVJT Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:283444 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
RE: Metadata for code documentation (was RE: SURVEY RESULTS: Is ColdFusion OO?)
-Original Message- From: Tom Chiverton [mailto:[EMAIL PROTECTED] Sent: Wednesday, 11 July 2007 7:59 PM To: CF-Talk Subject: Re: Metadata for code documentation (was RE: SURVEY RESULTS: Is ColdFusion OO?) On Wednesday 11 Jul 2007, Jaime Metcher wrote: there is no enforceable contract, so cfinterface turns into an elaborate commenting mechanism with a runtime performance penalty. Did you try the CF8 beta yet :-) ? That's the Mona Lisa smiley - I can tell you're thinking something, but I'm not sure what it is. Jaime ~| ColdFusion 8 beta â Build next generation applications today. Free beta download on Labs http://www.adobe.com/cfusion/entitlement/index.cfm?e=labs_adobecf8_beta Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:283512 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
Metadata for code documentation (was RE: SURVEY RESULTS: Is ColdFusion OO?)
-Original Message- From: Tom Chiverton [mailto:[EMAIL PROTECTED] Sent: Tuesday, 10 July 2007 7:16 PM To: CF-Talk Subject: Re: SURVEY RESULTS: Is ColdFusion OO? On Tuesday 10 Jul 2007, Sean Corfield wrote: In ColdFusion, all type checking is done at run time. So if you use interfaces, you will get a *runtime* check, just like all the other checks. And if you screw up, you'll get a runtime error. If you use interfaces, the error just has different text in it (OK, that's a *slight* oversimplification :) I want Interfaces so I can aid other developers intergrating with my code- it explictly codes the contract. I love the idea of documenting the intention - something that can be very obscure using mixins. However, as Sean and Ben Nadel have pointed out, there is no enforceable contract, so cfinterface turns into an elaborate commenting mechanism with a runtime performance penalty. That reminds me of another idea for documenting intention in a structured way that *doesn't* have a performance penalty. I'm certainly not the first person to point this out, but you can add arbitrary attributes to the cfcomponent, cffunction and cfargument tags that then appear in the metadata. I'd love to see the community generate some momentum on a standard set of metadata to aid in code introspection. For example, if converting code from typed to untyped for performance reasons, instead of removing type and returntype attributes, why not change them to _type and _returntype, thus documenting the original intention?. If ducktyping, the _type attribute could read any CFC that implements getID() for example. It would then be simple matter to adapt CF's builtin CFC introspection to read these attributes. Similarly, if you have a function in a superclass like this: cffunction name=doSomething cfthrow Subclass responsibility /cffunction why not add an abstract attribute to document the intention. From there it's not too hard to parse the metadata into XMI and produce a UML diagram, if that's what floats your boat. And I know there's somebody out there (sorry -forgot who you are) who uses cfproperty tags to document composition relationships. This *is* just documentation, *not* an attempt to add Java-style annotations, and isn't necessarily any more accurate than any other documentation. The cool thing is the ability to import it into other tools. Jaime Metcher ~| Macromedia ColdFusion MX7 Upgrade to MX7 experience time-saving features, more productivity. http://www.adobe.com/products/coldfusion?sdid=RVJW Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:283431 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4
Technical documentation sample
I'm asked to provide some technical documentation for a project, and I've done what I think is necessary, but the client's saying no I need PROPER technical documentation. Not what you have done. Well I thought i'd done a pretty good job of documenting the project, but i guess not. Does anyone have a technical document I can look at, so I can see what he might be meaning? -- Cheers Mike Kear Windsor, NSW, Australia Adobe Certified Advanced ColdFusion Developer AFP Webworks http://afpwebworks.com ColdFusion, PHP, ASP, ASP.NET hosting from AUD$15/month ~| Upgrade to Adobe ColdFusion MX7 Experience Flex 2 MX7 integration create powerful cross-platform RIAs http://www.adobe.com/products/coldfusion/flex2/?sdid=RVJQ Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:279418 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4
RE: Technical documentation sample
Mike, Is the client confusing a technical document with a specification document? Andrew Scott Senior Coldfusion Developer Aegeon Pty. Ltd. www.aegeon.com.au Phone: +613 8676 4223 Mobile: 0404 998 273 -Original Message- From: Mike Kear [mailto:[EMAIL PROTECTED] Sent: Tuesday, 29 May 2007 4:35 PM To: CF-Talk Subject: Technical documentation sample I'm asked to provide some technical documentation for a project, and I've done what I think is necessary, but the client's saying no I need PROPER technical documentation. Not what you have done. Well I thought i'd done a pretty good job of documenting the project, but i guess not. Does anyone have a technical document I can look at, so I can see what he might be meaning? -- Cheers Mike Kear Windsor, NSW, Australia Adobe Certified Advanced ColdFusion Developer AFP Webworks http://afpwebworks.com ColdFusion, PHP, ASP, ASP.NET hosting from AUD$15/month ~| Upgrade to Adobe ColdFusion MX7 Experience Flex 2 MX7 integration create powerful cross-platform RIAs http://www.adobe.com/products/coldfusion/flex2/?sdid=RVJQ Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:279419 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4
Re: Technical documentation sample
Quite likely. Or since i've got no formal (i.e. university) training in IT, maybe I dont know what's expected. The project works. The client's happy with that. But it's the technical documentation he reckons is blow par.Could be too for all I know. The documentation that contains the data dictionaries, flow charts, that kind of stuff. If i could see a sample of such a document i could compare that with what i've done to see what I ought to do differently. Sadly, with this, google hasnt been my friend so far. Cheers Mike Kear Windsor, NSW, Australia Adobe Certified Advanced ColdFusion Developer AFP Webworks http://afpwebworks.com ColdFusion, PHP, ASP, ASP.NET hosting from AUD$15/month On 5/29/07, Andrew Scott [EMAIL PROTECTED] wrote: Mike, Is the client confusing a technical document with a specification document? Andrew Scott Senior Coldfusion Developer Aegeon Pty. Ltd. www.aegeon.com.au Phone:+613 8676 4223 Mobile: 0404 998 273 ~| Upgrade to Adobe ColdFusion MX7 The most significant release in over 10 years. Upgrade see new features. http://www.adobe.com/products/coldfusion?sdid=RVJR Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:279420 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4
Re: Technical documentation sample
He probably wants *how* it works, how to set it up etc what is required software wise (and how to set them all up) not necessary to document specific code blocks but at least what you need to do/have in order to get it to work should you wish to maintain/move/further a project without in depth training etc. This e-mail is from Reed Exhibitions (Gateway House, 28 The Quadrant, Richmond, Surrey, TW9 1DN, United Kingdom), a division of Reed Business, Registered in England, Number 678540. It contains information which is confidential and may also be privileged. It is for the exclusive use of the intended recipient(s). If you are not the intended recipient(s) please note that any form of distribution, copying or use of this communication or the information in it is strictly prohibited and may be unlawful. If you have received this communication in error please return it to the sender or call our switchboard on +44 (0) 20 89107910. The opinions expressed within this communication are not necessarily those expressed by Reed Exhibitions. Visit our website at http://www.reedexpo.com -Original Message- From: Mike Kear To: CF-Talk Sent: Tue May 29 07:49:16 2007 Subject: Re: Technical documentation sample Quite likely. Or since i've got no formal (i.e. university) training in IT, maybe I dont know what's expected. The project works. The client's happy with that. But it's the technical documentation he reckons is blow par.Could be too for all I know. The documentation that contains the data dictionaries, flow charts, that kind of stuff. If i could see a sample of such a document i could compare that with what i've done to see what I ought to do differently. Sadly, with this, google hasnt been my friend so far. Cheers Mike Kear Windsor, NSW, Australia Adobe Certified Advanced ColdFusion Developer AFP Webworks http://afpwebworks.com ColdFusion, PHP, ASP, ASP.NET hosting from AUD$15/month On 5/29/07, Andrew Scott [EMAIL PROTECTED] wrote: Mike, Is the client confusing a technical document with a specification document? Andrew Scott Senior Coldfusion Developer Aegeon Pty. Ltd. www.aegeon.com.au Phone:+613 8676 4223 Mobile: 0404 998 273 ~| Upgrade to Adobe ColdFusion MX7 Experience Flex 2 MX7 integration create powerful cross-platform RIAs http://www.adobe.com/products/coldfusion/flex2/?sdid=RVJQ Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:279421 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4
RE: Technical documentation sample
Hmmm... What is the purpose of him having this information, this is different dependant on the type of job and the methodology that is used to do the work in the first place. In an Agile approach there really is no such think, just stories that describe each task. It sounds like he is IT savvy, but sounds like he is out of touch. Andrew Scott Senior Coldfusion Developer Aegeon Pty. Ltd. www.aegeon.com.au Phone: +613 8676 4223 Mobile: 0404 998 273 ~| Upgrade to Adobe ColdFusion MX7 The most significant release in over 10 years. Upgrade see new features. http://www.adobe.com/products/coldfusion?sdid=RVJR Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:279423 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
Re: Technical documentation sample
On Tuesday 29 May 2007, Mike Kear wrote: I've done what I think is necessary, but the client's saying no I need PROPER technical documentation. Not what you have done. I assume you've asked the client to explain where he feels it is lacking ? -- Tom Chiverton Helping to assertively envisioneer enterprise metrics on: http://thefalken.livejournal.com This email is sent for and on behalf of Halliwells LLP. Halliwells LLP is a limited liability partnership registered in England and Wales under registered number OC307980 whose registered office address is at St James's Court Brown Street Manchester M2 2JF. A list of members is available for inspection at the registered office. Any reference to a partner in relation to Halliwells LLP means a member of Halliwells LLP. Regulated by the Law Society. CONFIDENTIALITY This email is intended only for the use of the addressee named above and may be confidential or legally privileged. If you are not the addressee you must not read it and must not use any information contained in nor copy it nor inform any person other than Halliwells LLP or the addressee of its existence or contents. If you have received this email in error please delete it and notify Halliwells LLP IT Department on 0870 365 8008. For more information about Halliwells LLP visit www.halliwells.com. ~| ColdFusion MX7 by Adobe® Dyncamically transform webcontent into Adobe PDF with new ColdFusion MX7. Free Trial. http://www.adobe.com/products/coldfusion?sdid=RVJV Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:279426 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
RE: Technical documentation sample
Is he looking for documentation that meets a certain CMMI level? I'd ask the client for an example of what they want, otherwise it is a moving target. -Original Message- From: Mike Kear [mailto:[EMAIL PROTECTED] Sent: Tuesday, May 29, 2007 1:35 AM To: CF-Talk Subject: Technical documentation sample I'm asked to provide some technical documentation for a project, and I've done what I think is necessary, but the client's saying no I need PROPER technical documentation. Not what you have done. Well I thought i'd done a pretty good job of documenting the project, but i guess not. Does anyone have a technical document I can look at, so I can see what he might be meaning? -- Cheers Mike Kear Windsor, NSW, Australia Adobe Certified Advanced ColdFusion Developer AFP Webworks http://afpwebworks.com ColdFusion, PHP, ASP, ASP.NET hosting from AUD$15/month ~| Macromedia ColdFusion MX7 Upgrade to MX7 experience time-saving features, more productivity. http://www.adobe.com/products/coldfusion?sdid=RVJW Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:279438 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
RE: Technical documentation sample
Do you use CFC's? If so, you should load the component inspector and then convert the output to a PDF, combine them all and that should help to at least document your 'classes' and methods. In any case, it 'looks' impressive ;) Brook -Original Message- From: Andrew Scott [mailto:[EMAIL PROTECTED] Sent: May 28, 2007 11:55 PM To: CF-Talk Subject: RE: Technical documentation sample Hmmm... What is the purpose of him having this information, this is different dependant on the type of job and the methodology that is used to do the work in the first place. In an Agile approach there really is no such think, just stories that describe each task. It sounds like he is IT savvy, but sounds like he is out of touch. Andrew Scott Senior Coldfusion Developer Aegeon Pty. Ltd. www.aegeon.com.au Phone: +613 8676 4223 Mobile: 0404 998 273 ~| Upgrade to Adobe ColdFusion MX7 Experience Flex 2 MX7 integration create powerful cross-platform RIAs http://www.adobe.com/products/coldfusion/flex2/?sdid=RVJQ Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:279501 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
Re: Technical documentation sample
I'm asked to provide some technical documentation for a project, and I've done what I think is necessary, but the client's saying no I need PROPER technical documentation. Not what you have done. Well I thought i'd done a pretty good job of documenting the project, but i guess not. Does anyone have a technical document I can look at, so I can see what he might be meaning? Did they give you any indication of what they expected? There are several documentation methodologies to follow and they can be radically different from one another even when documenting the same system. I've never worked anyplace that actually used the methodology that they claimed to use: instead they used a (sometimes small) slice of it and customized anything else they needed. I've used Summit-D (now manged by IBM but I used it long ago) and it was decent - we shaved it down but ended up with two primary documents: the functional spec and the technical spec. In theory the functional spec contained all of the functionality of a system/project. User interface information, style information, functionality inventory, etc. The technical spec contained all of the low-level information: database design, object models, APIs, etc. The functional was a high-level business document while the technical was a low-level developer document - together they pretty neatly described the system. Now we're using a heavily modified UML model: use cases, objectified system flows, etc. UML is designed (if used properly) to build documentation in layers: each layer informs adjacent layers and each covers specific topics or concerns. It's really quite good but pretty labor intensive compared to others. In addition we also have several specialized pieces of documentation that go to various other teams: +) The Build-Book describes all aspects of configuration/installation of the project. +) The Run Book describes all of the touch points (system dependecies) of the project, all contacts for the systems and all of the escalation procedures when things go wrong. +) The Data Inventory. For those projects that need it this would describe all of the data-related depencies of the system (tables, stored procedures, triggers, etc) and be managed by the various DBAs involved. +) A Style Guide. Essentailly a sub-set of the functional spec this is specifically (for those systems that need it) a visually-focused document describing fonts, spacing, colors, etc. It's mostly used by designers and is often based (at least in part) on corporate style standards. One of the best questions to get clear is what the audience for the documentation is. Is it technical (people that might work on the system)? Is it business (people that might own or manage development on the system)? Is is end-user (you'd be suprised how many people say project documentation when what they really mean is user manual)? A good set of documentation can easily take longer to produce than the system being documented. Having the documentation done (and, almost more importantly, making sure to manage and update it) can save you tremendous work and money later. I only wish more project factored documentation as prominently as it should be (it's usually the first thing to be slashed when time/money gets tight). In your case you really to need to determine what kind of documentation they're looking for. Otherwise you might work for weeks and still not touch upon the style or audience they're concerned about. Jim Davis ~| Create robust enterprise, web RIAs. Upgrade integrate Adobe Coldfusion MX7 with Flex 2 http://www.adobe.com/products/coldfusion/flex2/?sdid=RVJP Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:279516 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
educational/simple CF/MSSQl application with documentation and description
Hi: Do you know any basic level CF/MSSQL (or even MSACCESS) application with complete description and documentation? I need it to learn more about CF plus learn how to make description/documentation for my own apps. It doesn't matter if it is blog or catalog or any other sort of application. The only things that matters are : 1.I need an easy one that I understand it all 2.The documentation/tutorial/description can help me to learn about all the pages of the application. Thanks Benign ~| Introducing the Fusion Authority Quarterly Update. 80 pages of hard-hitting, up-to-date ColdFusion information by your peers, delivered to your door four times a year. http://www.fusionauthority.com/quarterly Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:259876 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
Re: educational/simple CF/MSSQl application with documentation and description
Have you read Ben Forta's CFWACK? It is a great read, but also has sample apps in there on CD. http://search.barnesandnoble.com/booksearch/isbnInquiry.asp?z=yEAN=9780321223678itm=3 - Original Message - From: Ali Majdzadeh [EMAIL PROTECTED] To: CF-Talk cf-talk@houseoffusion.com Sent: Friday, November 10, 2006 2:21 AM Subject: educational/simple CF/MSSQl application with documentation and description Hi: Do you know any basic level CF/MSSQL (or even MSACCESS) application with complete description and documentation? I need it to learn more about CF plus learn how to make description/documentation for my own apps. It doesn't matter if it is blog or catalog or any other sort of application. The only things that matters are : 1.I need an easy one that I understand it all 2.The documentation/tutorial/description can help me to learn about all the pages of the application. Thanks Benign ~| Introducing the Fusion Authority Quarterly Update. 80 pages of hard-hitting, up-to-date ColdFusion information by your peers, delivered to your door four times a year. http://www.fusionauthority.com/quarterly Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:259883 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
Re: OT: Paymentech Documentation
it's actually available for anyone ... assuming you know the URL ... https://www.paymentech.net/download/ Would anyone, by chance, have a copy of the Paymentech Orbital Gateway API documentation they could e-mail me off-list? I have a client who is waiting to finalize their account through Chase and it seems that Paymentech only makes their API specs available to the account holders directly via their representatives (http://www.chasepaymentech.com/solgat.do). I haven't been able to find any documentation anywhere on this. Since their account hasn't been fully processed, it's kind of a Catch-22. The processor integration piece is pretty much all I have left on this particular project and I'd like to get the processing functions in place so that once the account information is back, it's a test and go deal. Thanks for any help you can give, Jon ~| Introducing the Fusion Authority Quarterly Update. 80 pages of hard-hitting, up-to-date ColdFusion information by your peers, delivered to your door four times a year. http://www.fusionauthority.com/quarterly Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:259374 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
OT: Paymentech Documentation
Would anyone, by chance, have a copy of the Paymentech Orbital Gateway API documentation they could e-mail me off-list? I have a client who is waiting to finalize their account through Chase and it seems that Paymentech only makes their API specs available to the account holders directly via their representatives (http://www.chasepaymentech.com/solgat.do). I haven't been able to find any documentation anywhere on this. Since their account hasn't been fully processed, it's kind of a Catch-22. The processor integration piece is pretty much all I have left on this particular project and I'd like to get the processing functions in place so that once the account information is back, it's a test and go deal. Thanks for any help you can give, Jon ~| Introducing the Fusion Authority Quarterly Update. 80 pages of hard-hitting, up-to-date ColdFusion information by your peers, delivered to your door four times a year. http://www.fusionauthority.com/quarterly Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:258501 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4
Re: Oracle stored procs and CF - documentation
I answered myself again. Thankme for the help. No probs :-) CF 7.0.2 doesn't include the 3.5 drivers. Interesting though that Solaris CF Ent and Win CF Dev show different behaviour with the same 3.3 drivers. On 10/10/06, James Holmes [EMAIL PROTECTED] wrote: OK, I worked it out again (damn my terrible memory). This showed up an interesting issue. I don't know if it's a difference in CF or a difference in the DB drivers, but our Solaris servers and my Win dev server behave differently. The windows server works as it should, with this: cfstoredproc procedure=myPachage.myProc datasource=myDSN cfprocresult name=RefCursor_Result resultset=1 /cfstoredproc returning a resultset when the proc is set up to return a ref cursor as an out parameter. However, or the Solaris server, I get this: [Macromedia][Oracle JDBC Driver][Oracle]ORA-06550: line 1, column 7: PLS-00306: wrong number or types of arguments in call to 'GETWSDATA' I had to add cfprocparam cfsqltype=cf_sql_varchar null=yes to get it to work. Does anyone know off-hand if this http://www.adobe.com/cfusion/knowledgebase/index.cfm?id=42dcb10a database driver is part of CF 7.0.2? On 10/10/06, James Holmes [EMAIL PROTECTED] wrote: Can someone point me to correct, working documentation on returning CF7 queries from Oracle stored procs? The livedocs are useless on this matter and the articles to which I previously referred are buried or lost somewhere on Adobe's site. -- CFAJAX docs and other useful articles: http://www.bifrost.com.au/blog/ -- CFAJAX docs and other useful articles: http://www.bifrost.com.au/blog/ ~| Introducing the Fusion Authority Quarterly Update. 80 pages of hard-hitting, up-to-date ColdFusion information by your peers, delivered to your door four times a year. http://www.fusionauthority.com/quarterly Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:256072 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
Oracle stored procs and CF - documentation
Can someone point me to correct, working documentation on returning CF7 queries from Oracle stored procs? The livedocs are useless on this matter and the articles to which I previously referred are buried or lost somewhere on Adobe's site. -- CFAJAX docs and other useful articles: http://www.bifrost.com.au/blog/ ~| Introducing the Fusion Authority Quarterly Update. 80 pages of hard-hitting, up-to-date ColdFusion information by your peers, delivered to your door four times a year. http://www.fusionauthority.com/quarterly Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:256064 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4
Re: Oracle stored procs and CF - documentation
OK, I worked it out again (damn my terrible memory). This showed up an interesting issue. I don't know if it's a difference in CF or a difference in the DB drivers, but our Solaris servers and my Win dev server behave differently. The windows server works as it should, with this: cfstoredproc procedure=myPachage.myProc datasource=myDSN cfprocresult name=RefCursor_Result resultset=1 /cfstoredproc returning a resultset when the proc is set up to return a ref cursor as an out parameter. However, or the Solaris server, I get this: [Macromedia][Oracle JDBC Driver][Oracle]ORA-06550: line 1, column 7: PLS-00306: wrong number or types of arguments in call to 'GETWSDATA' I had to add cfprocparam cfsqltype=cf_sql_varchar null=yes to get it to work. Does anyone know off-hand if this http://www.adobe.com/cfusion/knowledgebase/index.cfm?id=42dcb10a database driver is part of CF 7.0.2? On 10/10/06, James Holmes [EMAIL PROTECTED] wrote: Can someone point me to correct, working documentation on returning CF7 queries from Oracle stored procs? The livedocs are useless on this matter and the articles to which I previously referred are buried or lost somewhere on Adobe's site. -- CFAJAX docs and other useful articles: http://www.bifrost.com.au/blog/ ~| Introducing the Fusion Authority Quarterly Update. 80 pages of hard-hitting, up-to-date ColdFusion information by your peers, delivered to your door four times a year. http://www.fusionauthority.com/quarterly Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:256070 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
Re: Good Documentation on Setting up Multiple Instances of CF7 running on IIS
I am looking for more resources on setting up multiple instances of CF7 on IIS6. I have read through the docs at Adobe, but I was looking for more resources. I have set up CF Server many times before, but always as a single stand alone instance. I am looking for a good step by step document that I can pass along to my developers. Any help would be greatly appreciated. Thanks, Dave Hatz Anyone? Adobe documentation is seriously lacking AND often just plain incorrect. I have found bits of information but nothing complete. Hatz, you may start here but it seems to me that there are some differences with CFMX6.1 and CFMX7: http://www.bpurcell.org/blog/index.cfm?mode=entryentry=993 ~| Introducing the Fusion Authority Quarterly Update. 80 pages of hard-hitting, up-to-date ColdFusion information by your peers, delivered to your door four times a year. http://www.fusionauthority.com/quarterly Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:253165 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4
Good Documentation on Setting up Multiple Instances of CF7 running on IIS
I am looking for more resources on setting up multiple instances of CF7 on IIS6. I have read through the docs at Adobe, but I was looking for more resources. I have set up CF Server many times before, but always as a single stand alone instance. I am looking for a good step by step document that I can pass along to my developers. Any help would be greatly appreciated. Thanks, Dave Hatz ~| Introducing the Fusion Authority Quarterly Update. 80 pages of hard-hitting, up-to-date ColdFusion information by your peers, delivered to your door four times a year. http://www.fusionauthority.com/quarterly Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:252132 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4
RE: Good Documentation on Setting up Multiple Instances of CF7 ru nning on IIS
I am looking for more resources on setting up multiple instances of CF7 on IIS6. I have read through the docs at Adobe, but I was looking for more resources. I have set up CF Server many times before, but always as a single stand alone instance. I am looking for a good step by step document that I can pass along to my developers. Any help would be greatly appreciated. You're not really going to find an exact step-by-step checklist, because there are quite a few different ways you might go about this. Are you trying to separate applications belonging to different IIS virtual hosts? To the same virtual host? Or are you trying to cluster instances associated with one or more IIS virtual hosts? Dave Watts, CTO, Fig Leaf Software http://www.figleaf.com/ Fig Leaf Software provides the highest caliber vendor-authorized instruction at our training centers in Washington DC, Atlanta, Chicago, Baltimore, Northern Virginia, or on-site at your location. Visit http://training.figleaf.com/ for more information! ~| Introducing the Fusion Authority Quarterly Update. 80 pages of hard-hitting, up-to-date ColdFusion information by your peers, delivered to your door four times a year. http://www.fusionauthority.com/quarterly Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:252135 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
RE: Good Documentation on Setting up Multiple Instances of CF7 ru nning on IIS
Dave, What I want to do is set up different CF instances for each of our bigger clients. I was looking to separate out the CF instances so that they each will have their own memory allocation and resources, so as one of the instances begins to slow down, it doesn't take the other CF instances with it. And the CF instances will belong to 1 IIS Host. Thanks, Dave Hatz -Original Message- From: Dave Watts [mailto:[EMAIL PROTECTED] Sent: Tuesday, September 05, 2006 3:36 PM To: CF-Talk Subject: RE: Good Documentation on Setting up Multiple Instances of CF7 ru nning on IIS I am looking for more resources on setting up multiple instances of CF7 on IIS6. I have read through the docs at Adobe, but I was looking for more resources. I have set up CF Server many times before, but always as a single stand alone instance. I am looking for a good step by step document that I can pass along to my developers. Any help would be greatly appreciated. You're not really going to find an exact step-by-step checklist, because there are quite a few different ways you might go about this. Are you trying to separate applications belonging to different IIS virtual hosts? To the same virtual host? Or are you trying to cluster instances associated with one or more IIS virtual hosts? Dave Watts, CTO, Fig Leaf Software http://www.figleaf.com/ Fig Leaf Software provides the highest caliber vendor-authorized instruction at our training centers in Washington DC, Atlanta, Chicago, Baltimore, Northern Virginia, or on-site at your location. Visit http://training.figleaf.com/ for more information! ~| Introducing the Fusion Authority Quarterly Update. 80 pages of hard-hitting, up-to-date ColdFusion information by your peers, delivered to your door four times a year. http://www.fusionauthority.com/quarterly Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:252136 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
RE: Good Documentation on Setting up Multiple Instances of CF7 ru nning on IIS
What I want to do is set up different CF instances for each of our bigger clients. I was looking to separate out the CF instances so that they each will have their own memory allocation and resources, so as one of the instances begins to slow down, it doesn't take the other CF instances with it. And the CF instances will belong to 1 IIS Host. You had me right up until the last sentence. Do you mean you will have one IIS server, or one IIS virtual host? If you have separate clients, doesn't each have its own IIS virtual server? (www.client1.com, www.client2.com, etc, mapped to individual virtual hosts) Dave Watts, CTO, Fig Leaf Software http://www.figleaf.com/ Fig Leaf Software provides the highest caliber vendor-authorized instruction at our training centers in Washington DC, Atlanta, Chicago, Baltimore, Northern Virginia, or on-site at your location. Visit http://training.figleaf.com/ for more information! ~| Introducing the Fusion Authority Quarterly Update. 80 pages of hard-hitting, up-to-date ColdFusion information by your peers, delivered to your door four times a year. http://www.fusionauthority.com/quarterly Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:252137 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
RE: Good Documentation on Setting up Multiple Instances of CF7 ru nning on IIS
We have 1 IIS server with each client having their own virtual server, www.client1.com and www.client2.com. -Original Message- From: Dave Watts [mailto:[EMAIL PROTECTED] Sent: Tuesday, September 05, 2006 3:50 PM To: CF-Talk Subject: RE: Good Documentation on Setting up Multiple Instances of CF7 ru nning on IIS What I want to do is set up different CF instances for each of our bigger clients. I was looking to separate out the CF instances so that they each will have their own memory allocation and resources, so as one of the instances begins to slow down, it doesn't take the other CF instances with it. And the CF instances will belong to 1 IIS Host. You had me right up until the last sentence. Do you mean you will have one IIS server, or one IIS virtual host? If you have separate clients, doesn't each have its own IIS virtual server? (www.client1.com, www.client2.com, etc, mapped to individual virtual hosts) Dave Watts, CTO, Fig Leaf Software http://www.figleaf.com/ Fig Leaf Software provides the highest caliber vendor-authorized instruction at our training centers in Washington DC, Atlanta, Chicago, Baltimore, Northern Virginia, or on-site at your location. Visit http://training.figleaf.com/ for more information! ~| Introducing the Fusion Authority Quarterly Update. 80 pages of hard-hitting, up-to-date ColdFusion information by your peers, delivered to your door four times a year. http://www.fusionauthority.com/quarterly Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:252139 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
RE: Good Documentation on Setting up Multiple Instances of CF7 ru nning on IIS
We have 1 IIS server with each client having their own virtual server, www.client1.com and www.client2.com. Then the easiest thing to do is probably this: 1. Install CF Enterprise using Multiserver option. 2. During the install, don't connect CF to any external web server. 3. After the install, go into CF Administrator and select Instance Manager. 4. Create two new instances. Give each a unique name. 5. Use the web server configuration utility to connect each of the new instances to its corresponding IIS virtual server. 6. Turn off the original CF instance's service until you need to create more instances. Dave Watts, CTO, Fig Leaf Software http://www.figleaf.com/ Fig Leaf Software provides the highest caliber vendor-authorized instruction at our training centers in Washington DC, Atlanta, Chicago, Baltimore, Northern Virginia, or on-site at your location. Visit http://training.figleaf.com/ for more information! ~| Introducing the Fusion Authority Quarterly Update. 80 pages of hard-hitting, up-to-date ColdFusion information by your peers, delivered to your door four times a year. http://www.fusionauthority.com/quarterly Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:252140 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4
RE: Good Documentation on Setting up Multiple Instances of CF7 ru nning on IIS
Dave, I had the pleasure of sitting in your session at Cfun this year and as always you did a suburb job of speaking and getting your topic across. I have always found the Speakers from your company to be some of the best in the industry. Question for you, do you guys offer a advanced training class on CF Admin? And thanks for the info below, this is very helpful... Dave Hatz -Original Message- From: Dave Watts [mailto:[EMAIL PROTECTED] Sent: Tuesday, September 05, 2006 4:22 PM To: CF-Talk Subject: RE: Good Documentation on Setting up Multiple Instances of CF7 ru nning on IIS We have 1 IIS server with each client having their own virtual server, www.client1.com and www.client2.com. Then the easiest thing to do is probably this: 1. Install CF Enterprise using Multiserver option. 2. During the install, don't connect CF to any external web server. 3. After the install, go into CF Administrator and select Instance Manager. 4. Create two new instances. Give each a unique name. 5. Use the web server configuration utility to connect each of the new instances to its corresponding IIS virtual server. 6. Turn off the original CF instance's service until you need to create more instances. Dave Watts, CTO, Fig Leaf Software http://www.figleaf.com/ Fig Leaf Software provides the highest caliber vendor-authorized instruction at our training centers in Washington DC, Atlanta, Chicago, Baltimore, Northern Virginia, or on-site at your location. Visit http://training.figleaf.com/ for more information! ~| Introducing the Fusion Authority Quarterly Update. 80 pages of hard-hitting, up-to-date ColdFusion information by your peers, delivered to your door four times a year. http://www.fusionauthority.com/quarterly Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:252143 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
RE: Good Documentation on Setting up Multiple Instances of CF7 ru nning on IIS
I had the pleasure of sitting in your session at Cfun this year and as always you did a suburb job of speaking and getting your topic across. I have always found the Speakers from your company to be some of the best in the industry. Well, thank you very much! There were plenty of great speakers this year, but who am I to reject a compliment? Question for you, do you guys offer a advanced training class on CF Admin? No, not currently. We do, however, provide mentoring and onsite consulting; quite a bit of it covers this sort of thing. And thanks for the info below, this is very helpful... You're welcome! Dave Watts, CTO, Fig Leaf Software http://www.figleaf.com/ Fig Leaf Software provides the highest caliber vendor-authorized instruction at our training centers in Washington DC, Atlanta, Chicago, Baltimore, Northern Virginia, or on-site at your location. Visit http://training.figleaf.com/ for more information! ~| Introducing the Fusion Authority Quarterly Update. 80 pages of hard-hitting, up-to-date ColdFusion information by your peers, delivered to your door four times a year. http://www.fusionauthority.com/quarterly Archive: http://www.houseoffusion.com/groups/CF-Talk/message.cfm/messageid:252144 Subscription: http://www.houseoffusion.com/groups/CF-Talk/subscribe.cfm Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4
RE: Documentation Software Needed..
I should add though if you are simply looking for online help something everyone can add to - have a look at confluence: http://www.atlassian.com/software/confluence/ http://confluence.atlassian.com/dashboard.action It has some useful features such as notification of page updates, export to pdf etc. Kola -Original Message- From: Jose Diaz [mailto:[EMAIL PROTECTED] Sent: 15 June 2006 20:33 To: CF-Talk Subject: Re: Documentation Software Needed.. Hi Guys As Bob has mentioned RoboHelp(now Captivate) is the route to go. Thanks Jose Diaz On 6/15/06, Robert Everland III [EMAIL PROTECTED] wrote: Viewing the source of that site shows that they are using RoboHelp which just so happens to be an Adobe product. Bob ~ ~| Message: http://www.houseoffusion.com/lists.cfm/link=i:4:244225 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Documentation Software Needed..
Can anyone recommend a utility (CF based) that can allow a small team of developers to create / document their applications? I am looking for something free/cheap but costly solutions I am not ruling out just yet. I am looking for something like this http://www.red-gate.com/help/sqlbackup/sqlbackup.htm http://www.red-gate.com/help/sqlbackup/sqlbackup.htm Any help is appreciated. Brian R. Polackoff Web Applications Developer MONOC [EMAIL PROTECTED] mailto:[EMAIL PROTECTED] 732.919.3045 ext 1171 ~| Message: http://www.houseoffusion.com/lists.cfm/link=i:4:243619 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: Documentation Software Needed..
Viewing the source of that site shows that they are using RoboHelp which just so happens to be an Adobe product. Bob ~| Message: http://www.houseoffusion.com/lists.cfm/link=i:4:243657 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: Documentation Software Needed..
Hi Guys As Bob has mentioned RoboHelp(now Captivate) is the route to go. Thanks Jose Diaz On 6/15/06, Robert Everland III [EMAIL PROTECTED] wrote: Viewing the source of that site shows that they are using RoboHelp which just so happens to be an Adobe product. Bob ~| Message: http://www.houseoffusion.com/lists.cfm/link=i:4:243672 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: Documentation
Hi Neil For non-technical documentation I have found macromedia Captivate very useful, alot of non technical users want to just see the gui in action for a specific task and Captivate handles this perfectly, I've found many users dont read documentation fully anyway. The visual approach Captivate gives keeps the users attention, plus you can convert any presentations to word/pdf if you wish. From a developer doc route a wiki sounds the route to go as mentioned by the other guys. HTH Jose Diaz ;) On 6/8/06, Nick de Voil [EMAIL PROTECTED] wrote: How do you guys go about technical documentation, how do you write docs that tell other people (not necessarily technical, but project participants) how your code works, what the rules are, what the re-use potential is, how the UI works etc. What tools do you use for the job? Word? Visio? Wiki? How do you tackle it and when? Before writing your code? After? For us, the exact set of documentation deliverables is very project-dependent and is thrashed out at a high level at project initiation time and then in more details at the beginning of each project stage. It depends on the complexity of the job, the customer's expectations and the development method used for the project, but in general you need to have documentation tasks in all three places - beginning, middle and end. You need to document the functional and non-functional (performance etc) requirements up front or the project will fail. You need to document what you're doing at each stage in order to have a managed process (imo this is true even if you're doing agile development). And you need to document what you've done at the end, or the documentation will not reflect reality. We do still use Word/PDF for those documents where a simple, visible version control scheme is critical. We store everything in our web-based project support environment as a central reference point. Being basically a CMS, besides storing files it allows you to create more free-form web-based documentation as you go along, whether as traditional pages or blog/wiki/forum/helpfile entries. It also creates interactive diagrams. We use a lot of diagrams because they are information-rich and (some) customers can understand (some of) them. We use all sorts of diagramming techniques, both from UML and older toolsets. The only thing I would caution against is creating too many detailed how-to documents with embedded screenshots - they become a real pain when you want to change things. An up-to-date Captivate demo is much more likely to be correct and consistent. However, sometimes customers want things on paper. Nick ~| Message: http://www.houseoffusion.com/lists.cfm/link=i:4:243039 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Documentation
I know a lot of you will run for the hills at the sight of the subject line, but it really is quite a simple question. How do you guys go about technical documentation, how do you write docs that tell other people (not necessarily technical, but project participants) how your code works, what the rules are, what the re-use potential is, how the UI works etc. What tools do you use for the job? Word? Visio? Wiki? How do you tackle it and when? Before writing your code? After? -- Neil Middleton Visit feed-squirrel.com ~| Message: http://www.houseoffusion.com/lists.cfm/link=i:4:242887 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: Documentation
Hi Neil, Trac is great for this, it keep everything together. Highly recommend it. On 08/06/06, Neil Middleton [EMAIL PROTECTED] wrote: I know a lot of you will run for the hills at the sight of the subject line, but it really is quite a simple question. How do you guys go about technical documentation, how do you write docs that tell other people (not necessarily technical, but project participants) how your code works, what the rules are, what the re-use potential is, how the UI works etc. What tools do you use for the job? Word? Visio? Wiki? How do you tackle it and when? Before writing your code? After? -- Neil Middleton Visit feed-squirrel.com ~| Message: http://www.houseoffusion.com/lists.cfm/link=i:4:242888 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: Documentation
On Thursday 08 June 2006 10:54, Neil Middleton wrote: that tell other people (not necessarily technical, but project participants) how your code works, what the rules are, what the re-use potential is, how the UI works etc. Why do non-technical people care about reuse ? They just want a 'how-do-I' and bit of handholding. If it's taking a long time or complex document, your UI probably sucks :-) What tools do you use for the job? Word? Visio? Wiki? We use a sort of wiki amongest the devlopers, and .doc for user-visable stuff. Generally as we go along for the developer docs - things tend to be in flux more often than not during the writing stage. -- Tom Chiverton This email is sent for and on behalf of Halliwells LLP. Halliwells LLP is a limited liability partnership registered in England and Wales under registered number OC307980 whose registered office address is at St James's Court Brown Street Manchester M2 2JF. A list of members is available for inspection at the registered office. Any reference to a partner in relation to Halliwells LLP means a member of Halliwells LLP. Regulated by the Law Society. CONFIDENTIALITY This email is intended only for the use of the addressee named above and may be confidential or legally privileged. If you are not the addressee you must not read it and must not use any information contained in nor copy it nor inform any person other than Halliwells LLP or the addressee of its existence or contents. If you have received this email in error please delete it and notify Halliwells LLP IT Department on 0870 365 8008. For more information about Halliwells LLP visit www.halliwells.com. We are pleased to announce that Halliwells LLP has been voted AIM Lawyer of the Year at the 2005 Growth Company Awards ~| Message: http://www.houseoffusion.com/lists.cfm/link=i:4:242889 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: Documentation
I would say, anyone who is involved in a project either from a development or financial point of view cares about re-use as it has a direct effect on future costs. N On 6/8/06, Tom Chiverton [EMAIL PROTECTED] wrote: Why do non-technical people care about reuse ? ~| Message: http://www.houseoffusion.com/lists.cfm/link=i:4:242890 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: Documentation
On Thursday 08 June 2006 11:21, Neil Middleton wrote:
I would say, anyone who is involved in a project either from a development
or financial point of view cares about re-use as it has a direct effect on
future costs.
Fair enough.
If you start telling non-technical people 'We spent twice as long on this
project as we could have to reduce furture development time', that's OK, but
there's no need to go into the detail of what you did ('wrote an abstract
state manager for managing history logging and action execution').
--
Tom Chiverton
This email is sent for and on behalf of Halliwells LLP.
Halliwells LLP is a limited liability partnership registered in England and
Wales under registered number OC307980 whose registered office address is at St
James's Court Brown Street Manchester M2 2JF. A list of members is available
for inspection at the registered office. Any reference to a partner in relation
to Halliwells LLP means a member of Halliwells LLP. Regulated by the Law
Society.
CONFIDENTIALITY
This email is intended only for the use of the addressee named above and may be
confidential or legally privileged. If you are not the addressee you must not
read it and must not use any information contained in nor copy it nor inform
any person other than Halliwells LLP or the addressee of its existence or
contents. If you have received this email in error please delete it and notify
Halliwells LLP IT Department on 0870 365 8008.
For more information about Halliwells LLP visit www.halliwells.com.
We are pleased to announce that Halliwells LLP has been voted AIM Lawyer of the
Year at the 2005 Growth Company Awards
~|
Message: http://www.houseoffusion.com/lists.cfm/link=i:4:242891
Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4
Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4
Unsubscribe:
http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4
Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: Documentation
How do you guys go about technical documentation, how do you write docs that tell other people (not necessarily technical, but project participants) how your code works, what the rules are, what the re-use potential is, how the UI works etc. What tools do you use for the job? Word? Visio? Wiki? How do you tackle it and when? Before writing your code? After? For us, the exact set of documentation deliverables is very project-dependent and is thrashed out at a high level at project initiation time and then in more details at the beginning of each project stage. It depends on the complexity of the job, the customer's expectations and the development method used for the project, but in general you need to have documentation tasks in all three places - beginning, middle and end. You need to document the functional and non-functional (performance etc) requirements up front or the project will fail. You need to document what you're doing at each stage in order to have a managed process (imo this is true even if you're doing agile development). And you need to document what you've done at the end, or the documentation will not reflect reality. We do still use Word/PDF for those documents where a simple, visible version control scheme is critical. We store everything in our web-based project support environment as a central reference point. Being basically a CMS, besides storing files it allows you to create more free-form web-based documentation as you go along, whether as traditional pages or blog/wiki/forum/helpfile entries. It also creates interactive diagrams. We use a lot of diagrams because they are information-rich and (some) customers can understand (some of) them. We use all sorts of diagramming techniques, both from UML and older toolsets. The only thing I would caution against is creating too many detailed how-to documents with embedded screenshots - they become a real pain when you want to change things. An up-to-date Captivate demo is much more likely to be correct and consistent. However, sometimes customers want things on paper. Nick ~| Message: http://www.houseoffusion.com/lists.cfm/link=i:4:242893 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
CFC documentation not being displayed
I'm breaking all of my SQL out into a CFC library as a first step towards supporting multiple database types. It's a pretyt sizeable task, and, obviously, I'd like to be able to reference the self-documenting features of CFC's. The problem is, when browsing directly to the CFC in the hopes of seeing the generated documentation (http://localhost/lib/cfc/mssql.cfc in my case) I get a blank page. Here's a snippet of my cfc: cfcomponent displayname=Microsoft SQL Server Component hint=This component contains all Microsoft SQL Server database access code. style=RPC output=Yes cfset msg = !--- Security Authentication --- cffunction name=login access=public description=Logs in user. output=No returntype=query cfargument name=username required=Yes type=string default= cfargument name=password required=no type=string default= cfstoredproc procedure=spAuthenticateUser datasource=#request.app.dsname# returncode=Yes cfprocparam type=In cfsqltype=CF_SQL_VARCHAR dbvarname=username value=#arguments.username# null=No cfprocparam type=In cfsqltype=CF_SQL_VARCHAR dbvarname=password value=#arguments.password# null=No cfprocresult name=loginQuery resultset=1 /cfstoredproc cfreturn loginQuery /cffunction /cfcomponent Anything obvious that I'm doing wrong? The methods all work perfectly, so I'm pretty sure it's not my code. I'm using MX7 on WinXP/IIS. Thanks, Pete ~| Message: http://www.houseoffusion.com/lists.cfm/link=i:4:238262 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: CFC documentation not being displayed
Do you have access to the cfide? In other words, can you get to the administrator? You must have the cfide available to get to that documentation I believe. On 4/20/06, Pete Ruckelshaus [EMAIL PROTECTED] wrote: I'm breaking all of my SQL out into a CFC library as a first step towards supporting multiple database types. It's a pretyt sizeable task, and, obviously, I'd like to be able to reference the self-documenting features of CFC's. The problem is, when browsing directly to the CFC in the hopes of seeing the generated documentation (http://localhost/lib/cfc/mssql.cfc in my case) I get a blank page. Here's a snippet of my cfc: cfcomponent displayname=Microsoft SQL Server Component hint=This component contains all Microsoft SQL Server database access code. style=RPC output=Yes cfset msg = !--- Security Authentication --- cffunction name=login access=public description=Logs in user. output=No returntype=query cfargument name=username required=Yes type=string default= cfargument name=password required=no type=string default= cfstoredproc procedure=spAuthenticateUser datasource=#request.app.dsname# returncode=Yes cfprocparam type=In cfsqltype=CF_SQL_VARCHAR dbvarname=username value=#arguments.username# null=No cfprocparam type=In cfsqltype=CF_SQL_VARCHAR dbvarname=password value=#arguments.password# null=No cfprocresult name=loginQuery resultset=1 /cfstoredproc cfreturn loginQuery /cffunction /cfcomponent Anything obvious that I'm doing wrong? The methods all work perfectly, so I'm pretty sure it's not my code. I'm using MX7 on WinXP/IIS. Thanks, Pete ~| Message: http://www.houseoffusion.com/lists.cfm/link=i:4:238264 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: CFC documentation not being displayed
Yes, it's on my local workstation. On 4/20/06, Ryan Guill [EMAIL PROTECTED] wrote: Do you have access to the cfide? In other words, can you get to the administrator? You must have the cfide available to get to that documentation I believe. ~| Message: http://www.houseoffusion.com/lists.cfm/link=i:4:238265 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
RE: CFC documentation not being displayed
I am not very familiar with the CFC doc viewer, but I believe it runs through CF Administrator. Try logging into CFAdmin first, then view the CFC. See if that helps. ... Ben Nadel www.bennadel.com ~| Message: http://www.houseoffusion.com/lists.cfm/link=i:4:238266 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: CFC documentation not being displayed
I logged in to cfadmin and then browsed to the CFC, still no dice. On 4/20/06, Ben Nadel [EMAIL PROTECTED] wrote: I am not very familiar with the CFC doc viewer, but I believe it runs through CF Administrator. Try logging into CFAdmin first, then view the CFC. See if that helps. ... Ben Nadel www.bennadel.com ~| Message: http://www.houseoffusion.com/lists.cfm/link=i:4:238269 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: CFC documentation not being displayed
you should get either the admin password screen or if no password on localhost it should change the url to something like http://localhost/CFIDE/componentutils/cfcexplorer.cfc?method=getcfcinhtmlname=yourdotnotation.yourcfcpath=/yourpath/yourcfc.cfc On 4/20/06, Pete Ruckelshaus [EMAIL PROTECTED] wrote: I logged in to cfadmin and then browsed to the CFC, still no dice. On 4/20/06, Ben Nadel [EMAIL PROTECTED] wrote: I am not very familiar with the CFC doc viewer, but I believe it runs through CF Administrator. Try logging into CFAdmin first, then view the CFC. See if that helps. ... Ben Nadel www.bennadel.com ~| Message: http://www.houseoffusion.com/lists.cfm/link=i:4:238280 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: CFC documentation not being displayed
Michael, I just tried that, but no dice. Threw an error, looked like it was trying to pass me to the componentexplorer and told me that my method doesn't exist. However, after poking around a bit, I was able to see it listed in http://localhost/CFIDE/componentutils/componentdetail.cfm and was able to link to my CFC, which worked fine. Go figure. Thanks Pete On 4/20/06, Michael Traher [EMAIL PROTECTED] wrote: you should get either the admin password screen or if no password on localhost it should change the url to something like http://localhost/CFIDE/componentutils/cfcexplorer.cfc?method=getcfcinhtmlname=yourdotnotation.yourcfcpath=/yourpath/yourcfc.cfc On 4/20/06, Pete Ruckelshaus [EMAIL PROTECTED] wrote: I logged in to cfadmin and then browsed to the CFC, still no dice. On 4/20/06, Ben Nadel [EMAIL PROTECTED] wrote: I am not very familiar with the CFC doc viewer, but I believe it runs through CF Administrator. Try logging into CFAdmin first, then view the CFC. See if that helps. ... Ben Nadel www.bennadel.com ~| Message: http://www.houseoffusion.com/lists.cfm/link=i:4:238301 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
RE: CFEclipse - Good Beginner documentation.
Nathan, Your site is easy to read. Rob's videos are great. I never found out about them before because youtube is blocked at work by our corporate security team. I looked at them at home. Just what I needed. What I originally was looking for was something like Rob's videos only in document form. Sometimes it is just easier when you work full time (60+ hours a week), go to school full time (12 credit hours and yes I know that is the minimum for full time school!), have a family (two wonderful little boys ages 2 and 4 and a wonderful wife), and you still want to push forward in your craft, to just have something you can print out and read as you have a spare minute. [Wow was that a big run on sentence or what] Thanks for the help. Steve -Original Message- From: Nathan Strutz [mailto:[EMAIL PROTECTED] Sent: Monday, January 30, 2006 12:08 PM To: CF-Talk Subject: Re: CFEclipse - Good Beginner documentation. I thought my page was pretty easy to read: http://www.dopefly.com/pages/cfeclipse.cfm Also, Rob's got some videos, on the right column of his blog, in an iframe. http://www.robrohan.com/client/ -nathan strutz http://www.dopefly.com/ On 1/30/06, DURETTE, STEVEN J (AIT) [EMAIL PROTECTED] wrote: All, I have considered using CFEclipse in the past. Even installed it once, but I couldn't find any tutorials or such that could get me up and running quickly. Recently I decided to try again. I have Eclipse and the CFEclipse plug-in installed. Are there any good beginner tutorials out there? Last time I tried it looked like everything was... Go through all of the tutorials built into Eclipse, then come back and find out about CFEclipse. Also, a lot of the docs were in help file format that I saw. I generally print out tutorials, read them as I have a chance (sitting at the Dr. office etc) and then try out the stuff I read in the tutorial. Help file format generally means REAMS of paper or being tied to a computer. If CFEclipse really wants to pick up speed, I think more beginner tutorials need to be out there. Thanks, Steve ~| Message: http://www.houseoffusion.com/lists.cfm/link=i:4:230819 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
CFEclipse - Good Beginner documentation.
All, I have considered using CFEclipse in the past. Even installed it once, but I couldn't find any tutorials or such that could get me up and running quickly. Recently I decided to try again. I have Eclipse and the CFEclipse plug-in installed. Are there any good beginner tutorials out there? Last time I tried it looked like everything was... Go through all of the tutorials built into Eclipse, then come back and find out about CFEclipse. Also, a lot of the docs were in help file format that I saw. I generally print out tutorials, read them as I have a chance (sitting at the Dr. office etc) and then try out the stuff I read in the tutorial. Help file format generally means REAMS of paper or being tied to a computer. If CFEclipse really wants to pick up speed, I think more beginner tutorials need to be out there. Thanks, Steve ~| Message: http://www.houseoffusion.com/lists.cfm/link=i:4:230732 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: CFEclipse - Good Beginner documentation.
I thought my page was pretty easy to read: http://www.dopefly.com/pages/cfeclipse.cfm Also, Rob's got some videos, on the right column of his blog, in an iframe. http://www.robrohan.com/client/ -nathan strutz http://www.dopefly.com/ On 1/30/06, DURETTE, STEVEN J (AIT) [EMAIL PROTECTED] wrote: All, I have considered using CFEclipse in the past. Even installed it once, but I couldn't find any tutorials or such that could get me up and running quickly. Recently I decided to try again. I have Eclipse and the CFEclipse plug-in installed. Are there any good beginner tutorials out there? Last time I tried it looked like everything was... Go through all of the tutorials built into Eclipse, then come back and find out about CFEclipse. Also, a lot of the docs were in help file format that I saw. I generally print out tutorials, read them as I have a chance (sitting at the Dr. office etc) and then try out the stuff I read in the tutorial. Help file format generally means REAMS of paper or being tied to a computer. If CFEclipse really wants to pick up speed, I think more beginner tutorials need to be out there. Thanks, Steve ~| Message: http://www.houseoffusion.com/lists.cfm/link=i:4:230753 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
PayPal documentation
Hello, I am passing the aggregated shopping cart amount to PayPal as a payment option from our shopping cart. What I wanted to know is if anyone out there could email me a list of the variables that are returned from PayPal. Back in the old days, I used to get back from PayPal (after the payment was made) txn_id (transaction id), payment_status, and invoice number, etc. that I could then capture and put onto the order for the store owner. Txn_id no longer exists and I cannot seem to locate (quickly) documentation that tells me what the new variables are coming back. My day has come to a grinding halt. I haven't worked on a PayPal interface in years, so take it easy on me. Thanks for helping out a rookie. Nick ~| Discover CFTicket - The leading ColdFusion Help Desk and Trouble Ticket application http://www.houseoffusion.com/banners/view.cfm?bannerid=48 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:215775 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
CF code documentation . . . JavaDoc?
Hello all, I was wondering if anyone could recommend a documentation package that is similar to JavaDoc (uses JavaDoc tag standard)? Thanks! -- -chris.alvarado [application developer] ~| Logware (www.logware.us): a new and convenient web-based time tracking application. Start tracking and documenting hours spent on a project or with a client with Logware today. Try it for free with a 15 day trial account. http://www.houseoffusion.com/banners/view.cfm?bannerid=67 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:211023 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: CF code documentation . . . JavaDoc?
If you write a lot of CFCs Spikes cfcdoc tool is very cool http://spike.org.uk/projects/cfcdoc/ For static cfm stuff you can try NaturalDoc http://naturaldocs.org/ works well for most other languages and coldfusion is listed as supported (I've used naturaldoc with vb.net and javascript with much success) - requires perl On 7/1/05, chris.alvarado [EMAIL PROTECTED] wrote: Hello all, I was wondering if anyone could recommend a documentation package that is similar to JavaDoc (uses JavaDoc tag standard)? Thanks! -- -chris.alvarado [application developer] ~| Discover CFTicket - The leading ColdFusion Help Desk and Trouble Ticket application http://www.houseoffusion.com/banners/view.cfm?bannerid=48 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:211039 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: framework documentation (was Re: mach II or fusebox?)
onTap probably has the most comprehensive documentation of any of the frameworks out there. Thank you Sean, I really appreciate that... Just as an aside, they really are great docs. Good job Isaac, and thanks for setting an example for the rest of us to try to follow. -- Get Glued! The Model-Glue ColdFusion Framework http://www.model-glue.com ~| Discover CFTicket - The leading ColdFusion Help Desk and Trouble Ticket application http://www.houseoffusion.com/banners/view.cfm?bannerid=48 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:209930 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: framework documentation (was Re: mach II or fusebox?)
onTap probably has the most comprehensive documentation of any of the frameworks out there. Thank you Sean, I really appreciate that... Just as an aside, they really are great docs. Good job Isaac, and thanks for setting an example for the rest of us to try to follow. Thanks Joe, I appreciate that, especially coming from another framework author. :) One of these days I need to get around to adding MG and FarCry to the framework comparison chart (it'll be a poster eventually)... just haven't found the time to get a close enough look at them (since the original experiment) to evaluate their features. So much time and so little to do... wait... strike that, reverse it s. isaac dealey 954.522.6080 new epoch : isn't it time for a change? add features without fixtures with the onTap open source framework http://www.fusiontap.com http://coldfusion.sys-con.com/author/4806Dealey.htm ~| Logware (www.logware.us): a new and convenient web-based time tracking application. Start tracking and documenting hours spent on a project or with a client with Logware today. Try it for free with a 15 day trial account. http://www.houseoffusion.com/banners/view.cfm?bannerid=67 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:209933 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
framework documentation (was Re: mach II or fusebox?)
onTap probably has the most comprehensive documentation of any of the frameworks out there. Check out http://www.fusiontap.com/ for articles about onTap and other frameworks, tutorials, forums and so on. No matter what anyone might think of the actual framework / architecture, the supporting website really puts Fusebox, Mach II and Model-Glue to shame (no offence intended to any of those folks). Thank you Sean, I really appreciate that... It's ironic because the public site isn't kept up to date nearly as much as I'd like. Most of the site is the core framework documentation actually, which is included with the download, and the core code (including the documentation) has been updated more than the public site, so the public site is actually somewhat out of date... This stems from my not getting around to addressing upgrading the public site to the latest version of the core code, partly due to recent revisions of the member management plugin, which are now almost complete. The forum application also needs a revision to accomodate the member management changes, and of course, I haven't even begun on that yet. In an ideal world the framework will would already have upgrade installers for things like the member management plugin and the forum plugin to upgrade them to the latest version. Unfortunately I haven't had the time to address those yet. It is definately a plan for the future for that to happen so that it will be easier for myself (and others) to keep those things updated with the latest versions, and the framework itself is designed in large part to help facilitate that, it's just a matter of time. Although now that we're 2 major versions beyond CF5 I have to admit also that I'm a bit torn regarding what to do with the plugin manager. The way it's designed right now getting information about the available plugins currently is done with framework processes (because it was designed originally to be CF5 compatible), but changing it to use CFC's to return that data would be much more efficient. For the vast majority of pages this isn't an issue -- the only place where the efficiency would even be noticed is in the add/remove plugins index page and in the documentation menu (where it appends plugins to the tree), and updating it to use CFC's of course would force me to drop CF5 support for any of the plugins. Not that I'm necessarily averse to dropping CF5 support all-together, but it would mean another immediate revision of the Members onTap plugin which I'm just finishing a revision of now. So at least for the moment I'm inclined to leave it the way it is (because I've got other things to work on)... though I suppose if I'm going to make that change to the plugin manager it should be done sooner than later so that fewer plugins need to be modified... Though I suppose I could design it to transition gracefully so that the CFC is used only if it's available (both server version and file existence). Boy I am distracted today... getting way off-topic... s. isaac dealey 954.522.6080 new epoch : isn't it time for a change? add features without fixtures with the onTap open source framework http://www.fusiontap.com http://coldfusion.sys-con.com/author/4806Dealey.htm ~| Logware (www.logware.us): a new and convenient web-based time tracking application. Start tracking and documenting hours spent on a project or with a client with Logware today. Try it for free with a 15 day trial account. http://www.houseoffusion.com/banners/view.cfm?bannerid=67 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:209878 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
French CF documentation
Hi all, Some months ago, someone on this list was looking for french CF ressources.. I was woundering if he found some because we have som issue with CF and verity on the french side of our site and would like to read some docs on it.. english docs is quite ok for what we need but we are looking for the french counterpart of it. Thanks Pat ~| Logware (www.logware.us): a new and convenient web-based time tracking application. Start tracking and documenting hours spent on a project or with a client with Logware today. Try it for free with a 15 day trial account. http://www.houseoffusion.com/banners/view.cfm?bannerid=67 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:206598 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
ColdFusion App Documentation For Sys Admins
Does anyone have, or has anyone seen, a template or database for documenting ColdFusion applications from a system administrator standpoint? It would track elements such as which databases the application needs, which network resources the application accesses, security considerations, the primary contact for the application in case there is a problem, etc. Thank you, Mike Chabot ~| Logware (www.logware.us): a new and convenient web-based time tracking application. Start tracking and documenting hours spent on a project or with a client with Logware today. Try it for free with a 15 day trial account. http://www.houseoffusion.com/banners/view.cfm?bannerid=67 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:203876 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: Documentation Bug in GetCurrentTemplatePath()?
Well as far as I'm aware it's been this way since the release of ColdFusion MX and I'd be surprised if they changed it in 7 -- I think it was actually intentional... the reason being that if you were to use cfinclude or cfmodule inside of a function created with the cffunction tag, the relative path to the included template or module must be relative to the template containing the cffunction tag. I personally still think getCurrentTemplatePath() should return the path to the currently executing template (instead of the function template), but I suspect relative paths for cfinclude / cfmodule have something to do with why it produces that result. At this point there's a fair amount of code in use which observes the difference, so fixing it would require many of us to modify our existing code to check the version of CF to determine behavior. I would be okay with that (although I might not like it), though some people might be miffed. Actually I take that back -- if by fixing you mean making it always return the path to the template in which the function is declared (not called), then I'd be pretty royally upset over it -- because I can't think of another way to generate that information (which is vitally important to my code) if the behavior were changed in that direction. Ha, okay, I'll let it be. I'll settle for fixing the documentation, instead. ;-) Thanks, Jamie ~| Discover CFTicket - The leading ColdFusion Help Desk and Trouble Ticket application http://www.houseoffusion.com/banners/view.cfm?bannerid=48 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:202608 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: Documentation Bug in GetCurrentTemplatePath()?
The value of GetBaseTemplatePath() should exhibit the behavior you're saying you're getting from GetCurrentTemplatePath() when called from within Application.cfm... Yes, and the base template is the one that you see in the URL, correct? However... getCurrentTemplatePath() will provide varried behavior when it is called within a function -- when called within a function created using cffunction it returns the path to the template containing the cffunction tag. When called within a function created using cfscript it returns the template in which the function is called. Personally I think this is insane, but that's the way it is -- I suspect it's intended for CFC's. You aren't by any chance creating a function which called getCurrentTemplatePath() and then calling that function? Maybe in a CFC? Well, I'm quite glad that you knew this quirk, and replied to my message! The UDF containing the call to getCurrentTemplatePath() is indeed in cfscript (in my Application.cfm), and that UDF is indeed being called externally (sometimes). I guess that's why it was reporting the caller of the UDF instead of the caller to getCurrentTemplatePath(). I have to agree that this is insane, if it's not a bug. Does this quirk still exist in CFMX7? (I'm still on 6.1.) However, you're saying if I use cffunction for the function that calls getCurrentTemplatePath(), then it'll behave as desired? That's a pretty good workaround until getCurrentTemplatePath() starts to work properly in all contexts. No, expandPath() isn't, has never been and will never be a reliable means of determining the absolute path to any file Application.cfm or otherwise, because it expands the path from the base template -- imo pretty much useless. Got it! Thanks, Jamie ~| Logware (www.logware.us): a new and convenient web-based time tracking application. Start tracking and documenting hours spent on a project or with a client with Logware today. Try it for free with a 15 day trial account. http://www.houseoffusion.com/banners/view.cfm?bannerid=67 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:202486 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: Documentation Bug in GetCurrentTemplatePath()?
[my last post had some stuff stripped out of it (by the HoF posting mechanism?) trying again] -The value of GetBaseTemplatePath() should exhibit the behavior you're -saying you're getting from GetCurrentTemplatePath() when called from -within Application.cfm... Yes, and the base template is the one that you see in the URL, correct? -However... getCurrentTemplatePath() will provide varried behavior when -it is called within a function -- when called within a function -created using cffunction it returns the path to the template -containing the cffunction tag. When called within a function created -using cfscript it returns the template in which the function is -called. Personally I think this is insane, but that's the way it is -- -I suspect it's intended for CFC's. -You aren't by any chance creating a function which called -getCurrentTemplatePath() and then calling that function? Maybe in a -CFC? Well, I'm quite glad that you knew this quirk, and replied to my message! The function containing the call to getCurrentTemplatePath() is indeed in cfscript (in my Application.cfm), and that function is indeed being called externally (sometimes). I guess that's why it was reporting the *indirect* caller of getCurrentTemplatePath(). I have to agree that this is insane, if it's not a bug. Does this quirk still exist in CFMX7? (I'm still on 6.1.) However, you're saying if I use cffunction for the function that calls getCurrentTemplatePath(), then it'll behave as desired? That's a pretty good workaround until getCurrentTemplatePath() starts to work properly in all contexts. -No, expandPath() isn't, has never been and will never be a reliable -means of determining the absolute path to any file Application.cfm or -otherwise, because it expands the path from the base template -- imo -pretty much useless. Got it! Thanks, Jamie ~| Logware (www.logware.us): a new and convenient web-based time tracking application. Start tracking and documenting hours spent on a project or with a client with Logware today. Try it for free with a 15 day trial account. http://www.houseoffusion.com/banners/view.cfm?bannerid=67 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:202488 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: Documentation Bug in GetCurrentTemplatePath()?
-Yes, my reading of the docs agree that if you call -getCurrentTemplatePath() inside Application.cfm, it should return the -path of that Application.cfm file. Okay, S. Isaac seems to suggest that it misbehaves when: An external template calls a cfscript-defined UDF that, in turn, calls getCurrentTemplatePath(). It turns out that the caller of the *UDF* has *its* path reported. He notes that it doesn't behave this way when the UDF is defined in cffunction. I guess I'll send in a bug report, and make a note in the livedocs (of 6.1, and CFMX7 too, if it's confirmed that it still happens there). Thanks for both of your replies, Jamie ~| Find out how CFTicket can increase your company's customer support efficiency by 100% http://www.houseoffusion.com/banners/view.cfm?bannerid=49 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:202489 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: Documentation Bug in GetCurrentTemplatePath()?
-Yes, my reading of the docs agree that if you call -getCurrentTemplatePath() inside Application.cfm, it should return the -path of that Application.cfm file. Okay, S. Isaac seems to suggest that it misbehaves when: An external template calls a cfscript-defined UDF that, in turn, calls getCurrentTemplatePath(). It turns out that the caller of the *UDF* has *its* path reported. He notes that it doesn't behave this way when the UDF is defined in cffunction. I guess I'll send in a bug report, and make a note in the livedocs (of 6.1, and CFMX7 too, if it's confirmed that it still happens there). Thanks for both of your replies, Jamie Well as far as I'm aware it's been this way since the release of ColdFusion MX and I'd be surprised if they changed it in 7 -- I think it was actually intentional... the reason being that if you were to use cfinclude or cfmodule inside of a function created with the cffunction tag, the relative path to the included template or module must be relative to the template containing the cffunction tag. I personally still think getCurrentTemplatePath() should return the path to the currently executing template (instead of the function template), but I suspect relative paths for cfinclude / cfmodule have something to do with why it produces that result. At this point there's a fair amount of code in use which observes the difference, so fixing it would require many of us to modify our existing code to check the version of CF to determine behavior. I would be okay with that (although I might not like it), though some people might be miffed. Actually I take that back -- if by fixing you mean making it always return the path to the template in which the function is declared (not called), then I'd be pretty royally upset over it -- because I can't think of another way to generate that information (which is vitally important to my code) if the behavior were changed in that direction. s. isaac dealey 954.522.6080 new epoch : isn't it time for a change? add features without fixtures with the onTap open source framework http://macromedia.breezecentral.com/p49777853/ http://www.sys-con.com/author/?id=4806 http://www.fusiontap.com ~| Logware (www.logware.us): a new and convenient web-based time tracking application. Start tracking and documenting hours spent on a project or with a client with Logware today. Try it for free with a 15 day trial account. http://www.houseoffusion.com/banners/view.cfm?bannerid=67 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:202511 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Documentation Bug in GetCurrentTemplatePath()?
The documentation claims that GetCurrentTemplatePath() returns The absolute path of the page that contains the call to this function, as a string. This is probably true of most callers, but it's not true when Application.cfm is the calling page. The returned path varies, depending upon which page implicitly includes Application.cfm. So, two questions: 1. Shouldn't there be a note in the docs that explains the behaviour of this method when called from Application.cfm? 2. Is expandPath(./) a reliable means of determining the Application.cfm's absolute path? If so, is it cross-platform? If not, what is? Thanks, Jamie ~| Logware (www.logware.us): a new and convenient web-based time tracking application. Start tracking and documenting hours spent on a project or with a client with Logware today. Try it for free with a 15 day trial account. http://www.houseoffusion.com/banners/view.cfm?bannerid=67 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:202315 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: Documentation Bug in GetCurrentTemplatePath()?
The documentation claims that GetCurrentTemplatePath() returns The absolute path of the page that contains the call to this function, as a string. This is probably true of most callers, but it's not true when Application.cfm is the calling page. The returned path varies, depending upon which page implicitly includes Application.cfm. So, two questions: 1. Shouldn't there be a note in the docs that explains the behaviour of this method when called from Application.cfm? 2. Is expandPath(./) a reliable means of determining the Application.cfm's absolute path? If so, is it cross-platform? If not, what is? If the value returned by getCurrentTemplatePath() ever changes from Application.cfm, that's a bug. The value of GetBaseTemplatePath() should exhibit the behavior you're saying you're getting from GetCurrentTemplatePath() when called from within Application.cfm... However... getCurrentTemplatePath() will provide varried behavior when it is called within a function -- when called within a function created using cffunction it returns the path to the template containing the cffunction tag. When called within a function created using cfscript it returns the template in which the function is called. Personally I think this is insane, but that's the way it is -- I suspect it's intended for CFC's. You aren't by any chance creating a function which called getCurrentTemplatePath() and then calling that function? Maybe in a CFC? No, expandPath() isn't, has never been and will never be a reliable means of determining the absolute path to any file Application.cfm or otherwise, because it expands the path from the base template -- imo pretty much useless. s. isaac dealey 954.522.6080 new epoch : isn't it time for a change? add features without fixtures with the onTap open source framework http://macromedia.breezecentral.com/p49777853/ http://www.sys-con.com/author/?id=4806 http://www.fusiontap.com ~| Discover CFTicket - The leading ColdFusion Help Desk and Trouble Ticket application http://www.houseoffusion.com/banners/view.cfm?bannerid=48 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:202316 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: Documentation Bug in GetCurrentTemplatePath()?
On Apr 11, 2005 4:01 PM, S. Isaac Dealey [EMAIL PROTECTED] wrote: 2. Is expandPath(./) a reliable means of determining the Application.cfm's absolute path? If so, is it cross-platform? If not, what is? expandPath(./) will return the full filesystem path of the directory containing the file requested in the URL (regardless of which file you are currently executing). That's how Mach II, amongst others, figures out where to find the config file, based on your index.cfm file, even tho' expandPath() is called from /MachII/mach-ii.cfm. So it will never be able to tell you where Application.cfm is. If the value returned by getCurrentTemplatePath() ever changes from Application.cfm, that's a bug. Yes, my reading of the docs agree that if you call getCurrentTemplatePath() inside Application.cfm, it should return the path of that Application.cfm file. -- Sean A Corfield -- http://corfield.org/ Team Fusebox -- http://fusebox.org/ Got Gmail? -- I have 50, yes 50, invites to give away! If you're not annoying somebody, you're not really alive. -- Margaret Atwood ~| Logware (www.logware.us): a new and convenient web-based time tracking application. Start tracking and documenting hours spent on a project or with a client with Logware today. Try it for free with a 15 day trial account. http://www.houseoffusion.com/banners/view.cfm?bannerid=67 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:202321 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
CFC Documentation - document private variables?
I'm working on a doc generator for my CFC implementation and just want an opinion: Should private variables be documented? Right now I've got three Access types for properties: Public: These properties exist in the this scope. They can be accessed publicly or via special generic getter/setter functions (or, of course, via custom getter/setters). These are open, public properties Abstract: These properties exist in the variables scope. They are defined in my system such that they can be accessed via the generic getter/setter functions (or, of course, via custom getter/setters). In other words they're public (sort of) but abstracted via getter/setter methods. Static: These properties exist in the variables scope. They are defined such that they can accessed via the generic getter but NOT the generic setter. (Of course there's no way to stop you from building a custom setter. Also Static structs or queries, being passed by reference are also updatable outside the component instance.) These are read-only properties (as long as you don't create a custom setter). They are abstracted through the generic getter method but no the setter. I'm considering adding Private which would also be in the variables scope but would not be accessible by the generic getter/setter at all. However they would be available to ancestor components. These would be useful really only for documentation. Also many of them are not available until the component init() method has been run (so if and extended component failed to run super.init() then they might not be available at all). If you were reading documentation on CFCs, would you want to see them or not? I've already made the decision to display private methods in the docs (as they're definitely available and useful to ancestors) but I'm torn about private properties... (Please note that I'm not very familiar with Java either - I think that the names I've choosen are close to their Java meanings - or not in conflict at all - but I'm not sure. If the access names used strike you as really stupid please recommend something different... I spent way too long trying to come up with descriptive labels for this stuff. ;^) ) Jim Davis ~| Logware (www.logware.us): a new and convenient web-based time tracking application. Start tracking and documenting hours spent on a project or with a client with Logware today. Try it for free with a 15 day trial account. http://www.houseoffusion.com/banners/view.cfm?bannerid=67 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:199381 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
RE: CFC Documentation - document private variables?
I document all variables with notes if they are: Public (this) Private to the CFC (variables) Private to a method (var within a cffunction). Arguments Environmental - (usually just CGI but also Url and Form when specified) I like your concept of Abstract and would include a private as you've defined it. I'm working on a doc generator for my CFC implementation and just want an opinion: Should private variables be documented? Right now I've got three Access types for properties: Public: These properties exist in the this scope. They can be accessed publicly or via special generic getter/setter functions (or, of course, via custom getter/setters). These are open, public properties Abstract: These properties exist in the variables scope. They are defined in my system such that they can be accessed via the generic getter/setter functions (or, of course, via custom getter/setters). In other words they're public (sort of) but abstracted via getter/setter methods. Static: These properties exist in the variables scope. They are defined such that they can accessed via the generic getter but NOT the generic setter. (Of course there's no way to stop you from building a custom setter. Also Static structs or queries, being passed by reference are also updatable outside the component instance.) These are read-only properties (as long as you don't create a custom setter). They are abstracted through the generic getter method but no the setter. I'm considering adding Private which would also be in the variables scope but would not be accessible by the generic getter/setter at all. However they would be available to ancestor components. These would be useful really only for documentation. Also many of them are not available until the component init() method has been run (so if and extended component failed to run super.init() then they might not be available at all). If you were reading documentation on CFCs, would you want to see them or not? I've already made the decision to display private methods in the docs (as they're definitely available and useful to ancestors) but I'm torn about private properties... (Please note that I'm not very familiar with Java either - I think that the names I've choosen are close to their Java meanings - or not in conflict at all - but I'm not sure. If the access names used strike you as really stupid please recommend something different... I spent way too long trying to come up with descriptive labels for this stuff. ;^) ) Jim Davis ~| Discover CFTicket - The leading ColdFusion Help Desk and Trouble Ticket application http://www.houseoffusion.com/banners/view.cfm?bannerid=48 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:199383 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: CFC Documentation - document private variables?
You probably already know about this but spike has a really cool tool called cfcdoc that scans your cfcs and make documentation for them. It even works real time IIRC http://www.spike.org.uk/projects/cfcdoc/ On Fri, 18 Mar 2005 13:42:56 -0500, Michael Dinowitz [EMAIL PROTECTED] wrote: I document all variables with notes if they are: Public (this) Private to the CFC (variables) Private to a method (var within a cffunction). Arguments Environmental - (usually just CGI but also Url and Form when specified) I like your concept of Abstract and would include a private as you've defined it. I'm working on a doc generator for my CFC implementation and just want an opinion: Should private variables be documented? Right now I've got three Access types for properties: Public: These properties exist in the this scope. They can be accessed publicly or via special generic getter/setter functions (or, of course, via custom getter/setters). These are open, public properties Abstract: These properties exist in the variables scope. They are defined in my system such that they can be accessed via the generic getter/setter functions (or, of course, via custom getter/setters). In other words they're public (sort of) but abstracted via getter/setter methods. Static: These properties exist in the variables scope. They are defined such that they can accessed via the generic getter but NOT the generic setter. (Of course there's no way to stop you from building a custom setter. Also Static structs or queries, being passed by reference are also updatable outside the component instance.) These are read-only properties (as long as you don't create a custom setter). They are abstracted through the generic getter method but no the setter. I'm considering adding Private which would also be in the variables scope but would not be accessible by the generic getter/setter at all. However they would be available to ancestor components. These would be useful really only for documentation. Also many of them are not available until the component init() method has been run (so if and extended component failed to run super.init() then they might not be available at all). If you were reading documentation on CFCs, would you want to see them or not? I've already made the decision to display private methods in the docs (as they're definitely available and useful to ancestors) but I'm torn about private properties... (Please note that I'm not very familiar with Java either - I think that the names I've choosen are close to their Java meanings - or not in conflict at all - but I'm not sure. If the access names used strike you as really stupid please recommend something different... I spent way too long trying to come up with descriptive labels for this stuff. ;^) ) Jim Davis ~| Discover CFTicket - The leading ColdFusion Help Desk and Trouble Ticket application http://www.houseoffusion.com/banners/view.cfm?bannerid=48 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:199388 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
RE: CFC Documentation - document private variables?
I've emailed Spike with some alterations/improvements to it (mainly regex) and he said that others have added to it as well and he's behind in updating it. Expect an open source version to be posted by him as soon as he gets a moment (at least that's what I remember from his email). There was a thread on this a week or three back about documenting method access and the like. This was before my 3 hour CFC-OO presentation. :) Now that I have to post. You probably already know about this but spike has a really cool tool called cfcdoc that scans your cfcs and make documentation for them. It even works real time IIRC http://www.spike.org.uk/projects/cfcdoc/ ~| Find out how CFTicket can increase your company's customer support efficiency by 100% http://www.houseoffusion.com/banners/view.cfm?bannerid=49 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:199390 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
RE: CFC Documentation - document private variables?
-Original Message- From: Rob [mailto:[EMAIL PROTECTED] Sent: Friday, March 18, 2005 2:17 PM To: CF-Talk Subject: Re: CFC Documentation - document private variables? You probably already know about this but spike has a really cool tool called cfcdoc that scans your cfcs and make documentation for them. It even works real time IIRC http://www.spike.org.uk/projects/cfcdoc/ Yes - and it's very impressive. I've just never really liked the JavaDoc style and many aspect of my CFCs aren't represented by it. One thing, at least: my property definitions would never show up. Also my broker components and such would never be referenced. Besides - just because somebody's made a perfectly good wheel doesn't mean you can't make a... well... perfectly good wheel. ;^) All of my CFCs extend a common root component. I'd like that root component to be able to collect meta data from itself and construct an XML packet representing all of the documentation elements. Then I can apply whatever formatting to that packet I like. In the end this will only really work for CFCs created in my style but for those CFCs it will offer (I hope!) a lot more information. Spike's code is obviously much more versatile in that it can do any CFC at all - but that's just not what I'm looking for right now. Jim Davis ~| Logware (www.logware.us): a new and convenient web-based time tracking application. Start tracking and documenting hours spent on a project or with a client with Logware today. Try it for free with a 15 day trial account. http://www.houseoffusion.com/banners/view.cfm?bannerid=67 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:199392 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
RE: CFC Documentation - document private variables?
-Original Message- From: Michael Dinowitz [mailto:[EMAIL PROTECTED] Sent: Friday, March 18, 2005 2:25 PM To: CF-Talk Subject: RE: CFC Documentation - document private variables? I've emailed Spike with some alterations/improvements to it (mainly regex) and he said that others have added to it as well and he's behind in updating it. Expect an open source version to be posted by him as soon as he gets a moment (at least that's what I remember from his email). There was a thread on this a week or three back about documenting method access and the like. This was before my 3 hour CFC-OO presentation. :) Now that I have to post. I don't think it was recent - but Spike's thingie has always been open source from what I remember. I know it has been for the past 6 months or so at least. Jim Davis ~| Discover CFTicket - The leading ColdFusion Help Desk and Trouble Ticket application http://www.houseoffusion.com/banners/view.cfm?bannerid=48 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:199393 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: CFC Documentation - document private variables?
Well then, there are a couple other projects that show promise for documenting one by Apple called headerdoc (which I really like) and one on sourceforge called naturaldoc. Neither work really well with CF today, but both are open source and would at least provide a bit of a base and some of what you want is probably already done. Sadly, they are both in Perl though (sadly only because I don't know perl). http://www.naturaldocs.org/ (some cf support) http://developer.apple.com/darwin/projects/headerdoc/ Hope those help a bit On Fri, 18 Mar 2005 14:34:20 -0500, Jim Davis [EMAIL PROTECTED] wrote: -Original Message- From: Rob [mailto:[EMAIL PROTECTED] Sent: Friday, March 18, 2005 2:17 PM To: CF-Talk Subject: Re: CFC Documentation - document private variables? You probably already know about this but spike has a really cool tool called cfcdoc that scans your cfcs and make documentation for them. It even works real time IIRC http://www.spike.org.uk/projects/cfcdoc/ Yes - and it's very impressive. I've just never really liked the JavaDoc style and many aspect of my CFCs aren't represented by it. One thing, at least: my property definitions would never show up. Also my broker components and such would never be referenced. Besides - just because somebody's made a perfectly good wheel doesn't mean you can't make a... well... perfectly good wheel. ;^) All of my CFCs extend a common root component. I'd like that root component to be able to collect meta data from itself and construct an XML packet representing all of the documentation elements. Then I can apply whatever formatting to that packet I like. In the end this will only really work for CFCs created in my style but for those CFCs it will offer (I hope!) a lot more information. Spike's code is obviously much more versatile in that it can do any CFC at all - but that's just not what I'm looking for right now. Jim Davis ~| Logware (www.logware.us): a new and convenient web-based time tracking application. Start tracking and documenting hours spent on a project or with a client with Logware today. Try it for free with a 15 day trial account. http://www.houseoffusion.com/banners/view.cfm?bannerid=67 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:199430 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
User Documentation - Any suggestions?
We're trying to come up with a better way to document how our web application works for our end users. Can anyone suggest a good tool or software I should look at for creating and maintaining end user documentation? Jon ~| Purchase Homesite Plus with Dreamweaver from House of Fusion, a Macromedia Authorized Affiliate and support the CF community. http://www.houseoffusion.com/banners/view.cfm?bannerid=55 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:190451 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
RE: User Documentation - Any suggestions?
Captivate and RoboHelp come to mind... both Macromedia products. -Original Message- From: Jon Block [mailto:[EMAIL PROTECTED] Sent: Friday, January 14, 2005 10:42 AM To: CF-Talk Subject: User Documentation - Any suggestions? We're trying to come up with a better way to document how our web application works for our end users. Can anyone suggest a good tool or software I should look at for creating and maintaining end user documentation? Jon ~| Flash for programmers - Flash MX Pro http://www.houseoffusion.com/banners/view.cfm?bannerid=56 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:190453 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: User Documentation - Any suggestions?
I've been working on using simple UML activity diagrams for that purpose. Depends on what document how our web application works actually means. What exactly is it that you're trying to communicate to them? Laterz, J -- Continuum Media Group LLC Burnsville, MN 55337 http://www.web-relevant.com On Fri, 14 Jan 2005 10:42:09 -0500, Jon Block [EMAIL PROTECTED] wrote: We're trying to come up with a better way to document how our web application works for our end users. Can anyone suggest a good tool or software I should look at for creating and maintaining end user documentation? Jon ~| Discover CFTicket - The leading ColdFusion Help Desk and Trouble Ticket application http://www.houseoffusion.com/banners/view.cfm?bannerid=48 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:190468 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
RE: User Documentation - Any suggestions?
Jon, My recommendation is to build it right into your application. Any other form tends not be used or kept current. If your site has content mgmt already included, this can be used for field, screen and task level documentation. Since you will have to add the links to your app anyway, the actual page maintenance doesn't need to be a separate app. My 2 cents. If I deserve change back, so be it. Andy -Original Message- From: Jon Block We're trying to come up with a better way to document how our web application works for our end users. Can anyone suggest a good tool or software I should look at for creating and maintaining end user documentation? Jon ~| Find out how CFTicket can increase your company's customer support efficiency by 100% http://www.houseoffusion.com/banners/view.cfm?bannerid=49 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:190472 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: User Documentation - Any suggestions?
This is exactly what I'm doing in BlogFusion 4... rather than creating big sets of help docs, I'm actually putting page specific help on the bottom of each page. Jake countersinkdg.com Jon, My recommendation is to build it right into your application. Any other form tends not be used or kept current. If your site has content mgmt already included, this can be used for field, screen and task level documentation. Since you will have to add the links to your app anyway, the actual page maintenance doesn't need to be a separate app. My 2 cents. If I deserve change back, so be it. Andy -Original Message- From: Jon Block We're trying to come up with a better way to document how our web application works for our end users. Can anyone suggest a good tool or software I should look at for creating and maintaining end user documentation? Jon ~| Protect your mail server with built in anti-virus protection. It's not only good for you, it's good for everybody. http://www.houseoffusion.com/banners/view.cfm?bannerid=39 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:190547 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: User Documentation - Any suggestions?
Nothing beats the combination of RoboHelp and Captivate. We build all our Plum documentation in RoboHelp, then export both the compiled .chm file and the HTML version for online viewing with a single click. The only other tool I would recommend is RoboScreenCapture (also from Macromedia). I've used about a half dozen capture tools over the years, and RoboScreenCapture beats them all, hands down. I'm not sure, but RoboScreenCapture might come with Captivate, so check before you buy. Respectfully, Adam Phillip Churvis Member of Team Macromedia http://www.ProductivityEnhancement.com Download Plum and other cool development tools, and get advanced intensive Master-level training: * C# ASP.NET for ColdFusion Developers * ColdFusion MX Master Class * Advanced Development with CFMX and SQL Server 2000 - Original Message - From: Jon Block [EMAIL PROTECTED] To: CF-Talk cf-talk@houseoffusion.com Sent: Friday, January 14, 2005 10:42 AM Subject: User Documentation - Any suggestions? We're trying to come up with a better way to document how our web application works for our end users. Can anyone suggest a good tool or software I should look at for creating and maintaining end user documentation? Jon ~| Find out how CFTicket can increase your company's customer support efficiency by 100% http://www.houseoffusion.com/banners/view.cfm?bannerid=49 Message: http://www.houseoffusion.com/lists.cfm/link=i:4:190552 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: OT: Website Documentation?
LOL Mike, I had some of that zillion-line no-comment code when I started my current job, but worse yet is when there's a zillion comments, but they're only for commenting out code. Also, my boss and a co-worker had the idea that stripping out comments would reduce our bandwidth... yeah... h... -nathan strutz http://www.dopefly.com/ Mike Kear wrote: WOW! Documentation! I've never worked on anyone else's code that had much in the way of comments, let alone documentation. I've recently been working on a template that had more than 8500 lines!!! with a gazillion loops and nested CFIFs, and not a single comment anywhere. I guess the guy who wrote it thought the comments would bloat the code. HAH! Documentation! Whatever will they think of next. Cheers Mike Kear Windsor, NSW, Australia AFP Webworks http://afpwebworks.com .com,.net,.org domains from AUD$20/Year On Wed, 1 Dec 2004 11:57:33 -0500, Claremont, Timothy [EMAIL PROTECTED] wrote: Does anyone on the list have any pointers or website URLS that dictate some best practices when it comes to CF based web site documentation? It guess I am looking for advice on how to create an owners manual for the website that will allow another webmaster to step in and take over if and when the time comes. A google search for website and documentation came up a bit short. TIA, Tim ~| Special thanks to the CF Community Suite Silver Sponsor - New Atlanta http://www.newatlanta.com Message: http://www.houseoffusion.com/lists.cfm/link=i:4:185946 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
OT: Website Documentation?
Does anyone on the list have any pointers or website URLS that dictate some best practices when it comes to CF based web site documentation? It guess I am looking for advice on how to create an owners manual for the website that will allow another webmaster to step in and take over if and when the time comes. A google search for website and documentation came up a bit short. TIA, Tim ~| Special thanks to the CF Community Suite Silver Sponsor - RUWebby http://www.ruwebby.com Message: http://www.houseoffusion.com/lists.cfm/link=i:4:185814 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: OT: Website Documentation?
I like to use Docbook - it gives tags specific to technical documenation. Its somewhat of a standard for open source projects. You can google for DocBook to get a feel for what its about. The editor I like to use is XXE http://www.xmlmind.com/xmleditor/. While it wont help you with, like, what do I put for Chapter 1 it forces you to be consistant with your documentation. After you make the docbook xml, you can make the xml file into RTF, PDF, HTML, man pages, and a bunch of other formats. On Wed, 1 Dec 2004 11:57:33 -0500, Claremont, Timothy [EMAIL PROTECTED] wrote: Does anyone on the list have any pointers or website URLS that dictate some best practices when it comes to CF based web site documentation? It guess I am looking for advice on how to create an owners manual for the website that will allow another webmaster to step in and take over if and when the time comes. A google search for website and documentation came up a bit short. TIA, Tim ~| Special thanks to the CF Community Suite Gold Sponsor - CFHosting.net http://www.cfhosting.net Message: http://www.houseoffusion.com/lists.cfm/link=i:4:185826 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
Re: OT: Website Documentation?
WOW! Documentation! I've never worked on anyone else's code that had much in the way of comments, let alone documentation. I've recently been working on a template that had more than 8500 lines!!! with a gazillion loops and nested CFIFs, and not a single comment anywhere. I guess the guy who wrote it thought the comments would bloat the code. HAH! Documentation! Whatever will they think of next. Cheers Mike Kear Windsor, NSW, Australia AFP Webworks http://afpwebworks.com .com,.net,.org domains from AUD$20/Year On Wed, 1 Dec 2004 11:57:33 -0500, Claremont, Timothy [EMAIL PROTECTED] wrote: Does anyone on the list have any pointers or website URLS that dictate some best practices when it comes to CF based web site documentation? It guess I am looking for advice on how to create an owners manual for the website that will allow another webmaster to step in and take over if and when the time comes. A google search for website and documentation came up a bit short. TIA, Tim ~| Special thanks to the CF Community Suite Silver Sponsor - CFDynamics http://www.cfdynamics.com Message: http://www.houseoffusion.com/lists.cfm/link=i:4:185889 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations Support: http://www.houseoffusion.com/tiny.cfm/54
