Support ReadSpeaker docReader

Created on 19 November 2022, over 1 year ago
Updated 8 December 2023, 7 months ago

Problem/Motivation

ReadSpeaker support has suggested to also offer support for the product docReader, used to read online documents (pdf, docx, epub etc).

It could be a checkbox that the user checks, and codewise it will be an extra parameter to the webReader javascript.

If there's interest for this new feature, ReadSpeaker support is willing to provide us with more information.

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

✨ Feature request
Status

Needs work

Version

2.0

Component

Code

Created by

πŸ‡©πŸ‡°Denmark ressa Copenhagen

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • πŸ‡©πŸ‡ͺGermany sunlix Wesel

    @ressa can you provide the needed informations to get this feature adapted?
    Links to the online documentation or information from the ReadSpeaker support would be helpful.

  • Status changed to Postponed 8 months ago
  • πŸ‡©πŸ‡°Denmark ressa Copenhagen

    Absolutely @sunlix, I just wrote to them, and will share their reply here.

  • Status changed to Needs work 7 months ago
  • πŸ‡©πŸ‡°Denmark ressa Copenhagen

    @sunlix: I got some info from ReadSpeaker support, about their ReadSpeaker docReader, please let me know if you need more details.

    The primary way we think should be integrated into OpenReadSpeaker is the AutoAdd script. The script is loaded by adding the parameter revdload=DocReader.AutoAdd to the webReader.js script-url.

    In addition, configuration is then done by this object:

    window.rsConf.docReader

    The most important are the language settings.
    rsConf.docReader.lang: string with language to use for automatically added links
    rsConf.docReader.hrefLang: boolean to indicate whether to use the hreflang of document links to determine language.

    The configuration object looks like this:

    window.rsConf = {
        docReader = {
            lang = "en_uk", // For example.
        }
    }
    

    The plugin should only create one rsConf object, and "merge" in the docReader member, as other keys control webReader itself.

    If you want to supply a checkbox when uploading documents, disabling docReader for a specific link can be done by adding the class rspkr_dr_added.

Production build 0.69.0 2024