Bug 53820 - Wishlist: Image callouts in Docbook that actually work
Summary: Wishlist: Image callouts in Docbook that actually work
Status: RESOLVED INVALID
Alias: None
Product: Fop - Now in Jira
Classification: Unclassified
Component: general (show other bugs)
Version: 1.0
Hardware: All All
: P2 enhancement
Target Milestone: ---
Assignee: fop-dev
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-09-03 11:53 UTC by Jan Brogger
Modified: 2012-09-04 14:49 UTC (History)
0 users



Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Jan Brogger 2012-09-03 11:53:09 UTC
I'm not sure this is a FOP problem, or if it is the Docbook stylesheets that is the problem. I suspect that FOP would need to do the work anyways.

The image callout tag in Docbook (any version) is not useful. When writing user manuals for software, a not insignificant part of the work is creating screenshots and marking parts of the screen. If the screens could be "tagged" with callouts in a structured manner such as Docbook, then the workload would be significantly reduced. People use all sorts of horrible solutions such as doing it in Word, Powerpoint, or many different programs. 

One authoritative source has a work-intensive workaround. 
http://norman.walsh.name/2006/06/10/imageobjectco

This documents the tag:
http://www.sagehill.net/docbookxsl/Imagemaps.html

Current status with FOP:
Callouts are not rendered on top of images
Callouts are rendered in a calloutlist, below the figure (using standard stylesheets).

Expected behavior:
Given the following input:
    <figure>
      <title>The main screen</title>
      <mediaobject>
        <imageobjectco>
          <areaspec units="calspair">
            <area coords="0, 0 1000, 1000" xml:id="firstcallout"/>
          </areaspec>
          <imageobject>
            <imagedata fileref="screenshots/mainscreen.jpg"/>
          </imageobject>
          <calloutlist>
            <callout arearefs="firstcallout">
              <para>A first callout</para>
            </callout>
          </calloutlist>
        </imageobjectco>
      </mediaobject>
    </figure>

FOP should ideally produce a PDF file with a figure looks like "mainscreen.jpg" but is actually "mainscreen.jpg" merged with a "1.svg" file at the coordinates (callout number 1).
Comment 1 Glenn Adams 2012-09-03 12:27:52 UTC
FOP != DocBook; if you can express your enhancement request in terms of XSL-FO 1.1 [1] features or the future looking XSL-FO 2.0 requirements [2], then feel free to file a new enhancement bug

[1] http://www.w3.org/TR/2006/REC-xsl11-20061205/
[2] http://www.w3.org/TR/xslfo20-req/
Comment 2 Vincent Hennebert 2012-09-04 14:49:54 UTC
(In reply to comment #1)
> FOP != DocBook; if you can express your enhancement request in terms of
> XSL-FO 1.1 [1] features or the future looking XSL-FO 2.0 requirements [2],
> then feel free to file a new enhancement bug
> 
> [1] http://www.w3.org/TR/2006/REC-xsl11-20061205/
> [2] http://www.w3.org/TR/xslfo20-req/

A little less abrupt answer would be preferable. User feedback is precious and we wouldn't want to scare them off by responding bluntly.

Jan, please describe your issue on the fop-users mailing list: http://xmlgraphics.apache.org/fop/dev/index.html#mail-fop-dev (Bugzilla is used to report identified bugs.)
Like Glenn send, your will have to provide us with an XSL-FO file (the result of the transformation of your source DocBook file by the DocBook stylesheets), as this is what we are working with. Ideally you would make it as small as possible.

That said, you may want to try the docbook-apps mailing list first, as it might just be a matter of customizing the DocBook stylesheets.
http://wiki.docbook.org/DocBookAppsMailingList

Thanks,
Vincent