Re: See Also

[Damon Chaplin <damon karuna freeserve co uk>]

Dave Mason wrote:
> 
> I think we should incorporate a "See Also" section for every reference page. I
> know that the Object Hierarchy already does that to some extent but there are
> times when there are related items that are outside of the current hierarchy.
> 
> Perhaps we can make a new section for each page that will generate "See
> Also". In this section we can re-list the Object Hierarchy members and
> then the author can add other items that fall outside of that hierarchy.
> 
> thoughts?
> 
> Dave

Owen mentioned this as well a while back.

So we add another section to the templates:

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

This will be output at the bottom of the page, and for widgets we'll automatically
add the list of ancestors, e.g. for GtkSocket

See Also

  GtkPlug
     the opposite of a GtkSocket, allows a GTK+ widget to plug into an
     external X Window.

  The ancestors of GtkSocket: GtkContainer, GtkWidget, GtkObject.


I suppose we need to agree on a way to code these, e.g. for the above:

<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>#GtkPlug</term>
<listitem>the opposite of a GtkSocket, allows a GTK+ widget to plug into an
external X Window.</listitem>
</varlistentry>
</variablelist>
</para>

Damon