Difference between revisions of "value-excerption-value-title-test"

From Microformats Wiki
value-excerption-value-title-test
Jump to navigation Jump to search
m (→‎Response: Update link to brainstorm page, rather than issues page)
m (→‎The proposed parsing rules: Fixed typo and grammar error)
Line 28: Line 28:
 
* Only one value-title-element may be included as a child of a property. No splitting or concatenation, no combining with other value-excerption elements.
 
* Only one value-title-element may be included as a child of a property. No splitting or concatenation, no combining with other value-excerption elements.
 
* An empty value-title-element '''must''' be the ''first''-child of the property (not including any preceding whitespace)
 
* An empty value-title-element '''must''' be the ''first''-child of the property (not including any preceding whitespace)
* The machine-data value ''must'' represent the same data as the visible inner text; nor should the parent property should contain arbitrary data. Parsers and validator tools will be encouraged to test this where appropriate (for example, some languages have access to powerful date parsing algorithms).
+
* The machine-data value ''must'' represent the same data as the visible inner text; nor should the parent property contain arbitrary data. Parsers and validator tools will be encouraged to test this where appropriate (for example, some languages have access to powerful date parsing algorithms).
* The empty element can be ''any element'', but a generic, <code>span</code> is most appropriate. You could use <code>b</code> if you wanted to save bytes, or an <code>input type=hidden</code> if it makes sense to you. That choice will not matter to parsers. You are in control of that publishing decision. As per usual µf documentation, <code>span</code> will be used for generic examples.
+
* The empty element can be ''any element'', but a generic <code>span</code> is most appropriate. You could use <code>b</code> if you wanted to save bytes, or an <code>input type=hidden</code> if it makes sense to you. That choice will not matter to parsers. You are in control of that publishing decision. As per usual µf documentation, <code>span</code> will be used for generic examples.
  
 
==Example Tests==
 
==Example Tests==

Revision as of 10:42, 14 January 2009

<entry-title>Value Excerption Pattern: Parsing from empty elements test</entry-title> Please carefully note, this page is about a pre-draft, experimental and unfinished microformats proposal. You cannot use this pattern on your live pages, it is not supported by any stable parser and you should not assume that this pattern will be finalized as-is! We're just asking for help in testing this important experiment thoroughly. Thank you.

This is a special page to introduce and gather results to widespread testing of a proposed extension to the value-excerption pattern. It looks like this:

<p class='dtstart'>
    <span class='value-title' title='2009-01-06T22:54:00-0800'></span>
    January 6th, in the evening
</p>

It allows you to include machine-form data alongside the human form, without polluting visible formatted content with undesired machine form data.

This pattern is based on rendering behavior in browsers whereby an empty element, that is one containing no children (neither text-nodes or other elements), remains in the DOM tree (for parsing) but is not rendered visibly to a page. This allows an element to be included in the document with title content (as in the example), but without a tooltip being exposed to users, or data read out by screen readers.

Since this pattern attempts to resolve some long standing issues with including machine-data in microformats, it's imperative this is tested completely before adding it to a spec. Following are a number of examples. Please try them out. Push them into publishing systems, editor apps and tools, and check that it comes out the way you expect on the other side; render it in desktop browsers, mobile browers, screen readers, in braille… anything you can test, we want to know about it. We need to see any quirks, oddities and so on.

Also, by all means provide thoughts on the publishing flow for this. An empty element is an uncommon structure outside of forms and scripts, but the reasoning is as follows: ‘machine data’ is not metadata, it is still content. It's structurally appropriate to have it as a sibling to the human-formatted text.

Note that valid HTML is a cornerstone of microformats. Inventing new attributes, using non-standard DOCTYPEs or XML extensions is not an applicable option. We're trying to achieve something as gracefully as we can within the limits of HTML4, without harming user experience.

The proposed parsing rules

The current, likely incomplete, proposed parsing rules and restrictions for this pattern are as follows:

  • Only one value-title-element may be included as a child of a property. No splitting or concatenation, no combining with other value-excerption elements.
  • An empty value-title-element must be the first-child of the property (not including any preceding whitespace)
  • The machine-data value must represent the same data as the visible inner text; nor should the parent property contain arbitrary data. Parsers and validator tools will be encouraged to test this where appropriate (for example, some languages have access to powerful date parsing algorithms).
  • The empty element can be any element, but a generic span is most appropriate. You could use b if you wanted to save bytes, or an input type=hidden if it makes sense to you. That choice will not matter to parsers. You are in control of that publishing decision. As per usual µf documentation, span will be used for generic examples.

Example Tests

The following snippets are example tests for the new pattern. You can use them as is, if you like, or use them as a base for your own tests with your own content. If you write your own tests, please document them under ‘additional test cases’ so that any failing tests can be checked for validity.

hAtom#1: An hAtom published/updated Field

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
    "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
    <head>
        <title>Value Excerption Pattern Test hAtom#1</title>
    </head>
    <body>
        <div class="hentry">
            <h1 class="entry-title">An introduction to Microformats</h1>
            <p>
                Published on <span class="published updated">
                <span class="value-title" title="2009-01-09T11:33:00-0800"></span>
                January 9th, around lunchtime</span>
                by <span class="author vcard">
                  <a class="url fn" href="http://ben-ward.co.uk">
                      Microformats.org</a></span>.
            </p>
            <p class="entry-content">Wow, microformats are really useful! You can
                learn loads about them on the 
                <a href="http://microformats.org/wiki">microformats wiki</a>.
            </p>
        </div>
    </body>
</html>

