Re: programlisting and bgcolor



OK. Setting the 'role' on the generated stuff seems fine.

Though I would think example code should be nested in <example> or
<informalexample> really.

Damon


On Thu, 2001-12-06 at 02:24, Matthias Clasen wrote:
> You can look e.g. at the end of the description in
> http://developer.gnome.org/doc/API/2.0/gtk/gtkdrawingarea.html
> The example comes from a <programlisting> which is not nested inside an
> <example> or <informalexample>.
> 
> Matthias
> 
> ----- Original Message -----
> From: "Damon Chaplin" <damon ximian com>
> To: "Matthias Clasen" <matthiasc poet de>
> Cc: <gtk-doc-list gnome org>
> Sent: Thursday, December 06, 2001 1:22 AM
> Subject: Re: programlisting and bgcolor
> 
> 
> > On Wed, 2001-12-05 at 07:21, Matthias Clasen wrote:
> > > Looking at the current set of documents produced with gtk-doc, the
> > > red/green/blue coloring of text regions seems to be a somewhat
> arbitrary. My
> > > understanding is that gtk-doc tries to format things so that
> > >
> > > - function synopses are on blue background
> > > - parameter declarations are on red
> > > - examples are on green.
> > > - simple inline code snipplets are on white
> > >
> > > This works ok for function synopses and parameter declarations simple
> inline
> > > code snipplets, since the markup for function synopses and parameter
> > > declaration is generated by gtk-doc and inline code snipplets are
> generally
> > > marked up as literal if at all. But examples currently come out in a
> mixture
> > > of green and blue, since the green is used only if the programlisting is
> > > nested inside an example or
> > > informalexample, while other programlistings get blue, since gtk-doc
> > > generates programlistings for the function synopses.
> > >
> > > I would propose to have gtk-doc add a role attribute to the
> programlistings
> > > it produces for function synopses and let that role
> > > trigger blue. All other uses of programlisting should get green.
> > >
> > > Comments ?
> > >
> > > I'd volunteer to implement this if there is agreement.
> >
> > Could you point to an example somewhere (e.g. in the docs on
> > developer.gnome.org) so we can see what you mean?
> >
> > Yes, it would be good if all example code was in the same color.
> >
> > Damon
> >
> >
> > _______________________________________________
> > gtk-doc-list mailing list
> > gtk-doc-list gnome org
> > http://mail.gnome.org/mailman/listinfo/gtk-doc-list
> >
> 
> _______________________________________________
> gtk-doc-list mailing list
> gtk-doc-list gnome org
> http://mail.gnome.org/mailman/listinfo/gtk-doc-list





[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]