Friday 6 July 2012

Updated documentation

Over the past week or so I've had a jolly time checking that all the Oracc documentation is up-to-date and reflects current practice, and that all the links work. I won't list every tiny change here, but would like to draw your attention to a few points in particular:

All users: Citing Oracc URLs online and in print
Oracc 2 makes systematic use of stable URIs, so that you can be confident that print references and online links will remain valid. That means, though, that some details of the instructions on how to cite Oracc pages and resources have changed.
Mostly for editors and managers: Oracc language codes
If you have already read my overview of how the new lemmatiser works, you'll know that now you always need to specify Akkadian dialects (unless you are producing ATF for CDLI) and that glossary merges must now always specify the language. I've also worked those changes systematically through the documentation.
For editors and project managers: builder documentation
Editors and project managers will also notice that I have rearranged the list of builder documentation. It's still all there as before but now, I hope, in a more logical order.
For project managers: glossary management
I have incorporated the L2 updates into the sections on glossaries in the pages on project management with Unix and project management with Emacs (and written it into the rest of the documentation).
For project managers: The Oracc Command
This page has been reorganised and updated, so that it is easier to find help on the commands you most need for everyday project management work.

And you'll now find a Documentation full text search at the top of every documentation page.

If you notice anything wrong, broken, missing, or just plain confusing, please let me know, either in the comments or by email. The documentation is for you, the users and project creators, so please tell me if (and how) it isn't serving your needs.

No comments:

Post a Comment