Enhanced support for tag doc generation to support screenshots and better
formatting of example code snippets
-------------------------------------------------------------------------------------------------------------
Key: TRINIDAD-1529
URL: https://issues.apache.org/jira/browse/TRINIDAD-1529
Project: MyFaces Trinidad
Issue Type: Improvement
Components: Plugins
Reporter: Maria Kaval
This JIRA is to support having a tag to mark screenshots within the tag doc
xml. This will ensure that all pages have the same formatting for screenshots
(e.g. the header text will be the same, one can easily skin the section, and
the screenshots will appear at the same section of the tag doc, etc).
I suggest modifying the plugin to understand:
<mfp:screenshot>
<mfp:image> HERE YOU PLACE YOUR IMG TAGS</mfp:image>
<mfp:description> HERE YOU PLACE THE CAPTION THAT GOES WITH YOUR IMG TAG
</mfp:image-description>
</mfp:screen-shot>
A real-world example would look like:
<mfp:screenshot>
<mfp:image>
<![CDATA[
<img src="../images/inputDate.png" alt="inputDate screenshot"></img>
]]>
</mfp:image>
<mfp:description>
inputDate component as shown when rendered in a simple form
</mfp:description>
</mfp:screenshot>
This JIRA also covers modifying the plugin for how it generates the mfp:example
tag. Currently mfp:example outputs bold text at the end of the description
with "Example:". The issue is that depending on what text is towards the end
of the long description, sometimes it appears the Example is for something very
specific to that page instead of generic to the component. I've therefore
modifed the plugin to create a new section when mfp:example tag is encountered.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
