Incorrect description of "description" element in reference/project-descriptor.xml

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Fixed
  • Affects Version/s: 1.0-rc1
  • Fix Version/s: 1.0.1
  • Component/s: documentation
  • Labels:
    None
  • Environment:
    N/A

Description

The description for the "description" element in reference/project-descriptor.xml states that the content model for the element is CDATA so as to be able to include HTML tags. This is false according to the XML Schema xsd/maven-project.xsd which specifies the "description" element as being of type xs:string which prohibits children elements.

Either the description or maven-project.xsd should be fixed. Personally, I would rather be able to include HTML in the project description in project.xml...

Estimate is for fixing the documentation. Changing the schema might be trickier depending on the existence of side-effects.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
dion gillard added a comment -

I'd much rather the schema change

Show
dion gillard added a comment - I'd much rather the schema change
Hide
Permalink
Brett Porter added a comment -

Don't think we should encourage HTML in description long term - this should be a complete
plaintext description, that presents the default index page. If you need more on the index page, suggest index.xml.
Doco updated accordingly.

Show
Brett Porter added a comment - Don't think we should encourage HTML in description long term - this should be a complete plaintext description, that presents the default index page. If you need more on the index page, suggest index.xml. Doco updated accordingly.

People

  • Assignee:
    Unassigned
    Reporter:
    Chris Laprun
Vote (1)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved:

Time Tracking

Estimated:
30m
Original Estimate - 30 minutes
Remaining:
30m
Remaining Estimate - 30 minutes
Logged:
Not Specified
Time Spent - Not Specified