This is a suggestion on a way to name the documentation for Netconnect /
Vapor programs to avoid problems.
I have tried twice before to post it, but I never saw the posting come back,
so I can only think it is not getting there.
Sorry if I am wrong.
Hi,
I don't want to seem like I am critisizing the programs, but here is a
suggestion to help make it easier for the user to check the documentation
and the programs are the same.
This came about becaue of the recent (well......) release of the new contact
manager. v1.8
I see there have been some modifications to the program and how it interacts
with AMIRC - another of my FAV programs.
I am still getting to learn Contact manager. It seems like a good idea, but
there are things I don't understand about it that caused me to look at the
HTML files.
Now, when I got the new Contact manager I intsalled it fully. No quibbles
about things.
So I would expect the documentation be the correct version when I call the
main HTML help file.
They are not.
In the one I get from the MAIN index, I get 1.7's HTML files.
I have just looked now and I can see what MAY of happened.
Either way, I think this should be brought to the attention of the guys
writing the programs, and a kind of defacto standard be adopted. Please.
The "correct" documentation files are in programs/CManager/docs
Where I can see that the included ICON for the "HELP" loads a script:
.key url
.bra {
.ket }
.def url netconnect3:docs/index.html
Stack 10000
Assign tcpdldir: netconnect3:docs
Run >NIL: netconnect3:programs/voyager/v file://localhost/{url}
There is a problem here that I would also like addressed, but more on that
later. *
So, the "netconnect3:docs/index.html" file is opened.
You click on the contact manager link and you go to:
"netconnect3:docs/manager/main.html"
All well and good, but this is (apparantly) the older way of the documents
being installed. Now they are installed in a docs drawer with the
program.
Therefore when I look for the help on Contact manager, I get an older
version.
Suggestion/s:
1) Either put the documentation with the program, or in the
netconnect3:docs drawer.
I guess you could put them in both, but why?
2) I am not sure if the Netconnect3: assign is established when you install
Netconnect3. Couldn't progdir: be used instead?
*
There are also possible conflicts with people who have both 2 and 3 - like
myself. What I have done is taken the programs for Netconnect2 and
Netconnect3 and moved them together into a directory called Netconnect with
NO "version" number. It keeps it simpler for me.
3) As the main file is index.html and it branches out the all the other
program documentation files and points to their respective index.html file,
adopt this scheme of documentation file names:
All programs have their MAIN.html file which then branches down to that
program's sub-functions.
Append the version number to all OTHER files. This way, the main.html only
has to be edited - no big deal really.
Then you would have a quick and easy way for people to check they are
reading the correct documentation for the program. I can speak from
experiance that it is frustrating reading documentation that is out of date
and probably inacurate.
Do you think that this would be a better way?
I am only suggesting it but all the same, hope you do adopt the idea.
Cya!
--
Ski resorts use man-made snow. Hint, hint - Calvin
Andrew Bruno
[EMAIL PROTECTED]
_____________________________________________________________
NetConnect mailing list. To unsubscribe, send an 'unsubcribe'
message to <[EMAIL PROTECTED]>
