feat(deck-description): 'Format as Markdown' support & various UX improvements #18748

david-allison · 2025-07-02T17:39:36Z

Purpose / Description

I was looking into #18528. While I was making improvements to the screen, I found that the 'Anki 2.1.41+ handling' checkbox upstream enabled markdown support (but disabled <img>), so I added support for it

Improved Deck Description UI/UX
- Better unsaved changes handling
- ⚠️ I could not easily hook 'click outside', so I disabled this so changes are not lost
- Swapped 'save' text for an icon
- Disabled icon if no changes available
Deck Description screen now supports markdown if Format as Markdown is enabled
Deck Description: Added 'Format as Markdown'
- And a help page with help icon

Fixes

Approach

expose the md property of deck
use it when rendering
support modification of md via EditDeckDescriptionDialog
Standard UI/UX improvements to EditDeckDescriptionDialog

How Has This Been Tested?

new

older

Learning (optional, can help others)

ankitects/anki@ded626f

Checklist

You have a descriptive commit message with a short title (first line, max 50 chars).
You have commented your code, particularly in hard-to-understand areas
You have performed a self-review of your own code
UI changes: include screenshots of all affected screens (in particular showing any new or changed strings)
UI Changes: You have tested your change using the Google Accessibility Scanner
- ✅ Zero issues

github-actions · 2025-07-02T17:39:45Z

Important

Maintainers: This PR contains Strings changes

Sync Translations before merging this PR and wait for the action to complete
Review and merge the auto-generated PR in order to sync all user-submitted translations
Sync Translations again and merge the PR so the huge automated string changes caused by merging this PR are by themselves and easy to review

resolved

david-allison · 2025-07-03T20:33:26Z

Updated screenshots, added corners via MaterialAlertDialogBuilder.

Long string to prove that the checkbox remains on screen

lukstbit

The dialog expands to occupy full width of the screen(most obvious in tablets).
The user input is not saved if the app goes in the background and then comes back.

I know that I'm one of the people that approved the initial code but after looking at this the last couple of days I would recommend that we use a standard dialog with Cancel/Save buttons at the bottom instead of the current toolbar actions approach(used probably because the dialog doesn't play too well with very big content but I think we could get round this somehow).

Also, I'm surprised that you didn't use a ViewModel.

lukstbit · 2025-07-12T08:52:49Z

AnkiDroid/src/main/java/com/ichi2/anki/dialogs/EditDeckDescriptionDialog.kt

