[jbosstools-issues] [JBoss JIRA] Commented: (JBIDE-5708) JBoss Tools docbook xslt does not allow for alt tags to be rendered correctly

[OLga Chikvina (JIRA)]

    [ https://jira.jboss.org/jira/browse/JBIDE-5708?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12507563#action_12507563 ] 

OLga Chikvina commented on JBIDE-5708:
--------------------------------------

Isaak,i investigated the problem and found out that the problem with weird html files appeared because in some textobject tags <textobject><para>some text</para></textobject>was used instead of <textobject><phrase>some text</phrase></textobject>.As it's written in the textobject describtion( http://www.docbook.org/tdg/en/html/textobject.html)&lt;phrase> tag is used "for providing a simple "alt text" for a media object. The phrase might be used, for example, as the value of the ALT attribute on an HTML IMG, with the primary content of the image coming from one of the other objects in the media object. " So I think this standard behavior is ok and we shouldn't change it in our templates.So I changed <para> to <phrase> in these places.I also restuctured the guide a little according to our documentation agreements.I hope it will be useful.

> JBoss Tools docbook xslt does not allow for alt tags to be rendered correctly
> -----------------------------------------------------------------------------
>
>                 Key: JBIDE-5708
>                 URL: https://jira.jboss.org/jira/browse/JBIDE-5708
>             Project: Tools (JBoss Tools)
>          Issue Type: Bug
>          Components: maven
>         Environment: RHEL 5 and the jbosstools-docbook-xslt-1.0.0-SNAPSHOT
>            Reporter: Isaac Rooskov
>            Assignee: OLga Chikvina
>
> When using the <textobject> tag to house the necessary information of an image for the visually impared who use screenreaders to read our documentation, weird html files are created in the directory where the 'target' folder is generated. 
> Here's an example of the xml:
> <figure id="figu-Beginners_Guide-Visual_Web_Tools-Visual_Page_Editor">
> 						<title>Visual Page Editor</title> 
> 						<mediaobject>
> 							<imageobject>
> 								<imagedata fileref="images/figu-Beginners_Guide-Visual_Web_Tools-Visual_Page_Editor.png" format="PNG" width="444" />
> 							</imageobject>
> 							<textobject>
> 								<phrase>
> 									The Visual Page Editor, showing both the source and a visual preview simultaneously.
> 								</phrase>
> 							</textobject>
> 						</mediaobject>
> 					</figure>
> When the <textobject> isn't specified (which it doesn't seem to be in other JBoss Tools documentation I've had a look at) the title of the image is used as the alt-text for the image, however a visually impared reader requires more information than this, which is why the <textobject> tag exists. When using the <textobject> tag, the information in it is indeed used as the alt-text for the image, however weird xml files are generated in the output of compiling the book in maven (mvn compile). I have attached a screenshot of these files.
> Each weird html file contains the text of one <textobject> tag, thus there is a weird html file for every <textobject> in the book. 

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira