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 615582 - add syntax highlighting to the code in the documentation
add syntax highlighting to the code in the documentation
Status: RESOLVED FIXED
Product: GStreamer
Classification: Platform
Component: documentation
unspecified
Other All
: Normal enhancement
: git master
Assigned To: GStreamer Maintainers
GStreamer Maintainers
Depends on:
Blocks:
 
 
Reported: 2010-04-12 21:31 UTC by Jordi Burguet-Castell
Modified: 2016-11-29 12:06 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Jordi Burguet-Castell 2010-04-12 21:31:07 UTC
In the documentation for gstreamer:
http://gstreamer.freedesktop.org/data/doc/gstreamer/head/pwg/html/index.html
it would be great to have the code excerpts with syntax highlighting.

It can very easily be done using source-highlight, code2html or similar tools.
Comment 1 Stefan Sauer (gstreamer, gtkdoc dev) 2011-03-01 21:15:12 UTC
Do you intend to make a patch?
Comment 2 Jordi Burguet-Castell 2011-03-03 22:22:42 UTC
Not really, I had a quick look at the code for the site and couldn't figure out where the code snippets appear.

But for example, if the code appeared in static web pages as "<!-- code2html add -l c /home/weasel/foobar.c -->" like in:

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html>
  <head>
    <title>Foobar</title>
  </head>

  <body>
    <h1>Foobar</h1>

    Hello everybody!

<!-- code2html add -l c /home/weasel/foobar.c -->

    That's it.
  </body>
</html>

then by running "code2html -p thisfile.html" it would substitute the comment line with the actual colored code. (see http://www.palfrader.org/code2html/patching.html )
Comment 3 Tim-Philipp Müller 2016-11-29 12:06:42 UTC
This should be mostly done now, see e.g.

https://gstreamer.freedesktop.org/documentation/plugin-development/advanced/events.html