search

alhassy / holy-books

An Emacs interface to the Quran and the Bible: Org-mode links, tooltips, and Lisp look-ups
GNU General Public License v3.0
25 stars 5 forks source link

Unlear documentation for `holy-books-quran-translation` variable #9

Closed alhassy closed 3 years ago

alhassy commented 3 years ago

Describe the bug It is not at all clear how to get alternate translations of the Quran; in contrast, the way to get alternate versions of the Bible is fully documented in holy-books-bible-version.

To Reproduce Steps to reproduce the behavior:

  1. The link mentioned in the documentation, https://quran.api-docs.io/v3/options/translations, does not easily show how to get the translation codes.

  2. Perhaps @ashfaqfarooqui could tackle this ticket or provide direction.

Expected behavior As with holy-books-bible-version, it would be idle if users could have the list of possible Quranic translations directly in the holy-books-quran-translation variable ---although mention of the Quran.com API should be kept around for interested developers ...it would be nice if @ashfaqfarooqui could mention how we could get such a list of translations, so others could reproduce this later on.

Additional context If this issue becomes stale, the holy-books-quran-translation variable may be scrapped; or, at least, not mentioned in the top level user documentation.

alhassy commented 3 years ago

Was there a particular way you fetched the lists? Maybe we can try to automate it ;-)