[TRINIDAD-1529] Enhanced support for tag doc generation to support screenshots and better formatting of example code snippets

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.2.10-plugins
• Component/s: Plugins
• Assignee: Unassigned
• Reporter: Maria Kaval
• Created: 08/Jul/09 17:51
• Updated: 27/Jan/10 08:46
• Resolved: 10/Jul/09 18:29

Description

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 TAG</mfp:image>
<mfp:description> HERE YOU PLACE THE CAPTION THAT GOES WITH YOUR IMG TAG </mfp:description>
</mfp:screenshot>

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.