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

No support for certain DocBook elements #7

Open
pmkovar opened this issue Oct 27, 2015 · 13 comments

Comments

Projects
None yet
3 participants
@pmkovar
Copy link

commented Oct 27, 2015

When converting Publican-based DocBook XML docs from the Fedora Doc Project, it turned out some of the often-used elements are unsupported:

  • productname
  • productnumber
  • menuchoice
  • guimenu
  • guisubmenu
  • guimenuitem
  • userinput
  • computeroutput
  • option
  • systemitem
  • remark
  • revhistory
  • replaceable
  • guiicon
  • citetitle
  • package
  • qandaset
  • programlistingco
  • foreignphrase
  • calloutlist
  • property
  • type
  • attribution
  • database
  • exceptionname
  • biblioentry
  • quote
  • citation
  • function
@pmkovar

This comment has been minimized.

Copy link
Author

commented Nov 2, 2015

One more that seems to be missing:

  • replaceable
@pmkovar

This comment has been minimized.

Copy link
Author

commented Nov 5, 2015

Found two more:

  • guiicon
  • citetitle
@mojavelinux

This comment has been minimized.

Copy link
Member

commented Dec 5, 2015

It's going to be really helpful if you can cite examples for each missing element. Just point to a DocBook source somewhere. The reason is that there are so many ways to structure a DocBook file, so how the element is used in context actually becomes quite important to the implementation of the converter (at least to hit the 80-90% case).

@mojavelinux

This comment has been minimized.

Copy link
Member

commented Dec 5, 2015

In my opinion, some of these inline elements should just get erased when converting to AsciiDoc (or mapped to simplified markup such as bold with a role perhaps). The reason is because I feel very strongly that DocBook goes way overboard with markup. It's such a time sync for writers when the reader never sees the distinction anyway. My observation is that writers often overuse markup, wasting time and money and making editing much harder than it has to be.

@mojavelinux

This comment has been minimized.

Copy link
Member

commented Dec 5, 2015

Something like a gui menu is a great example of something that should be preserved...and we do have support for that in Asciidoctor.

@mojavelinux

This comment has been minimized.

Copy link
Member

commented Dec 5, 2015

I think I've implemented menuchoice correctly now, which also covers:

  • guimenu
  • guisubmenu
  • guimenuitem

If I'm missing a use case, just point me to a sample.

@mojavelinux

This comment has been minimized.

Copy link
Member

commented Dec 5, 2015

I've handled a whole bunch more. I'm updating the original list as I go.

@mojavelinux mojavelinux added the bug label Dec 6, 2015

@mojavelinux

This comment has been minimized.

Copy link
Member

commented Dec 6, 2015

We now have a test suite to use for providing samples.

@mojavelinux

This comment has been minimized.

Copy link
Member

commented Dec 12, 2015

part is also missing, but we're handling that as part of #6

@pmkovar

This comment has been minimized.

Copy link
Author

commented Jan 7, 2016

@mojavelinux Thanks a lot for working on these! Erasing some of the elements works for me and makes sense provided the content itself is preserved.

Do you still need samples for the remaining elements?

@mojavelinux

This comment has been minimized.

Copy link
Member

commented Jan 8, 2016

I'll always take samples. But now that we have a test suite, there's actually somewhere to put those examples now. Definitely looking for edge cases and things that we aren't currently covering.

@mojavelinux

This comment has been minimized.

Copy link
Member

commented Jan 8, 2016

I'd like to get this list in the description completed checked off. That's definitely the goal here. Some of the tags I don't yet understand the context, so seeing it "in the wild" definitively helps know how to map it.

@tradej

This comment has been minimized.

Copy link

commented Jun 28, 2016

Hi, it seems to me that

  • simplelist
  • superscript

also aren't supported.

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.