Skip to content

Module Commentary

Rodolfo Goulart edited this page Jun 13, 2024 · 2 revisions

The Commentary Module Schema

On Windows, the database path is

%AppData%\Roaming\com.i53\Aletheia Bible Study

and the file is dbAletheia-commentary.sqlite

Table Commentary

class Commentary {
  int id;
  String name;
  String? description;
  String? author;
  String? copyright;
  String? htmlStyle;
}
Column Type Required Description
id int yes unique field
name String yes Name of the commentary
description String no Some description for the commentary
author String no the author of the commentary
copyright String no the copyright of the commentary
html_style String no As the Commentary suport some tags of HTML, you can add css style here, and will be parsed to the commentary. Note that not all style is supported by the plataform.

Table Commentary Content

Important

On database table is rename to commentary_content

class CommentaryContent {
  int id;
  int idCommentary;
  int idBook;
  int? chapter;
  int? verse;
  int? verseEnd;
  String content;
}
Column Type Required Description
id int yes unique field
id_commentary int relationship with Table Commentary
idBook int yes relationship with Table Books, see the id of the books, some book has static ID, please see the list provided on Books Doc. If provided just the idBook, Aletheia app will handle as a book introduction, showing on Page Commentary for each chapter.
chapter int no the chapter of this comment, if provided, the commentary will be loaded when the chapter is selected
verse int no the verse of this comment, if provided need the field chapter, this will be loaded and will follow the user navegation throuth the chapter
verse_end int no some verses has joined comment, so you can provide with the verse
content String yes The content of the comment. you can use as html, but NOT ALL tags are recognized. Aletheia make use of this package, so please se the list of tags and styles that is recognized on.

External Packages use

Important

Aletheia make use of the external package Flutter HTML, so before add some module, look at the list of Tags and Styles that is supported by the package.

Clone this wiki locally