Skip to content

WIP: ENH: add a tour menu and p/n buttons

Henrik tom Wörden requested to merge f-tour-menu into dev

Summary

Create menu/TOC for the tour that allows to jump to various positions/chapters in the code. Also, included previous and next buttons in the pages.

HINT

  1. Still includes logging.
  2. Deactivation of buttons is currently inconsistent. When the previous button is on the same site and it is not deactivated via tour.yaml, the previous button does not work, since it would activate the button but it is still activated. -> Nothing happens.
  3. Something is still wrong with the class caosdb-f-tour-open-page. If you click on next in no. 3 of Data Model Chapter and then on previous in no. 4, you will get back to the correct site, but the page will not open. This is probably due to the fact, that the button still has the class caosdb-f-tour-open-page but the page is not open.
  4. Some hrefs in the tour.yaml (see Test Environment) are not yet meaningful.

Focus

Note, that the menu was changed. It is now a drop down entry. There is now sub navbar collapsed element anymore.

Test Environment

Please use tour.yaml of defautl profile of deploy; branch f-crawler-tour

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

  • All automated tests pass
  • Reference related Issues
  • Up-to-date CHANGELOG.md
  • Annotations in code (Gitlab comments)
    • Intent of new code
    • Problems with old code
    • Why this implementation?

Check List for the Reviewer

  • I understand the intent of this MR
  • All automated tests pass
  • Up-to-date CHANGELOG.md
  • The test environment setup works and the intended behavior is reproducible in the test environment
  • In-code documentation and comments are up-to-date.
  • Check: Are there spezifications? Are they satisfied?

For further good practices have a look at our review guidelines.

Edited by Henrik tom Wörden

Merge request reports