stevedlawrence commented on a change in pull request #36:
URL:
https://github.com/apache/incubator-daffodil-site/pull/36#discussion_r571202111
##########
File path: site/dfdl-layout.md
##########
@@ -51,51 +51,54 @@ organizing projects so as to achieve the above benefits.
### Conventions
-Let's assume the DFDL schema contains two files named main.dfdl.xsd, and
-format.dfdl.xsd, and that our format is named RFormat with an organization of
+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
organization of
example.com.
The standard file tree would be:
- RFormat/
- ├── src/
- │ ├── main/
- │ │ └── resources/
- │ │ └── com/
- │ │ └── example/
- │ │ └── RFormat/
- │ │ ├── xsd/
- │ │ │ ├── main.dfdl.xsd - Main DFDL schema file
- │ │ │ └── format.dfdl.xsd - DFDL schema file
imported/included from main
- │ │ └── xsl/
- │ │ └── xforms.xsl - Resources other than
XSD go in other directories
- │ └── test/
- │ ├── resources/
- │ │ └── com/
- │ │ └── example/
- │ │ └── RFormat/
- │ │ └── tests1.tdml - TDML test files
- │ └── scala/
- │ └── com/
- │ └── example/
- │ └── RFormat/
- │ └── Tests1.scala - Scala test driver file
- ├── project/
- │ └── build.properties - Defines the sbt version
+ rfmt /
+ ├── .gitattributes - Git revision control system 'attributes' (see
below)
+ ├── .gitignore - Git revision control system 'ignore' file
(should contain
+ │ 'target' and 'lib_managed' entries)
├── build.sbt - Simple Build Tool (sbt) specification file.
Edit to change version
│ of Daffodil needed, or versions of other DFDL
schemas needed
├── README.md - Documentation about the DFDL schema in
Markdown file format
- ├── .classpath - Eclipse classpath file (optional)
- ├── .project - Eclipse project file (optional)
- └── .gitignore - Git revision control system 'ignore' file
(should contain
- 'target' and 'lib_managed' entries)
+ ├── project/
+ │ └── build.properties - Defines the sbt version
+ └── src/
+ ├── main/
+ │ └── resources/
+ │ └── com/
+ │ └── example/
+ │ └── rfmt /
+ │ ├── xsd/
+ │ │ ├── rfmt.dfdl.xsd - RFormat DFDL schema file
+ │ │ └── format.dfdl.xsd - DFDL schema file
imported/included from rfmt.dfdl.xsd
+ │ └── xsl/
+ │ └── xforms.xsl - Resources other than
XSD go in other directories
+ └── test/
+ ├── resources/
+ │ └── com/
+ │ └── example/
+ │ └── rfmt/
+ │ ├── Tests1.tdml - TDML test files
+ │ ├── data/ - Test data files not
embedded in a TDML file
+ │ │ └── test01.rfmt
Review comment:
I like the extension because it sortof implies that the format of this
file is "rfmt", just like a "jpeg" extension implies this is a JPEG formated
file. I like the comment.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
