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

class="current" not applied to <li> for module tab within 'group__*.html' module html files (Origin: bugzilla #754130) #5847

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Copy link
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity normal in component general for ---
Reported in version 1.8.10 on platform Other
Assigned to: Dimitri van Heesch

On 2015-08-26 15:53:12 +0000, Eric Pruett wrote:

The behavior of the pages tab in the horizontal tab bar doesn't seem to be replicated in the modules tab:

  1. Select related pages
  2. Select a link to a page
  3. Observe that the 'related pages'
  4. entry is <li class="current> as defined in templates/html/htmltabs.tpl, presumably since page.highlight=='pages'.

For the problem case:

  1. Select Modules
  2. Select a link to a module
  3. Observe that the 'modules'
  4. entry is simply
  5. , and in fact no tabs have class="current" applied, even though htmltabs.tpl seems to apply this class when page.highlight=='modules'.

Result:
Tab look and feel is inconsistent and the user loses context of where they are in the documentation. Css cannot alter the current tab's look for module pages.

I tried to investigate this, but actually nothing I did in the htmltabs.tpl file seemed to have any effect. Even plain html tags outside of the {% if %} blocks to this template file did not propagate to the html generated. If you can give me some pointers, I can look into this. It seems that page.highlight=='modules' is only getting applied for the module listing page, and not for the individual 'group__*.html' module pages. I suspect this has to do with the implementation or calling of a function in src/context.cpp

On 2015-08-26 19:31:55 +0000, Dimitri van Heesch wrote:

Hi Eric,

Don't look at any of the .tpl files or the code in context.cpp or template.cpp. This is for doxygen 2.0 and is not used yet!

I think the issue is:

void GroupDef::writeDocumentation(OutputList &ol)
{
//static bool generateTreeView = Config_getBool("GENERATE_TREEVIEW");
ol.pushGeneratorState();
startFile(ol,getOutputFileBase(),name(),title,HLI_None);
...

where the HLI_None should have been HLI_Modules.

Can you check if that works?

On 2015-08-26 20:31:18 +0000, Eric Pruett wrote:

Yes, that does indeed work. Thanks!

And thanks for clearing up the .tpl file issue. I thought I was going crazy there for a minute :)

Would you like me to submit a pull request or is there a test suite you run these changes through first?

On 2015-08-27 07:34:06 +0000, Dimitri van Heesch wrote:

pull request is not needed. It is such a small change that I've committed it myself. Just wanted to be sure it actually fixes your problem.

On 2015-12-30 10:19:09 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.11. 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 (preferably in the form of a self-contained example).

On 2016-02-10 17:21:57 +0000, Eric Pruett wrote:

I can confirm this is fixed, and is working properly in 1.8.11.

Sorry for the late confirmation.

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.