Page 1 of 5

Documentation problems

Posted: Sun Mar 29, 2015 7:50 pm
by lazi
The Hollywood project documentation is really huge. It is surely a tough job to maintain.
I think the findings of documentation related problems, missing or incorrect descriptions, typos, etc. should be post in the same thread.
If you think the same, please post here what you found!

Re: Documentatation problems

Posted: Sun Mar 29, 2015 7:53 pm
by lazi
... and here is the first :-)

The Hollywood 6.0 history says about the "Driver" table argument of OpenVideo() and @VIDEO.
At the corresponding nodes has no info about it.

Edit: Ok, the "Driver" word in the history should be "Loader" to be consistent.

Re: Documentatation problems

Posted: Sun Mar 29, 2015 8:48 pm
by airsoftsoftwair
You have to read the complete history item. It clearly says that the "Driver" tag has been killed, cf.:
- New: @VIDEO and OpenVideo() accept an additional table argument named "Driver" now which allows you to specify the video driver to use on a per-call basis; previously it was impossible to enforce this because the ForceVideoDriver() command could not be called at preprocessor level [VOID; please use the new "Loader" tag instead]
Compare with the note at the beginning which says:
Please read the history bottom-up. Note that the history might list some features that were implemented in beta versions and removed later but are still mentioned here. This history is a log of the programmer so that he can look up what has been done/tried/modified. Things that were implemented and removed later are marked with [VOID].
"Driver" is marked as VOID in the history, i.e. it was implemented in beta versions but was later substituted by the "Loader" tag and hence didn't make it into any release versions...

Re: Documentatation problems

Posted: Sun Mar 29, 2015 10:33 pm
by lazi
Overlooked it, sorry.

Working on the AmigaMania article about HW6, and it is hard to sum up the changes, because there is a lot.

Re: Documentatation problems

Posted: Sat Apr 04, 2015 3:03 am
by SMF
Good thread! a massive documentation like this got to have a few typos ;) so if we can help and improve it i'm glad.
So far after reading it for a while i have only found one tiny thing:

In section 10:26 tutorial. There's a line with this code: @BGPIC 1, "BG.png"
The file is actually called "BG.iff"

Re: Documentatation problems

Posted: Mon Apr 06, 2015 9:50 pm
by airsoftsoftwair
Oops, that's rather a bug in the distribution. I've renamed it to BG.png now ;)

Re: Documentatation problems

Posted: Tue Apr 12, 2016 9:05 am
by lazi
FileToString returns the file contents and a second return value hold the length of the string.
The manual miss to mention of the second value.

Re: Documentatation problems

Posted: Tue Apr 12, 2016 6:26 pm
by airsoftsoftwair
Oh right, fixed now. Thanks.

Re: Documentatation problems

Posted: Tue Mar 28, 2017 8:21 am
by lazi
PathItems() documentation CurveTo paragraph says X2,Y2: "The ... coordinate of the first control point." instead of second control point.

Re: Documentatation problems

Posted: Tue Mar 28, 2017 11:52 pm
by airsoftsoftwair
Fixed in master.