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 149253 - Customize example page
Customize example page
Status: RESOLVED OBSOLETE
Product: doxygen
Classification: Other
Component: documentation
1.3.x
Other Linux
: Normal enhancement
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
[moved_to_github]
Depends on:
Blocks:
 
 
Reported: 2004-08-04 08:24 UTC by Philipp Frauenfelder
Modified: 2018-07-30 10:13 UTC
See Also:
GNOME target: ---
GNOME version: 2.5/2.6



Description Philipp Frauenfelder 2004-08-04 08:24:50 UTC
I do have a few examples in our project. Actually they are more tutorials than
examples. They have descriptive names and should be looked at in a specific
order. However, this specific order is not the same as the alphabetic order of
the example names.

I have created a tutorials index with the @page command which appears in the
'related pages' section (the index contains some more description on the
examples). Now, there are two pages referencing the same examples: one with the
good ordering and one with the alphabetical ordering.

I would like to either turn off the examples index alltogether or have a
possibility to customize it / replace it with my own @page.

You can have a look at what I mean here:
- Tutorials overview (the 'better' examples index):
  http://www.concepts.math.ethz.ch/doxygen/html/tutorials.html
- Doxygen generate examples index (with 'wrong' alphabetical ordering):
  http://www.concepts.math.ethz.ch/doxygen/html/examples.html
Comment 1 Anne 2010-08-11 12:48:55 UTC
What nice pages you have Philipp! I'm glad they're still up to view; 2004 is a long time ago now :).

I like your ability to see both orderings of the examples. Since they both have links, why not add either straight html or <see cref=""/> links to the other pages on each one? So tutorials.html can say "for an alphabetical list, go to [examples]" and examples.html say "for descriptions and the proper sequence, go to tutorials." 

On Tutorials you already have text you've written.
On Examples, if none of the text is handwritten, then maybe adding a description blurb would be an easy enhancement. Otherwise, you could perhaps [a bit annoyingly] add the blurb to the top of each tutorial itself.
Comment 2 Anne 2010-08-11 12:55:40 UTC
Philipp or anyone else, if you happen to read this, I'd be curious how you constructed your pages. I would like to have similar writeups. Thank you!
Comment 3 ferrishu3886 2016-04-04 12:49:56 UTC
Hello, I'm up with Anne. It would be really nice if anyone can offer some pointers on how to construct those pages. Thanks!
Comment 4 André Klapper 2018-07-30 10:13:32 UTC
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!