Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

missing: navigation special command #9434

Open
aotto1968 opened this issue Jul 3, 2022 · 6 comments
Open

missing: navigation special command #9434

aotto1968 opened this issue Jul 3, 2022 · 6 comments
Labels
enhancement a request to enhance doxygen, not a bug needinfo reported bug is incomplete, please add additional info

Comments

@aotto1968
Copy link

aotto1968 commented Jul 3, 2022

Hi,

a \page is a collection of \section, \subsection, etc…

I would like to have a \navigation feature to jump to the innermost section or section of section etc…

reason: it is very complicated for the end-user to add an additional \navigation feature into a page because of section-names and documentations-structure is changing over the time.

I think doxygen knows which is the current section all the way up to the top most section.

example: my largest doxygen-(html)-page has more than 1000 lines (everything on one page) and an extra navigation feature would be pleasant.

The most important navigation targets are:

  1. topmost → topmost section
  2. start → beginning of current section
  3. up → one section up
  4. previous → beginning of previous section
  5. next → beginning of next section

thanks for your great work.

@albert-github albert-github added enhancement a request to enhance doxygen, not a bug needinfo reported bug is incomplete, please add additional info labels Jul 4, 2022
@albert-github
Copy link
Collaborator

In the doxygen manual we have at the bottom of the page lines like:

Go to the next section or return to the index.

thenext, probably, represent what you mean with \navigation next, though in the doxygen manual this is hard coded.
A \navigation topmost I would more likely name \navigation first (and also have a \navigation last).
Some navigation is already possible in some outputs (e.g. by means of the treeview in HTML or the more general \tableofcontents with an in page "index").
What would be the difference between \navigation up and \navigation previous?

As the \tableofcontents information is written in the beginning of a page it should probably be possible to also have some way to have the requested \navigation commands.

@aotto1968
Copy link
Author

\section 1
  \subsection  11
  \subsection  12
    \subsubsection 111
    \subsubsection 112
    \subsubsection 113
  \subsection  13

you are in "112"

topmost(first)=1
start=112
up=12
previous=111
next=113

@albert-github
Copy link
Collaborator

When having:

\section 1
  \subsection  11
  \subsection  12
    \subsubsection 111
    \subsubsection 112
    \subsubsection 113
  \subsection  13
\section 2

and being in 112:

  • shouldn't there also be a possibility to do to 13? like there is with up to 12. This could probably be accomplished by down.
  • as there is is the possibility to jump to 1 shouldn't be there also a possibility to jump to 2?

@aotto1968
Copy link
Author

everything could be possible → my mention was only the minimum-requirement.

With the minimum-requirement I can generate all the other movements with a combination of these minimum-requirement

example:

  1. the down is a combination of up + next → you save one click
  2. the up 2 is combination of up + up → you save one click

There is a good point to minimize the additional api to the minimum-requirement

@albert-github
Copy link
Collaborator

You say:

There is a good point to minimize the additional api to the minimum-requirement

what is this good point? I just see, as far as I understand the problem, that the minimum-requirement would result in more clicks for the user.
The up 2 means to go to from subsection 112 the section 1. For clarity of the writer of the user documentation it might be more clear to have something like up section though here we have to be careful as at some places doxygen does add / remove a level in the naming.

@aotto1968
Copy link
Author

You are always free to add more specific \navigation elements than described in the previous requirement.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement a request to enhance doxygen, not a bug needinfo reported bug is incomplete, please add additional info
Projects
None yet
Development

No branches or pull requests

2 participants