Skip to content

Reader refactoring #14

@dragfyre

Description

@dragfyre

The reader functionality was originally conceived as a way to display the Baha'i Writings in a readable and attractive way, using Discord embeds. We did a fair bit of work on this and got the Hidden Words (Arabic and Persian) fully working, as seen in the screenshot below.

However, many of the other Writings we wanted to add contained paragraphs which were too long to be displayed within Discord embeds, which are limited to 2048 characters in length. As a result, we opened issue #2 to discuss the possibility of a paging system. Other bots have similar systems in place to display long messages.

To make a long story short, this issue was never resolved due to its growing complexity and a lack of free time to deal with it. For now, the paging issue has been closed as "wontfix", although there is no prejudice against reopening it in the future. We've taken a different tack for now, which is simply to add commands that jump to certain paragraphs and pages of the Writings which are hosted on the web (ex.: bahai-library.org).

This issue can serve as a home for ongoing discussions about what we want to do with the bot's reader / Writings reference functionality. Key questions include:

  • Do we want to try adding more texts that can be displayed using embeds, as we had originally envisioned? If so, which texts?
  • Should embeds be reserved for short quotes that don't need to be paged?
  • How do we harmonize reader embeds with the "jump-to-para/jump-to-page" functionality? Do we even need to?
Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    questionFurther information is requested

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions