burrokeet
 

Frequently Asked Questions

Questions

1. Contributing

1.1. How can I help write documentation?

^

This project is self hosting in terms of its documentation. That is the Burrokeet documentation is created in and managed with the Burrokeet software.

If you want to write a new document for inclusion in our documentation you can do one of the following (in order of preference):

  • install Burrokeet and write content using the tool directly
  • write XHTML and submit it to the project as a patch
  • write Open Office Writer or Impress files and submit it to the project as a patch
  • write Microsoft Word files and submit it to the project as a patch
  • send a text document to the developer mailing list

If you are updating or improving existing documentation you must get the latest copy of that documentation from CVS, make the relevant changes and submit a patch to the project.

Open Source projects are typically poorly documented, we would greatly appreciate any help you can give in making sure that our documentation is continually improving.

2. Standards Compliance

2.1. Burrokeet uses an "IMS Manifest" to describe the resources available in a contents package and the structure they should take, where can I find out more about the IMS Manifest standard?

^

The IMS Content Packaging Specification can be found on the IMS Project web site.