Oz Documentation Project

[pframpton]

There have been many rants and raves about the lack of documentation for OZ. I plan to put together a set of manuals for as many applications as possible. Not just a collection of tips/tricks/FAQs but a comprehensive manual on using the programs.

For this I will need volunteers. The first stage is to write quides for the most important/common applications. I welcome suggestions on which apps these are, aswell as volunteers to write documentation.

Ideall the document for an app will include:

Installation
Configuration
Use
Bugs/Trick/Tips
Links to source, more info, etc

I have started a webpage at OZ Documentation Project

I can be contacted by e-mail (details on the link above). Let me know which apps you want to write about and I will update the details on the website.

Philip

PS Could the admin pin this post to the top of the forum please?

[lardman]

Let's get writing everyone.


Si

[Merardon]

What would be particularly helpful would be a short description of all the packages installed by default, to aid in uninstalling the unessential ones. (Freeing up space) The information could then be integrated into the package manager via a description button. Unless this already exists, and I merely haven't located it yet.

[lardman]

The packages file contains a short description of each package - ipkg info <packagename> spits this info out to the terminal.

This would be a useful addition to aqpkg/opie-package-manager (IMHO), and may already have been suggested added (you'd need to check the opie bugtracker).

Edit: This functionality does exist in opie-packagemanager


Si

[mimeca]

Hi pframpton

I would like owrk in that project. Zaurus isn't for newbies and a good documentation can help. I can write some documents in english, but my language is spanish.

[Hrw]

in opie-packagemanager try to hold on package - infos will open

[Merardon]

From the packages I tested that out on, it didn't really tell what the package was, and what it was for, merely what it was called, space, what it requried, etc. Perhaps adding a small description of each package there would be helpful?

[pframpton]

Perhaps adding a small description of each package there would be helpful?
[div align=\"right\"][a href=\"index.php?act=findpost&pid=67086\"][{POST_SNAPBACK}][/a][/div]

This puts the burden on the maintainers rather than the volunteer document writers. They (the maintainers) have enough to do. This is why the description fields are minimal.

[lardman]

You could submit a patch for the .bb file to alter the description if you don't think it's descriptive enough.


Si

[Merardon]

I don't know enough about the packages to write up descriptions, unfortunately,and if I did, I wouldn't have requested the feature in the first place. I was implying a volunteer, actually.

[Merardon]

Are you alive, pframpton? You haven't responded to the e-mail that I sent weeks ago, my proposed fixes haven't been added, and it's not been moved to OESF.

[pframpton]

Yes, I'm alive. What message? Do you mean texteditor documents, if so I only just found it in my junk box, I've whitelisted you now.

[Merardon]

It was essentially just what I said last post, and was an e-mail from harpalus hush ai (insert the @ and ., respectively) I'll have enough time to write up something in a few weeks, so I can start contributing then.

[acpkendo]

Do you mean texteditor documents, if so I only just found it in my junk box, I've whitelisted you now.

opie-textedit docs were from me, opie-write or Hancom (probably not tinykate) to follow. . .

[pframpton]

Before too much more is written, it would be good to produce some documents based on the OPIE and GPE documentation. No need to write instructions form scratch when the basics are already done.

I'm working on an the main manual PDF at the moment. Copying across info from the OZ website. Hopefully we can have a 0.1 release manual, based on what is done so far, ready for OZ 3.5.3.