Skip to content

Adds HowTo schema and example.#1616

Merged
danbri merged 3 commits intoschemaorg:masterfrom
earljwagner:add-howto
May 22, 2017
Merged

Adds HowTo schema and example.#1616
danbri merged 3 commits intoschemaorg:masterfrom
earljwagner:add-howto

Conversation

@earljwagner
Copy link
Contributor

This is a continuation of the work started in #1087 and continued in #1517.

  • Renames the new instructions schema to HowTo
  • Distinguishes between tools and resources, the latter of which are consumed and count toward the cost
  • Distinguishes between action and tips within steps
  • Adds before/during/after media for illustrating actions
  • Supports grouping steps in "sections"

@danbri, @vholland, @robdodson, @dbiollo PTAL

@danbri
Copy link
Contributor

danbri commented May 9, 2017

Thanks, great to see this moving again. Since it is intimately tied to the Recipe structures this makes sense going direct into core schema.org (rather than a pending.schema.org proposal). I'm not 100% for the ("HowTo") type name but can't think of a better one. Why don't I go ahead and merge it into the work-in-progress editor's draft webschemas.org site for review, so we can see how it looks? It'll need some careful review as there's a lot of Recipe markup out there...

@danbri
Copy link
Contributor

danbri commented May 9, 2017

I'll aim to merge it within a day or so, but want to summarize the changes first (for docs/releases.html and review). There may be some naming changes e.g. could 'tool' be handled by our existing http://schema.org/instrument from the /Action vocabulary?

@earljwagner
Copy link
Contributor Author

OK, sounds good. Yes, "instrument" for "tool" also makes sense.

@danbri
Copy link
Contributor

danbri commented May 10, 2017

Looking through this, a bit more caution.

HowToAction is a subtype of ListItem. However in schema.org we have an extensive hierarchy of Action subtypes - I fear this could confuse. Would "HowToTask" work, perhaps?

Similarly, both 'resource' and 'element' are words over-used in the underlying standards around schema.org (HTML, Microdata/json-ld/rdfa). I wonder if we can come up with alternate words here.

@chaals any view?

@earljwagner
Copy link
Contributor Author

Dan, all, please take a look at the update.

This introduces HowToDirection, removing any reference to Action. It removes "element" from HowToStep since it's already an ItemList and doesn't need another property for children.

It also renames HowToResource to HowToSupply, replacing "resource" with "supply". It sets "supply" and "tool" to inherit from "instrument" but preserving the properties to distinguish between the consumable and non-consumed items used. "estimatedCost" accounts for only the former.

Also, the first of these commits was amended and force-pushed to replace the inaccurate commit message.

</div>
<div>
<div>
Remove the hubcap and loosen the lug nuts.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lots of people would say that you should do this before raising the tire off the ground. It's much harder if the wheel is spinning…

I would have moved this step earlier.

<span property="rdfs:comment">A media object representing the circumstances before performing this direction.</span>
<span>Domain: <a property="http://schema.org/domainIncludes" href="http://schema.org/HowToDirection">HowToDirection</a></span>
<span>Range: <a property="http://schema.org/rangeIncludes" href="http://schema.org/MediaObject">MediaObject</a></span>
</div>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure that beforeMedia and afterMedia are anything except apparent specialisations of duringMedia, at the first and last step...

Do we really need them?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to clarify, they don't apply to the steps as a whole, they apply to a single direction in a single step.

Many instructions have multiple pictures for some of the steps (e.g. http://www.instructables.com/id/How-to-Make-a-Modern-Wooden-Clock/). However, the temporal connections between the pictures and the action are not specified (or specifiable). beforeMedia, duringMedia, and afterMedia solve this by enabling the author to annotate how things should look "before", "during" and "after" an action, respectively.

@danbri
Copy link
Contributor

danbri commented May 22, 2017

Noting @chaals comments, I am going to merge this into our release candidate. During the ~2 week release candidate review we can consider putting beforeMedia / afterMedia into the Pending area of schema.org. In general because this is so closely tied to the existing Recipe design it makes sense not to use Pending. Let's see how it is is received.

@danbri danbri merged commit 9070b90 into schemaorg:master May 22, 2017
danbri added a commit that referenced this pull request May 22, 2017
@danbri danbri mentioned this pull request Sep 27, 2017
@danbri
Copy link
Contributor

danbri commented Mar 2, 2018

@earljwagner et al., just wanted to follow up on beforeMedia / afterMedia, ... do you/we/anyone think these would still be useful? Can the same thing be expressed with existing vocabulary somehow? Any more tweaks or feedback on what we have so far?

@earljwagner
Copy link
Contributor Author

earljwagner commented Mar 20, 2018 via email

@tisdall
Copy link

tisdall commented Apr 2, 2019

image

Shouldn't the "Expected Type" column contain HowToStep and HowToSection?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants