Proofreading & comments on Help documentation

[Jennifer]

Openshot v1.4.3 on Ubuntu 10.04 LTS Lucid Lynx, installed via PPA. (Older version previously installed via Synaptic and removed with "Complete Removal".)

I've just been reading the Help files, as a newcomer and "documentation enthusiast" :-) Some things caught my attention, so I thought I'd flag them up. A few are about the actual information, some are just typos.

a) None of my "help" file was pictures - it was all text & tables. Sometimes it refers to illustrations, so I guess there ought to have been some...?

b) Part 4.1 Overview.

Item 2 - Function Tabs - the text is "Copy text Switch between Project Files, Transitions, and Effects."
Item 3 - Project Files - the text is "Switch between Project Files, Transitions, and Effects."

This looks to me like a leftover of some updating or something :-)

c) Part 6.9 Save Project screen.

Item 3 - Project Length - the text is "The maximum length of the timeline. However, the length of the timeline will automatically grow, if and when clips exceed the length."

I'm not sure what this means. If the clips exceed _this_ length, it isn't the maximum, is it? I'm thinking maybe you must mean something like "The length of the timeline will automatically grow as you add clips, up to this maximum." (If that _is_ what you mean, you might want another sentence which says what happens if you try to add a clip beyond the maximum length.)

d) Import Files – Audio, Video, and Images

I'd have liked to be told here whether the files I import will be saved as part of the project, or whether the project is simply referring to files external to itself.

e) Part 12.2. Only the Audio.

A minor proof-reading point: in "click the eye icon on the track", you have two spaces in between "eye" and "icon".

f) 14.5. Speed Tab

"The advanced tab let's you set...": should be "lets".

g) 15.3. Manually

"The following properties are affected by key-frames: Height, Wight, X, Y, and Alpha." Is there such a thing as "Wight" that I've never heard of, or is that a typo for "Width"?

h) 18.4.3. Animate Each Title

"(as show in the illustration)": should be "shown". (But as I said above, I didn't get any illustrations.)

i) Upload Video

"Choose a video file to upload to YouTube. Be sure it's a compatible format with YouTube first, or it might not work correctly."

I'm guessing the Vimeo option was added later? I suggest "Choose a video file to upload to YouTube or Vimeo. Be sure that your video's format is compatible with the destination, or it might not work correctly."

j) Layout of the help manual: where the page of info is shorter than the index on the right, I would prefer not to have to move to the bottom of the page before being able to click on the "next" link. I'd like to have the next & previous links at the top as well. But I don't know if you can do anything about that.

h.t.h. :-)

[Olivier Girard (eolinwen)]

HI Jennifer,

Please, first use this FAQ (and especially) which will give more
complementary informations.
https://answers.launchpad.net/openshot/+faq/2197
Thanks.

2013/3/9 Jennifer <email address hidden>

> Public bug reported:
>
> Openshot v1.4.3 on Ubuntu 10.04 LTS Lucid Lynx, installed via PPA.
> (Older version previously installed via Synaptic and removed with
> "Complete Removal".)
>
> I've just been reading the Help files, as a newcomer and "documentation
> enthusiast" :-) Some things caught my attention, so I thought I'd flag
> them up. A few are about the actual information, some are just typos.
>
> a) None of my "help" file was pictures - it was all text & tables.
> Sometimes it refers to illustrations, so I guess there ought to have
> been some...?
>
> b) Part 4.1 Overview.
>
> Item 2 - Function Tabs - the text is "Copy text Switch between
> Project Files, Transitions, and Effects."
> Item 3 - Project Files - the text is "Switch between Project Files,
> Transitions, and Effects."
>
> This looks to me like a leftover of some updating or something :-)
>
> c) Part 6.9 Save Project screen.
>
> Item 3 - Project Length - the text is "The maximum length of the
> timeline. However, the length of the timeline will automatically grow,
> if and when clips exceed the length."
>
> I'm not sure what this means. If the clips exceed _this_ length, it
> isn't the maximum, is it? I'm thinking maybe you must mean something
> like "The length of the timeline will automatically grow as you add
> clips, up to this maximum." (If that _is_ what you mean, you might want
> another sentence which says what happens if you try to add a clip beyond
> the maximum length.)
>
> d) Import Files – Audio, Video, and Images
>
> I'd have liked to be told here whether the files I import will be saved
> as part of the project, or whether the project is simply referring to
> files external to itself.
>
> e) Part 12.2. Only the Audio.
>
> A minor proof-reading point: in "click the eye icon on the track", you
> have two spaces in between "eye" and "icon".
>
> f) 14.5. Speed Tab
>
> "The advanced tab let's you set...": should be "lets".
>
> g) 15.3. Manually
>
> "The following properties are affected by key-frames: Height, Wight, X,
> Y, and Alpha." Is there such a thing as "Wight" that I've never heard
> of, or is that a typo for "Width"?
>
> h) 18.4.3. Animate Each Title
>
> "(as show in the illustration)": should be "shown". (But as I said
> above, I didn't get any illustrations.)
>
> i) Upload Video
>
> "Choose a video file to upload to YouTube. Be sure it's a compatible
> format with YouTube first, or it might not work correctly."
>
> I'm guessing the Vimeo option was added later? I suggest "Choose a
> video file to upload to YouTube or Vimeo. Be sure that your video's
> format is compatible with the destination, or it might not work
> correctly."
>
> j) Layout of the help manual: where the page of info is shorter than
> the index on the right, I would prefer not to have to move to the bottom
> of the page before being able to click on the "next" link. I'd like to
> have the next & previous links at the top as well. But I don't know i...

[Jennifer (jennifer-uncharted-worlds)]

Here's what I know in the requested format:

Bug Date : Today
Reporter : Jennifer
Architecture (64 bits or 32 bits) : 32
Plateform (Linux, Windows, Mac OSX) : Linux
Operating System (Ubuntu, Archlinux, Seven, Mountain Lion, .....) : Ubuntu
Version OS ( 12.04, 7, 10.6, .....) : 10.04
New installation or update : New
Installation Method : PPA / command line (Older version previously installed via Synaptic and removed with "Complete Removal".)
Version of Openshot installed : 1.4.3
Revision used (if any) : ?

I'm not sure the other questions are relevant, as we're only talking about the Help file - is there anything in particular I've missed out that would make a difference?

[Andy Finch (fincha)]

Thanks for your proof reading efforts.

The reason you won't see any illustrations is due to a bug in the help system itself (yelp?). In later versions it is corrected, but it's something to do with relative paths of the images I think. It certainly works OK in later distributions.