Conversation
ba4c24c to
461e26b
Compare
|
Is it possible to have also previous/next tutorial links at the bottom of the page? In my opinion, it is useful when you follow a tutorial to not have to scroll up to go to the next tutorial. Some examples:
With the MoveIt tutorials, I like the previous/next buttons at the bottom of the page and the "address bar" at the top of the page, that could be used in OpenCV to navigate at the different levels of the tutorials hierarchy. One issue with previous/next links is that it is not automatic. So if you want to add a tutorial, you have to update these links manually for two consecutive tutorials. Maybe languages compatibility could be added also here? There are already language buttons to select the sample code language in the page, so not sure if it is useful or not. What about adding for each tutorial page a Just an idea. What about keeping the extra tutorial description? Something like: |
|
@catree , thank you for comments. I've added TOCs to most tutorials. As for prev/next links at the bottom and better navigation, I don't see a convenient way to do it without manually copying this part from the top. We need to either extend tutorial-checking script added in this PR to be able to modify all tutorials, either some JS code which would transform contents at loading time. I'll try to experiment with the first approach later. Languages information and tutorial description was removed in this PR, because in most cases this information is redundant and not very useful. I think maybe we can use longer titles if current one is not descriptive enough. |
Looks like it doesn't work on public CI. Which doxygen version is required? |
|
i think updating doxigen version will be fine. Last Release is 1.8.20 |
|
It should work. There are already some pages that have table of contents:
In |
0bad588 to
c79a152
Compare
|
I use latest doxygen 1.8.20 and TOCs work for me. However I do not recommend upgrading yet because language-switching buttons do not work in many tutorials because H2 headers have changed to H1 and our JS code does not handle it well and must be updated. I suggest leaving them in this PR, because they do not harm and can be useful in future when we upgrade or find another solution. |
|
|
||
| @prev_tutorial{tutorial_gapi_anisotropic_segmentation} | ||
|
|
||
| [TOC] |
There was a problem hiding this comment.
BTW, Also there is another way to specify table of contents. Page
But I agree that we need to check/fix headers on problematic pages.




appsection (application utils), flattened contentothersection, flattened contentimgproctutorialsdoc/tools/scan_tutorials.pywhich checks order in tutorial lists and prev/next navigation links for consistency (must be run in thedocfolder)preview
Note: have not updated G-API tutorials yet to avoid possible conflicts
Note: USAC tutorial is not added to any list and have slightly different format than others, I think it would be better to fix it in separate PR