Skip to content
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

Support for @Id #29

Open
KajKandler opened this issue Nov 14, 2023 · 3 comments
Open

Support for @Id #29

KajKandler opened this issue Nov 14, 2023 · 3 comments
Labels
enhancement New feature or request
Milestone

Comments

@KajKandler
Copy link
Contributor

In Schema markup, there is an important attribute (if not the most important one), to support @id for entities.

In webpages, mostly the @id attribute is set to the URL (i.e. "https://example.com/about-us/") or URL derived from the web page's URL, such as "https://example.com/#organization"

I tried to set value in the front matter to {url}, which did not work. Is there a way that is not obvious? If so it would be great to document it.

@KajKandler
Copy link
Contributor Author

P.S.: @id is a very important attribute, so one can assemble schema from different pieces and amend schema defined in the header also in the body (affording the power of templating)

@johnfraney
Copy link
Contributor

Interesting! I didn't know about that feature, so I've been reading more here: https://schema.org/docs/datamodel.html#identifierBg

I'll add this to the next release

@johnfraney johnfraney added the enhancement New feature or request label Nov 15, 2023
@KajKandler
Copy link
Contributor Author

An implementation note:

  • the URIs used as IDs are supposed to be http:// not https://
  • technically it is possible to use https, but the norm is http
  • that implies if one can utilize the url or base url as part of the value it should allow exchange of the scheme

See url_for in Flask framework for how this is supported there.

@johnfraney johnfraney added this to the v0.5.0 milestone Nov 22, 2023
@johnfraney johnfraney modified the milestones: v0.5.0, v1.0.0 Mar 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants