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 613886 - add a clickable concept map to gst-core docs
add a clickable concept map to gst-core docs
Status: RESOLVED FIXED
Product: GStreamer
Classification: Platform
Component: documentation
unspecified
Other Linux
: Normal enhancement
: 0.10.29
Assigned To: GStreamer Maintainers
GStreamer Maintainers
Depends on:
Blocks:
 
 
Reported: 2010-03-25 08:50 UTC by Stefan Sauer (gstreamer, gtkdoc dev)
Modified: 2010-04-08 12:22 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
add concept map (5.49 KB, patch)
2010-03-25 08:50 UTC, Stefan Sauer (gstreamer, gtkdoc dev)
none Details | Review
the svg (18.25 KB, image/svg+xml)
2010-03-25 09:59 UTC, Stefan Sauer (gstreamer, gtkdoc dev)
  Details
the html page (2.66 KB, text/html)
2010-03-25 10:01 UTC, Stefan Sauer (gstreamer, gtkdoc dev)
  Details

Description Stefan Sauer (gstreamer, gtkdoc dev) 2010-03-25 08:50:46 UTC
Created attachment 157036 [details] [review]
add concept map

The patch adds a graphviz dot file, rules to render it to svg and include in docs. Nodes are clickable. 

The idea is to give an overview things in gstreamer universe fit together.

TODO:
- people that build docs need graphviz installed (the rule to make the svg would silently fail, but the image won't be copied). We could simply add the generated svg to git.
- it works fine in firefox, but e.g. not in my version of epiphany (2.28.0) and neither in devhelp (0.23) :/ - I simply don't see the svg there.
- it could look nicer - should it be handdrawn in inkscape?

Including it as a png + a image map would work, but then we would need to patch the generated html with it :/
Comment 1 Tim-Philipp Müller 2010-03-25 09:29:48 UTC
Could you attach your .svg so we can have a look without applying the patch?
Comment 2 Stefan Sauer (gstreamer, gtkdoc dev) 2010-03-25 09:59:37 UTC
Created attachment 157043 [details]
the svg
Comment 3 Stefan Sauer (gstreamer, gtkdoc dev) 2010-03-25 10:01:14 UTC
Created attachment 157044 [details]
the html page

copy this and the svg to e.g. gstreamer/docs/gst/html/ to have working links
Comment 4 Stefan Sauer (gstreamer, gtkdoc dev) 2010-04-08 12:22:21 UTC
Okay, its in. I'll try to make it look nicer in the future.