GENERATE_TREEVIEW breaks the back button in several browsers (Origin: bugzilla #685940)

[doxygen]

status RESOLVED severity major in component general for ---
Reported in version 1.8.2-SVN on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

• treeview_breaks_backbutton.zip (ID 226239)

On 2012-10-11 09:15:00 +0000, Philipp Moeller wrote:

Created attachment 226239
A Doxyfile an example class to reproduce the issue.

When GENERATE_TREEVIEW is enabled the back button in several browsers (Firefox, Chrome, Safari) doesn't behave as intended after jumping to a detailed member description. The exact steps to reproduce are as follows:

unzip treeview_breaks_backbutton.zip
doxygen Doxyfile
firefox html/index.html
Navigate to "Class", then to "X"
click the "what" member of X (jumps down to the detailed description of what)
click the back button of the browser (nothing happens)
click the back button again (jumps back to "Classes")

The expected behavior after using the Back Button would be to jump to the position the window was at before clicking the member. The correct behavior can be observed with GENERATE_TREEVIEW = NO.

This is a major annoyance in class documentation with many members.

Attached is an example with a lot of pseudo-text in a class documentation and an enabled treeview where this can be reproduced in classX.html.

As far as I can tell this is related to the rewriting of $(window).location performed by navtree.js.

On 2012-10-12 16:46:26 +0000, Philipp Moeller wrote:

The issue seems to be that overflow: auto used in navtree.css for #doc-content. Removing it breaks the layout, but restores the back button functionality. This is also reproducible in smaller layouts. Is this the expected behavior?

On 2012-10-18 15:47:57 +0000, Philipp Moeller wrote:

My current workaround is to rewrite the css for the top and footer divs using position: fixed. After that it is necessary to pad the doc-content div with the header and footer height. A css trick has to be applied to make the anchors respect the padding (This could be avoided by having two divs just for padding inside doc-contents). This has the drawback of not working on IE6, but this is not really a problem for me. This also makes some of the code in resize.js (which should be merged into navtree.js and the main NAVTREE variable should be moved to a separate file to enable colocation of more js files) unnecessary.

All this is currently done through external stylesheets and overwriting of some of the javascript code, but could be factored into the generator code.

On 2012-10-28 09:15:49 +0000, Dimitri van Heesch wrote:

I think I found a better solution which only impacts the navtree.js. I will include this in the next subversion update.

On 2012-12-26 16:09:11 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.3. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information
that you think can be relevant.

On 2016-07-28 20:53:14 +0000, LorenaGdL wrote:

Hello Dimitri,

This is still an issue. I can reproduce it with your own Doxygen documentation, in Chrome and IE. Others have told me they have reproduced the issue in Firefox too. Did you finally apply the patch? If you need extra information, please let me know.

Thanks in advance

[solstice333]

This behavior still happens on 1.10.0. For me, I have a page generated from markdown. I have a link at the bottom that links to anywhere on the same page. I scroll down and click the link. The page navigates to the correct position. I click browser back. The page navigates back to the top, when I expect it to return to the bottom of the page, the previous position before I had clicked on the link.

[albert-github]

@solstice333 It would always be an advantage to have an example.

I wrapped up a small example: example.tar.gz

• scroll down to the bottom
• click link, will jump to the middle of the page
• hit the back button, will jump back to the top of the page

Original example: bug685940_226239_treeview_breaks_backbutton.zip

[solstice333]

@albert-github ah, yes, you're right. My fault. I meant to append to my earlier post "LMK if a minimal reproduction is needed". I am extending that offer now if the information and examples provided so far is not enough.

[albert-github]

@solstice333 No example needed, I think that my example already covers the issue.