hCal#1: An hCalendar dtstart

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
    "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
    <head>
        <title>Value Excerption Pattern Test hCal#1</title>
    </head>
    <body>
        <div class="vevent">
            <h1 class="summary">Value Exception Test Day!</h1>
            <p class="description">Come help <span class="organizer vcard">
                <a class="fn url org" href="http://microformats.org">microformats.org</a>
                </span> test a new value-excerption pattern for sanity and 
                robustness!
            </p>
            <p>Help out by running some tests at 
              <span class="dtstart">
                <span class="value-title" title="2009-01-12T12:00:00-0800"></span>
                midday on Monday January 12th</span>.
            </p>
            <p>See <a href="url" href="http://microformats.org/wiki/value-excerption-pattern-issues/empty-value-element-test">the
                wiki</a> for more details!
            </p>
        </div>
    </body>
</html>

hCard#1: An hCard bday

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
    "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
    <head>
        <title>Value Excerption Pattern Test hCard#1</title>
    </head>
    <body>
        <!-- Behind Test -->
        <div class="vcard">
            <h1 class="fn">Ben Ward</h1>
            <p>Ben Ward's birthday is 
                <span class="bday">
                    <span class="value-title" title="1984-02-09"></span>
                    February 9th
                </span>.
                You should throw him a party! Or call his <span class="tel">
                <span class="type"><span class="value-title" title="cell"></span>mobile</span>
                on <span class="value">415.123.123</span></span> to wish him well!
            </p>
        </div>
        <!-- End Test -->
    </body>
</html>

hAudio#1: An hAudio duration

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
    "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
    <head>
        <title>Value Excerption Pattern Test hAudio#1</title>
    </head>
    <body>
        <h1>Song of the year?</h1>
        <!-- Behind Test -->
        <p class="haudio">Did you hear ‘<span class="fn">Heavy Water</span>’ on
            <span class="contributor">Foals</span><span class="album">Antidodes</span>’ record 
            <span class="published">
                <span class="value-title" title="2008">
                last year
            </span>? It's
            <span class="duration">
                <span class="value-title" title="PT04M32S"></span>
                4 and a half minutes long
            </span>, you should make time to hear it!</p>
        </div>
        <!-- End Test -->
    </body>
</html>

If you believe there is an error in any of these tests, or in any others that people contribute, please post on the mailing list.

Evil Tests

If you want to give microformat parsers a good run for their money, construct ‘evil’ tests using nesting, combination and interpolation of different microformats.

hAtom + hCalendar

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
    "http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
    <head>
        <title>Value Excerption Pattern Test hAtomhCalEvil#1</title>
    </head>
    <body>
        <div class="hentry vevent">
            <h1 class="entry-title summary">An introduction to Microformats</h1>
            <p>
                Published on <span class="published updated">
                <span class="value-title" title="2009-01-09T11:33:00-0800"></span>
                January 11th, late afternoon</span>
                by <span class="author organizer vcard">
                  <a class="url fn" href="http://ben-ward.co.uk">
                      Ben Ward</a></span>.
            </p>
            <p class="entry-content description">
                <span class="dtstart">
                    <span class="value-title" title="2009-01-14T19:00:00"></span>
                    this coming Wednesday at 7
                </span> is not the date of a completely fictional microformats
                event. If it existed, it would promise to be informative and get
                you up to speed on microformats.org for 2009! Now you've 
                learned to work with microformats a little, why not attend and
                get involved! Why not? Because this event is a test case, not 
                for real.
            </p>
        </div>
    </body>
</html>

hAudio + hCard

Response

  • Don't like the empty element? Don't like the use of the title attribute? Please file general issues concerning the proposed pattern on the main [excerption brainstorming page], or discuss them on the mailing list.
  • Add the results of and responses to these tests themselves on this page.

Misplaced responses will be moved, and having to do so will make Ben growly, so, y'know, please be helpful.

Successful Tests

List successfully tested environments here. Add new environments as new list items, and expand existing list items with your name and platform variants to indicate verified successes.

Results of tests across various publishing/rendering environments
Test Environment Type Platforms Verified By
hAtom#1 Safari 3.1 Rendering Mac OSX 10.5 User:BenWard
hCal#1 Safari 3.0 Rendering Mac OSX 10.5 User:BenWard
hCard#1 Safari 3.0 Rendering Mac OSX 10.5 User:BenWard

Failed Tests

For failures, please provide as much information as you can. The precise impact of the error, whether the behavior could be regarded as a bug in the software you're testing, whether it works in future versions, whether you changed any settings in the software to produce the result, and if so, whether enabling/disabling that setting would be regarded a showstopper if this pattern were certified.

Since we want more detail, please expand failures into headed sections rather than cramming into a table.

For example, take this entirely plausible scenario as a template:

Example: Fake Publisher 3.1ß

Platform
Windows Vista
Verified By
User:BenWard
Description
When trying to enter an empty span in my editor, which I wrote myself whilst I was high, the application immediately crashes, performs rm -rf / on all UNIX boxes connected to my local network (which appears to cause Android phones within Bluetooth range to do the same…), and then causes all attached peripherals to combust. I was not able to reproduce, as my house was now on fire. I think using a self closing XHTML tag instead might work-around the problem because as we know, it's been proved by Real Scienticians that XML is always better than HTML. Alternatively, it may be a bug in the beta software.
Notes
This is a beta release, and a bug has been filed.
This product has a known history of flammability bugs.
The user must explicitly enable the ‘Endanger My Life’ checkbox under the ‘Advanced Mislabelled Checkboxes’ tab of the ‘Complicated Preferences’ preferences pane.
You get the idea.

General Test Feedback

  • Any general feedback you have on this test is most welcome. However, if you have issues with the pattern or alternate suggestions, please file them on the main Value Class Pattern Issues page. Also, please remember to sign your comments with —~~~~ —BenWard 00:12, 9 January 2009 (UTC)

Related Pages