Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add LwDITA XDITA to distribution #3108

Merged
merged 1 commit into from
Oct 18, 2018
Merged

Add LwDITA XDITA to distribution #3108

merged 1 commit into from
Oct 18, 2018

Conversation

robander
Copy link
Member

Signed-off-by: Robert D Anderson robander@us.ibm.com

Adds the Lightweight DITA XDITA document types as a plugin. This adds out-of-the-box processing support for documents that use the pre-release XDITA document types.

The plugin is pulled from the latest XDITA release (created today): https://github.com/oasis-tcs/dita-lwdita/releases/tag/v0.2.1

I haven't yet been able to test this properly - whenever I try to build the distribution package on my system I get Java failures (also true before this update):

> Task :integrateDistmarkdown
Buildfile: C:\Users\IBM_ADMIN\github\dita-ot\build\tmp\dist\integrator.xml

install:

BUILD FAILED
C:\Users\IBM_ADMIN\github\dita-ot\build\tmp\dist\integrator.xml:70: java.nio.fil
e.InvalidPathException: Illegal char <:> at index 5: https://github.com/jelovirt
/org.lwdita/releases/download/2.0.6/org.lwdita-2.0.6.zip
        at sun.nio.fs.WindowsPathParser.normalize(WindowsPathParser.java:194)
        at sun.nio.fs.WindowsPathParser.parse(WindowsPathParser.java:165)
        ...

@robander robander added the dita standard Something does not comply with DITA specification label Oct 17, 2018
@robander robander self-assigned this Oct 17, 2018
@robander robander added this to In progress in 3.2 via automation Oct 17, 2018
@infotexture
Copy link
Member

infotexture commented Oct 17, 2018

I tested this by installing the new XDITA plug-in manually:

feature/xdita $ src/main/bin dita --install \
    https://github.com/oasis-tcs/dita-lwdita/releases/download/v0.2.1/org.oasis-open.xdita.v0_2_1.zip

I then built output from org.oasis-open.xdita/samples/remotelighting.ditamap, which failed with an error related to the use of footnotes on Line22 of remote-components.md:

Error: Failed to run pipeline: No renderer configured for com.vladsch.flexmark.ext.footnotes.Footnote

Commenting out the offending topic on Line 15 of remotelighting.ditamap reveals errors with HDITA input:

[xslt] file:/…/org.oasis-open.xdita/samples/hdita/intro-network-lighting.html:182:3: 
    [DOTX074W][WARN]: No formatting defined for unknown class attribute value 
    "- topic/title ". 
[xslt] file:/…/org.oasis-open.xdita/samples/hdita/considerations.html:182:3: 
    [DOTX074W][WARN]: No formatting defined for unknown class attribute value 
    "- topic/title ". 

Commenting out both of these HDITA files on Lines 14 and 21 allow the build to complete successfully.

@carlosevia
Copy link

The LwDITA committee note 2.0 introduces the MDITA footnote behavior after PHP Markdown Extra syntax. Jarno's original Markdown plugin did not have that behavior.

@jelovirt jelovirt added build Changes to DITA-OT build scripts dependency Related to external plugin or bundled library labels Oct 18, 2018
Signed-off-by: Robert D Anderson <robander@us.ibm.com>
@robander robander moved this from In progress to Review in 3.2 Oct 18, 2018
@robander robander merged commit 9301528 into develop Oct 18, 2018
3.2 automation moved this from Review to Done Oct 18, 2018
@robander robander deleted the feature/xdita branch October 18, 2018 21:41
@robander robander added this to the 3.2 milestone Oct 18, 2018
@infotexture
Copy link
Member

@carlosevia Can you comment on the HDITA errors shown above that appear when publishing the dita-lwdita/org.oasis-open.xdita/samples/ ?

Should that be filed as an issue in the upstream dita-lwdita/org.oasis-open.xdita repo?

@carlosevia
Copy link

@infotexture Something I noticed is that both files have an HTML heading 2 that should map to a section in DITA... that could be breaking it

@carlosevia
Copy link

We also need to check support in the OT for HDITA keyrefs and conrefs. I don't know what is functional as of today.

@infotexture
Copy link
Member

paging @jelovirt

@jelovirt
Copy link
Member

Haven't read the spec, haven't implemented anything. To be added later.

@carlosevia
Copy link

I will fix the HDITA errors and then we can talk.

@infotexture
Copy link
Member

@carlosevia Are the HDITA errors something that can be fixed in the sample files?

I'd like to link to these samples from the docs, so it would be nice if we could get them to build without errors in time for the 3.2 release next weekend.

@carlosevia
Copy link

Errors fixed... new release coming soon

@infotexture
Copy link
Member

👍 @carlosevia resolved HDITA warnings with oasis-tcs/dita-lwdita@f5eec1f. 🙏

@infotexture infotexture added the feature New feature or request label Nov 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Changes to DITA-OT build scripts dependency Related to external plugin or bundled library dita standard Something does not comply with DITA specification feature New feature or request
Projects
No open projects
3.2
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants