6 replies to this topic

[wiesshund]

This thread is to see how many people would be genuinely interested in writing and assembling a VPX CHM help file.

 

This would NOT be a how to make tables or code VBS or how to do lighting or anything like that kind of help file

 

It would be a program Help file, like most windows programs have, that would simply cover how the program works

what the preferences do, command line options, windows explorer integration etc

 

It is something VPX needs, but not something Toxie or Fuzzel can feasibly try doing unless they stop doing code work on 10.7

in which case it will be forever until 10.7 becomes not a beta.

 

Also, sometimes help is better left written to non programmers

[Thalamus]

It's a good idea I guess. But, honestly. Is there anyone that knows what all the options do anymore ?

[jpsalas]

It's a good idea I guess. But, honestly. Is there anyone that knows what all the options do anymore ?

Nope

[jpsalas]

Anyway there is a lot of built-in information when you let the mouse still on top of a property or selection, like this:

 

[attachment=32121:Help in VPX.PNG]

 

You get a good explanation of what the parameter does.

[toxie]

Also: A lot of stuff is hidden in the plain Changelog.txt, Changelog_Scripts.txt and CommandReference.txt files

We always tried to be very vocal about new stuff in there, so if one would work from back to front, one should be able to catch a lot.

 

And then, of course, Fuzzel, me, and i guess at least also Freezy would at least proof read it and correct things that are off or outdated in that new documentation.

 

Thanks wiesshund for driving this!!

[freezy]

Yeah, also maybe check with Scotty Wic, he already has some kind of VPX reference in his Orbital docs:

 

https://docs.orbital...x-documentation

 

For me personally one of the most annoying things was to know which and under which conditions properties of game items can be updated during gameplay.

[wiesshund]

Yeah, also maybe check with Scotty Wic, he already has some kind of VPX reference in his Orbital docs:

 

https://docs.orbital...x-documentation

 

For me personally one of the most annoying things was to know which and under which conditions properties of game items can be updated during gameplay.

 

That is more to the programming knowledge though, which is not what i was thinking of for the scope of the help file

A help file for that would be enormous and probably not be the greatest in CHM form either.

 

Not looking to teach a table author, though a single "doc" for that would be great
but more for how to use just the app itself
how to set it up, how to configure, how to run it
what do the various buttons do etc.

 

Without having to search websites and such.
A person may feasibly download all the stuff to a flash drive, then haul it off to set it up on something that has no internet to go searching