[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Atom 0.2 feedback



Joe English <jenglish@xxxxxxxxxxxxx> writes:

> Tim Bray wrote:

> > Since <summary> doesn't allow markup, I can't do any styling
> > there, right?  So is it OK to put my teaser in <content>, which
> > does allow this, or is the semantic of <content> that the content
> > must be complete?  At ongoing, if the <description> in the RSS is
> > *not* the full text of the entry, I signal this with a trailing
> > "...".  If we are going to allow non-complete <content> elements
> > should this be made explicit with a full=(yes|no) attribute?
> 
> A better solution would be to just give <summary> the
> same content model as <content>.
> 
> Compare:
> 
>     summary -- a brief summary of the entry (optional)
>     content -- the full content of the entry (optional)
> 
> with:
> 
>     summary -- a brief summary of the entry (optional)
>     content -- the full content of the entry, if @full=yes
>     	is specified or there is no '@full' attribute.  Otherwise,
> 	if there is no 'summary' element and (and/or?) '@full=no'
> 	is specified, a brief summary of the entry.
> 
> Ick!  This is just like the <guid>/<link> problem in RSS 2.0.
> Please don't go that route.

'summary' is the summary or abstract, often not the same as some
portion or excerpt of the content.  (I think we all agree there).

The question is: must it be full <content>?

<proposal kind="already on the wiki">

On the content[1] wiki page the 'rel' attribute is used to describe
the relation of this content.  Given that <content> approximates an
HTTP/MIME resource entity, the absense of a 'rel' attribute means the
resource entity should be complete, and using XHTML as an example,
that would mean including the DOCTYPE declaration and thus meaning the
XHTML content would have to be mode="escaped".

Possible Atom-defined 'rel's are not documented yet, but some are used
in examples.

rel='fragment' is a partial resource entity that corresponds to the
"full" entry.  rel='fragment excerpt' would be a partial resource
entity that is an excerpt of the full entry, distinct from the
summary.  Using XHTML as an example, rel='fragment' means they can use
mode="xml".

</proposal>

  -- Ken