[Accessibility conventions are described at the bottom of the page]
*** This is a free preview excerpt of a commercial publication. ***

`Practical Code List Implementation`

Notices
Copyrights
[[1] - Other original material herein is copyright (C) 1998-2009 Crane Softwrights Ltd. This is commercial material and may not be copied or distributed by any means whatsoever without the expressed permission of Crane Softwrights Ltd.
]
Disclaimer
[[1] - By purchasing and/or using any product from Crane Softwrights Ltd. ("Crane"), the product user ("reader") understands that this product may contain errors and/or other inaccuracies that may result in a failure to use the product itself or other software claiming to utilize any proposed or finalized standards or recommendations referenced therein. Consequently, it is provided "AS IS" and Crane disclaims any warranty, conditions, or liability obligations to the reader of any kind. The reader understands and agrees that Crane does not make any express, implied, or statutory warranty or condition of any kind for the product including, but not limited to, any warranty or condition with regard to satisfactory quality, merchantable quality, merchantability or fitness for any particular purpose, or such arising by law, statute, usage of trade, course of dealing or otherwise. In no event will Crane be liable for (a) punitive or aggravated damages; (b) any direct or indirect damages, including any lost profits, lost savings, damaged data or other commercial or economic loss, or any other incidental or consequential damages even if Crane or any of its representatives have been advised of the possibility of such damages or they are foreseeable; or (c) for any claim of any kind by any other party. Reader acknowledges and agrees that they bear the entire risk as to the quality of the product.
]
Notices
OASIS Copyrights
[[1] - Some information included in this publication is from copyrighted material from the Organization for the Advancement of Structured Information Standards (OASIS) [http://www.oasis-open.org]. Files containing the copyrighted material include the following, which applies only to original OASIS documents and not to this commercial material created by Crane; please go to original OASIS documents to obtain any publicly-available content:
[[2] - Portions copyright (C) OASIS Open 2001-2009. All Rights Reserved.
[2] - http://www.oasis-open.org/who/intellectualproperty.php
]]
Preface
Preface
The main content of this book is in an unconventional style primarily in bulleted form
[[1] - derivations of the book are used for instructor-led training, requiring the succinct presentation
[[2] - note the exercises included in instructor-led training sessions are not included in the book
][1] - derivations of the book can be licensed and branded for customer use in delivering training
[1] - the objective of this style is to convey the essence and details desired in a compact, easily perused form, thereby reducing the search for key words and phrases in lengthy paragraphs
[1] - each chapter of the book corresponds to a module of the training
[1] - each page of the book corresponds to a frame presented in the training
[1] - a summary of subsections and their pages is at the back of the book
]
Much of the content is hyperlinked both internally and externally to the book in the 1-up full-page sized electronic renditions:
[[1] - (note the Acrobat Reader "back" keystroke sequence is "Ctrl-Left")
[1] - page references (e.g.: [Chapter 3.])
[1] - external references (e.g.: [http://docs.oasis-open.org/codelist/genericode])
[1] - chapter references in book summary
[1] - section references in chapter summary
[1] - subsection references in table of contents at the back of the book
[1] - hyperlinks are not present in the cut, stacked, half-page, or 2-up renditions of the material
]
Diagram legend:
[[1] - triangle: a structured XML/SGML/HTML document or resource
[1] - parallelogram: a non-structured document or resource in an arbitrary format
[1] - box: a process in the work flow
[1] - diamond: a decision in the workflow
]
Sample code fragments:
[[1] - included with the book purchase is a ZIP file of sample code fragments
[1] - directory names referenced in the book are referencing subdirectories in the unpacked ZIP files
[1] - the readme.txt file in the ZIP package documents the running of sample batch files and shell scripts
]
Important caveat regarding the information in this publication
[[1] - while the author, G. Ken Holman, is the chairman of the OASIS Code List Representation Technical Committee, not all of the material in this publication is necessarily accepted by all of the TC members as some of it is just proposed for acceptance
[1] - all of the content in this book is written from the opinion of G. Ken Holman and Crane Softwrights Ltd. and does not necessarily represent official or agreed-upon content from the perspective of the CLRTC
[1] - this content is not to be construed as legal advice of any kind, nor is it recommending that any particular methodology or process or tool be implemented, it only documents methodologies and technologies available to be considered
]
Entire chapters of this publication will undergo revision
[[1] - the CLRTC is debating the CVA specification
[1] - some software being developed by Crane Softwrights Ltd. is being made freely available for anyone to download and use
[1] - some software being developed by Crane Softwrights Ltd. will be made available only to customers of this publication
[[2] - to supplement the software that is made freely available
]]
The purchase of this publication is protected by the no-charge availability of all future editions
[[1] - all of the content in this publication is subject to revision and update and editions will get out of date
[1] - early editions are expected to be created frequently and be short-lived as the community experience with the code list file formats and processes reveals various practices and experiences that will influence how to consider working with this standard
]
The purchase of this publication grants the legitimate owner no-charge access to accompanying software written by Crane Softwrights Ltd.
[[1] - there are no warranties expressed or implied regarding the use of the software; more details are found in the documentation for the software
[1] - access details to download the software are found by registered users on [http://www.CraneSoftwrights.com/sales/pcli/]
[1] - while the software is free of charge, the software is not to be copied for or distributed to or used by anyone who is not a legitimate customer of this book, unless permission has been granted in writing
]
The author welcomes any and all suggestions for improvements and additional content
[[1] - please do not hesitate to contribute ideas for improving on this publication
[1] - all submissions to [info@CraneSoftwrights.com [mailto:info@CraneSoftwrights.com]] will be acknowledged (though not necessarily accepted!)
[[2] - please note that aggressive spam filters may make our email delivery difficult
]]
Prologue
This book is oriented to the system architect and system developer interested in deploying OASIS specifications for code lists in XML
[[1] - how do external code lists differ from embedded code lists and to what benefit?
[1] - what information design facets support flexible code list deployment?
[1] - what responsibilities face a community needing to support a legacy and a future of code lists?
[1] - what tools are available to be adapted for use in validating code lists?
]
This book covers that subset of OASIS genericode 1.0 suitable for expressing a single code list, and all of the OASIS context/value association draft specification
[[1] - [http://docs.oasis-open.org/codelist/genericode]
[1] - [http://www.oasis-open.org/committees/document.php?document_id=29990]
]
The first two chapters overview controlled vocabularies in general
[[1] - what do they represent?
[1] - how are they used?
[1] - how, historically, have they been deployed?
[1] - what new approaches are available for deployment?
]
The third and fourth chapters overview the specification of code lists in XML
[[1] - the use of the OASIS genericode specification
[1] - the detail of the OASIS genericode vocabulary
]
The fifth and sixth chapters overview the specification of context/value association files
[[1] - the use of OASIS CVA files
[1] - the detail of the OASIS CVA vocabulary
]
The last chapter outlines how to adapt validation stylesheets to use genericode and CVA files for an arbitrary vocabulary
The only annex introduces Crane Softwrights Ltd.'s OpenOffice 3 XML filter package Crane-gc2ods
[[1] - opening and saving OASIS genericode files
[1] - opening and saving OASIS CVA files
]
Enjoy!
Epilogue
Where to go from here?
The work on genericode and context/value association continues:
[[1] - OASIS Genericode 1.0 Committee Specification - December 27, 2007
[[2] - [http://docs.oasis-open.org/codelist/genericode]
][1] - OASIS Context/value Association Specification - 0.5 draft 1
[[2] - [http://www.oasis-open.org/committees/document.php?document_id=29990]
][1] - focus now shifts to association, support, deployment, awareness and evangelism
[1] - committee mail list - OASIS Code List Representation TC:
[[2] - [http://lists.oasis-open.org/archives/codelist/]
][1] - community mail list - CLR-Dev
[[2] - [http://lists.oasis-open.org/archives/clr-dev/]
[2] - [http://www.oasis-open.org/mlmanage/]
]]
Colophon
These materials were produced using structured information technologies as follows:
[[1] - authored source materials
[[2] - content in numerous XML files maintained as external general entities for a complete prose book that can be made into a subset for training
[[3] - specification of applicability of constructs for each configuration
[[4] - 45- and 90-minute lecture, half-, full-, two- and three-day lecture and hands-on instruction, and book (prose) configurations
][3] - an XSLT transformation creates the subset of effective constructs from applying applicability to the complete file
[3] - content from other presentations/tutorials included semantically (not syntactically) during construct assembly
][2] - customized appearance engaged with marked sections and both parameter and general entities
[[3] - different host company logos and venue and date marginalia
[3] - changing a single external parameter entity to a key file includes suite of files for given appearance
]][1] - accessible rendition in HTML
[[2] - an XSLT stylesheet produces a collection of HTML files using Saxon for multiple file output
[2] - mono-spaced fonts and list-depth notation conventions assist the comprehension of the material when using screen-reader software
][1] - printed handout deliverables
[[2] - an XSLT stylesheet produces an instance of XSL formatting objects (XSL-FO) for rendering
[2] - XPDF [http://www.foolabs.com/xpdf] extracts raw text from PDF files for the back-of-the-book index methodology published as a free resource by Crane Softwrights Ltd.
[2] - XEP by RenderX [http://www.renderx.com] produces PostScript from XSL-FO
[2] - GhostScript [http://www.GhostScript.com] produces PDF from PostScript
[2] - the iText [http://itext.sf.net] PDF manipulation library for Java is used for page imposition by a custom Python [http://www.python.org] program running under the Jython [http://www.jython.org] environment
]]
Obtaining a copy of this material
This comprehensive tutorial on code lists in XML is available for subscription purchase and free preview download:
[[1] - "Practical Code List Implementation" First Edition - 2009-02-09 - ISBN 978-1-894049-22-1
[[2] - the free download preview excerpt of the publication includes the complete text of the first chapter and the introductory text of all of the other chapters
][1] - the cost of purchase includes all future updates to the materials with email notification
[[2] - the materials are updated after new content developed
[[3] - more frequent in earlier editions than later editions
][2] - the materials are updated after incorporating comments gleaned during presentations and from feedback from customers
][1] - available in PDF
[[2] - formatted as 1-up or 2-up book pages per imaged page
[2] - dimensions in either US-letter or A4 page sizes
[2] - available as either single sided or double sided
][1] - accessible rendition available for use with screen readers
[1] - site-wide and world-wide staff licenses (one-time fee) are available
]
See [http://www.CraneSoftwrights.com/links/trn-20090209.htm] for more details.
Software available to customers
[[1] - accompanying software is available at no charge to customers of this book
[1] - the license for this free software does not allow for free distribution of the software to others
[1] - free download from [http://www.CraneSoftwrights.com/sales/pcli/] to registered users
]
Feedback
[[1] - the unorthodox style has been well-accepted by customers as an efficient learning presentation
[1] - feedback from customers is important to improve or repair the content for future editions
[1] - please send suggestions or comments (positive or negative) to [info@CraneSoftwrights.com [mailto:info@CraneSoftwrights.com]]
]

*** This is a free preview excerpt of a commercial publication. ***

This is an accessible version of Crane's commercial training material. The content has been specifically designed to assist screen reader software in viewing the entire textual content. Figures are replaced with text narratives.

Navigation hints are in square brackets:
[Tx.x] and [Fx.x] are textual representations of the applicability icons;
[digit] indicates list depth for nested lists;
[link [URL]] indicates the URL of a hyperlink if different than link;
[EXAMPLE] indicates an example listing of code;
[FIGURE] indicates the presence of a figure replaced by its description;
[>] jumps forward;
[<] jumps backward;
[^] jumps to start of the section;
[^^] jumps to the start of the chapter;
[^^^] jumps to the table of contents.

Suggestions for improvement are welcome: [info@CraneSoftwrights.com]
Book sales: [http://www.CraneSoftwrights.com/links/trn-acc.htm]
Information: [http://www.CraneSoftwrights.com/links/info-acc.htm]
This content is protected by copyright and, as there are no means to protect this accessible version from plagiarism, please do not make any commercial edition available to others.

+//ISBN 1-894049::CSL::Presentation::UBL//DOCUMENT Practical Code List Implementation 2009-02-09 22:30UTC//EN Practical Code List Implementation First Edition - 2009-02-09 ISBN 978-1-894049-22-1 Copyright © Crane Softwrights Ltd.