New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix to HowTo examples #1895

Merged
merged 6 commits into from Apr 26, 2018

Conversation

Projects
None yet
4 participants
@RichardWallis
Contributor

RichardWallis commented Apr 24, 2018

Implements fix for issue (#1884)

Dataliberate and others added some commits Apr 24, 2018

Issue (#1866): Added reference to cryptocurrencies in description for…
… 'paymentAccepted' & 'currenciesAccepted' properties.

For consistency, also added to description of properties: 'discountCurrency', 'price', 'priceCurrency', 'currency'.
Reversed some changes not needed
Reversed some changes not needed as already visible on webschemas.org eg. HowToSection now a subtype of ListItem, HowToDirection now a subtype of CreativeWork.
@danbri

This comment has been minimized.

Contributor

danbri commented Apr 25, 2018

Thanks, though not gonna rush this one. There are unconventional currencies other than "crypto" currencies, https://en.wikipedia.org/wiki/Local_exchange_trading_system#Examples that we maybe ought to handle in common manner.

@danbri

This comment has been minimized.

Contributor

danbri commented Apr 25, 2018

Actually my comment was meant w.r.t. #1866 "Added reference to cryptocurrencies in description" ; not sure what those edits were doing here, was that part of the bit you removed?

Dataliberate added some commits Apr 26, 2018

Revert "Fix typos"
Removing references to issue (#1866) incorrectly added to branch 1884
This reverts commit fc4ea93.
Revert "Issue (#1866): Added reference to cryptocurrencies in descrip…
…tion for 'paymentAccepted' & 'currenciesAccepted' properties."

This reverts commit 182dd79.
@RichardWallis

This comment has been minimized.

Contributor

RichardWallis commented Apr 26, 2018

Spurious commits from cryptocurrencies work reverted. This PR now only includes changes/enhancements to HowTo examples. Good to go for a merge!

@danbri

This comment has been minimized.

Contributor

danbri commented Apr 26, 2018

Looking at this with a colleague, we are concerned the steps section is broken, but will look at a followup edit after merging as the other fixes are good.

@danbri danbri merged commit b7cd388 into master Apr 26, 2018

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
</span>$20</div>
<div>About <span itemprop="totalTime" content="PT30M">30 minutes</span></div>
<div>Necessary Items:</div>
<div itemprop="tool" itemscope itemtype="http://schema.org/HowToTool">Spare tire</div>

This comment has been minimized.

@dbiollo

dbiollo Apr 26, 2018

Contributor

I believe the name of the HowToTool will not be set with this syntax. The previous way works, or if you remove the itemscope & itemtype.

@RichardWallis

This comment has been minimized.

Contributor

RichardWallis commented Apr 27, 2018

@dbiollo Good point.

There are two approaches to getting the name of the HowToTool, and HowToSuppy, to be picked out.

~~~<div itemprop="tool" itemscope itemtype="http://schema.org/HowToTool"\>Spare tire</div>~~~

<div itemprop="tool" >Spare tire</div>

or

<div itemprop="tool" itemscope itemtype="http://schema.org/HowToTool">
     <span itemprop="name">Spare tire</span>
</div>

My preference is for the second of these as it could be expanded thus:

<div itemprop="tool" itemscope itemtype="http://schema.org/HowToTool">
     <span itemprop="name">Spare tire</span>
     <img itemprop="image" src="spare-tire.jpg" />
</div>

I will raise a new issue to explore this fix and the concerns raised by @danbri

Update: New issue raised: (#1899)

</div>
<strong><span itemprop="name">Change a Flat Tire</span></strong>
<div>About <span itemprop="estimatedCost" itemscope itemtype="http://schema.org/MonetaryAmount">
<meta itemprop="currency" content="USD"></meta>

This comment has been minimized.

@dbiollo

dbiollo Apr 27, 2018

Contributor

There isn't a close tag, meta is an empty element.

<div itemprop="tool" itemscope itemtype="http://schema.org/HowToTool">Jack</div>
<div itemprop="tool" itemscope itemtype="http://schema.org/HowToTool">Wheel wedges</div>
<div itemprop="supply" itemscope itemtype="http://schema.org/HowToSupply">Flares</div>
<div itemprop="steps" itemscope itemtype="http://schema.org/ItemList">

This comment has been minimized.

@dbiollo

dbiollo Apr 27, 2018

Contributor

The field name is now called "step" - see http://webschemas.org/HowTo

This comment has been minimized.

@dbiollo

dbiollo Apr 27, 2018

Contributor

Also "step" can be CreativeWork, HowToSection, HowToStep, Text. So I don't think ItemList is valid is it?

If the ItemList wrapper is removed then the sections can be steps like so:

<div itemprop="step" itemscope itemtype="http://schema.org/HowToSection">

<meta itemprop="position" content="2"></meta>
<div itemprop="text">You're going to need space and want to be visible.</div>
</div>
<div itemprop="itemListElement" itemscope itemtype="http://schema.org/HowToDirection">

This comment has been minimized.

@dbiollo

dbiollo Apr 27, 2018

Contributor

I believe this changes the meaning of the HowTo Steps. Originally there was a HowToStep wrapping each HowToDirection. My understanding is that a HowToStep represents a (usually numbered) significant step, which can contain the HowToDirection primary text and optionally a HowToTip (a side note for more complex steps).

Was there any intent / discussion around changing the design of the HowTo for this release? If not, I'd suggest keeping the original HowToStep structure (wrapping the direction + tip) for now.

<div itemprop="itemListElement" itemscope itemtype="http://schema.org/HowToSection">
<div itemprop="name">Preparation</div>
<meta itemprop="position" content="1"></meta>
<div itemprop="steps" itemscope itemtype="http://schema.org/HowToStep">

This comment has been minimized.

@dbiollo

dbiollo Apr 27, 2018

Contributor

HowToSection does not have a "steps" property, but it is an ItemList so this itemprop should be "itemListElement".

@dbiollo

This comment has been minimized.

Contributor

dbiollo commented Apr 27, 2018

Took a closer look and left some comments on things that look problematic.

@RichardWallis

This comment has been minimized.

Contributor

RichardWallis commented Apr 27, 2018

Changes made and now in PR (#1902)

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