Weblink in documentation and maintain a "back" ("myLib/index.html") link header

Question

I have a library (let´s call it "myLib") documented using Doxygen that does some (external) references/linking; for that I am using the <a href="../path/to/other/documentation/page/index.html">OtherDoc</a> syntax. That´s perfectly fine; working properly. The side effect is that when I click on the link (and goes to the OtherDoc page) I have no way to go back to myLib if not using the browser "go back" button.

What I was thinking so solve this issue is to maintain a "myLib" header (or as a "footnote") when the user goes to the "OtherDoc" linked page. My question is: How do I do that in Doxygen? Also, is there a better way to solve this "back link" issue?

Obs: The "OtherDoc" html pages are also doxygen generated documentation of another library I have, but it (OtherDoc) doesn't know about "myLib"; so, I would not like to put links on its documentation to "myLib".

Thanks in advance. []

simon.watts · Accepted Answer · 2013-09-03 14:22:02Z

2

I suggest that you lookup the use of TAG files within Doxygen. These would allow you to reference "OtherDoc" classes (etc) from "myLib" in the normal "Doxygen" way.

This by itself will not allow "back-links" from "OtherDoc" - without modifying the HTML there.

An alterate approach would be to have Doxygen generate to a "wiki" format; which would allow "trails" and back links to be generated dynamically. However, I am not aware of anyone doing this type of thing at the present time.

answered Sep 3, 2013 at 14:22

simon.watts

1,12511 silver badges17 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

simon.watts Over a year ago

Just a quick update - the latest version of Doxygen (1.8.8 at time of writing) now supports a BREAD_CRUMB_TRAIL configuration option. If set to YES then the complete bread crumb trail for a page will be displayed rather than just the root group. I have not yet seen this in action though.

Community · Accepted Answer · 2017-05-23 12:23:19Z

1

If you don't want to add back links in the OtherDoc documentation to myLib then why don't you simply have the link to OtherDoc open in a new tab or window? This way the myLib documentation remains open and the user can simply change back to that tab. From How to make HTML open a hyperlink in another window or tab? you could use

<a href="../path/to/other/documentation/page/index.html" target="_blank">OtherDoc</a>

for your links. Note the addition of target="_blank".

edited May 23, 2017 at 12:23

CommunityBot

11 silver badge

answered Sep 19, 2012 at 17:35

Chris

46.7k17 gold badges140 silver badges160 bronze badges

Collectives™ on Stack Overflow

Weblink in documentation and maintain a "back" ("myLib/index.html") link header

2 Answers 2

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related