alps-io / spec

ALPS Specification documents.
59 stars 13 forks source link

Inconsistent XML representation of title #113

Open filip26 opened 3 years ago

filip26 commented 3 years ago

A title may appear on a document, a descriptor or on a link. The XML example in the specification represents title on document level as an element but on descriptor level as an attribute.

   <?xml version="1.0"?>
     <alps version="1.0">
     <title>Search Profile</title>
     <doc href="http://example.org/samples/full/doc.html" />

     <descriptor id="search" type="safe" title="Search for a profile.">
       ...
     </descriptor>
   </alps>

see 2.2.15 paragraph.

Let's make it consistent and recommend title be represented either as an element or as an attribute. My vote goes to an element because it recalls (X)HTML.

e.g.

   <?xml version="1.0"?>
     <alps version="1.0">
     <title>Search Profile</title>
     <doc href="http://example.org/samples/full/doc.html" />

     <descriptor id="search" type="safe">
         <title>Search for a profile.</title>
       ...
     </descriptor>
   </alps>