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

Add geometry tools documentation #77

Merged
merged 2 commits into from
Aug 23, 2023
Merged

Conversation

rolandlo
Copy link
Member

This is taken from the development documentation. It's the first part of it. The plan is to replace the first part of the development documentation on the setsquare by a link to the website and to just keep the second part, which contains the implementation details.

@rolandlo rolandlo requested a review from Technius August 14, 2022 15:43
docs/guide/tools/geometry.md Outdated Show resolved Hide resolved
docs/guide/tools/geometry.md Outdated Show resolved Hide resolved
![Setsquare-Overview](../../img/guide/setsquare_overview.png)

The longest side of the setsquare is used for measuring lengths and to draw lines aligned to it.
Units are centimeters for lengths and degrees for angles. There are marks (in green) parallel

This comment was marked as resolved.

This comment was marked as resolved.


### Interaction with other tools

**Stylus/Mouse** interact with the Pen, Highlighter and Hand tool

This comment was marked as resolved.

This comment was marked as resolved.

docs/guide/tools/geometry.md Show resolved Hide resolved
@rolandlo rolandlo changed the title add setsquare documentation Add geometry tools documentation Jan 1, 2023
@rolandlo rolandlo marked this pull request as draft January 1, 2023 08:33
@rolandlo rolandlo force-pushed the setsquare branch 3 times, most recently from 532cc2c to a34f973 Compare August 19, 2023 21:17
Copy link
Member

@Technius Technius left a comment

Choose a reason for hiding this comment

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

Thanks for the update, I have a few suggestions below.

docs/guide/tools/geometry.md Outdated Show resolved Hide resolved
docs/guide/tools/geometry.md Outdated Show resolved Hide resolved
docs/guide/tools/geometry.md Outdated Show resolved Hide resolved
docs/guide/tools/geometry.md Outdated Show resolved Hide resolved
docs/guide/tools/geometry.md Outdated Show resolved Hide resolved
docs/guide/tools/geometry.md Outdated Show resolved Hide resolved
docs/guide/tools/geometry.md Outdated Show resolved Hide resolved
docs/guide/tools/geometry.md Outdated Show resolved Hide resolved
Comment on lines 57 to 59
Using the keyboard (`m` key) the current distinguished point can be marked with an "x"-like shape
that is added to the page. For example when drawing a circle the center using the compass,
the center of the circle can be marked like that.
Copy link
Member

Choose a reason for hiding this comment

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

These should be moved to the keyboard controls section. They seem out of place here.

Copy link
Member Author

Choose a reason for hiding this comment

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

Since it is already written in the keyboard controls section, I have just removed it here.

Comment on lines +63 to +61
In order to setup the geometry tools, check your Display DPI Calibration in the Zoom panel of menu
`Edit > Preferences` to ensure that the length on your screen matches the physical length. Set
the zoom to 100% to profit from the calibration.
Copy link
Member

Choose a reason for hiding this comment

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

Should set the zoom to 100% before calibration. Might also want to suggest using a physical ruler to compare the length.

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't think it is needed to set the zoom to 100% before calibration. Moreover it is already suggested there to use a physical ruler.

grafik

@rolandlo rolandlo marked this pull request as ready for review August 21, 2023 04:25
@rolandlo
Copy link
Member Author

Thanks a lot for the review @Technius
I have applied your suggestions (except one where I disagree).

I will squash the last 3 commits into one and merge in 48 hours if no objections are raised.

Co-authored-by: Bryan Tan <Technius@users.noreply.github.com>
@rolandlo rolandlo merged commit 9a28c82 into xournalpp:site Aug 23, 2023
@rolandlo rolandlo deleted the setsquare branch August 23, 2023 09:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants