Skip to content
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.

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

Update views.md #663

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

alikstimix
Copy link
Contributor

Update text to reflect the existence of the "Other" dropdown

Update text to reflect the existence of the "Other" dropdown
Copy link
Contributor

@elstoc elstoc left a comment

Choose a reason for hiding this comment

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

Reading this I'm not sure it's worth drawing a distinction between "main" and "subsidiary" views

The functionality in darktable is separated into six different views:
The functionality in darktable is delivered through two main views and four subsidiary views:

**Main Views**
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this should use markdown "header" syntax (with the # symbol) rather than just bold text. Additionally dtdocs has headings in lower case to match the style of the application UI.

The functionality in darktable is delivered through two main views and four subsidiary views:

**Main Views**
<br>Switch between main views by clicking the view name at the top right of the window:
Copy link
Contributor

Choose a reason for hiding this comment

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

Please avoid html (remove the <br>). If you must have a new paragraph you can use a line feed in markdown. Similarly below.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agreed


[lighttable](../../lighttable/_index.md)
: Manage images and collections.

[darkroom](../../darkroom/_index.md)
: Develop a single image.

The currently active view is highlighted.

**Other Views**
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's keep the terminology consistent. Are they subsidiary views or "other" views? Given that the application uses the term "other" I'd go with that, but I agree it makes the text harder to write. On reflection I'm not sure it's worth the effort to call them "main" and "other/subsidiary". Perhaps it's better to just add a line before the map/tethering sections saying something like "the following views are available by clicking on the 'other' label"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agree with using "other" instead of subsidiary.

The main reason for splitting out the "Other" views is that the UI already casts them as different/lesser by relegating them to the dropdown. So the manual should emphasise the ease of switching between lightable and darkroom which is where users will spend 90+% of their time.

Your call.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

On a practical note. I can make the corrections to the text in my fork alixtimix/dtdocs/patch-4

Once I commit those changes, how do I send the updated material back to you? A new push request? or what?

Copy link
Contributor

Choose a reason for hiding this comment

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

If you update your branch that automatically updates the PR

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK all done

Copy link
Contributor

Choose a reason for hiding this comment

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

also note it isn't always called "other" -- when you change to the map view, then it is called "map", etc etc. So what it is called depends on what view you're currently in.

Revised initial Pull Request in lite of reviewer comments
@paperdigits
Copy link
Contributor

paperdigits commented Jul 18, 2024 via email

Copy link

This pull request has not had any activity in the past 60 days and will be closed in 365 days if not updated. Please verify it has no conflicts with the master branch and rebase if needed. Please add a comment if you need help or give permission to other people to finish your work.

@github-actions github-actions bot added the no-pr-activity No activity on this PR label Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-pr-activity No activity on this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants