git.squeep.com Git - akkoma/blob - lib/pleroma/web/gettext.ex

   1 # Pleroma: A lightweight social networking server
   2 # Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
   3 # SPDX-License-Identifier: AGPL-3.0-only
   4
   5 defmodule Pleroma.Web.Gettext do
   6   @moduledoc """
   7   A module providing Internationalization with a gettext-based API.
   8
   9   By using [Gettext](https://hexdocs.pm/gettext),
  10   your module gains a set of macros for translations, for example:
  11
  12       import Pleroma.Web.Gettext
  13
  14       # Simple translation
  15       gettext "Here is the string to translate"
  16
  17       # Plural translation
  18       ngettext "Here is the string to translate",
  19                "Here are the strings to translate",
  20                3
  21
  22       # Domain-based translation
  23       dgettext "errors", "Here is the error message to translate"
  24
  25   See the [Gettext Docs](https://hexdocs.pm/gettext) for detailed usage.
  26   """
  27   use Gettext, otp_app: :pleroma
  28 end