Lightweight DITA SC

 View Only

Fwd: FYI -- Some LwDITA test results

  • 1.  Fwd: FYI -- Some LwDITA test results

    Posted 01-18-2021 16:21
    Adding to today's agenda -- Carlos Evia, Ph.D. Professor and Director of Transdisciplinary Initiatives College of Liberal Arts and Human Sciences Virginia Tech Blacksburg, VA 24061-0112 (540)200-8201 ---------- Forwarded message --------- From: Stanley Doherty < stan@modularwriting.com > Date: Sun, Jan 17, 2021 at 8:58 PM Subject: FYI -- Some LwDITA test results To: < mpriestl@ca.ibm.com >, < cevia@vt.edu >, < arh@groupwellesley.com >, < jschlot@us.ibm.com >, < sabine.ocker@comtech-serv.com >, < mark@markgiffin.com >, < keith@ditawriter.com >, < Frank.Wegmann@softwareag.com > Cc: Stan Doherty < stan@modularwriting.com > Hi folks -- I have two little projects this spring that involve LwDITA: March : A DITA Adoption TC tech paper on "How to set up LwDITA pilot" May : A Boston DITA Users Group presentation on "Why you should care about LwDITA" Over the past couple of weeks I buckled down to do some real-world testing of the LwDITA samples files that ship with DITA-OT 3.6.0, specifically dita-ot-3.6/plugins/org.oasis-open.xdita.v0_2_2/samples . I focused on the interoperability of XDITA, MDITA, and HDITA as manifest in the following features: - content referencing - key referencing - cross-referencing To validate the markup, I used the latest build of Oxygen 23.0 and the PDF/HTML5 transforms in DITA-OT 3.6. The results were pretty mixed. I tend to paddle around in the shallow end of the DITA engineering pool, but I believe that all the things that I tested conformed to our current committee note. Please review and second-guess my markup. Perhaps there are subtleties that I have missed. Anyway -- I have attached the source files that I tested and a detailed set of testing notes. At some point, it would be useful to get a feel from subcommittee for how much of the overall LwDITA specification 1.0 needs to be working to encourage "regular" DITA folks to get involved with testing it. Pax Stan Test-1: MDITA transclude XDITA ==================================== Rootmap: ./remotelighting.ditamap ./xdita/intro-product.dita contains the content: <p id="warning">Electrical hazards can cause burns, shocks and electrocution (death).</p> ./mdita/led-specs.md contains the reference: <p data-conref="../xdita/intro-product.dita#intro-product/warning" /> RESULTS: - Oxygen 23.0: PASS - DITA-OT pdf: PASS - DITA-OT html5: PASS Test-2: HDITA transclude XDITA ==================================== Rootmap: ./remotelighting.ditamap ./xdita/intro-product.dita contains the content: <p id="warning">Electrical hazards can cause burns, shocks and electrocution (death).</p> ./hdita/considerations.html contains the reference: <p data-conref="../xdita/intro-product.dita#intro-product/warning"></p> RESULTS: - Oxygen 23.0: FAIL / No error (test_01.png) - DITA-OT pdf: FAIL / No error and no referenced content - DITA-OT html5: PASS Test-x: XDITA transclude XDITA ==================================== Rootmap: ./remotelighting.ditamap ./xdita/intro-product.dita contains the content: <p id="warning">Electrical hazards can cause burns, shocks and electrocution (death).</p> ./xdita/test-topic.dita contains the reference: <p conref="intro-product.dita#intro-product/warning"></p> RESULTS: - Oxygen 23.0: PASS - DITA-OT pdf: PASS - DITA-OT html5: PASS Test-5: HDITA transcludes MDITA ==================================== Rootmap: ./remotelighting.ditamap ./mdita/test-topic.md contains the content: <p id="warning-test-md">This MDITA paragraph has the @id "warning-test".</p> ./hdita/test-topic.html contains the reference: <li><p data-conref="../mdita/test-topic.md#test-topic-md/warning-test-md"></p></li> RESULTS: - Oxygen 23.0: FAIL / no error (test_03.png) - DITA-OT pdf: FAIL / HDITA topic does not build - DITA-OT html5: FAIL / HDITA topic does not build Test-6: MDITA transcludes MDITA ==================================== Rootmap: ./remotelighting.ditamap ./mdita/test-topic.md contains the content: <p id="warning-test-md">This MDITA paragraph has the @id "warning-test".</p> ./mdita/test-topic2.html contains the reference: <p data-conref="../mdita/test-topic.md#test-topic-md/warning-test-md"></p> RESULTS: - Oxygen 23.0: FAIL / reports error "Content is not allowed in prolog." (test-04.png) - DITA-OT pdf: FAIL / no error / no transcluded content generated - DITA-OT html5: FAIL / no error / no transcluded content generated Test-x: XDITA transcludes MDITA ==================================== Rootmap: ./remotelighting.ditamap ./mdita/test-topic.md contains the content: <p id="warning-test-md">This MDITA paragraph has the @id "warning-test".</p> ./xdita/test-topic.dita contains the reference: <p conref="../mdita/test-topic.md#test-topic-md/warning-test-md"></p> RESULTS: - Oxygen 23.0: FAIL / reports error "Content is not allowed in prolog." (test-04.png) - DITA-OT pdf: FAIL / error "Content is not allowed in prolog." / no transcluded content generated - DITA-OT html5: FAIL / errors = [move-meta] file:/E:/LwDITA/samples_dita-ot-3.6/remotelighting.ditamap:31:59: [DOTX021E][ERROR]: Missing navtitle attribute or element for non-DITA resource "hdita/test-topic.html". References must provide a local navigation title when the target is not a local DITA resource. [move-meta] file:/E:/LwDITA/samples_dita-ot-3.6/remotelighting.ditamap:31:59: [DOTX025E][ERROR]: Missing linktext and navtitle for non-DITA resource "hdita/test-topic.html". References must provide a local navigation title when the target is not a local DITA resource. Test-9: XDITA transcludes HDITA ==================================== Rootmap: ./remotelighting.ditamap ./hdita/test-topic.html contains the content: <p id="warning-test-html">HDITA paragraph with @id warning-test-html.</p> ./xdita/test-topic.dita contains the reference: <p conref="../hdita/test-topic.html#test-article-hdita/warning-test-html"></p> RESULTS: - Oxygen 23.0: FAIL / with error "The element type "meta" must be terminated by the matching end-tag "</meta>". (test_05.png) - DITA-OT pdf: FAIL / no error / no transcluded content generated - DITA-OT html5: FAIL Test-10: MDITA transcludes HDITA ==================================== Rootmap: ./remotelighting.ditamap ./hdita/test-topic.html contains the content: <p id="warning-test-html">HDITA paragraph with @id warning-test-html.</p> ./mdita/test-topic2.html contains the reference: <p data-conref="../hdita/test-topic.html#test-article-hdita/warning-test-html"></p> RESULTS: - Oxygen 23.0: FAIL / with error "The element type "meta" must be terminated by the matching end-tag "</meta>". (test_05.png) - DITA-OT pdf: FAIL / no error / no transcluded content generated - DITA-OT html5: FAIL Test-x: HDITA transcludes HDITA ==================================== Rootmap: ./remotelighting.ditamap ./hdita/test-topic.html contains the content: <p id="warning-test-html">HDITA paragraph with @id warning-test-html.</p> ./xdita/test-topic.dita contains the reference: <p conref="../mdita/test-topic.md#test-topic-md/warning-test-md"></p> RESULTS: - Oxygen 23.0: FAIL / no error / no referenced content - DITA-OT pdf: FAIL / XDITA topic does not build - DITA-OT html5: FAIL Test-x: XDITA resolves an XDITA map key definition ==================================== Rootmap: ./remotelighting.ditamap ./remotelighting.ditamap contains the key definition: <keydef keys="product-name"> <topicmeta> <linktext>Remote Lighting Network</linktext> </topicmeta> </keydef> ./xdita/turn-on-off-dim-lights.dita contains the reference: <keyword keyref="product-name"/> RESULTS: - Oxygen 23.0: PASS - DITA-OT pdf: PASS - DITA-OT html5: PASS Test-x: MDITA resolves an XDITA map key definition ==================================== Rootmap: ./remotelighting.ditamap ./remotelighting.ditamap contains the key definition: <keydef keys="product-name"> <topicmeta> <linktext>Remote Lighting Network</linktext> </topicmeta> </keydef> ./mdita/remote-components.md contains the reference: [product-name] RESULTS: - Oxygen 23.0: PASS - DITA-OT pdf: FAIL - DITA-OT html5: PASS Test-x: HDITA resolves an XDITA map key definition ==================================== Rootmap: ./remotelighting.ditamap ./remotelighting.ditamap contains the key definition: <keydef keys="product-name"> <topicmeta> <linktext>Remote Lighting Network</linktext> </topicmeta> </keydef> ./hdita/low-power.html contains the reference: <span data-keyref="product-name"></span> RESULTS: - Oxygen 23.0: FAIL - DITA-OT pdf: FAIL - DITA-OT html5: PASS Test-x: XDITA cross-references an XDITA topic ==================================== Rootmap: ./remotelighting.ditamap ./xdita/test-topic-xrefs.dita contains the reference: <xref href="intro-product.dita"/> RESULTS: - Oxygen 23.0: PASS - DITA-OT pdf: PASS - DITA-OT html5: PASS Test-x: XDITA cross-references an MDITA topic ==================================== Rootmap: ./remotelighting.ditamap ./xdita/test-topic-xrefs.dita contains the reference: <p>XDITA to XDITA: See <xref href="../mdita/remote-components.md" format="markdown"></xref>.</p> RESULTS: - Oxygen 23.0: PASS - DITA-OT pdf: PASS - DITA-OT html5: PASS Test-x: XDITA cross-references an HDITA topic ==================================== Rootmap: ./remotelighting.ditamap ./xdita/test-topic-xrefs.dita contains the reference: <p>XDITA to HDITA: See <xref href="../hdita/intro-networking-lighting.html" format="html" scope="local"></xref>.</p> RESULTS: - Oxygen 23.0: PASS - DITA-OT pdf: FAIL - DITA-OT html5: PASS Test-x: MDITA cross-references an MDITA topic ==================================== Rootmap: ./remotelighting.ditamap ./mdita/product-specs.md contains the reference: [Specifications describing the electronics and technology inside the LED light bulb](led-specs.md) RESULTS: - Oxygen 23.0: PASS - DITA-OT pdf: - DITA-OT html5: PASS Test-x: MDITA cross-references an HDITA topic ==================================== Rootmap: ./remotelighting.ditamap ./mdita/test-topic-xrefs.md contains the reference: [Basic Concepts of Network Lighting](intro-network-lighting.html) RESULTS: - Oxygen 23.0: PASS - DITA-OT pdf: FAIL - DITA-OT html5: PASS Test-x: MDITA cross-references an XDITA topic ==================================== Rootmap: ./remotelighting.ditamap ./mdita/product-specs.md contains the reference: [Specifications describing the electronics and technology inside the remote control](../xdita/remote-specs.dita) RESULTS: - Oxygen 23.0: PASS - DITA-OT pdf: PASS - DITA-OT html5: PASS Test-x: HDITA cross-references an MDITA topic ==================================== Rootmap: ./remotelighting.ditamap ./mdita/product-specs.md contains the reference: [Specifications describing the electronics and technology inside the LED light bulb](led-specs.md) RESULTS: - Oxygen 23.0: PASS - DITA-OT pdf: - DITA-OT html5: FAIL Test-x: HDITA cross-references an HDITA topic ==================================== Rootmap: ./remotelighting.ditamap ./mdita/test-topic-xrefs.md contains the reference: [Basic Concepts of Network Lighting](intro-network-lighting.html) RESULTS: - Oxygen 23.0: PASS - DITA-OT pdf: FAIL - DITA-OT html5: PASS Test-x: HDITA cross-references an XDITA topic ==================================== Rootmap: ./remotelighting.ditamap ./mdita/product-specs.md contains the reference: [Specifications describing the electronics and technology inside the remote control](../xdita/remote-specs.dita) RESULTS: - Oxygen 23.0: PASS - DITA-OT pdf: FAIL / Topic failed to build - DITA-OT html5: FAIL Attachment: LwDITA-test-results_01-17-2021.xlsx Description: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet Attachment: samples_dita-ot-3.6.zip Description: Zip archive Attachment: smime.p7s Description: S/MIME Cryptographic Signature

    Attachment(s)