uid-brainstorming

(Difference between revisions)

Jump to: navigation, search
(Add UID + SOURCE option)
Current revision (21:55, 20 December 2008) (view source)
m (Reverted edits by AllieLtrle (Talk) to last version by TobyInk)
 
(6 intermediate revisions not shown.)
Line 16: Line 16:
* It would be useful for autodiscovery puposes to be able to follow a network resolvabale UID and extract more metadata from the referenced UID. Having a well defined UID pattern would prevent an explosion of rel values: rel-vcard, rel-vevent, etc.
* It would be useful for autodiscovery puposes to be able to follow a network resolvabale UID and extract more metadata from the referenced UID. Having a well defined UID pattern would prevent an explosion of rel values: rel-vcard, rel-vevent, etc.
 +
** [http://www.google.com/search?q=rel+meta rel=meta] can be used to suggest that additional relevant metadata can be found by following a link. This is often used to link to RDF files, but rel values aren't restricted to any particular MIME types - an HTML document could acceptably be linked to.
* Efforts such as [http://unapi.info unAPI] have a real need for marking up identifiers so that they can be used for retrieving identified objects.
* Efforts such as [http://unapi.info unAPI] have a real need for marking up identifiers so that they can be used for retrieving identified objects.
Line 29: Line 30:
== Thoughts ==
== Thoughts ==
-
== UID + SOURCE -> permalink? ==
+
=== UID + SOURCE -> permalink? ===
URL is used in hcalendar examples to point not to the permalink of the vevent, but to the permalink for the event home page. If the event home page contains the authorative hcalendar entry, that's fine. Alternatively the source attribute could be borrowed from vcard to mean "microformat permalink" instead of "permalink of the thing the microformat is about".
URL is used in hcalendar examples to point not to the permalink of the vevent, but to the permalink for the event home page. If the event home page contains the authorative hcalendar entry, that's fine. Alternatively the source attribute could be borrowed from vcard to mean "microformat permalink" instead of "permalink of the thing the microformat is about".
Line 61: Line 62:
How does/doesn't the ID attribute from HTML fit into all this? Can it be repurposed to help here?
How does/doesn't the ID attribute from HTML fit into all this? Can it be repurposed to help here?
 +
 +
* Yes. Here's what I ([[User:TobyInk|TobyInk]]) use for hCard and hCalendar:
 +
*# If the object has an element with class="uid" and that element links somewhere (e.g. <a href>, <img src>) then the linked URL is the UID;
 +
*# Otherwise, if the element with class="uid" has an ID attribute set, then the page's URL followed by "#", followed by the ID attribute is the UID;
 +
*# Otherwise, use the content of the element with class="uid", respecting the ABBR pattern.
 +
*# If there is no element with class="uid", then if the root element of the microformatted object (e.g. <div class="vcard">) has an ID attribute set, then the page's URL followed by "#", followed by the ID attribute is the UID;
 +
*# Otherwise, there is no UID for this object. The processor {{may}} generate its own UID if the presence of a UID is necessary for further processing.
== Proposals ==
== Proposals ==
Line 90: Line 98:
== See Also ==
== See Also ==
 +
* [[isbn]] (and [[issn]])
* [http://www.iana.org/assignments/urn-namespaces IANA URN Namespaces - RFC2141, RFC3406]
* [http://www.iana.org/assignments/urn-namespaces IANA URN Namespaces - RFC2141, RFC3406]
* [http://www.iana.org/assignments/uri-schemes.html IANA Uniform Resource Identifer (URI) Schemes]
* [http://www.iana.org/assignments/uri-schemes.html IANA Uniform Resource Identifer (URI) Schemes]

Current revision

Contents

UID Brainstorming

This page is for brainstorming about ideas, proposals, constraints, requirements for a UID microformat.

Authors

Experience

Goals Requirements

Thoughts

UID + SOURCE -> permalink?

URL is used in hcalendar examples to point not to the permalink of the vevent, but to the permalink for the event home page. If the event home page contains the authorative hcalendar entry, that's fine. Alternatively the source attribute could be borrowed from vcard to mean "microformat permalink" instead of "permalink of the thing the microformat is about".

There seems to be a conflict between iCalendar and vCard rfcs as to what a url is. iCalendar says permalink of iCalendar object. vCard says identifying url (eg home page) of the person or object the vCard is about. vCard uses "source" for iCalendar's "url".

UIDs that are URLs

It seems like in the 80% case (perhaps 99.99% case on the Web), a UID is going to be a URL, thus a common pattern will likely be things like:

<a class="url uid" href="http://example.com/contentspace/somenumber">the item</a>


SHOULD rather than MUST

A UID SHOULD be a URL rather than MUST. The UID microformat will ordinarily be a URL, but it should be flexible enough to allow it to contain non-network resolvable URIs.

UID + URL -> permalink?

Can you infer that if something is a URL and a UID that it is also a permalink? It seems so. I can't think of any semantic of "permalink" that isn't covered by the union of the semantics of URL and UID.

abbr pattern

Use the abbr-design-pattern to allow identifiers to be more fully described.

<abbr class="uid" title="urn:isbn:0950788120">0 9507881-2-0</abbr>

HTML ID attribute

How does/doesn't the ID attribute from HTML fit into all this? Can it be repurposed to help here?

Proposals

Just use UID from hCard

Use rel-bookmark from hAtom

hAtom currently uses the HTML standard rel-bookmark to identify its bookmark. This appears to be precisely eqivalent to the class combination "uid url". This does not appear to permit non-url uids, but if we are identifying the authorative id of a piece of microformatted data that we already have in-hand a non-url uid may never be required. Non-url uids (eg isbn) can still appear in citation formats without affecting the development of this "identify myself" microformat.

If rel-bookmark is not appropriate for this format, we should consider retrofiting this format back to hAtom. It may be appropriate to replace rel-bookmark with the separate url and uid classes, or to allow either form to be used.

Create a URI microformat

References

See Also

Related Discussion

uid-brainstorming was last modified: Saturday, December 20th, 2008

Views