After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 649107 - Add an index of help topics to the Mallard manual
Add an index of help topics to the Mallard manual
Status: RESOLVED FIXED
Product: anjuta
Classification: Applications
Component: documentation
git master
Other All
: Normal normal
: ---
Assigned To: Anjuta maintainers
Anjuta maintainers
Depends on:
Blocks:
 
 
Reported: 2011-05-01 19:22 UTC by Philip Chimento
Modified: 2011-07-01 20:06 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Patch with proposed implementation (17.38 KB, patch)
2011-05-01 19:22 UTC, Philip Chimento
none Details | Review
A better implementation using facets (20.89 KB, patch)
2011-05-05 16:25 UTC, Philip Chimento
accepted-commit_now Details | Review

Description Philip Chimento 2011-05-01 19:22:29 UTC
Created attachment 186988 [details] [review]
Patch with proposed implementation

> > > I think we can keep the main page as it is now and provide another
> > > page giving a complete index.
> > 
> > I experimented with that, and can prepare a patch for that too. The
> > only problem is that where each page shows its hierarchy at the top
> > (e.g. Anjuta ->  Project Management) it now shows a second entry
> > (Anjuta ->  Index ->  Index of all help topics).
> 
> That's looking fine to me, do you think it would be better in another
> way? I have an idea but perhaps you have better ones.

Here's my proposal. As discussed on the anjuta-devel-list, I'd be interested to discuss the merits of the various ways to implement such a thing.
Comment 1 Philip Chimento 2011-05-05 16:25:32 UTC
Created attachment 187292 [details] [review]
A better implementation using facets

Here's a better implementation, using Mallard's experimental facets, as suggested by Shaun McCance on the Mallard mailing list. This solves the problems of having each page display a link to the index; the only drawback is that you still have to specify on each page that you want it listed in the index, but at least that is not visible to the user.
Comment 2 Sébastien Granjoux 2011-07-01 20:06:09 UTC
Review of attachment 187292 [details] [review]:

Thank you very much for finding a solution to this issue and implementing it. I have committed your patch without any change.