include-pattern-brainstorming

include pattern brainstorming

brainstorming to improve or extend the include-pattern.

alternatives to using a or object

Here are possible variations on the include pattern, attempting to resolve issues of accessibility (with empty anchors) and server load (with object).

Non-Verbose Class-Based Solution

(Originally suggested by Toby Inkster, based on an earlier proposal by Andy Mabbett)

An alternative way of implementing the include pattern in a less verbose, and hopefully more accessible manner.

 <p>We have three branches in <span class="locality" id="ldn">London</span>,
 including our head office in <span class="locality" id="ken">Kensington</span>:</p>
 <ul>
   <li class="adr #ldn">
     <span class="street-address">123 Oxford Street</span>
   </li>
   <li class="adr #ken #ldn">
     <span class="street-address">5 Kensington High Street</span>
   </li>
   <li class="adr #ldn">
     <span class="street-address">1 Pall Mall</span>
   </li>
 </ul>

The order of the space-delimited class attributes should be considered significant -- that is, in <foo class="bar #baz"> the content referred to by #baz is logically included as the last child of the <foo> element, but in <foo class="#baz bar">, it is logically included as the first child. (See below for an example where the included element should occur in the middle of the element content.)

Yes, the hash mark is valid in the class attribute, though rarely used because it won't work with CSS 1 selectors.

If people can find real-life uses of the hash character in existing sites that would conflict with this proposed usage pattern, then perhaps another character could be used. I rather like '@foo', or maybe even a combination such as '@#foo'.

Including data in the middle of an element

Above, the examples show how an element can be logically included as the first or last child of another element. For including data into the middle of an element, we need to be a tiny bit more verbose and insert a dummy element (in this case a <span> element) where the included content should go:

 <p>Our head office is in <span id="ldn" class="locality">London</span> at:
 <p class="adr">
   <span class="street-address">5 Kensington High Street</span><br>
   <span class="#ldn"></span>
   <span class="postal-code">SW7 1AA</span>
 </p>

problems with ordered ids in class

Two problems:

1. class is an unordered set of values per HTML4. introducing ordering is a non-starter both from a violation of HTML4 spec perspective and likely requiring of rewriting HTML4 parsers to maintain an ordering where they currently don't.

A reading of HTML 4.01, section 7.5.2 doesn't seem to claim that the class list is unordered.

It does claim that it's a "set" of class names, and in mathematical parlance sets are unordered by definition, and must not contain duplicates, but it's unlikely that the framers of the HTML 4.01 spec intended the world "set" to be interpreted in that way -- far more likely they were referring to the layman's definition of the word.

As far as parsers are concerned, DOM Level 2 HTML provides as "className" property as part of the HTMLElement interface, which is either directly used or is inherited by all DOM element nodes. The className is a string exactly reflecting the contents of the HTML class attribute, so should reflect their original order.

And any non-DOM, naive SGML or XML parser that encounters a class attribute will just parse it as a plain old string anyway, so the order should be retained. TobyInk 08:34, 5 Feb 2008 (PST)

2. inclusion of arbitrary data (#baz) in the class attribute is a documented anti-pattern.

Tantek

Simple class name

<foo id="birmingham" class="locality">Birmingham</foo>

then:

<foo class="adr includes-birmingham">[...]</foo>

Some other possible variants are:

<foo class="adr birmingham">[...]</foo>

or

<foo class="adr part-microformat birmingham">[...]</foo>

or

<foo class="adr use-birmingham">[...]</foo>

or

<foo class="adr uses-birmingham">[...]</foo>

or

<foo class="adr include-birmingham">[...]</foo>

or

<foo class="adr locality-birmingham">[...]</foo>

or

<foo id="birmingham">Birmingham</foo>

[...]

<foo class="adr locality-birmingham">[...]</foo>

(originally suggested in <http://microformats.org/discuss/mail/microformats-discuss/2008-January/011422.html et seq.)

problems with arbitrary id values in class attributes

In short: similar to problems with ordered ids in class, inclusion of arbitrary data (birmingham) in the class attribute is a documented anti-pattern.

Longer: The value of an id attribute on an element is essentially an arbitrary string used to uniquely identify that element in the context of the document. Thus the re-use of such an arbitrary string (e.g. "birmingham") in a class attribute is an instance of including arbitrary data in the class attribute, which is a documented anti-pattern.

Tantek

• In this proposal, the class name is not "arbitrary data", since it uses a semantically valid IDs; and is semantically logical. In the cited page the use of data in class names is deprecated as "another form of invisible metadata". This proposal involves no more "invisible metadata" than do the existing include patterns. Andy Mabbett 00:52, 4 Feb 2008 (PST)
  • existing include patterns use href and data (not class) attributes which are both of type URI to point to a fragment identifier. arbitrary links are proper semantic use of URI attributes per HTML4. however in a class attribute, arbitrary links are no more than arbitrary data, and are thus an example of the documented anti-pattern. (Unsigned comment by Tantek)

Martin McEvoy

Please name proposals by some technical aspect of the proposal rather than the author(s) in order to avoid overly "personalizing" an idea and having the idea be judged (positively or negatively) by the author associated with it rather than the merits of the idea, and to avoid having a specific person feel like they must defend attacks on the idea as if they were attacks on their person.

Don't "include" your data, you could perhaps just reference them.

<foo id="me" class="fn">Martin McEvoy</foo>

<bar class="me@url">http://wherever.com/</bar>

parsers instead of replacing data can then just append their data?

Suggested on Microformats Discuss: http://microformats.org/discuss/mail/microformats-discuss/2008-February/011470.html

problems with using at ref to id

• Too verbose http://microformats.org/discuss/mail/microformats-discuss/2008-February/011473.html
• Inclusion of arbitrary data @, "documented anti-pattern" as pointed out on microformats discuss http://microformats.org/discuss/mail/microformats-discuss/2008-February/011479.html

contributors

• Toby Inkster
• Andy Mabbett
• Martin McEvoy

Related Pages

• the include pattern
• include-pattern examples in the wild - an on-going list of websites which use the include pattern.
• include-pattern FAQ - if you have any questions about the include pattern, check here, and if you don't find answers, add your questions!
• include-pattern feedback- general feedback (as opposed to specific issues).
• include-pattern issues - specific issues with the include pattern.
• include-pattern strawman - alternative proposals