W3C home > Mailing lists > Public > www-rdf-calendar@w3.org > September 2005

RDF Calendar - Short review

From: Karl Dubost <karl@w3.org>
Date: Thu, 29 Sep 2005 15:52:05 -0400
Message-Id: <41C81C5B-AEDE-4A8F-A7DD-7ACCEBDF6292@w3.org>
To: www-rdf-calendar@w3.org

Dan, Libby,


First of all, congratulations for this useful W3C Note on Calendaring  
in RDF and for the Web. It was interesting to read  and I have  
learned a lot, and it seems there are plenty of things to create with  
what you have started. I could foresee a next step explaining how to  
solve different kind of calendaring problems like events conflicts,  
coordination of information sources, etc with the help of calendars  
in RDF.

So Again a big congrats.

My comments when reading the document.


* Reading the document
     Sometimes the document is a bit difficult to understand in its  
organization. It's not clear also in each section

  - the use case
  - what was the issue
  - how to solve it
  - example

Having a systemic template for writing sections are often practical  
and can help the reader to understand with clarity  the content of  
your work. For example in QA Spec GL, the template is

     - Requirement/Good Practice
     - What does it mean?
     - Why Care?
     - Related Information
     - Examples

We define a process to write the document that helped to maintain  
this uniformity
http://lists.w3.org/Archives/Public/www-qa-wg/2004Jun/0023

You might find a template which suits for your document.


* Links through the text
     If someone prints the text, all links reference will be lost.  
You might want to add [LINK-REF] through the text. OR give a  
printable version of your document with explicit references.

* link
[[[
The resulting RDF/XML analogs served useful purposes to at least some  
of the participants and seemed to be correct, by inspection, to all  
present. This provided critical mass to begin maintaining a test suite
]]] - http://www.w3.org/TR/2005/NOTE-rdfcal-20050929/#intro

=> I would have added a link to the test suite.


* typo
[[[
Email offers the chance to read and compse at your own pace, but the  
the timezone gaps between America, Europe, and Asia effective impose  
a 24 hour round-trip time that is a real barrier to conversation.
]]] - http://www.w3.org/TR/2005/NOTE-rdfcal-20050929/#Collaborat

=> s/the the/the/
=> I'm not sure of English correctness for "effective impose"


* Examples markup and style.
     I found the CSS style of examples a bit rough. If you want I  
could propose you a style, but I wanted to be sure that you were open  
to a suggestion.

* 3. A simple example
http://www.w3.org/TR/2005/NOTE-rdfcal-20050929/#exsim

I would add a bit more context for your simple example. Tell a story  
even in one very small paragraph, ala  @@I was planning to attend  
the  scooby conference, so with calendaring application @@
     A reader will understand even more.


* Example not closed.
http://www.w3.org/TR/2005/NOTE-rdfcal-20050929/#ns-gnd

     I know it might seem bizarre, but I have always a tendency to  
shock on not well formed examples ;) could you close the RDF?


* "footnotes"

     I didn't find obvious the understanding of footnotes in your  
document. Maybe it's a question of layout, maybe a question of topic  
marker.


* Notation 3 rules syntax

[[[
We explored using rules to generate a schema from our example data.  
Rules such as "if something is related to semething else by ?P, then ? 
P is a Property" and "if something is a ?C, then ?C is a Class" can  
be expressed in Notation3 rule syntax:
]]] - http://www.w3.org/TR/2005/NOTE-rdfcal-20050929/#Generating

     => When I follow the link to Notation 3, I found a document  
which is hard to read and not very explicit to understand what is the  
notion of rules in Notation 3. I would give a link to another  
document clearly explaining how does it work with examples. If such a  
document doesn't exist, it might be an opportunity to create it.


* 9. Quote from another specification
http://www.w3.org/TR/2005/NOTE-rdfcal-20050929/#Generating

You give an excerpt from icalendar specification, give a link to the  
appropriate part. Put the "pre" element in a blockquote with the  
appropriate cite attribute.


* Table of test references
http://www.w3.org/TR/2005/NOTE-rdfcal-20050929/#testdr

In this section, there's a big table with name of files. I'm not sure  
that the table is useful as it is for the user or implementers. It's  
a bit like URI in your face.
Is there a list describing each test with the minimum metadata

     See http://www.w3.org/TR/test-metadata

Maybe, In the last column of the table,  make list with a short  
abstract of the test and a link to the real file.


* hcalendar
Maybe unrelated to this document
     <abbr class="dtstart" title="2005-10-05">October 5</abbr>
Do you know what people from WAI thinks about the title which is less  
readable than the abbr. Will it be a problem with screen reader?

[[[
title = text [CS]
     This attribute offers advisory information about the element for  
which it is set.

Unlike the TITLE element, which provides information about an entire  
document and may only appear once, the title attribute may annotate  
any number of elements. Please consult an element's definition to  
verify that it supports this attribute.

Values of the title attribute may be rendered by user agents in a  
variety of ways. For instance, visual browsers frequently display the  
title as a "tool tip" (a short message that appears when the pointing  
device pauses over an object). Audio user agents may speak the title  
information in a similar context.

]]] - http://www.w3.org/TR/html401/struct/global.html#adef-title



-- 
Karl Dubost - http://www.w3.org/People/karl/
W3C Conformance Manager
*** Be Strict To Be Cool ***
Received on Thursday, 29 September 2005 19:52:38 UTC

This archive was generated by hypermail 2.3.1 : Tuesday, 6 January 2015 20:14:13 UTC