Many text corrections and improvements #104630

New Issue

Molaskes · 2023-11-13T08:41:03+01:00

Molaskes commented

2023-11-13 08:41:03 +01:00

Page Information
File: manual/editors/video_sequencer/sequencer/sidebar/proxy.rst
Blender Version: 3.6
Documentation Language: en
Permanent Link

Short description of error
The Proxy Settings > Storage description

Defines whether the proxies are for individual strips or the entire sequence.

should be improved to "[...] for individual strips or for the entire sequence." (add the second "for")

In the Strip Proxy & Timecode section,

or button in Proxy Settings panel.

should be corrected to "or the according button in the Proxy Settings panel." (two "the" were missing, and insert "according")

In the Strip Proxy & Timecode section,

In order to use proxies, you have to select matching Proxy Render Size in the Sequencer preview Sidebar panel.

needs to be corrected, either to "[...] select a matching [...]" (but matching what exactly?) or to simply ""[...] select a Proxy Render Size [...]".

In the Strip Proxy & Timecode > Custom Proxy > Directory section,

[...] all generated proxy images are storing to the [...]

should be corrected to "[...] images will be stored in the [...]",

and

can be set by hand using this option.

should be corrected to "[...] set manually using [...]".

The Strip Proxy & Timecode > Resolutions description

Buttons to control how big the proxies are. The available options are 25%, 50%, 75%, 100 percent of original strip size.

should be rewritten, for instance as "Set the proxy image size to either 25, 50,75 or 100 percent of the original strip image size".

The Strip Proxy & Timecode > Overwrite description

Saves over any existing proxies in the proxy storage directory.

should be rewritten to clearly explain what happens if you do not select this option. Does it prompt the user otherwise whether to overwrite or not, or does it just silently fail to recreate proxies, ...? — At the very least, "Saves over" should be corrected to "Set whether to overwrite". And if the user is otherwise given the choice by a prompt, the whole description could read "Set whether to overwrite any existing proxies in the proxy storage directory without showing a confirmation prompt popup.".

In the Strip Proxy & Timecode section, the image shows a Build JPEG Quality option, but the descriptios only call it "Quality", which should be made consistent, i.e. name it in the descriptions as it is named in the software.

In the Strip Proxy & Timecode > Timecode Index description,

there might be bunch of artifacts, mostly due to seeking a given frame in sequence.

should be corrected to "there might be numerous artifacts, mostly due to seeking to a given frame in the sequence." (fixing three grammatical errors),

and

This happens because such footage usually does not have correct frame rate values in their headers.

should be corrected to "[...] in its file header",

and

to correctly calculate frames and frame rate there are two possible solutions:

should be corrected to "[...] and the frame rate [...]",

and option 2. given there,

Use Proxy/Timecode option in Blender.

should be corrected to "Use the Proxy/Timecode option in Blender.".

The Strip Proxy & Timecode > Timecode Index > Free Run description

Use global timestamp written by recording device.

should be corrected to "Use the global timestamp written by the recording device.".

In the Strip Proxy & Timecode > Timecode Index > Free Run (Rec Date) description,

written by recording device.

should be corrected to "written by the recording device.".

The Strip Proxy & Timecode > Timecode Index > Record Run No Gaps description

Record run, but ignore timecode, changes in frame rate or dropouts.

needs to be rewritten. Firstly, it should start with "Like the Record Run option, but [...]", and secondly, the rest seems quite garbled up. MAYBE what was meant was "but ignore both the timecode given in the file header and any framerate changes or (frame)? dropouts." — This should be checked by someone who knows the actual tech here, as far as it is relevant for the end user.

In the Note at the end of the page,

Record Run is the timecode which

should be corrected to "Record Run is the timecode indexing mode which"

and

of getting acceptable result.

should be corrected to "of getting acceptable results." or "of getting an acceptable result."

