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

docs(xmlupload): improve examples, add documentation of geometry-prop JSON format #240

Merged
merged 7 commits into from Oct 18, 2022

Conversation

jnussbaum
Copy link
Collaborator

resolves DEV-1404

@jnussbaum jnussbaum self-assigned this Oct 10, 2022
docs/dsp-tools-usage.md Outdated Show resolved Hide resolved
docs/dsp-tools-usage.md Outdated Show resolved Hide resolved
docs/dsp-tools-usage.md Outdated Show resolved Hide resolved
docs/dsp-tools-usage.md Outdated Show resolved Hide resolved
docs/dsp-tools-usage.md Outdated Show resolved Hide resolved
docs/dsp-tools-xmlupload.md Show resolved Hide resolved
docs/dsp-tools-xmlupload.md Show resolved Hide resolved
docs/dsp-tools-xmlupload.md Show resolved Hide resolved
docs/dsp-tools-xmlupload.md Outdated Show resolved Hide resolved
testdata/test-data-systematic.xml Outdated Show resolved Hide resolved
Copy link
Collaborator

@BalduinLandolt BalduinLandolt left a comment

Choose a reason for hiding this comment

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

looks good, just some minor remarks, and/or stuff for later

docs/dsp-tools-xmlupload.md Show resolved Hide resolved
docs/dsp-tools-xmlupload.md Outdated Show resolved Hide resolved
Comment on lines 840 to 845
"status": "active",
"type": "circle",
"lineColor": "#ff1100",
"lineWidth": 5,
"points": [{"x":0.5,"y":0.3}],
"radius": {"x":0.1,"y":0.1}
Copy link
Collaborator

Choose a reason for hiding this comment

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

still wondering if the circle shouldn't actually be an ellipsis?

Copy link
Collaborator

Choose a reason for hiding this comment

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

ah, I see now, this can be an ellipsis. But wouldn't it be simpler to define the ellipsis by the bounding rectangle? (like e.g. in paint, when you "drag" a box with the mouse, and it "fills" it with an ellipsis)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

No, I don't think that an ellipsis is possible. It's just that the creators of knora decided to define the radius as vector (x, y). It's a bit like the hypothenuse of a right-angled triangle. I added a comment line in the JSON example to make it more clear.

Copy link
Collaborator

Choose a reason for hiding this comment

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

ok, I understand, thanks for the explanation. Interesting design choice. ;-)
Then my point remains, that in my opinion it should be an ellipsis, not a circle... (but again, that's not scope of this PR, so let's just keep it in the back of our heads)

Comment on lines +867 to +868
- In the SALSAH data, there is also a key named `original_index` in the JSON format of all three shapes, but it doesn't
seem to have an influence on the shapes that TANGOH displays, so it can be omitted.
Copy link
Collaborator

Choose a reason for hiding this comment

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

"doesn't seem to ..." probably doesn't sound very confidence-inspiring to users

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I know. I reverse-engineered this entire thing, and since dsp-tools is mostly internal, I decided to reflect my current state of knowledge.

Copy link
Collaborator

Choose a reason for hiding this comment

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

fair enough

@jnussbaum jnussbaum changed the title docs(xmlupload): update docs, add better examples docs(xmlupload): improve examples, add documentation of <geometry-prop> JSON format Oct 18, 2022
@jnussbaum jnussbaum changed the title docs(xmlupload): improve examples, add documentation of <geometry-prop> JSON format docs(xmlupload): improve examples, add documentation of geometry-prop JSON format Oct 18, 2022
@jnussbaum jnussbaum merged commit 7df1d86 into main Oct 18, 2022
@jnussbaum jnussbaum deleted the wip/dev-1404-update-docs-xmlupload branch October 18, 2022 06:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants