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

Problem with formats supported by LWDita plugin #47

Closed
raducoravu opened this issue Mar 19, 2019 · 3 comments

Comments

Projects
None yet
4 participants
@raducoravu
Copy link

commented Mar 19, 2019

The plugin.xml declares the following format parsers:

   <parser format="html" class="com.elovirta.dita.html.HtmlReader"/>
  <parser format="hdita" class="com.elovirta.dita.html.HtmlReader"/>

Two possible problems:

  1. Shouldn't the "hdita" format use the "HDitaReader" instead of "HtmlReader"?

  2. I do not quite agree that the "html" DITA format should be automatically handled by this plugin.
    For example if in my topic I have a reference to some HTML document from my project:

     <p><xref format="html" href="test.html"/></p>
    

why should it be parsed as a DITA topic? Maybe I want to keep this HTML document separate from my PDF and I just want to refer to it. And now I have no control over this behavior, I need to comment out parts of the plugin and run the integrator to remove this automatic handling of the "html" format.
How about if we just add the processor on some specific format like "htmlDita" which would mark that we want the HTML to be interpreted as DITA?

@robander

This comment has been minimized.

Copy link
Contributor

commented Jul 10, 2019

I've turned off parsing for format="html" in our instance of DITA-OT; it's a common way to refer to local HTML files that already exist and should not be converted.

@raducoravu

This comment has been minimized.

Copy link
Author

commented Jul 10, 2019

@robander so did I in the DITA OT bundled with Oxygen.

@infotexture

This comment has been minimized.

Copy link
Contributor

commented Jul 10, 2019

Per dita-ot/docs#262 (comment):

The conversion from HTML to DITA should not be automatic.

To parse an HTML file as HDITA, the @format attribute should be set to hdita as described in the docs:

<topicref href="hdita-topic.html" format="hdita"/>

If topicrefs with format=html are currently being converted to DITA, that sounds like a bug in the LwDITA plug-in […] .

@jelovirt jelovirt added the bug label Jul 10, 2019

jelovirt added a commit that referenced this issue Jul 10, 2019

Disable `html` as HDITA format #47
Signed-off-by: Jarno Elovirta <jarno@elovirta.com>

@jelovirt jelovirt added this to the 2.2.2 milestone Jul 10, 2019

@jelovirt jelovirt self-assigned this Jul 10, 2019

@jelovirt jelovirt closed this Jul 10, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.