GNOME Bugzilla – Bug 634116
custom layout does not always honor visibility attribute in the index
Last modified: 2018-07-30 10:53:24 UTC
In an attempt to work around PR611413 [Ambiguous header: Modules (i.e. Classes) vs. Modules (i.e. Groups)], I had a look at the LAYOUT_FILE. As I understand it, this should provide the means to relabel some headings, in particular the modules/namespaces ones. I generated a layout file with `doxygen -l` and modified it to: <tab type="modules" visible="yes" title="Groups"/> After rebuilding the documentation, (a) the main page has the "Groups" label in the TOC (b) the INDEX has the "Groups" label (c) when clicking the link to modules.html, the caption is "Modules", not "Groups" (d) likewise in the QHC output, the tree item has the caption "Modules" Same holds for namespaces and possibly for other sections.
The TreeView panel has the same issue in that it displays "Modules" instead of "Groups".
Confirmed. Should be fixed in the next subversion update.
(In reply to comment #2) > Confirmed. Should be fixed in the next subversion update. Not fully. I do get the proper heading now, so that's already an improvement. However, the modules page now reads: -- 8< -- Groups Here is a list of all modules: [...] -- 8< -- Here, "Groups" is the changed title. Is it possible to omit the intro? Or have it parametrized? Second, the visibility of at least these elements is not taken into account: <navindex> <tab type="namespaces" visible="yes" title=""> <tab type="namespaces" visible="yes" title="MODULEs"/> <tab type="namespacemembers" visible="no" title=""/> </tab> <tab type="classes" visible="yes" title=""> <tab type="classes" visible="yes" title="Derived TYPEs"/> <tab type="classindex" visible="no" title=""/> <tab type="classmembers" visible="no" title=""/> </tab> Even with visible="no", they are still listed and if the title is changed, the modified title is shown (tested with QCH output only).
This bug was previously marked ASSIGNED, which means it should be fixed in doxygen version 1.7.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.
Reopen. In r753, comment #3 still applies.
In 1.7.3 I've added the "intro" attribute to the relevant tab tags. This can be used to customize the introduction texts. Can you check if this solves your problem?
(In reply to comment #6) > In 1.7.3 I've added the "intro" attribute to the relevant tab tags. This can be > used to customize the introduction texts. > > Can you check if this solves your problem? Regenerated the layout file, got the intro-tags. Assuming that they expect yes|no parameters, I set them accordingly, but can't observe any difference. For this: <tab type="namespaces" visible="yes" title=""> <tab type="namespaces" visible="yes" title="xxxModules" intro="yes"/> <tab type="namespacemembers" visible="no" title="xxxModuleMembersxxx" intro="no"/> </tab> I still see both entries in the menu on the left, named "xxxModules" and "xxxModuleMembersxxx" respectively. However, the latter should not be there.
Hi Daniel, The "intro" attribute can be used to specify the text used as an introduction on the page, i.e. the "Here is a list of all modules" line. Empty means the default text, so it is NOT a yes/no parameter, but an alternative text. I overlooked the second part of your observation; that visibility="no" does not work, which is indeed still a problem.
(In reply to comment #8) > The "intro" attribute can be used to specify the text used as an introduction > on the page, i.e. the "Here is a list of all modules" line. > Empty means the default text, so it is NOT a yes/no parameter, but an > alternative text. Ah, yes, that makes sense. I wondered. Yes, that works - thanks! :)
As discussed in https://github.com/doxygen/doxygen/pull/734 , Doxygen has moved its issue tracking to https://github.com/doxygen/doxygen/issues All Doxygen tickets in GNOME Bugzilla have been migrated to Github. You can subscribe and participate in the new ticket in Github. You can find the corresponding Github ticket by searching for its Bugzilla ID (number) in Github. Hence I am closing this GNOME Bugzilla ticket. Please use the corresponding ticket in Github instead. Thanks a lot!