images in tables are not pulled into the archive

[LightGuard]

You can recreate this by building the book at vromero/mule-doc@4eed0f1. The list discussion is at http://discuss.asciidoctor.org/Asciidoc-EPUB3-and-local-images-td1936.html

[mojavelinux]

There are two sources of this problem. First, the converter does not pull in inline images because they aren't available in the AST after a parse atm. If the images are changed to be block images, then it still won't find them because find_by doesn't currently look in AsciiDoc table cells.

Here are the lines in question:

• https://github.com/asciidoctor/asciidoctor-epub3/blob/master/lib/asciidoctor-epub3/packager.rb#L316
• https://github.com/asciidoctor/asciidoctor/blob/master/lib/asciidoctor/abstract_block.rb#L250

[mojavelinux]

For now, here's the logic that's needed.

images = (doc.find_by context: :image).concat doc.find_by(context: :table).map {|table|
  table.rows.body.flatten.select {|cell| cell.style == :asciidoc }
}.flatten.map {|cell|
  cell.instance_variable_get(:@inner_document).find_by(context: :image)
}.flatten

[mojavelinux]

I suppose we'll eventually want to support this in find_by, but it's definitely a rough-in. For now, it might be best just to put it in asciidoctor-epub3 as a stop-gap measure.

[mojavelinux]

Feel free to attempt a patch if you get to it before me.

[mojavelinux]

I've decided to solve this by using the document catalog instead of the AST. We already have the limitation that the imagesdir cannot be changed within a chapter file, so we have enough information to be able to reconstruct the path to the image from the value in document catalog alone.

In order to make this work, we have to set the catalog_assets option on the document to true. Fortunately, we control the loading of each chapter file in the spine processor, so we can set additional options. (See

asciidoctor-epub3/lib/asciidoctor-epub3/spine_item_processor.rb

Lines 50 to 58 in 9c241f6

	spine_item_doc = ::Asciidoctor.load_file include_file,
	# setting base_dir breaks if outdir is not a subdirectory of spine_doc.base_dir
	#base_dir: spine_doc.base_dir,
	# NOTE won't write to correct directory if safe mode is :secure
	safe: spine_doc.safe,
	backend: 'epub3-xhtml5',
	doctype: :article,
	header_footer: true,
	attributes: inherited_attrs

).

One problem we're going to run into is that, as of 1.5.6.1, core does not pass the catalog_assets option to nested documents (e.g., an AsciiDoc table cell). There's no easy way around this limitation. Therefore, images in AsciiDoc table cells will not be included until that is fixed in core (slated for 1.5.7).

[mojavelinux]

I also needed to add SVG support for inline images in the converter and set a max-width value for inline images. I decided to add the class inline to inline images to help distinguish them from block / figure images in the stylesheet.

[mojavelinux]

Please note if you are reading this that images in AsciiDoc table cells will not be included unless you are using at least Asciidoctor (core) 1.5.7 (and it has been released, of course).