Ticket #9613 (closed: fixed)
Handle algorithm screenshot resizing within documentation more intelligently
Reported by: | Martyn Gigg | Owned by: | Martyn Gigg |
---|---|---|---|
Priority: | blocker | Milestone: | Release 3.2 |
Component: | Documentation | Keywords: | |
Cc: | Blocked By: | ||
Blocking: | Tester: | Nick Draper |
Description
We currently set an arbitrary width for the generated screen shot images in the documentation, which allows a clickable link to be generated. Some images however are smaller and could just have the image with the correct width.
We should set a maximum allowed width and only use this width if the actual size of the image is larger.
Change History
comment:2 Changed 6 years ago by Martyn Gigg
- Status changed from assigned to inprogress
Set a maximum height for screenshots on algorithm pages.
Use the actual aspect ratio to then set the width if the height exceeds the preset maximum. Refs #9613
Changeset: 0f36d7cbb56cfa1bc0d085f25e3f66e40518738c
comment:3 Changed 6 years ago by Martyn Gigg
Put image in centre of screenshot container div
Refs #9613
Changeset: 728125a25fee5409da17e07cea5ed0a8850f82df
comment:4 Changed 6 years ago by Martyn Gigg
- Summary changed from Handle algorithm screenshot resizing better in documentation to Handle algorithm screenshot resizing within documentation more intelligently
comment:5 Changed 6 years ago by Martyn Gigg
- Status changed from inprogress to verify
- Resolution set to fixed
Branch: feature/9613_docs_screenshot_sizing
Tester: Merge the branch and build the docs-html target. The screenshots that are automatically generated now have a maximum height of 250 pixels and if the image is taller than this then it is shrunk, while preserving its aspect ratio. Check pages with different size dialogs, some good examples:
- Load
- Rebin
- CreateMDWorkspace
- CreateSampleWorkspace
The images should be clickable and take you to the full size image.
comment:6 Changed 6 years ago by Nick Draper
- Status changed from verify to verifying
- Tester set to Nick Draper
comment:7 Changed 6 years ago by Nick Draper
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/9613_docs_screenshot_sizing'
Full changeset: fc231bdbbef1e69fa1ca640bc46eac645ced07b3