[oslc-core] OSLC Compact representation, titles with markup

[Arthur Ryman]

Sam,

You are correct. If you need to include formatting markup in text, the you 
should use the XML Literal datatype and put XHTML in it. XML Literal 
allows any well-formed  XML fragment, e.g. anything that is valid XML 
element content.

Your example is almost correct. It should also include the XHTML namespace 
declaration. A processor could assume that tags in the default namespace 
are XHTML. However, you should be explicit and include the namespace 
declaration:

  <dcterms:title rdf:parseType="Literal" xmlns="
http://www.w3.org/1999/xhtml ">12345: <s>Null pointer exception
during startup</s></dcterms:title>


A looked at the core spec [1] for dcterms:title and noticed another typo. 
The description description says:


Title of the resource represented as rich text in XHTML content. SHOULD 
include only content that is valid inside an XHTML <div> element. 

I think this was just copied from the description for dcterms:description, 
which SHOULD be like a <div>. A dcterms:title SHOULD be like a <span>, 
i.e.:

Title of the resource represented as rich text in XHTML content. SHOULD 
include only content that is valid inside an XHTML <span> element. 

[1]
http://open-services.net/bin/view/Main/OSLCCoreSpecAppendixA#Dublin_Core_Properties

Regards, 
___________________________________________________________________________ 

Arthur Ryman 


DE, PPM Chief Architect

IBM Software, Rational 

Toronto Lab | +1-905-413-3077 
Twitter | Facebook | YouTube







From:
Samuel Padgett <spadgett at us.ibm.com>
To:
"oslc-core at open-services.net" <oslc-core at open-services.net>
Cc:
Adam Archer/Toronto/IBM at IBMCA, Randy Hudson <hudsonr at us.ibm.com>
Date:
08/07/2011 01:07 PM
Subject:
[oslc-core] OSLC Compact representation, titles with markup
Sent by:
oslc-core-bounces at open-services.net




Small correction, that first example should be,

  <dcterms:title rdf:parseType="Literal">12345: <s>Null pointer exception
during startup</s></dcterms:title>

- Sam


__________________

I believe the spec is a bit confusing when it comes to titles with markup
for UI Preview.

The Compact representation has a dcterms:title property. It's defined as 
an
XML Literal that can contain XHTML markup [1]. My understanding of XML
Literals as discussed in the RDF Primer [2] means a title with markup 
would
look like this,

  <dcterms:title>12345: <s>Null pointer exception during
startup</s></dcterms:title>

The example [3] of this resource has a title like this, however,

  <dcterms:title> 12345: <s>Null pointer exception during
startup</s> </dcterms:title>

The example doesn't seem to fit with the description.

It's very difficult to parse the former using XPath. For instance, the
expression "/oslc:Compact/dcterms:title" takes out the "<s>" and "</s>"
Most implementations I'm aware also follow the example where markup is
encoded. It means special characters need to be "double encoded." For
instance, "12345: Values > 1000 incorrectly calculated" would be,

  <dcterms:title>12345: Values &gt; 1000 incorrectly
calculated</dcterms:title>

I think we should add more clarity to the spec here, as getting this wrong
can open up consumers to cross-site scripting attacks. I'd also suggest we
say that providers MUST NOT use any markup with a <script> tag and 
consumer
MUST NOT display any markup with a <script> tag to guard against this
problem.

Best Regards,
Sam


[1]
http://open-services.net/bin/view/Main/OslcCoreUiPreview?sortcol=table;up=#Representation_Compact

[2] http://www.w3.org/TR/rdf-syntax/#xmlliterals
[3]
http://open-services.net/bin/view/Main/OslcCoreUiPreview?sortcol=table;up=#XML_Representation_Format



_______________________________________________
Oslc-Core mailing list
Oslc-Core at open-services.net
http://open-services.net/mailman/listinfo/oslc-core_open-services.net