How should a document with multiple authors be presented?
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Quiet
- Domain
- documentation
Research direction
Start by reviewing the oEmbed specification and the existing author_name and author_url fields. Compare the proposed authors array with the backwards-compatibility requirement, then document a decided schema and fallback behavior for multiple authors.
Written by the indexing model from the issue text.
Description
Many documents on the web are a product of joint authorship. How should they be presented?
The most-backwards-compatible way is to put the author names all in the author_name field, and then pick one author's URL for display:
{
"version": "1.0",
"provider_name": "largo.test",
"provider_url": "https://largo.test",
"author_name": "Alice Example and Bob Example",
"author_url": "https://largo.test/author/alice-example/",
"title": "This is a post by two authors",
"type": "rich",
But that loses the link for Bob Example.
Could this spec be updated to support multiple authors, with a fallback for parsers that have not been updated?
{
"version": "1.0",
"provider_name": "largo.test",
"provider_url": "https://largo.test",
"authors": [
{
"author_name": "Alice Example",
"author_url": "https://largo.test/author/alice-example/",
},
{
"author_name": "Bob Example",
"author_url": "https://largo.test/author/bob-example/",
}
],
"author_name": "Alice Example and Bob Example",
"author_url": "https://largo.test/author/alice-example/",
"title": "This is a post by two authors",
"type": "rich",
- Dominant language
- PHP
- Stars
- 1.5k
- Forks
- 786
- Avg merge
- 10h 38m
- Merged PRs (30d)
- 13
Getting set up
- Ships a Dockerfile or Docker Compose file
- No pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from iamcal/oembed
-
stale
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
iamcal/oembed#843 · 2 comments ·
Maintainers usually reply within 1 day
-
stale
Difficulty 1/5 Under an hour Newbie friendliness 72/100
iamcal/oembed#801 · 1 comment ·
Maintainers usually reply within 1 day
-
stale
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
iamcal/oembed#803 · 1 comment ·
Maintainers usually reply within 1 day
-
stale
Difficulty 5/5 Over a week Newbie friendliness 25/100
iamcal/oembed#676 · 9 comments · 1 reaction ·
Maintainers usually reply within 1 day
-
stale
Difficulty 5/5 Over a week Newbie friendliness 20/100
iamcal/oembed#614 · 2 comments ·
Maintainers usually reply within 1 day
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
backdrop-contrib/print#58 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
laravel/nova-issues#7008 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
FriendsOfFlarum/badges#20 ·
-
[Dashboard Redesign] Support and Documentation links should warn they'll be opened in another tabOpenModule: dashboard type: enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 1 day