You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@myfaces.apache.org by "Maria Kaval (JIRA)" <de...@myfaces.apache.org> on 2010/02/17 21:58:28 UTC

[jira] Created: (TRINIDAD-1731) Improve Formatting of Tag Doc Summary section

Improve Formatting of Tag Doc Summary section
---------------------------------------------

                 Key: TRINIDAD-1731
                 URL: https://issues.apache.org/jira/browse/TRINIDAD-1731
             Project: MyFaces Trinidad
          Issue Type: Improvement
          Components: Documentation
    Affects Versions:  1.2.12-plugins 
            Reporter: Maria Kaval
            Priority: Minor


Today the summary section of the tag doc (the top section where it lists for example the tag name, component class, component type and whether or not something is a naming container doesn't have very nice formatting.   As an example see http://myfaces.apache.org/trinidad/trinidad-api/tagdoc/tr_table.html

With this JIRA I will instead generate an HTML table, so that the left side and right side are well-aligned, and it will be cleaner to read.  I will make the formatting of the lines consistent (bold on left, each word starts with a capital letter, each phrase ends with a colon and each line takes up the same amount of space - today some lines have white space around them while others don't).

The summary section table will be in a div to allow CSS styling separate from other tables in the tag doc.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (TRINIDAD-1731) Improve Formatting of Tag Doc Summary section

Posted by "Maria Kaval (JIRA)" <de...@myfaces.apache.org>.
     [ https://issues.apache.org/jira/browse/TRINIDAD-1731?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Maria Kaval updated TRINIDAD-1731:
----------------------------------

    Status: Patch Available  (was: Open)

> Improve Formatting of Tag Doc Summary section
> ---------------------------------------------
>
>                 Key: TRINIDAD-1731
>                 URL: https://issues.apache.org/jira/browse/TRINIDAD-1731
>             Project: MyFaces Trinidad
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions:  1.2.12-plugins 
>            Reporter: Maria Kaval
>            Priority: Minor
>         Attachments: trinidad_new_summary.PNG
>
>
> Today the summary section of the tag doc (the top section where it lists for example the tag name, component class, component type and whether or not something is a naming container doesn't have very nice formatting.   As an example see http://myfaces.apache.org/trinidad/trinidad-api/tagdoc/tr_table.html
> With this JIRA I will instead generate an HTML table, so that the left side and right side are well-aligned, and it will be cleaner to read.  I will make the formatting of the lines consistent (bold on left, each word starts with a capital letter, each phrase ends with a colon and each line takes up the same amount of space - today some lines have white space around them while others don't).
> The summary section table will be in a div to allow CSS styling separate from other tables in the tag doc.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (TRINIDAD-1731) Improve Formatting of Tag Doc Summary section

Posted by "Jeanne Waldman (JIRA)" <de...@myfaces.apache.org>.
     [ https://issues.apache.org/jira/browse/TRINIDAD-1731?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Jeanne Waldman updated TRINIDAD-1731:
-------------------------------------

       Resolution: Fixed
    Fix Version/s:  1.2.13-plugins 
           Status: Resolved  (was: Patch Available)

applied the patch by Maria Kaval. Fixed a typo in the patch, otherwise it was fine.

> Improve Formatting of Tag Doc Summary section
> ---------------------------------------------
>
>                 Key: TRINIDAD-1731
>                 URL: https://issues.apache.org/jira/browse/TRINIDAD-1731
>             Project: MyFaces Trinidad
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions:  1.2.12-plugins 
>            Reporter: Maria Kaval
>            Assignee: Jeanne Waldman
>            Priority: Minor
>             Fix For:  1.2.13-plugins 
>
>         Attachments: JIRA1731_trunk.patch, trinidad_new_summary.PNG
>
>
> Today the summary section of the tag doc (the top section where it lists for example the tag name, component class, component type and whether or not something is a naming container doesn't have very nice formatting.   As an example see http://myfaces.apache.org/trinidad/trinidad-api/tagdoc/tr_table.html
> With this JIRA I will instead generate an HTML table, so that the left side and right side are well-aligned, and it will be cleaner to read.  I will make the formatting of the lines consistent (bold on left, each word starts with a capital letter, each phrase ends with a colon and each line takes up the same amount of space - today some lines have white space around them while others don't).
> The summary section table will be in a div to allow CSS styling separate from other tables in the tag doc.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.