Mike Beckerle created DAFFODIL-2997:
---------------------------------------

             Summary: Modernize example schemas on DFDLSchemas
                 Key: DAFFODIL-2997
                 URL: https://issues.apache.org/jira/browse/DAFFODIL-2997
             Project: Daffodil
          Issue Type: Improvement
          Components: Documentation
    Affects Versions: 3.10.0
            Reporter: Mike Beckerle


A recent support experience with a new user has made it apparent that the 
hardest part of working with Daffodil is the sorry state of the example schemas.

The example schemas on DFDLSchemas and OpenDFDL aren't strictly speaking part 
of the Apache Daffodil project, but nevertheless are important to our users.

We should tag them at their current versions and create github releases of them.

Then we should modernize them:
 * Make them JSON compatible - this means following the style defined in 
[https://cwiki.apache.org/confluence/display/DAFFODIL/DFDL+Schema+Style+Guide]
 ** This also eliminates all use of XSD element namespaces which just 
simplifies life for new users, namespaces are one of the most confusing things 
about XSD/DFDL.
 * Get rid of all the xs: prefixes by using the XSD namespace as the default 
namespace.
 * Test them with 3.,10.0, 3.11.0, but do NOT remove the Daffodil versions they 
currently work with. 
 ** If this is not possible then they need a branch to continue to support the 
older versions of Daffodil
 ** within reason. I'm not sure how far back these examples go, but keeping 
examples working with Daffodil 3.4.0 is not out of the question. That version 
has certainly been deployed in products. 
 * Organize them into files such that they reflect the structure that the giter 
g8 daffodil tool would create.
 ** Do not chaange namespaced schema into the flatter structure. Some of these 
schemas are components for sure, and others could be used as components, so we 
should probably leave the deeper directory structure as is. 
 * Update the version number. This is almost certainly a major version update 
since the namespace of root elements will be changing. 
 * Tag and create appropriate github releases from the tags
 * Update Readme files to explain the releases. 



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to