D&C GLug - Home Page

[ Date Index ] [ Thread Index ] [ <= Previous by date / thread ] [ Next by date / thread => ]

[LUG] Readability check request

 

Comments welcome on this prototype manual for an imminent release of
pilot-qof 0.0.10.

http://pilot-qof.sourceforge.net/manual.html

"pilot-qof can be just the starting point for your personal data. This
extensions manual documents stylesheets and scripts that convert
pilot-qof data to and from standard formats. pilot-qof also tries to
work with a variety of other applications via text-based formats. The
most recent addition is calcurse: a text-based calendar and todo
manager, where pilot-qof datebook entries can be converted to calcurse
calendar appointments and pilot-qof todo entries to the calcurse todo list."

The examples are primarily intended to be run from within a shell
script, example scripts are included alongside the manual.

pilot-qof description:

pilot-qof provides a query interface to data on a Palm device, using
pilot-link and QOF - the Query Object Framework.
pilot-qof supports reading addressbook, datebook, expenses and ToDo data
from a Palm device to XML files using the generic XML format used by
QOF, called QSF. pilot-qof runs SQL-type queries on the live data or a
QSF XML file and results can be imported into other QOF applications or
converted to other text based formats, including non-XML formats like vcard.

More information at:
http://pilot-qof.sourceforge.net/

The basic idea is that current Palm utilities only offer the Palm data
as a single block. pilot-qof allows that data to be queried: e.g. to
exclude old results, to correlate records from different Palm databases,
to extract results within a time period or isolate data for one specific
event, customer, project or task.

Actually, any feedback on the overall readability of the website, the
manpage or the manual would be welcome. The website is a little short on
content right now. Substantial amendments can be attributed in the
package. Please quote the original text and specify the current filename
alongside your amendment when replying.

Here's your chance to make GNU documentation easier to read and understand.

:-)

The combination of the manual and the manpage should be sufficient to
allow you to understand how the application works and how you could use
it alongside other applications. I suspect more content is required
before that is actually achieved but the majority of content should go
in the manual - manpages should be a quick reference, mostly.

-- 

Neil Williams
=============
http://www.data-freedom.org/
http://www.nosoftwarepatents.com/
http://www.linux.codehelp.co.uk/


Attachment: signature.asc
Description: OpenPGP digital signature

-- 
The Mailing List for the Devon & Cornwall LUG
http://mailman.dclug.org.uk/listinfo/list
FAQ: http://www.dcglug.org.uk/linux_adm/list-faq.html