Re: Idea for the Eye Of GNOME documentation

[Mario Blättermann <mariobl freenet de>]

Hi Tiffany,

Am 14.06.2011 20:36, schrieb Tiffany Antopolski:
> 
> How would someone go about doing what is suggested in this thread?  I am
> actually having some trouble picturing this.
> 
Let's begin with a simple attempt without affecting any existing docs.
The gedit manual could be a playground for that.

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. 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>

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

Of course, we have to make sure that the plugin manual has landed in the
same installation folder as the gedit manual itself. After installing
the plugin, the help files for that plugin should appear in the right
topic, under the "plugins" topic.

If we do so, we can't let recognize plugins which are installed in
~/.local/share/gedit/plugins, though. But we can plugin docs let appear
which come from a distribution package, at least.

In general, I could imagine a convenient way to identify any *.page
files as assigned to a certain help module. I mean, Yelp should be able
to find a gedit plugin manual, although it doesn't reside within the
gedit manual folder itself. As far as I know, the Scrollkeeper
cataloging system is no longer included in the GNOME help. But there
should be a replacement in the nearest future which allows to identify
doc files in certain places.

Best Regards,
Mario