...
Unfortunately, tools will wrap lines in XML comments. So auto-formatting a whole XML file containing this bannerOur nicely structured comments like
<!--
Copyright (c) 2012-2013 Tresys Technology, LLC. All rights reserved.
Developed by: Tresys Technology, LLC
http://www.tresys.com
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal with
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimers.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimers in the
documentation and/or other materials provided with the distribution.
3. Neither the names of Tresys Technology, nor the names of its contributors
may be used to endorse or promote products derived from this Software
without specific prior written permission.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE
SOFTWARE.
-->
will result in
<!-- Copyright (c) 2012-2013 Tresys Technology, LLC. All rights reserved. Developed
by: Tresys Technology, LLC http://www.tresys.com Permission is hereby granted, free
of charge, to any person obtaining a copy of this software and associated documentation
files (the "Software"), to deal with the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions: 1. Redistributions of source
code must retain the above copyright notice, this list of conditions and the following
disclaimers. 2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimers in the documentation
and/or other materials provided with the distribution. 3. Neither the names of Tresys
Technology, nor the names of its contributors may be used to endorse or promote products
derived from this Software without specific prior written permission. THE SOFTWARE
IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
AND NONINFRINGEMENT. IN NO EVENT SHALL THE CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
OR OTHER DEALINGS WITH THE SOFTWARE. -->
That might be fine legally, but it's definitely unacceptable.
Similarly, our nicely structured comments like
<!--
Test name: csv_test
Schema: csv.dfdl.xsd
Root: file
Purpose: This test is to exercise the csv schema.
-->
turns into
<!-- Test name: csv_test Schema: csv.dfdl.xsd Root: file Purpose: This test is
to exercise the csv schema. -->
But there is a good fix for this, (at least as far as Eclipse tooling is concerned). You can use XML's so called "Processing Instructions" to hold this content. Processing Instructions are part of the XML information model, but almost nothing uses them. (xsl-stylesheets are the only use I know of). They can have anything in them except the sequence '?>' which ends them.
Test name: csv_test
Schema: csv.dfdl.xsd
Root: file
Purpose: This test is to exercise the csv schema.
-->
turns into
<!-- Test name: csv_test Schema: csv.dfdl.xsd Root: file Purpose: This test is
to exercise the csv schema. -->
Tools like Eclipse have a setting to turn this "feature" off. See Eclipse Settings for DFDL Schema Authoring/Editing. Other tools may have similar options.
An alternative is to use XML Processing Instructions instead of comments. For I tested these banners and comments and eclipse will not reformat them when auto-formatting, and they are ignored by the TDML runner and by Daffodil. So, for example, our nicely formatted block comment can be done like so:
...
And then auto-reformatting won't mess it up. Our copyright banner can be similarly bracketed.