| 1 | = Synopsis
|
|---|
| 2 |
|
|---|
| 3 | A ruby library for ADL parser which includes cADL and dADL parser.
|
|---|
| 4 |
|
|---|
| 5 | = Requirements
|
|---|
| 6 |
|
|---|
| 7 | * Ruby 1.8 or later.
|
|---|
| 8 | * Tested in Ruby 1.8.6.
|
|---|
| 9 | * if you use Ruby 1.6, you should prepare racc runtime environment and some adjustment.
|
|---|
| 10 |
|
|---|
| 11 | = Usage
|
|---|
| 12 |
|
|---|
| 13 | The script 'bin/adl_validator.rb' validates given ADL files.
|
|---|
| 14 |
|
|---|
| 15 | Usage: bin/adl_validator.rb [file_name|http://location.to.adl]+ [options]
|
|---|
| 16 | -v, --verbose display verbose message(Not Implemented Yet)
|
|---|
| 17 | -h, --help display this help
|
|---|
| 18 |
|
|---|
| 19 | In order to validate an ADL file on your local machine, just give the file name as an argument as follows.
|
|---|
| 20 |
|
|---|
| 21 | $ bin/adl_validator.rb tests/openEHR-EHR-CLUSTER.exam-chest.v1.adl
|
|---|
| 22 | =>
|
|---|
| 23 | Accepted 'tests/openEHR-EHR-CLUSTER.exam-chest.v1.adl'
|
|---|
| 24 |
|
|---|
| 25 | If you want to validate a remote ADL file on the web, specify its URL location.
|
|---|
| 26 |
|
|---|
| 27 | $ bin/adl_validator.rb http://svn.openehr.org/knowledge/archetypes/dev/adl/openehr/ehr/cluster/openEHR-EHR-CLUSTER.auscultation-chest.v1.adl
|
|---|
| 28 | =>
|
|---|
| 29 | Accepted 'http://svn.openehr.org/knowledge/archetypes/dev/adl/openehr/ehr/cluster/openEHR-EHR-CLUSTER.auscultation-chest.v1.adl'
|
|---|
| 30 |
|
|---|
| 31 | In addition, you can try unit testing.
|
|---|
| 32 |
|
|---|
| 33 | $ rake test
|
|---|
| 34 |
|
|---|
| 35 | = Files and Paths
|
|---|
| 36 |
|
|---|
| 37 | * Path
|
|---|
| 38 | + bin --+--- adl_validator.rb
|
|---|
| 39 | + lib --+--- parser.rb
|
|---|
| 40 | +--- parser.y
|
|---|
| 41 | +--- validator.rb
|
|---|
| 42 | +--- shell.rb
|
|---|
| 43 |
|
|---|
| 44 | * bin/adl_validator.rb
|
|---|
| 45 | The command-line ADL validator.
|
|---|
| 46 |
|
|---|
| 47 | * lib/parser.rb
|
|---|
| 48 | This is the key library for ADL parsing. This parser algorithm is LALR implemented in racc library.
|
|---|
| 49 | This file contains one module and one class first generated by racc from grammertical definition of parser.y.
|
|---|
| 50 | Main class is ADLParser that scans ADL and parses both cADL and dADL.
|
|---|
| 51 |
|
|---|
| 52 | = License
|
|---|
| 53 |
|
|---|
| 54 | This product is under openEHR Open Source Software License
|
|---|
| 55 |
|
|---|
| 56 | The openEHR Foundation uses the Mozilla Tri-license 1.1 on all software copyrighted to the Foundation. This licence essentially provides the user a choice of licence conditions under which to operate with any given piece of software, being: the Mozilla Public licence (MPL), and the Free Software Foundation GNU General Public Licence (GPL) and Lesser GNU Public Licence (LGPL). See the Mozilla relicensing FAQ for details of this license. This in no way constrains the way in which software created by other organisations is licenced.
|
|---|
