Help spread the word
The best way to help the OASIS project is to use it, of course. From the beginning, OASIS has been designed using real-life projects as examples to define features. The first public version was the one matching the most common requirements for the author's projects. It is now time to expand this requirements to your projects as well.
- Try OASIS on your libraries/programs
- If it doesn't work out of the box, you can try to fix the generated files
- If you are able to solve the problme by yourself, send us your fix for inclusion
- If it doesn't work for you, you can ask for help:
- on the IRC channel #ocaml on freenode (nickname: gildor)
- on the caml-list mailing list with subject containing "OASIS help" (caml-list AT inria.fr)
- on the caml-beginner mailing list with subject containging "OASIS help" (ocaml_beginners AT yahoogroups.com)
We really appreciate to get your feedback. Use bug reports or feature requests.
Once your project is OASIS enabled, you can advertise for the OASIS project on your project webpages. You can also ask to be added to the list of projects using OASIS.
Get involved into development
The main page for development is the project on forge.ocamlcore.org. You can browse the source code of the project and of its website.
To get a copy of the source tree, you must use darcs anonymously:
$> darcs get http://darcs.ocamlcore.org/repos/oasis
or if you have write access to the project:
$> darcs get scm.ocamlcore.org:/darcsroot/oasis/oasis oasis
Once you have the source code, you can pick a bug or a feature request to fix.
You can send back patches using darcs:
$> darcs send --to oasis-devel@lists.forge.ocamlcore.org
or commit directly your changes, if you have write access to the project:
$> darcs push scm.ocamlcore.org:/darcsroot/oasis/oasis
or with a bug report.
To update the source code with the latest available version:
$> darcs pull http://darcs.ocamlcore.org/repos/oasis
or if you have write access to the project:
$> darcs pull scm.ocamlcore.org:/darcsroot/oasis/oasis
Further documentation about darcs on darcs.net
Translation
OASIS uses ocaml-gettext for internationalization support. If you want to translate it to another languages, just fetch the .pot files and start translating.
Once done, you can submit a bug report or send us an email so that we can include your work into the next version of OASIS.
Write plugins and tools
If your requirements cannot be fulfilled by the actual code, you can extend OASIS features through plugins. For now, plugins development need to be done with the OASIS source tree.
- Get a copy of the OASIS source tree (see next section)
- Add a directory into
src/plugins/ - Add an "open" statement in
src/OASISBuiltinPlugins.ml - Create a test into
test/dataand call it from within a test case (seetest/TestFull.ml) - Create your plugin
Writing tools is not yet very easy. You need to depend only on the content of src/oasis, which should become a library soon. Theses files contain everything needed to parse and extract information from an _oasis file. You can also subscribe to the oasis-devel mailing list.
