tipitaka-pali-reader icon indicating copy to clipboard operation
tipitaka-pali-reader copied to clipboard

Please add a clear explanation of the database structure and usage instructions to the README

Open ttizze opened this issue 6 months ago • 0 comments

Is your feature request related to a problem? Please describe. I'm working on a project to translate Pali texts into various languages. I've downloaded the database from the Tipitaka Pali Reader project, but I'm having difficulty identifying which tables contain the specific data I need. For my project, I require the Pali original text and the English translation (if available) as a reference for other language translations.

Describe the solution you'd like

  1. Please add a clear explanation of the database structure and usage instructions to the README, specifically identifying:
    • Table(s) containing the Pali original text
    • Table(s) containing English translations (if available)
    • Any table(s) that contain HTML formatting information for displaying the text (if any)
    • Relationships between tables
  2. Examples of how to properly join or query these tables to obtain Pali text with corresponding English translations
  3. Information on the licensing and usage rights for the English translations, if available
  4. Any existing methods or tools within the project for exporting or accessing this data in a format suitable for multilingual translation projects

Describe alternatives you've considered I've considered manually exploring each table in the database to identify the required data, but this is time-consuming and prone to misinterpretation without proper documentation. I've also thought about creating my own mapping of the data structure, but I'm concerned about potentially missing important relationships or metadata.

Additional context

  • My project aims to facilitate the translation of Pali texts into multiple languages, using English as a reference where available.
  • I was recommended to use Tipitaka Pali Reader's data on the SuttaCentral forum.
  • I'm not looking to replicate or compete with this project, but to use it as a valuable resource for my multilingual translation project.
  • I'm committed to respecting all licensing and attribution requirements associated with the data.

I believe adding this information to the README would be extremely beneficial for other developers and translators working on similar multilingual projects.

ttizze avatar Aug 20 '24 08:08 ttizze