create account

garboard


Garboard is the new garbure helper that replaces the main rolling menu and the documentation/exemples browsing via nautilus.

It's a hack of yelp (gnome-help), it allows different tables-of-content (e.g. ratatouille-toc.xml or rollmops-toc.xml), with nicer look-and-feel. Any entry is a link to an internationalised dockbook-xml documentation, and it is able to launch applications with a single-click


intallation

Add garbure APT repository tou your /etc/apt/sources.list:
deb http://garbure.org/debian/ ./
deb-src http://garbure.org/debian/ ./


Then update new available packages:
apt-get update

And install garboard:
apt-get install garboard


usage

Write an xml file in /etc/garbure/ or in ~/.garbure/ with the name of your distribution followed by -tox.xml, e.g. kimchi-toc.xml.

Then discribe the applications you want in your distribution using the exemple below:

<?xml version="1.0" encoding="UTF-8"?>
<toc id="index" type="garbure" bgcolor="#cccccc">

<title>Kimchi</title>
<title xml:lang="fr">Kimchi</title>
<title xml:lang="ko">김치</title>

<toc id="Audacity">
<title>Audacity</title>
<title xml:lang="fr">Audacity</title>
<garbure_resource>/usr/share/doc/audacity/garbure/doc.xml</garbure_resource>
<garbure_icon>/usr/share/pixmaps/gnome-mixer.png</garbure_icon>
<garbure_description>Sound editor.</garbure_description>
<garbure_description xml:lang=fr>Logiciel de son.</garbure_description>
</toc>

<toc id="Inkscape">
<title>Inkscape</title>
<title xml:lang="fr">Inkscape</title>
<garbure_resource>/usr/share/doc/inkscape/garbure/doc.xml</garbure_resource>
<garbure_icon>inkscape</garbure_icon>
<garbure_description>Vectorial drawing</garbure_description>
<garbure_description xml:lang="fr">Dessin vectoriel</garbure_description>
</toc>

<toc id="foo">
...
</toc>

<toc id="bar">
...
</toc>

</toc>


Save it and run garboard --garbure-toc kimchi !

Take care of it, it will be the master piece of our next realeses ;-)


docbook XML

The link you specify in <garbure_resource> markup must be in dockbook format, you can use emacs, openoffice, conglomerate, or wahtever. At the difference that garboard allows you to launch application using the "run:" prefix in you <link> markups, e.g.:

to do

Integrate a button to allow user to improve the documentation in an external doocbook based wiki.


screenshot

garboard.png