Finding and Using the ONIX Manual and Code Lists

The documentation prepared by EDItEUR is superb – it's clear, concise and fully supported including in the HTML 5 version cross reference links between the specifications and best practices.   And not only do they maintain and update it with every code issue release (normally 4 times a year), they provide different versions – PDF and HTML 5 for most things and it comes in multiple languages, though you may be happy to know the English language version is the source copy.  

They also have extra supporting documentation in white papers explaining specific sections and have been add "Application Notes" covering things that generate questions.   Some of the material can be dated.  That doesn't mean wrong – they remain a good guide to the underlying structure and intent but don't reflect additions made since publication.  So check the date. Their Best Practices are the best reference because it is updated regularly.

The only problem with all that choice is when you go to the EDItEUR website, and you're just trying to download the Manual, it's hard to know what to download.  Then once you have it, it's big and intimidating.   Here we look at what to get, and how to use it.

First,  you need to make a choice:  HTML 5 or PDF.  

OUR RECOMMENDATION: The HTML 5 version is much more flexible and easier to search and use.

The main reason you should consider using the PDF would be if your browser doesn't support HTML 5 well and updating your browser is a problem. We don't recommend printing the manual and recommend against printing the ONIX code lists.  Both are hard to use without a search function but the Code Lists are exceptionally quick to get outdated as the codes are updated 3 to 5 times a year.  

If you do print the manual, the PDF version is the way to go – just be sure to re-print the manual with every version change or couple of years (which is about how often new versions are issued).  A version change includes new composites and elements as well as existing composites and elements may be deprecated.    The ONIX for Books standard is not static.  How do you track version and code list updates?   BookNet's eNews will warn you or join the ONIX Implementation Group

Second,  do you get the Manual, or the Manual plus Best Practices

OUR RECOMMENDATION:  The Manual and Best Practices are best – especially if you get the HTML 5 version.  When you don't understand a section in the manual, the Best Practices will have additional content.  Sections in blue boxes are the 'not to be missed' content, white boxes reference common mistakes.  It's fast to use. Note that while the Best Practices assume you're using ONIX 3.0 much of the material applies equally to ONIX 2.1, just use some caution.  The concepts are mostly the same.

Third, the code lists.  

Here you have more options still – HTML 5, PDF 
http://www.editeur.org/14/Code-Lists/

and EDItEUR supports an on-line look up for the code lists:
https://ns.editeur.org/onix
with an instruction PDF here: ONIX browser.pdf

The most important thing to understand is that the code lists have a "Notes" section where code use is described.  If you use software most only show the "description" and it's short memory jog but seldom completely clear about what the code means.  And a drop down doesn't always display enough of the code list to see what your options are.  You must have access to the full code list and whenever you're unsure what code to use, use it.  More often than not the Notes will explain things fully.  If they don't the Best Practices document will.   And if you're still unsure you can contact BookNet Canada at biblio@booknetcanada.ca.

But please use a code list with the Notes as much as possible – it will give you the confidence you are using the right code

OUR RECOMMENDATION:  Try the on-line lookup (the  at the top or the * are used to get the Notes) as it can be the fastest way to access a code, but we would still recommend downloading the HTML 5 single document code list.  Both it and the on-line look up are unified documents that you can search it for terms (an example would be finding which Lists reference "Bestseller" – and finding the term leads you to Code List which can be used to find out where it's used Specifications) but the HTML 5 version displays everything at a glance.  Arguably so does the on-line version – so maybe we're old fashioned – but try both and read the notes!  

But whatever you do you should always use Specifications and Best Practices with their linked HTML code pages.  That way you always have the right code at your fingertips – with the Notes that explain when to use it.

ALL CODE LISTS, INCLUDING AS A SINGLE DOCUMENT HTML 5:

http://www.editeur.org/14/Code-Lists/

ONIX 3.0

Also available on  http://www.editeur.org/93/Release-3.0-Downloads/

ONIX 2.1

Also available at:  http://www.editeur.org/15/Previous-Releases/

Using the ONIX Manual and Best Practices.

Graham Bell of EDItEUR prepared some guidelines to using the manual – reprinted here from the ONIX Implementers User Group:

ONIX implementers