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

Add errata #575

Merged
merged 7 commits into from
Feb 22, 2025
Merged

Add errata #575

merged 7 commits into from
Feb 22, 2025

Conversation

mmougy
Copy link
Contributor

@mmougy mmougy commented Jan 6, 2025

This dev adds errata from the RRG (up to 1.6) and closes zzorba/marvelsdb#256

errata in "text" will be displayed as deleted and inserted words (with tags <del> and <ins>)
errata in "traits" and "name" are directly applied (marvelsdb does not support html tags for those fields)

The property "erratum" has been added for a future possible improvment

The css style used comes from another PR, the link will follow

--

Here are some snapshots from local devenv

image

image

image

the name has been changed
image

trait removed
image

@jordanweiler
Copy link
Contributor

I'm not a fan of this approach. I think this PR will make reading cards that have entire phrases replaced really difficult (for example the Logan card is very hard to read and not user friendly). This makes the cards look like a diff but that's not useful for users trying to use this tool.

ArkhamDB versions cards so that you can choose what version to use. Each version of the card includes that text and doesn't include prior text that might be different. If we did that type of solution here, it would be pretty robust and probably mean significant database and backend changes as well as JSON changes. That would need to be designed before we are ready for a PR. I'm not necessarily advocating for that here, just mentioning how a similar website has solved a similar issue.

A simpler approach here could be to just update the text on cards to the new version and not keep any outdated text around. This would make the cards more readable than this approach and I think it would likely solve the issue you are trying to fix, which is making sure cards have the most up-to-date text on them.

If there is any confusion on why the card text doesn't match the image, we might need to consider tagging cards that have been updated with some sort of rules/errata version (for example, "Rules Update: 1.6" or "Errata: 1.6") and display it near the bottom of the card. I think that would need to be separate from the card text area because sometimes a card's title changes but no other text changes (https://marvelcdb.com/card/01184).

Curious what @Kamalisk thinks about how to solve this issue.

@Kamalisk
Copy link
Collaborator

taboo is very different from actual errata. ArkhamDB just updates the card text to the latest official text. I actually like how you made it look, but I think it better if we do a mix, and update the text to the latest errata, then have an errata field to display the difference (or describe what was changed, such as if the name was changed)

@mmougy mmougy marked this pull request as draft January 14, 2025 19:39
@mmougy
Copy link
Contributor Author

mmougy commented Jan 24, 2025

What about this design:
image

@mmougy
Copy link
Contributor Author

mmougy commented Jan 27, 2025

Here is some capture from the new design, errata replace official text, an erratum description is displayed at the bottom:

The result below is obtained with zzorba/marvelsdb#286

image

image

@mmougy mmougy marked this pull request as ready for review January 27, 2025 23:44
Copy link
Contributor

@jordanweiler jordanweiler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this new design 👍 I think it makes a lot more sense and is cleaner

@@ -130,6 +130,7 @@
{
"attack": 1,
"code": "37034",
"erratum": "Removed “and put it back into play”. (RRG 1.6)",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if we need smart quotes in all of these or if normal quotes will suffice. With the flavor text, we usually use normal quotes. If I put this line into a file and run the add_octgnid.py script to format it, it'll replace all these smart quotes with \u201c and \u201d.

@mmougy
Copy link
Contributor Author

mmougy commented Jan 28, 2025

@jordanweiler Thanks for the review, I fixed typo I made.

@Kamalisk
Copy link
Collaborator

Nice. I definitely prefer this, and thanks for taking the time to do it. Will try to get it merged this weekend.

@Kamalisk Kamalisk merged commit 2aac8ed into zzorba:master Feb 22, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add errata on card description
3 participants