Re: Idea for the Eye Of GNOME documentation

[Tiffany Antopolski <tiffany antopolski gmail com>]

Hi Mario,

Have a look in the Git. There are two modules which are related to
gedit, but don't have a manual: gedit-cossa and gedit-collaboration.

 
Okay, I have cloned both of these from git.  I think I will use gedit-collaboration to play with.
 

We
need to write some documentation therefore (just stubs, only for testing
purposes) and setup a gnome-doc-utils/yelp-tools infrastructure. Then
the header of the *.page file(s) should look as follows (for gedit-cossa):

-----------------------------------------------------------------------

<page xmlns="http://projectmallard.org/1.0/"
     type="topic" style="task"
     id="gedit-plugins-cossa">

<info>
 <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
 <revision pkgversion="3.0" version="0.1" date="2011-06-14" status="stub"/>
...
</info>

-----------------------------------------------------------------------

 

The docs for these plugins should not have an index.page?  

How do I setup a gnome-doc-utils/yelp-tools infrastructure?

Of course, we have to make sure that the plugin manual has landed in the
same installation folder as the gedit manual itself.

How do I make sure this happens?
 

After installing
the plugin, the help files for that plugin should appear in the right
topic, under the "plugins" topic.

Thanks,

Tiffany