Details
-
Type:
Improvement
-
Status: Closed (View Workflow)
-
Priority:
Major
-
Resolution: Done
-
Affects Version/s: None
-
Fix Version/s: 10.0.0 Major Release
-
Labels:None
-
Story Points:3
-
Epic Link:
-
Sprint:Summer 5 2023 July 10, Summer 6 2023 July 24, Summer 7 2023 Aug 7
Description
Situation: As part of IGBF-3236 we are adding additional meta characters to the Advanced Search residues logic (R = A or G). This information should be made easily available to IGB users.
Task: Add an info icon button to the Advanced Search tab that explains this and the other "advanced searches" a user can do.
Additional task: update the advanced search wiki page with the additional meta character information.
Attachments
Issue Links
Activity
Thanks for making the changes Kaushik Gopu. PR is now merged. Built development branch installers and ran bioviz-playbook "setup.yml" to copy the installers over to the "early access" section of BioViz.org Web site.
Read for testing.
To test:
- Download and install "early access" IGB from the BioViz.org web site; run the new IGB version
- Choose File > Preferences > Other > Reset Preferences to defaults (to ensure a "fresh" run of IGB)
- Restart this new version of IGB
- Choose Help > About IGB to confirm the latest commit is from this ticket
- Select Advanced Search Tab
- You should observe a "i" icon on the interface. Click the icon and confirm that a Web page opens in your default Web browser and that the page being shown is the https://bioviz.org/advancedsearch.html
- Choose the "log" tab. You should see no errors or warnings. If you see any errors or warnings, repeat the above steps using IGB version 9.1.10 to determine if the errors or warnings are new.
If testing reveals any problems, report them here and move the ticket to "To-Do" for further investigation. Or, if the problems exist in previous version of IGB, consult with the team to determine if a new ticket needs to be created.
pull request submitted.
All instances of advance have been changed to advanced.
Ready for pull request.
- Modified the branch so that methods, variables, and class names use *advanced" as prefix instead of advance.
- If everything looks fine, will squash the commits and submit the pull request.
Regarding the target of the proposed informational link for "design one":
- Instead of sending the user to a page on wiki.bioviz.org, let's send the user to a new page on BioViz.org: "https://bioviz.org/advancedsearch.html"
The benefit of sending users to a page on bioviz.org is that it's now very easy to modify and update bioviz.org pages. From there, we can link to the Advanced Search documentation on wiki.bioviz.org. We could also configure the server with a redirect rule that would automatically send the user there. There are many options, all very easy to implement.
Linking directly to a pages on wiki.bioviz.org, which hosts wiki software Confluence, is problematic because the addresses of pages on wiki.bioviz.org frequently change. such as when we edit page titles.
Followed testing outlined above on Mac.
Everything working correctly, no issues found in log.
Closing ticket.