Return-Path: 
 <dev-return-39989-apmail-myfaces-dev-archive=myfaces.apache.org@myfaces.apache.org>
Delivered-To: apmail-myfaces-dev-archive@www.apache.org
Received: (qmail 38980 invoked from network); 8 Jul 2009 17:53:28 -0000
Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.3)
  by minotaur.apache.org with SMTP; 8 Jul 2009 17:53:28 -0000
Received: (qmail 76211 invoked by uid 500); 8 Jul 2009 17:53:37 -0000
Delivered-To: apmail-myfaces-dev-archive@myfaces.apache.org
Received: (qmail 76158 invoked by uid 500); 8 Jul 2009 17:53:37 -0000
Mailing-List: contact dev-help@myfaces.apache.org; run by ezmlm
Precedence: bulk
List-Help: <mailto:dev-help@myfaces.apache.org>
List-Unsubscribe: <mailto:dev-unsubscribe@myfaces.apache.org>
List-Post: <mailto:dev@myfaces.apache.org>
List-Id: <dev.myfaces.apache.org>
Reply-To: "MyFaces Development" <dev@myfaces.apache.org>
Delivered-To: mailing list dev@myfaces.apache.org
Received: (qmail 76150 invoked by uid 99); 8 Jul 2009 17:53:37 -0000
Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136)
    by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 08 Jul 2009 17:53:37 +0000
X-ASF-Spam-Status: No, hits=-2000.0 required=10.0
	tests=ALL_TRUSTED
X-Spam-Check-By: apache.org
Received: from [140.211.11.140] (HELO brutus.apache.org) (140.211.11.140)
    by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 08 Jul 2009 17:53:35 +0000
Received: from brutus (localhost [127.0.0.1])
	by brutus.apache.org (Postfix) with ESMTP id D2178234C004
	for <dev@myfaces.apache.org>; Wed,  8 Jul 2009 10:53:14 -0700 (PDT)
Message-ID: <1719095050.1247075594852.JavaMail.jira@brutus>
Date: Wed, 8 Jul 2009 10:53:14 -0700 (PDT)
From: "Maria Kaval (JIRA)" <dev@myfaces.apache.org>
To: dev@myfaces.apache.org
Subject: [jira] Created: (TRINIDAD-1529) Enhanced support for tag doc
 generation to support screenshots and better formatting of example code
 snippets
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit
X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394
X-Virus-Checked: Checked by ClamAV on apache.org

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.