Skip to content

Update scopes.md #704

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update scopes.md #704

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions content/module-reference/utility-modules/shared/scopes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,15 +111,21 @@ Bear in mind that these controls are provided as a basic guide to achieving colo

# exposure adjustment

The histogram, waveform, and RGB parade scopes can be used to directly alter the _exposure_ and _black level_ of the [_exposure_](../../processing-modules/exposure.md) module.
The histogram, waveform, and RGB parade scopes can be used to directly alter the exposure and black level of the exposure module.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In other places in the docs, individual controls (like exposure and black level here) are highlighted using italics.
Also, why remove the link to the exposure module's docs?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for looking at this @kofa73. This is my first attempt at learning how to help with documentation. I just copied what was already in the user manual and added the bare minimum to update the documentation to be correct. I didn't mean to remove any links or change the use of italics, but I see the inconsistency in the use of italics in the document I copied from. Can you advice how I retain the link? I am still on my L plates here.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The site uses markdown format, which is pretty simple, and the same as github uses for its comments. Github provides a guide (here) or there are various "cheat sheets" available (for example here)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I rewrite my correction or is this close enough to be edited and used?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just restore the original text:

Suggested change
The histogram, waveform, and RGB parade scopes can be used to directly alter the exposure and black level of the exposure module.
The histogram, waveform, and RGB parade scopes can be used to directly alter the _exposure_ and _black level_ of the [_exposure_](../../processing-modules/exposure.md) module.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this PR is a one-off I don't mind making edits when I get around to merging, but if you intend to submit more pull requests in the future it would be good to learn the process for making changes.


For the histogram, click towards the right-hand side of the histogram and then drag right to increase or drag left to decrease the exposure. In a similar manner you can control the black level by clicking and dragging in the left-hand side.

For horizontal waveform and RGB parade, drag the upper portion of the scope up/down to increase/decrease exposure. Drag the lower portion up/down to increase/decrease the black level.

For vertical waveform and RGB parade scopes, the corresponding regions are to the right (exposure) and left (black level).

You can also scroll in the appropriate area -- rather than dragging -- to adjust exposure and black point. Double-click in the scope to reset the exposure module's parameters to their defaults.
You can also scroll in the appropriate area – rather than dragging – to adjust exposure and black point.

Soft limits are respected in this module but can be overridden with ctrl+shift

Fine tuning can be achieved by adjusting the speed when dragging or scrolling by using the ctrl key for fine tuning. Alternatively, a right-click will pop up a fine-tuning option.

Double-click in the appropriate part of the scope to reset the exposure or black point individually to their defaults.

# histogram profile

Expand Down
Loading