Welcome to the third issue of the GNOME Documentation Project Status Report. As always, lots of exciting things are going on. Nautilus is getting even better at rendering SGML documents, ScrollKeeper is quickly approaching its first beta release, a bunch of new people have joined the GDP and started writing various documents, a solution to licensing issues has been found, a number of docs have recently been finished, more Sun contributors have trickled in and quietly started working, a GNOME style guide is slowly being prepared for discussion on the mailing list, and more. Read below for more information.
After some discussion with Richard Stallman, we have determined a nice way to properly ship our documents with the FDL. Most GNOME packages and documents on the web should be updated. See the section called Free Licenses - Come and Get 'Em for details.
John Fleck has written a nice summary of the GDP Document Changes Required For GNOME 1.4. These are changes which we should make for all GNOME documents which are shipped with GNOME. Most of these changes are necessary to make them render properly in Nautilus which does not yet support the full DocBook DTD. Others are more stylistic. Please note that this list of updates is not 100% complete and may change. You may consider holding off a couple more weeks before making these changes if you do not wish to revisit the list later to see if any additional modifications are necessary. (Note that we also need to start installing the SGML documents.)
Install your SGML docs. The current plan is to ship GNOME 1.4 with both SGML and HTML docs. The intention is to use the SGML, which should give us some additional benefits like extraction of the table of contents. However we will continue to install HTML docs as well until we are confident we have all the bugs worked out of the new system. If you have CVS access and are responsible for the installation or packaging of GNOME packages, please make sure the SGML files are installed with the HTML.
GNOME Stock Ticker is now part of gnome-applets. A new GDP member, Gilles Robitaille, is writing the user manual.
The author of GHex would like some help converting the GHex manual from HTML into DocBook/SGML. He has also agreed to license it under the FDL. This would be a great way for somebody to learn DocBook. If you would like to do this, send me an email.
GNOME is Free, which means that the software is under the GPL or LGPL and the documentation is under the FSF's GNU Free Documentation License. Eric Baudais has been working hard to mark up these various licenses in DocBook. If you would like to include these licenses as appendices to your documents, you can grab them out of CVS at gnome-docu/gdp/fdl.sgml and gnome-docu/gdp/gpl.sgml.
![]() | Using these licenses |
|---|---|
To use the FDL, you must include a copy of it in the package. Further, your documentation must link to a reliable source of the license which is part of the package(s). To suit these requirements, all packages which have FDL'd documents should include a copy of the FDL in a file called COPYING-DOCS. You can get this file out of CVS at gnome-docu/gdp/COPYING-DOCS. A copy of the FDL will be installed by gnome-core which GNOME applications can link to. This is not yet set up, but a link to "gnome-help:fdl" should work soon (look here for an example). If you have any documents which appear on the web, you should grab the file gnome-docu/gdp/fdl.sgml from CVS and include it as an entity to create an appendix containing the FDL which you can refer to. |
We have had quite a few new people join the GDP in the last couple months. I thought I should introduce them so that everybody can welcome them when they see them on IRC or the mailing lists. New contributors (shown with their project) include: Liam Hazell (GNOME Color picker), Jeff Waugh (Sawfish Capplet), Ian Miller (Free Cell), Tim Riehle (GNOME Mines), Gilles Robitaille (GNOME Stock Ticker), Michael Koziarski (GNOME Xbill), Emese Kovacs (Glines), Erik Jarvi (gtcd, other gnome-media), John Gilger (GNOME Manual of Style), Pat Costello (GNOME Manual of Style), Michael McElree (GNOME Manual of Style, Sawfish), Rob Bradford (GNOME-Stones). (If I forgot anybody, please email me and I'll include you next time.)
The GDP has always been one of the coolest parts of GNOME, but now it is getting style too. One of the offspring of a long but interesting discussion on whether we should change the name from "GNOME" to "Gnome" was the idea that the GDP needs a style guide. This has been discussed and even partially started in the past, but now it is really happening. Plus, it is being developed by a combination of hard-core GDPers and professional style guide authors. The team developing The GNOME Manual of Style is: Pat Costello, John Fleck, John Gilger, Alexander Kirillov, and Michael McElree. As soon as they have a draft ready, we will discuss it on gnome-doc-list and make any necessary revisions before using it in the GDP.
Dan Mueth wrote up a short tutorial on Joining the GNOME Project. It aims to help people who want to join the GNOME project get started. It seems to be drawing attention to some areas of GNOME which have not been receiving much attention, such as desktop sounds.
Just as everybody was crossing their fingers and saying their prayers for a GUI DocBook editor, a number of possible solutions have popped onto the scene. The one many of us are most familiar with is Conglomerate. This was a beautiful demonstration of how nicely a GUI DocBook editor could be. The concensus seems to be that Conglomerate is a very ambitious project and making it work properly would require a substantial amount of additional coding. There is currently some private discussion between a couple GNOME and KDE hackers to try to do a joint effort to build on this. There are obvious complications to making a joint effort here, but it would be great if we could work this out.
What I think many of us were surprised by were some newcommers to the DocBook editing scene. First, Lyx has recently acquired the ability to export DocBook/SGML and even ships with a DocBook template. It does not import DocBook/SGML yet, but it is rumoured this is in the works. There is also a GNOME port of Lyx in progress, which would make this an even more attractive solution.
Abiword has also recently obtained DocBook exporting support. Later the same day it acquired DocBook importing support. Boy - you have to love these Abiword guys. I haven't tried it out yet, but it looks like Abiword will win the prize for the first viable DocBook editing tool under GNOME. Send them an email and show your support.
GNOME 1.4 will have a new package called gnome-user-docs which will contain general user documents. Alexander Kirillov is coordinating this package and has been doing a lot of the writing so far. It currently has a glossary, Introduction to Gnome, and If you are new to Linux/UNIX. If you have any feedback on these documents, please send them to Alexander or else to docs@gnome.org for general discussion.
We are looking for volunteers for the following tasks:
We need people to work on the following:
Fix doc bugs remaining from GNOME 1.2 release. (Documentation bug list in HTML format)
Test Nautilus-based help system. Please send all bug reports to Eazel's Bugzilla server. (Note: This involves building Nautilus out of CVS.) (Contact: Ali Abdin)
Improve subject tree for a Contents list which includes all types of documentation on a system.
Coordinate an update of the developer documention in the architecture section of the developer web pages. This information should also be placed into a stand-alone DocBook document which we can distribute under the FDL. (Contact Dan Mueth for more information.)
We need developers to work on the following:
Update GNOME technology descriptions in the Architecture and Design part of the developer web pages.
Write API docs. (High priority)
Write/maintain developer tutorials and white papers.
We need document authors to work on the following documents:
GNOME Icon Edit manual.
Manuals for any games in gnome-games which lack them. (See the DocTable for a complete list.)
GHex manual.
Help docs for internal GNOME widgets (file picker, font picker, color selector, print preview, etc.).
This is a list of documents which have recently been updated or finished. It is meant primarily to help translators, but may also be of use to package maintainers and users.
FDL (Free Documentation License)
GPL (GNU Public License)
Joining the GNOME Project
gnome-xbill (not yet in CVS)
This is a list of documents which have been finished for a while, but are still good candidates for translation. They are sorted by package.
gnome-utils (essentially all apps: gcalc, gcharmap, gsearchtool, gdict, gfloppy, gstripchart, gtt, gless, guname, gw, gshutdown, idetool, gfontsel, gcolorsel, gdiskfree)
gnome-core (Panel, all applets in gnome-core, gnome-terminal)
gnome-applets (almost all of them)
gnome-games (Iagno, Aisleriot, Gnibbles, Mahjongg)
gnome-media (gtcd, gmix)
bug-buddy
gtop
Glade FAQ and Glade Quickstart Guide
The GNOME Documentation Project Status Report is a periodic report describing the recent events of the GDP (GNOME Documentation Project) and the status of various documents. I hope that these reports will be useful for GDP members, translators, developers, and potential GDP contributors. If you have any submissions or suggestions for these Status Reports, please send them to <d-mueth@uchicago.edu>.
The goal of the GDP (GNOME Documentation Project) is to provide a complete documentation system for GNOME. The main part of this is writing and maintaining application manuals for all applets and applications in the main GNOME distribution and GNOME Office. The GDP also writes other user documentation such as application hints (a la gnome-hint), pop-up help (coming soon), the GNOME User FAQ, and the GNOME User's Guide. The GDP also writes and maintains developer documentation such as API documents, White Papers, and developer tutorials. These developer documents are generally written by developers who work with the GDP since it requires technical expertise on the particular topic. And lastly, the GDP, along with various GNOME hackers, is responsible for designing the different components of the GNOME help system, such as the tutorial/demo wizard (coming soon), pop-up help (coming soon), and the documentation browsing system.
The GDP is always looking for new volunteers to write documentation or help in other ways. If you are interested in joining or contacting the GDP, visit the GDP web page or chat with us on IRC at #docs on irc.gnome.org.