Bug 1091570
| Summary: | RFE: Support import from Asciidoc | ||
|---|---|---|---|
| Product: | [Community] PressGang CCMS | Reporter: | Matthew Casperson <mcaspers> |
| Component: | ImportTool | Assignee: | Matthew Casperson <mcaspers> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | |
| Severity: | unspecified | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 1.4 | CC: | cbredesen, lnewson, mmurray |
| Target Milestone: | --- | ||
| Target Release: | 1.7 | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | Bug Fix | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | Type: | Bug | |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
| Bug Depends On: | 1095560, 1095590, 1097902, 1098851, 1098856, 1100471 | ||
| Bug Blocks: | |||
|
Description
Matthew Casperson
2014-04-25 23:14:04 UTC
Asciidoctor.js is still experimental, but I have a demo working at https://googledrive.com/host/0B6cpJDiEKC62cndwWkNmNmVqbE0/test.html To add to the use cases, JBDS and Mobile Platform are both in asciidoc upstream. We would like to import this into PG and make enterprise books from it. [We would also like an export tool at some point - but one thing at a time!] 1.5.0 preview 7 was just released: https://github.com/asciidoctor/asciidoctor.js/releases/tag/v1.5.0-preview.7 To enable conversion to DocBook the following lines need to be added to ~/.gem/ruby/gems/asciidoctor-1.5.0.preview.7/lib/asciidoctor/asciidoctor.rb require 'asciidoctor/converter/docbook5' if RUBY_ENGINE_OPAL require 'asciidoctor/converter/docbook45' if RUBY_ENGINE_OPAL The files that are shown when selecting the main file should be filtered, as showing all the images in the book makes it hard to find the main file. Additionally directories are shown in the main file list (ie images/). Default Preface = Off Is being added to all imported books. Given that we've always wanted the Preface included, this should not be set. Ideally this should be an option either configurable by the user or per deployment (ie at Red Hat we would prefer it to be on, but others might not) Some characters aren't being imported correctly. As an example trying to import https://github.com/asciidoctor/asciidoctor/blob/master/test/fixtures/asciidoc.txt which uses a double dash (--) in it's intro chapter/section, is imported as an mdash (—) (or some similar character). Ignore the last comment, although it's not mentioned anywhere (as far as I can see) the double dash notation seems to get transformed for both asciidoc tools I know of. Internal cross references (http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#links) are being escaped and aren't transformed to what I imagine should be Injections or xrefs. As an example try importing https://github.com/asciidoctor/asciidoctor/blob/master/test/fixtures/asciidoc.txt and notice that "<<X6,Getting Started>>" is escaped as "<<X6,Getting Started>>" The internal reference "<<X6,Getting Started>>" is not being converted because it is split over a line break. This is an AsciiDoctor.js bug, which has been logged at https://github.com/asciidoctor/asciidoctor.js/issues/36 Putting this back ON_QA. Asciidoc import will be a beta feature for as long as Asciidoctor.js is in testing, but everything else is in place to support it. Moving this to VERIFIED since Matt has identified any bugs mentioned as being upstream bugs, so for a beta version that is fine. |