Date: Tuesday, March 31, 2015 at 10:46 AM
To: Scott Hudson
Cc: "dita@lists.oasis-open.org", Kristen James Eberlein
Subject: Re: [dita] Purpose of files in the scott-example-sandbox directory
How would you see them being used? The code samples for the specification are maintained within <codeblock> elements inside the specification source. I don't think we can or should change this.
From a practical perspective, Kris and I found several instances while updating the spec where descriptive text about a code sample no longer matched the sample itself. I think this is because over each release, samples had been fixed, expanded, or improved
without looking at the surrounding text. That problem would increase significantly if the code samples were moved out and no longer tied to the context.
From a technical perspective, there is no standard way to pull markup from a valid DITA file and present only the relevant portion as a code sample. There are DITA-OT extensions to <coderef> that allow you to pull specific lines from a sample file, such as
lines 5 to 10 -- but those extensions are non-standard. Using that method would likely break the specification as soon as somebody edited the sample file with a new editor, causing the text to flow differently.
Robert D Anderson
IBM Authoring Tools Development
Chief Architect, DITA Open Toolkit (http://www.dita-ot.org/)
"Hudson,
Scott" ---03/31/2015 11:32:54---I still think these could be useful for validation and testing for 1.3, though they may need to be u
From: "Hudson, Scott" <scott.hudson@comtech-serv.com>
To: Robert D Anderson/Rochester/IBM@IBMUS
Cc: Kristen James Eberlein <kris@eberleinconsulting.com>, "dita@lists.oasis-open.org" <dita@lists.oasis-open.org>
Date: 03/31/2015 11:32
Subject: Re: [dita] Purpose of files in the scott-example-sandbox directory
I still think these could be useful for validation and testing for 1.3, though they may need to be updated to reference the 1.3 schemas. Where are the validated examples for 1.3 currently stored? I hate to remove the files if they can still be of use. Since these are directly from the spec (though now valid), why couldn’t these be part of the official material?
—Scott
From: Robert D Anderson
Date: Tuesday, March 31, 2015 at 10:13 AM
To: Scott Hudson
Cc: Kristen James Eberlein, "dita@lists.oasis-open.org"
Subject: Re: [dita] Purpose of files in the scott-example-sandbox directory
Hi Scott,
I'm still not sure what these files are for now? They are not part of the DITA 1.3 creation, review, or delivery, so I think SVN is probably not the right place for them. I'm nervous about them causing confusion when others start looking for official material,
as we had with some of the extra files in the doctypes\ directory a few weeks back.
Also, as a related note, I think the bad examples from 1.2 have been corrected. They were never tested for XML (or DITA) validity during the 1.2 process, which is something we corrected for 1.3, resulting in tweaks to quite a few of the code examples.
Robert D Anderson
IBM Authoring Tools Development
Chief Architect, DITA Open Toolkit (http://www.dita-ot.org/)
"Hudson,
Scott" ---03/31/2015 10:44:17---Kris, et al, These files take all of the examples from the DITA 1.2 Specification (http://docs.oasis
From: "Hudson, Scott" <scott.hudson@comtech-serv.com>
To: Kristen James Eberlein <kris@eberleinconsulting.com>, "dita@lists.oasis-open.org"
<dita@lists.oasis-open.org>
Date: 03/31/2015 10:44
Subject: Re: [dita] Purpose of files in the scott-example-sandbox directory
Sent by: <dita@lists.oasis-open.org>
Kris, et al,
These files take all of the examples from the DITA 1.2 Specification (http://docs.oasis-open.org/dita/v1.2/spec/DITA1.2-spec.html) and makes them valid XML samples.
These were originally intended for use in testing the generated DTDs (from RNG). Eliot didn’t want individual element tests, but rather larger, complete examples, so he has used different test documents.
These files can also be used for inclusion by reference as the examples. I still noticed quite a few “bad” xml examples in the specification, so this attempts to fix those issues.
Still to do:
1. Learning and Training
2. New DITA 1.3 elements
Thanks and best regards,
Scott Hudson
Senior Consultant
Comtech Services Inc.
303-232-7586
On 3/31/15, 8:37 AM, "Kristen James Eberlein" <kris@eberleinconsulting.com> wrote:
>Scott, what are these files intended for?
>
>Best,
>Kris
>
>Kristen James Eberlein
>Chair, OASIS DITA Technical Committee
>Principal consultant, Eberlein Consulting
>www.eberleinconsulting.com
>+1 919 682-2290; kriseberlein (skype)
>
>On 3/30/2015 11:38 PM, workgroup_mailer@lists.oasis-open.org wrote:
>> Author: scott.hudson1
>> Date: 2015-03-31 03:38:35 +0000 (Tue, 31 Mar 2015)
>> New Revision: 2356
>> Web View: https://tools.oasis-open.org/version-control/browse/wsvn/dita/?rev=2356&sc=1
>>
>> Removed:
>> scott-examples-sandbox/abbreviated-form.001.ditamap
>> scott-examples-sandbox/anchorid.001.dita
>> Log:
>> Updates from 1.2 specification examples
>>
>> ---------------------------------------------------------------------
>> To unsubscribe from this mail list, you must leave the OASIS TC that
>> generates this mail. Follow this link to all your TCs in OASIS at:
>> https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php
>>
>>
>>
>>
>
>
>---------------------------------------------------------------------
>To unsubscribe from this mail list, you must leave the OASIS TC that
>generates this mail. Follow this link to all your TCs in OASIS at:
>https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php
>
[attachment "graycol.gif" deleted by Robert D Anderson/Rochester/IBM]