[oslc-core] oslc v2.0 spec - observed issue with oslc:shorttitle description

[Arthur Ryman]

Jacob,

I agree.  dcterms:title should contain valid <span> content. I assume this 
is a copy-paste from dcterms:description which should have valid <div> 
content.

Also, the oslc:shortTitle in practice will be just plain text, e.g. a bug 
number. It's supposed to be short. Perhaps the intention is that the 
formatted result only be 5 characters? Even that seems too small for 
jazz.net where bug numbers are 6 digits now.

Regards, 
___________________________________________________________________________ 

Arthur Ryman 

DE, PPM & Reporting Chief Architect
IBM Software, Rational 
Toronto Lab | +1-905-413-3077 (office) | +1-416-939-5063 (mobile) 





From:
Jacob Yackenovich <jyackeno at us.ibm.com>
To:
oslc-core at open-services.net
Date:
09/01/2011 05:04 PM
Subject:
[oslc-core] oslc v2.0 spec - observed issue with oslc:shorttitle 
description
Sent by:
oslc-core-bounces at open-services.net



Hi Team, 
        In reviewing the OSLC Core spec contents, I've observed some level 
of ambiguity with two declarations of the use of oslc:shorttitle 

Open Services for Lifecycle Collaboration Core Specification Version 2.0 
UI Preview: 
http://open-services.net/bin/view/Main/OslcCoreUiPreview?sortcol=table;up=#Representing_a_Resource_for_UI_P 


provides a definition of oslc:shortTitle with a value-type of "XMLLiteral" 
and a description of: 
"Abbreviated title which may be used in the display of a link to the 
resource. The value SHOULD include only content that is valid inside an 
XHTML <span> element. Providers SHOULD include an abbreviated title for 
the resource when possible. The abbreviated title is typically shown to a 
user as a hyperlink in presentations where visual space is limited. As a 
general guideline, the length of the abbreviated title SHOULD be 5 
characters or less. A user-visible identifier that ordinarily appears in 
the dcterms:title, such as a defect number, makes for a good 
oslc:shortTitle value. When a resource has no obvious identifier or 
handle, Providers SHOULD omit the oslc:shortTitle property. " 

My issue is with regard to the length statement. I am not aware of many 
well-balanced self-contained XML values that would be meaningful and also 
fit in the boundary of 5 characters or less. 


In addition, the Open Services for Lifecycle Collaboration Core 
Specification Version 2.0 Appendix A: Common Properties: 
http://open-services.net/bin/view/Main/OSLCCoreSpecAppendixA 

Provides the following definition for oslc:shortTitle with a value-type of 
"XMLLiteral" and a description of: 
"Shorter form of dcterms:title for the resource represented as rich text 
in XHTML content. SHOULD include only content that is valid inside an 
XHTML <div> element. " 


My additional issue is the apparent ambiguity between the descriptions of 
shortTitle. I may adhere to the best practices of the description of the 
Core declaration for this property, however in doing so I will (quite 
possibly) violate the best practices listed in the UI Preview 
specification for this property. 

Further, there is a discrepancy as to what content is valid the property. 
UI Preview best practice is content SHOULD be valid inside an XHTML <span> 
element, while Core best practice is SHOULD be valid inside an XHTML <div> 
element. 

Could you investigate and suggest a course of action to reconcile the 
descriptions of oslc:shortTitle between the core specifications? 



Regards,
Jacob

Jacob Yackenovich
Data Integration Lead, Common Data Model Architecture 
Tivoli Software |  IBM  |  Research Triangle Park, NC
jyackeno at us.ibm.com  |  (919) 224-1373
_______________________________________________
Oslc-Core mailing list
Oslc-Core at open-services.net
http://open-services.net/mailman/listinfo/oslc-core_open-services.net