**Page Information** File: `manual/editors/video_sequencer/sequencer/sidebar/proxy.rst` Blender Version: `3.6` Documentation Language: `en` [Permanent Link](https://docs.blender.org/manual/en/3.6/editors/video_sequencer/sequencer/sidebar/proxy.html) **Short description of error** The Proxy Settings > Storage description > Defines whether the proxies are for individual strips or the entire sequence. should be improved to "[...] for individual strips or for the entire sequence." (add the second "for") In the Strip Proxy & Timecode section, > or button in Proxy Settings panel. should be corrected to "or the according button in the Proxy Settings panel." (two "the" were missing, and insert "according") In the Strip Proxy & Timecode section, > In order to use proxies, you have to select matching Proxy Render Size in the Sequencer preview Sidebar panel. needs to be corrected, either to "[...] select a matching [...]" (but matching what exactly?) or to simply ""[...] select a Proxy Render Size [...]". In the Strip Proxy & Timecode > Custom Proxy > Directory section, > [...] all generated proxy images are storing to the [...] should be corrected to "[...] images will be stored in the [...]", and > can be set by hand using this option. should be corrected to "[...] set manually using [...]". The Strip Proxy & Timecode > Resolutions description > Buttons to control how big the proxies are. The available options are 25%, 50%, 75%, 100 percent of original strip size. should be rewritten, for instance as "Set the proxy image size to either 25, 50,75 or 100 percent of the original strip image size". The Strip Proxy & Timecode > Overwrite description > Saves over any existing proxies in the proxy storage directory. should be rewritten to clearly explain what happens if you do not select this option. Does it prompt the user otherwise whether to overwrite or not, or does it just silently fail to recreate proxies, ...? — At the very least, "Saves over" should be corrected to "Set whether to overwrite". And if the user is otherwise given the choice by a prompt, the whole description could read "Set whether to overwrite any existing proxies in the proxy storage directory without showing a confirmation prompt popup.". In the Strip Proxy & Timecode section, the image shows a Build JPEG Quality option, but the descriptios only call it "Quality", which should be made consistent, i.e. name it in the descriptions as it is named in the software. In the Strip Proxy & Timecode > Timecode Index description, > there might be bunch of artifacts, mostly due to seeking a given frame in sequence. should be corrected to "there might be numerous artifacts, mostly due to seeking to a given frame in the sequence." (fixing three grammatical errors), and > This happens because such footage usually does not have correct frame rate values in their headers. should be corrected to "[...] in its file header", and > to correctly calculate frames and frame rate there are two possible solutions: should be corrected to "[...] and the frame rate [...]", and option 2. given there, > Use Proxy/Timecode option in Blender. should be corrected to "Use the Proxy/Timecode option in Blender.". The Strip Proxy & Timecode > Timecode Index > Free Run description > Use global timestamp written by recording device. should be corrected to "Use the global timestamp written by the recording device.". In the Strip Proxy & Timecode > Timecode Index > Free Run (Rec Date) description, > written by recording device. should be corrected to "written by the recording device.". The Strip Proxy & Timecode > Timecode Index > Record Run No Gaps description > Record run, but ignore timecode, changes in frame rate or dropouts. needs to be rewritten. Firstly, it should start with "Like the Record Run option, but [...]", and secondly, the rest seems quite garbled up. MAYBE what was meant was "but ignore both the timecode given in the file header and any framerate changes or (frame)? dropouts." — This should be checked by someone who knows the actual tech here, as far as it is relevant for the end user. In the Note at the end of the page, > Record Run is the timecode which should be corrected to "Record Run is the timecode indexing mode which" and > of getting acceptable result. should be corrected to "of getting acceptable results." or "of getting an acceptable result."

Molaskes added the

labels 2023-11-13 08:41:04 +01:00

Aaron Carlisle referenced this issue from a commit

2024-02-05 00:06:02 +01:00

Fix: Grammar

Aaron Carlisle closed this issue