Tayori.Translation (Tayori v0.1.0)

Copy Markdown View Source

An entry in one language: its title, an optional summary (what the panel and the emails show), and its body, a Kotoba.Content.

  • :text - the plain text of the body, kept for search.
  • :seo_title and :seo_description - what search engines and shared links show, when not the title and the summary.
  • :cta_label and :cta_url - the button of its announcement in the app ("Try it", a path or a URL).

Summary

Functions

The Kotoba features of an entry's body.

Types

t()

@type t() :: %Tayori.Translation{
  __meta__: term(),
  body: Kotoba.Content.t() | nil,
  cta_label: String.t() | nil,
  cta_url: String.t() | nil,
  entry: term(),
  entry_id: Ecto.UUID.t() | nil,
  id: Ecto.UUID.t() | nil,
  inserted_at: term(),
  locale: String.t() | nil,
  seo_description: String.t() | nil,
  seo_title: String.t() | nil,
  summary: String.t() | nil,
  text: String.t() | nil,
  title: String.t() | nil,
  updated_at: term()
}

Functions

features()

@spec features() :: [atom()]

The Kotoba features of an entry's body.