Issue #647: Add new classes for how-to/diy/instructionSet schema#1087
Issue #647: Add new classes for how-to/diy/instructionSet schema#1087dragonghy wants to merge 1 commit intoschemaorg:sdo-deimosfrom
Conversation
|
Comments:
|
|
@Dataliberate thanks for the comments! 3 things to clarify:
Where the "expected types" should be added? In the
Is it possible to make it a subclass of both
Instead of |
|
Updated code and http://schemaorg-127321.appspot.com/ per @Dataliberate's comment except the bullets mentioned above. |
|
Sorry for my lack of clarity. This 2nd look has made me think you are missing something from this proposal that possibly could work better as: Taking this approach would make it simple to order individual instructions and if needed the supply items the instructions. Also as well as listing all supplies relevant to the instruction step you would have the option to link a subset to individual steps in the process. Some examples would be good to clarify things. |
|
Let us find some name other than InstructionSet. Will be confusing for |
|
estimatedCost should use PriceSpecification instead of Number,Text so we can encourage correctly specifying currency and can support ranges. |
|
+1 for @rvguha 's point regarding naming: InstructionSet sounds like computing jargon |
|
how about things like (I am really bad at naming)
|
92c92d4 to
0713ba0
Compare
|
Updated code and http://schemaorg-127321.appspot.com/ per @Dataliberate and @vholland's comment. @Dataliberate I think having an |
|
I understand your desire to have separate descriptions for a property dependant on which type (class) it is being used. Unfortunately a property only has one definition which is reused wherever it is displayed on the Schema.org site. There have been, yet to be acted upon, thoughts on how Type specific notes could be added to descriptions but there is nothing there yet. From your words I believe you agree that the property named I believe that such a generic description, coupled with the description of the Type it is being used with and associated examples, will give sufficient guidance to a user. Also I would see potential wider reuse of such a property, in which case a generic description is helpful. I recommend that As to naming, taking in to account that once established these Types could be used not only for DIY projects but also potentially for industrial processes, or scientific projects, recipes, etc., I think the most appropriate name root suggested so far is ~Richard |
|
Agreed that a simple description is a best fit for a generic field name. Though a more class-specific description usually helps, it's fine to me having a generic class field for @danbri @rvguha @vholland would love to have you thoughts on the naming. Does |
|
I quite liked idea of something based on "HowTo", ... it keeps things informal and hints at the parallel with Recipe. "Method" can mean many things in many settings (e.g. methods in OO programming) |
|
Looking at the example here, it is basically a Recipe ("How to Make Healthy and Crunchy Granola"), for which we have already got extensive and widely used vocabulary. In fact one of the problems with Recipe is that people have been using it for non-edible tasks because we had nothing else. I suggest we move to a less foodie example and double-check that vocabulary is aligned as much as possible with Recipe (as well as with whatever we're doing around Courses...). |
|
Added two new examples into http://schemaorg-127321.appspot.com/InstructionSet One is for how to replace iPhone screen (skill). The only thing I found missing was a difficulty level, which seems to be a common flag for a lot of diy websites. |
|
@dragonghy thanks. How does this design relate to @chaals point in #617 that it ought to aim at being a superset of the current Recipe design. Are we close to that? |
|
Indeed, sorry! #647 (I scrolled to the top of the page to find the number, scrolled back down, and ... well, my short term memory isn't what I remember it being...) |
|
@danbri It does look like a good idea to me. The only issue is that some recipe fields may need to be renamed (to use the parent's field) or be kept in parallel with a similar field in parent class, including
Please let me know your take on this. I'm more than happy to update the |
|
A decent amount of Recipe markup exists already. Can we make the recipe-specific properties subproperties of the new ones rather than renaming? |
|
Yes, subproperty is the right mechanism here |
|
It's the first time that I heard about subproperty. Is it something like the |
|
I mean, it works for me. Just not sure if this is a concept that's widely adopted. |
|
Yes, it's a piece of schema.org's infrastructure. Sometimes we have pairs of properties where one of them is more specific, and says the same thing as the general one plus some other stuff. By declaring a subproperty relationship it gives a bit more built-in navigation within the site, as well as helps consumers understand how different structures relate. For example, if we said that 'recipeYield' was a subproperty of the more general 'yield' property, we should make sure that 'yield' expects the same kinds of values, so that "X recipeYield Y" could be turned into "X yield Y" automatically. |
|
Gonna drop this since I am not working on this anymore. |
|
Thanks for your efforts, @dragonghy I will reopen this as there seems to be broader (if slow moving) interest... |
|
Creating a new InstructionSet class would make TechArticle almost redundant, according to the description this is what its for.
You could simply add an
and this means the APIReferance class can be used for platform specific tutorial by populating the |
|
@danbri I would like to continue pushing this forward. Looking over the threads I agree with @tarranjones that the ability to write how to's, step by step, etc pretty much exists in Tech Article. My addition to the thread is add Product to dependencies. |
|
@my-def-diesel As the "dependencies" Property is plural I would expect the itemProp attribute to only be declared once, meaning an Expected Type of "Product" would only allow for a single dependancy while "Text" would allow for multiple but less informative dependencies". For the "dependancies" value to contain multiple dependancies then the Expected Types are limited "Text", "URL", "ItemList" etc. If the "dependencies" Property were to become singular and be renamed "dependancy" or "dependsOn" then the itemProp attribute could be declared multiple times which would increase the benefit of having "Product" as an Expected Type.
@my-def-diesel I think giving "dependency" an Expected Type of "Product" would be too specific, "Thing" would be more flexible and beneficial.
|
|
I have to say I like @tarranjones's suggestion:
1+1=2 yes, no? |
|
http://webschemas.org/recipeInstructions also has ItemList of Text, and could be a subproperty of a more generic 'instructions'. |
|
Nice @danbri, I guess that 1+1=3 then. |
|
closing as I am not working on this. |
Following the discussion in #647 (comment), this is a demonstration of the schema type that needed by diy/how-to type of contents.
I only added one example because a discussion is on-going on naming. Glad to add more examples after the discussion is settle down. (The commit message will be updated accordingly as well)
Live prototype:
@danbri @ajax-als @chaals @mfhepp @pmika @scor @shankarnat @tmarshbing @vholland @rvguha @philbarker
cc my coworker @j-squared