Roadmap and To-Do

[sircharlo]

Here's a simple tracker of things I'd like to do eventually. I accept code contributions and suggestions!

---

To-Do / Wishlist

• [ ] Allow zooming before showing a picture (#2302)
• [ ] Add date format setting
• [ ] Fix and enable website presenting on macOS (#2768)
• [ ] Add "start mirroring" button to allow finding the page you want before displaying it
• [ ] Fix/tweak action island popup placement
• [ ] Fix mirroring on macOS (#2768)
• [ ] Look into macOS full-screen toggle not having the desired behavior
• [ ] Look into hiding mouse over media window (#2571)
• [ ] Add a re-fetch button (in settings?) to force a refresh of scheduled media
• [ ] Look into adding Study Bible media picker
• [ ] Add MP4 conversion utility to convert a meeting's media to MP4 for use with Zoom sharing (if requested)
• [ ] Implement play/pause/next/previous keyboard shortcuts (if requested) (#2766)
• [ ] Add Cypress testing

Done / Implemented

• [x] Clean up UI based on feedback
• [x] Test migration from previous version at a KH
• [x] Prevent going to day when in past (additional media for example)
• [x] Show warning notification in existing version of M³ about upcoming update
• [x] Fix Chrome image drop
• [x] Fix song adding/loading UI
• [x] Compare existing strings and remove unneeded strings to allow updated translations on Crowdin
• [x] sircharlo/mmm-refactor#59
• [x] sircharlo/mmm-refactor#65
• [x] Add documentation website, built using VitePress and deployed to Github Pages
• [x] Make video fetching non-blocking (stream if not downloaded yet)
• [x] Add feature to include meeting songs in the background music
• [x] Fix the audio click when stopping media mid-play
• [x] Add public talk media logic

Needed refactors to eventually allow the additional media folder to be 'portable' or synced

I'm sure I'm missing some things, but here's what I could think of so far.

• [ ] Convert from fileUrls in localStorage to paths
• [ ] Standardize paths and URLs stored in a DynamicMediaObject:
  • [ ] relativePath (relative path to file on filesystem)
  • [ ] streamUrl (url in case local file is not ready or present)
  • [ ] thumbnailPath (path to download thumbnail file on filesystem)
  • [ ] thumbnailUrl (url thumbnail in case local file is not ready or present)
• [ ] Make 'additional media' paths in localStorage relative, not absolute
• [ ] Create helper functions to be invoked when converting paths in localStorage to fileUrls (pointing to user configured folder + relative path is sectionOriginal = 'additional', and to userdata folder + relative path otherwise)
• [ ] create 'getAbsolutePath' helper functions to get a real path from a DynamicMediaObject's relativePath
• [ ] Create a migration to go from the old fileUrl route to the new relativePath way
• [ ] Add congregation sync section to settings
• [ ] Allow user to choose directory for additional media
• [ ] Allow user to change congregation ID in congregation sync settings (all synced congregation should set same ID)
• [ ] Show warning before editing congregation ID that all current custom media, sorting, and durations will be lost
• [ ] On congregation ID change, 'logout' of profile
• [ ] Update getAdditionalMediaPath to point to that directory if specified, or to default
• [ ] Save additionalMediaMaps, mediaSort and customDurations from localStorage to additional media directory
• [ ] Load additionalMediaMaps, mediaSort and customDurations into localStorage on profile load
• [ ] Add manual sync button to congregation sync settings section that reloads additionalMediaMaps, mediaSort and customDurations into localStorage

[ux-git]

@sircharlo The docs site shuts down completely? Or will be re-written for the new app version?

[sircharlo]

@sircharlo The docs site shuts down completely? Or will be re-written for the new app version?

The current docs will be rendered mostly obsolete with the new version. I also find them quite "heavy".

The new version of M³ is for the most part self-explanatory; perhaps a very simplified docs could replace the existing one; I would prefer to have most essential documentation in the app itself though, with hint text for each setting for example.

[ux-git]

Totally agree! Though, some deeper explanation like a full list of supported formats, settings guide, etc would be great to have on a documentation site, to be able to quickly link to it when needed.

Take a look at Docusaurus, it's pretty user-friendly, with nice essential design, and contribution-open. My experience with it is awesome so far. Plus, in the current GitHub pages documentation, when I open it on mobile, all the languages are mixed up with no way to fix it or to find anything. I didn't face this issue with the Docusaurus.

[sircharlo]

Totally agree! Though, some deeper explanation like a full list of supported formats, settings guide, etc would be great to have on a documentation site, to be able to quickly link to it when needed.

Take a look at Docusaurus, it's pretty user-friendly, with nice essential design, and contribution-open. My experience with it is awesome so far. Plus, in the current GitHub pages documentation, when I open it on mobile, all the languages are mixed up with no way to fix it or to find anything. I didn't face this issue with the Docusaurus.

Very nice!

[sircharlo]

@ux-git In about 5 minutes I will release v24.7.1, which implements almost all of the UI/UX improvements you suggested!

Would you mind taking a look when you can to see if some things need to be further tweaked, or if I missed some screens?

Also, here are some dialogs that I didn't see in your mockups:

• Keyboard shortcut picker popup
• Cache clear confirmation popup
• Congregation deletion confirmation popup
• Media custom start/stop picker popup
• Video stop confirmation popup
• Media deletion popup

Do you think you could take a look and offer some feedback to make the UI consistent for these popups as well?

Thanks so much for your help!

Note: I haven't yet added the caption/explainers to all the settings, but they'll be there for the next release. I just didn't want to wait for that to be done before getting your feedback.

[mrtavor]

Hi @sircharlo, we added a new page in the project in Figma called “Design review”, where we wrote some of the details along with images to make it clearer. Feel free to leave your additional comments there.

Quick overview. Most important things are: • Consistent icons (fill vs stroke & sizes & roundness index) • Apply min-width and max-width for some elements • Meeting media items: title, icon, reorder structure and logic. • Menus and sidebar icon gaps

There are also lower priority points that can be improved and polished. We will mention those in the corresponding priority sections later and will ping you.

[mrtavor]

What is the difference between the Media custom start/stop picker popup and Video stop confirmation popup?

[sircharlo]

What is the difference between the Media custom start/stop picker popup and Video stop confirmation popup?

The video stop popup is what shows up when attempting to stop a video while it is playing; to prevent accidentally stopping a song for example.

The custom start-stop modal is what shows up when you click on the black HH:MM badge on a video. It allows you to set a custom start and stop time for the video (useful for when a congregation is playing a streamed public talk, they can set the start and stop times without having to cut the actual video file).

[sircharlo]

@ux-git @mrtavor I just released 24.7.2 in which the vast majority of the improvements you suggested are implemented. I documented a few icons that appear to be missing from the UI kit, and a few for which I could not find a use. When you have time, I’d love to see your thoughts on what could be still be improved or changed, or things I might have overlooked. Thanks again!

[alanfermtz]

Based on what I have been trying is really good. Its feels smoother. And thanks for adding zoom in to jw org mirroring, its perfect!

Also, worth mentioning its that now I see more often images on both apps (stable, refactor) that are related to watchtower footnotes, and also the brochure love people. Its a bug? If its intended, can you make a exclude button for this cases?

[sircharlo]

Based on what I have been trying is really good. Its feels smoother. And thanks for adding zoom in to jw org mirroring, its perfect!

Thanks so much!

Also, worth mentioning its that now I see more often images on both apps (stable, refactor) that are related to watchtower footnotes, and also the brochure love people. Its a bug? If its intended, can you make a exclude button for this cases?

Did you look into these options in the advanced settings?

[alanfermtz]

Yes, I have that enabled I still see all this images:

[sircharlo]

Yes, I have that enabled I still see all this images:

Those two pictures are from talk 1. “Tell the Next Generation” About God’s Power, specifically the reference: w14 1/15 23 ¶4-5.

In 2014, the Spanish Watchtower publication files were structured differently, which makes it more difficult to know which paragraph a picture is for. For this reason, all pictures are included.

In other languages, such as English, those pictures don't show up because the publication files are structured in a way that makes it clear which paragraph media relates to.

[ux-git]

@ux-git @mrtavor I just released 24.7.2 in which the vast majority of the improvements you suggested are implemented. I documented a few icons that appear to be missing from the UI kit, and a few for which I could not find a use. When you have time, I’d love to see your thoughts on what could be still be improved or changed, or things I might have overlooked. Thanks again!

Great! Sure, we will take a look, most likely starting from Monday.

[mtdvlpr]

Totally agree! Though, some deeper explanation like a full list of supported formats, settings guide, etc would be great to have on a documentation site, to be able to quickly link to it when needed.

Take a look at Docusaurus, it's pretty user-friendly, with nice essential design, and contribution-open. My experience with it is awesome so far. Plus, in the current GitHub pages documentation, when I open it on mobile, all the languages are mixed up with no way to fix it or to find anything. I didn't face this issue with the Docusaurus.

I would personally recommend VitePress, because it's Vue-based, just like M3 itself. It's very easy to setup and extremely fast!

[mtdvlpr]

Hi @sircharlo, we added a new page in the project in Figma called “Design review”, where we wrote some of the details along with images to make it clearer. Feel free to leave your additional comments there.

Any chance I can be added to that Figma file? I would love to see it and perhaps even contribute my thoughts on it.