Should there be a "FF3 Function Reference" in the Help File?

Started by John Montenigro, November 07, 2009, 04:35:31 PM

Previous topic - Next topic

John Montenigro

If it's there, I can't seem to find it...
Could you add "FF3 Function Reference" to the Help Menu?

(Also, the Help file's Search and Index buttoms do not seem to be functioning properly... ) Any term is ask of the Index always gives me "Formatting and Aligning", and Search always returns "No topics found".
I'll post this in the bug section...

Paul Squires

FF Functions are "self documenting". Basically, the idea is that all functions in the Functions Library should have their properties documented in the "Description" tab. I would rather put additional documentation there rather than trying to synchronize it with a Help file also.
Paul Squires
PlanetSquires Software

John Montenigro

I see what you mean - I missed the significance of the Functions Library (FL). I found the description in the Help File to be a bit "sales-y"; and I didn't read it in depth first time through. I know I'm missing some significant ideas there; maybe they could be made more clear?

IOW, if I'm understnading the FL properly, the FF3 functions are no longer "built-in" to the designer's EXE. Instead, the designer "brings them in" from the .inc files in the CodeStore...

So, that must mean that I can modify them (if I were so bold), or make copies and modify the copies, or drop my own .inc files there, etc.

Also, it appears that I have the freedom to (and FF has an expectation that I can) modify the folder structure and names.
What's not clear to me is whether there are limitations - what happens if I change a folder from the name installed by FF3?

Also, might it be useful to put a pointer or a link from the Help File Contents to the Function Library? And one in the designer's Help Menu, too?

-Jphn

Paul Squires

Quote from: John Montenigro on November 08, 2009, 11:08:08 AM
IOW, if I'm understnading the FL properly, the FF3 functions are no longer "built-in" to the designer's EXE. Instead, the designer "brings them in" from the .inc files in the CodeStore...
Yes, exactly right.

Quote
So, that must mean that I can modify them (if I were so bold), or make copies and modify the copies, or drop my own .inc files there, etc.
Yes you can. You have the freedom to do whatever you wish.

Quote
Also, it appears that I have the freedom to (and FF has an expectation that I can) modify the folder structure and names.
What's not clear to me is whether there are limitations - what happens if I change a folder from the name installed by FF3?
FF3 looks at all of the folders under the "\CodeStore\PowerBasic\" parent folder. As long as you don't change the names of those folders then you should be okay. You could even change the name of the "FireFly_Functions" folder if you wish. FF3 could care less.

Quote
Also, might it be useful to put a pointer or a link from the Help File Contents to the Function Library? And one in the designer's Help Menu, too?
I don't understand how this would be useful? From my count, there is already 3 different ways to get to the Functions Library. Adding another to the Help menu.... it would seem out of place there. :)


Paul Squires
PlanetSquires Software