Bug 448331

Summary: inline graphic tag does not render inline. See 2 in above page.
Product: [Community] Publican Reporter: Susan Burgess <sburgess>
Component: publicanAssignee: Jeff Fearn 🐞 <jfearn>
Status: CLOSED WONTFIX QA Contact: Michael Hideo <mhideo>
Severity: medium Docs Contact:
Priority: medium    
Version: 2.0CC: afitzsim, mhideo, mmcallis, publican-list
Target Milestone: ---Keywords: Documentation, FutureFeature
Target Release: ---   
Hardware: All   
OS: Linux   
URL: https://engineering.redhat.com/docbot/en-US/oVirt/0.1/html/Using_oVirt/Adding-Resource-Pools.html
Whiteboard:
Fixed In Version: Doc Type: Enhancement
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2008-06-11 05:57:53 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Susan Burgess 2008-05-25 23:50:26 UTC
From Bugzilla Helper:
User-Agent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.8.0.12) Gecko/20080213 Red Hat/1.5.0.12-11.el5_1 Firefox/1.5.0.12

Description of problem:
it appears that the <inlinegraphic> tag does not exist in Fedora or RedHat brands.
This is the error.

WARNING: Unknown tag: inlinegraphic. This tag may not be displayed correctly


Version-Release number of selected component (if applicable):


How reproducible:
Always


Steps to Reproduce:
1. Insert tag into file
2. make test
3. error message appears
WARNING: Unknown tag: inlinegraphic. This tag may not be displayed correctly


Actual Results:
It compiles fine, but there is line break after the content tagged as inlinegraphic

Expected Results:
The should be no line break

Additional info:

Comment 1 Jeff Fearn 🐞 2008-05-26 02:51:44 UTC
Please include the SVN details for where you are using this.

Comment 3 Jeff Fearn 🐞 2008-06-05 07:25:08 UTC
Here is the simple fix for the css, the PDF will require more work.

p img {
	display:inline;
	margin:0em;
	padding: 0em 0.5em;
}

We need to discuss if this tag is acceptable.

The HTML, even fixed, looks poor, and I doubt much can be done to fix this.

This tag can break section 508 compliance. At the minimum we would require
enforcing the use of attributes to overcome this breakage.

This tag breaks txt output; possibly the section 508 fix would overcome this.

This tag may impact translation.

Comment 4 Andy Fitzsimon 2008-06-05 08:39:40 UTC
Just a comment.

inline images affect the line-height... 
changing the line height for one line breaks the visual flow for readers.

we cannot force authors to only upload 12pt high graphics and therefore i
reccoment removing this ability.

(its why we have images as block-level objects in the first place)

Comment 5 Andy Fitzsimon 2008-06-05 08:44:33 UTC
wow,  you can tell I'm not a writer:  D and T are nowhere near each other :)
sorry about that.

let me state this differently while I'm here:

I recommend keeping all images as block level objects.

Screenshots are a more appropriate way to communicate interface elements.  
Using icons removes regional context of the interaction. 
Why show the icon but not say where the toolbar is?

Comment 6 Susan Burgess 2008-06-06 00:49:33 UTC
This was a documentation review request from the UI designer.
I will let them know that the ECS designers have rejected this.

If this is a decision, I recommend that we add this to the Style Guide.

If inlinegraphic cannot be used, what is the alternative? I tried tables but it
seems to have a predetermined pagewide attribute.


Comment 7 Andy Fitzsimon 2008-06-06 01:29:47 UTC
the alternative already mentioned is screenshot snippets on their own line.

They show the visual metaphor for your action and also show where it exists in
the UI at the same time.  

It's a 2 for one and the text-leading gets left alone 

Andy :-)

Comment 8 Susan Burgess 2008-06-06 02:29:36 UTC
No, that's not clear enough - doesnt drill down to the individual icon, so
doesnt meet the users need to identify the icon with the function.
of course I could create a ticket for you to create the shot with a nice overlay
on each icon.
;)

Comment 9 Andy Fitzsimon 2008-06-06 05:42:32 UTC
I'd be happy with that.  
This is an issue of appropriate communication design. 


Comment 10 Jeff Fearn 🐞 2008-06-11 05:57:53 UTC
inlinegraphic has been banned as it:

1: breaks section 508 accessibility standards
2: makes translation extremely difficult
3: fails to meet information design standards