You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@daffodil.apache.org by gi...@apache.org on 2021/03/17 11:43:26 UTC

[daffodil-site] branch asf-site updated: Publishing from 19cdb94db5f77e73ee7efac8a9b50500dd6c6f66

This is an automated email from the ASF dual-hosted git repository.

github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/daffodil-site.git


The following commit(s) were added to refs/heads/asf-site by this push:
     new f326d25  Publishing from 19cdb94db5f77e73ee7efac8a9b50500dd6c6f66
f326d25 is described below

commit f326d2592f227f919a082749fbda79a1ea74389a
Author: Steve Lawrence <st...@gmail.com>
AuthorDate: Wed Mar 17 11:42:43 2021 +0000

    Publishing from 19cdb94db5f77e73ee7efac8a9b50500dd6c6f66
---
 content/dfdl-layout/index.html | 21 ++++++++++++++++++---
 1 file changed, 18 insertions(+), 3 deletions(-)

diff --git a/content/dfdl-layout/index.html b/content/dfdl-layout/index.html
index 4ea9c3f..0374139 100644
--- a/content/dfdl-layout/index.html
+++ b/content/dfdl-layout/index.html
@@ -90,8 +90,23 @@
 <p>There is a specific way of organizing a DFDL schema project that has been found
 to be helpful. It uses specific directory naming conventions and tree structure
 to manage name conflicts in a manner similar to how Java package names
-correspond to directory names. This set of conventions provides a number of
-benefits:</p>
+correspond to directory names.</p>
+
+<h3 id="quick-start">Quick Start</h3>
+
+<p>To quickly get started and generate this directory structure, you can install
+<a href="https://www.scala-sbt.org/">SBT</a> and run the following command:</p>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>sbt new apache/daffodil-schema.g8
+</code></pre></div></div>
+
+<p>This prompts for various properties and creates the directory structure
+described below, including git and sbt configuration files, a basic DFDL schema
+file, and TDML and test files.</p>
+
+<h3 id="conventions">Conventions</h3>
+
+<p>This set of conventions provides a number of benefits:</p>
 
 <ul>
   <li>No name conflicts or ambiguity on classpath if multiple DFDL schemas are used
@@ -122,7 +137,7 @@ a library of pieces to be included/imported by other formats.</li>
 they’re not really DFDL-specific conventions. They’re general conventions for
 organizing projects so as to achieve the above benefits.</p>
 
-<h3 id="conventions">Conventions</h3>
+<h3 id="standard-file-tree">Standard File Tree</h3>
 
 <p>Let’s assume the DFDL schema contains two files named rfmt.dfdl.xsd, and
 format.dfdl.xsd, and that our format is named RFormat (rfmt) with an