Add ERC: NFT Alternative Text in Metadata #191
Conversation
Co-authored-by: Andrew B Coathup <[email protected]>
eip-review-bot
changed the title
|
Thanks for moving over. Don't forget to update the file path to "ERC/erc-7515.md" and then turn back to merge |
eip-review-bot
changed the title
|
There has been no activity on this pull request for 2 weeks. It will be closed after 3 months of inactivity. If you would like to move this PR forward, please respond to any outstanding feedback or add a comment indicating that you have addressed all required feedback and are ready for a review. |
|
There has been no activity on this pull request for 2 weeks. It will be closed after 3 months of inactivity. If you would like to move this PR forward, please respond to any outstanding feedback or add a comment indicating that you have addressed all required feedback and are ready for a review. |
|
|
||
| #### 2. Concise & Relevant Descriptions | ||
|
|
||
| Ideally, aim for descriptions around 150 characters, though this isn't a strict limit. |
There was a problem hiding this comment.
Length limit shall be in the specification instead of test case
|
|
||
| ### Best Practices For Alternative Text | ||
|
|
||
| The guidelines below are derived from the established Web Content Accessibility Guide (WCAG) standards. |
There was a problem hiding this comment.
Can you add the link to the specific WCAG standard here?
|
|
||
| ## Abstract | ||
|
|
||
| This ERC advocates for the consistent inclusion of alternative text in NFT metadata. Marketplaces, creators, and decentralized applications should adopt this best practice to improve accessibility. When rendering NFT images on frontend interfaces, these platforms can leverage the `alt` attribute effectively. |
There was a problem hiding this comment.
Hi @DecoratedWings thanks for the draft. can you help me see the necessity of not using description but having another alt?
There was a problem hiding this comment.
Hi @xinbenlv,
Absolutely, thank you for the question. Typically I've noticed that the description field in the metadata is used more to describe aspects of the collection or longer details even for that particular token. Alternative Text should be limited to a specific description of what is actually in the image.
I grabbed an example at random from opensea to help illustrate: https://opensea.io/assets/ethereum/0x5463612c30cd4deac35af4a930c6f997dba24ad1/287
In this case, the description field was used to explain the collection. Token 287 has the following metadata: https://app.bueno.art/api/contract/24vXZhPEzz593uVhdyoCE/chain/1/metadata/287
If it were to have the alt field it would actually described the image of token 287, stating something like: "An abstract portayal of a woman with brown hair and white shirt playing a game of chess. There is a black and white patterned background with pink flowers along the left frame."
|
There has been no activity on this pull request for 2 weeks. It will be closed after 3 months of inactivity. If you would like to move this PR forward, please respond to any outstanding feedback or add a comment indicating that you have addressed all required feedback and are ready for a review. |
|
|
||
| ## Test Cases | ||
|
|
||
| ### Best Practices For Alternative Text |
There was a problem hiding this comment.
These all should be in the Specification section, since they are giving requirements on the content of the field.
| The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 and RFC 8174. | ||
|
|
||
| The `alt` attribute should be positioned at the root level within the metadata structure. It MUST provide a concise and accurate description of the image. | ||
|
|
|
There has been no activity on this pull request for 2 weeks. It will be closed after 3 months of inactivity. If you would like to move this PR forward, please respond to any outstanding feedback or add a comment indicating that you have addressed all required feedback and are ready for a review. |
|
This pull request was closed due to inactivity. If you are still pursuing it, feel free to reopen it and respond to any feedback or request a review in a comment. |
Overdue update from migration to ERC repo: #8
Initial post: https://ethereum-magicians.org/t/erc-7515-nft-alternative-text-in-metadata/14639