View Source BibleEx.Chapter (bible_ex v0.1.0)

A Bible chapter struct.

Link to this section Summary

Functions

Make a new %Chapter{} struct.

Link to this section Functions

Make a new %Chapter{} struct.

parameters

Parameters

  • book: a string that is one of the four possible book name formats
  • "GEN" (abbr)
  • "Genesis" (name)
  • "Gen" (osis)
  • "Gn" (short)
  • chapter_number: an integer that is the chapter number

examples

Examples

iex> alias BibleEx.Chapter
iex> Chapter.new(book: "Gn", chapter_number: 2)

%BibleEx.Chapter{
  book: "Gn",
  book_names: %{abbr: "GEN", name: "Genesis", osis: "Gen", short: "Gn"},
  reference_type: :chapter,
  reference: "Gn 2",
  chapter_number: 2,
  start_verse_number: 1,
  ...
}

iex> alias BibleEx.Chapter
iex> Chapter.new(book: "Gn", chapter_number: nil)

%BibleEx.Chapter{
  book: "Gn",
  book_names: %{abbr: "GEN", name: "Genesis", osis: "Gen", short: "Gn"},
  reference_type: :chapter,
  reference: nil,
  chapter_number: nil,
  start_verse_number: 1,
  start_verse: %BibleEx.Verse{
    book: "Gn",
    book_names: %{abbr: "GEN", name: "Genesis", osis: "Gen", short: "Gn"},
    book_number: 1,
    reference_type: :verse,
    reference: nil,
    chapter_number: nil,
    verse_number: 1,
    is_valid: false
  },
  end_verse: %BibleEx.Verse{
    book: "Genesis",
    book_names: %{abbr: "GEN", name: "Genesis", osis: "Gen", short: "Gn"},
    book_number: 1,
    reference_type: :verse,
    reference: "Genesis 50:26",
    chapter_number: 50,
    verse_number: 26,
    is_valid: true
  },
  end_verse_number: 26,
  verses: nil,
  is_valid: true
}