-                currentDescription = getDescription()
+    override fun onCreateDialog(savedInstanceState: Bundle?): Dialog {
+        this.dialogView = layoutInflater.inflate(R.layout.dialog_deck_description, null)
+        return MaterialAlertDialogBuilder(requireContext())


Seeing that MaterialAlertDialogBuilder doesn't produce an ui like AlertDialog does we should settle which one we use going forward.

Let's discuss:

Define theme surface/container colors #18767

libanki/src/main/java/com/ichi2/anki/libanki/Deck.kt

AnkiDroid/src/main/java/com/ichi2/anki/dialogs/EditDeckDescriptionDialog.kt

AnkiDroid/src/main/java/com/ichi2/anki/ui/DelegatedViewProperties.kt

david-allison · 2025-07-13T22:18:00Z

@lukstbit I have handled all requests

mikehardy · 2025-07-21T16:54:28Z

Thanks for giving it a look again - it does seem like most (all?) items were addressed and, as ever, we can always do followups

mikehardy · 2025-07-21T17:10:59Z

@david-allison merge queue caught a quiet conflict with refactorings and order of merge...

e: file:///home/runner/work/Anki-Android/Anki-Android/AnkiDroid/src/test/java/com/ichi2/anki/dialogs/EditDeckDescriptionDialogViewModelTest.kt:30:28 Unresolved reference 'TestClass'.
e: file:///home/runner/work/Anki-Android/Anki-Android/AnkiDroid/src/test/java/com/ichi2/anki/dialogs/EditDeckDescriptionDialogViewModelTest.kt:175:9 Unresolved reference 'TestClass'.
gradle/actions: Writing build results to /home/runner/work/_temp/.gradle-actions/build-results/__run-1753116949796.json

I'm not sure if we'll want to implement the setter, but the getter is useful https://redirect.github.com/ankitects/anki/commit/ded626f0b9685355e9856c352daf21c09382999e Issue 18749

https://redirect.github.com/ankitects/anki/blob/da907053460e2b78c31199f97bbea3cf3600f0c2/pylib/anki/collection.py#L1171 Issue 18749

* fix margins to be standard 24dp * add icon for save * add content description for 'close' Fixes Issue 18528

* touch outside -> no-op

* fixes saved state restoration

Note that this option has unintended consequences. * `<img>` tags, are now stripped, although they work with the option disabled * It does not work on old versions of Anki https://redirect.github.com/ankitects/anki/commit/ded626f0b9685355e9856c352daf21c09382999e Issue 18749

Adds rounded corners Issue 18528

Requested in review, instead of icons Issue 18749

Didn't look good on tablets

david-allison · 2025-07-21T17:24:11Z

Updated strings from Crowdin 2025/07/21 15:33 #18932

github-actions · 2025-07-21T17:46:53Z

Maintainers: Please Sync Translations to produce a commit with only the automated changes from this PR.

Read more about updating strings on the wiki,

david-allison added Anki Ecosystem Compatibility Needs Review labels Jul 2, 2025

github-actions bot added the Strings label Jul 2, 2025

david-allison removed the Anki Ecosystem Compatibility label Jul 2, 2025

david-allison force-pushed the deck-description branch 4 times, most recently from df7a81b to c852c79 Compare July 2, 2025 20:29

This comment was marked as resolved.

Sign in to view

BrayanDSO added the Needs Author Reply Waiting for a reply from the original author label Jul 3, 2025

david-allison force-pushed the deck-description branch from c852c79 to 380296b Compare July 3, 2025 20:31

david-allison removed the Needs Author Reply Waiting for a reply from the original author label Jul 3, 2025

david-allison requested a review from BrayanDSO July 3, 2025 20:33

github-actions bot added the Has Conflicts label Jul 5, 2025

david-allison force-pushed the deck-description branch from 380296b to 6626e0a Compare July 8, 2025 17:19

david-allison removed the Has Conflicts label Jul 8, 2025

david-allison force-pushed the deck-description branch from 6626e0a to 8beea87 Compare July 9, 2025 19:50

lukstbit previously requested changes Jul 13, 2025

View reviewed changes

lukstbit added Needs Author Reply Waiting for a reply from the original author and removed Needs Review labels Jul 13, 2025

david-allison force-pushed the deck-description branch 4 times, most recently from 71a3b4e to 064d2cc Compare July 13, 2025 22:17

david-allison force-pushed the deck-description branch 2 times, most recently from 53057d0 to 5ff75ea Compare July 14, 2025 02:11

mikehardy added this pull request to the merge queue Jul 21, 2025

mikehardy removed the Review High Priority Request for high priority review label Jul 21, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jul 21, 2025

mikehardy added the Needs Author Reply Waiting for a reply from the original author label Jul 21, 2025

david-allison added 14 commits July 21, 2025 18:15

improvement(libAnki): expose deck 'descriptionAsMarkdown'

ba698de

I'm not sure if we'll want to implement the setter, but the getter is useful https://redirect.github.com/ankitects/anki/commit/ded626f0b9685355e9856c352daf21c09382999e Issue 18749

refactor(libanki): make 'description' a property of 'Deck'

63e4e87

feat(study-options): render description as markdown

f82b27e

https://redirect.github.com/ankitects/anki/blob/da907053460e2b78c31199f97bbea3cf3600f0c2/pylib/anki/collection.py#L1171 Issue 18749

refactor(deck-description): onViewCreated

6cd360d

improvement(deck-description): UI design

27c9e51

* fix margins to be standard 24dp * add icon for save * add content description for 'close' Fixes Issue 18528

fix(deck-description): don't cancel on touch outside/back

c612c1a

* touch outside -> no-op

refactor(deck-description): introduce viewmodel

f9390de

* fixes saved state restoration

improvement(deck-description): disable 'save' if no changes

60d5d3d

improvement(deck-description): 'discard changes?' on back press

4a36697

improvement(deck-description): show snackbar on save

cf2a976

improvement(deck-description): use material theme

435845a

Adds rounded corners Issue 18528

improvement(deck-description): use 'Save/Close' buttons

cfd2a4e

Requested in review, instead of icons Issue 18749

design(deck-description): remove full width

e312461

Didn't look good on tablets

david-allison force-pushed the deck-description branch from e55be13 to e312461 Compare July 21, 2025 17:18

david-allison enabled auto-merge July 21, 2025 17:18

david-allison removed the Needs Author Reply Waiting for a reply from the original author label Jul 21, 2025

david-allison added this pull request to the merge queue Jul 21, 2025

Merged via the queue into ankidroid:main with commit ebc33d3 Jul 21, 2025
10 checks passed

github-actions bot removed the Pending Merge Things with approval that are waiting future merge (e.g. targets a future release, CI wait, etc) label Jul 21, 2025

github-actions bot added this to the 2.22 release milestone Jul 21, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(deck-description): 'Format as Markdown' support & various UX improvements #18748

feat(deck-description): 'Format as Markdown' support & various UX improvements #18748

Uh oh!

david-allison commented Jul 2, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 2, 2025

Uh oh!

This comment was marked as resolved.

Uh oh!

david-allison commented Jul 3, 2025 •

edited

Loading

Uh oh!

lukstbit left a comment

Uh oh!

lukstbit Jul 12, 2025

Uh oh!

david-allison Jul 14, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

david-allison commented Jul 13, 2025

Uh oh!

mikehardy commented Jul 21, 2025

Uh oh!

Uh oh!

mikehardy commented Jul 21, 2025

Uh oh!

david-allison commented Jul 21, 2025

Uh oh!

Uh oh!

github-actions bot commented Jul 21, 2025

Uh oh!

Uh oh!

Uh oh!

feat(deck-description): 'Format as Markdown' support & various UX improvements #18748

feat(deck-description): 'Format as Markdown' support & various UX improvements #18748

Uh oh!

Conversation

david-allison commented Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose / Description

Fixes

Approach

How Has This Been Tested?

Learning (optional, can help others)

Checklist

Uh oh!

github-actions bot commented Jul 2, 2025

Uh oh!

This comment was marked as resolved.

Uh oh!

david-allison commented Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lukstbit left a comment

Choose a reason for hiding this comment

Uh oh!

lukstbit Jul 12, 2025

Choose a reason for hiding this comment

Uh oh!

david-allison Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

david-allison commented Jul 13, 2025

Uh oh!

mikehardy commented Jul 21, 2025

Uh oh!

Uh oh!

mikehardy commented Jul 21, 2025

Uh oh!

david-allison commented Jul 21, 2025

Uh oh!

Uh oh!

github-actions bot commented Jul 21, 2025

Uh oh!

Uh oh!

david-allison commented Jul 2, 2025 •

edited

Loading

david-allison commented Jul 3, 2025 •

edited

Loading