MishkaDocument.Plugins.UsedTranslationKeys (Mishka Document v0.0.1)

Copy Markdown View Source

Names the words the documentation looks up in a site's translations, through the runtime:translations:used_keys mishka_installer hook (MishkaCmsCore.Runtime.Translations.used_keys/1).

The words of the bar under the header (MishkaDocument.Plugins.PageFrame.words/0) are asked for by a plugin, not by a template, so nothing a page, a component or a layout says holds them. Without this, "Remove unused" on the site's translations would delete them, and what a translator wrote for them, as words nobody asks for.

Registered in MishkaDocument.Application.

Summary

Types

error_return()
okey_return()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

config()
config(key)
enable()

Callback implementation for MishkaInstaller.Event.Hook.enable/0.

get()

Callback implementation for MishkaInstaller.Event.Hook.get/0.

health_check()

Optional. See MishkaInstaller.Event.Hook.health_check/0. Override to report health.

on_dependency_error(error)

Optional. See MishkaInstaller.Event.Hook.on_dependency_error/1. Override to react.

register()

Callback implementation for MishkaInstaller.Event.Hook.register/0.

restart()

Callback implementation for MishkaInstaller.Event.Hook.restart/0.

start()

Callback implementation for MishkaInstaller.Event.Hook.start/0.

start_link(args \\ [])
stop()

Callback implementation for MishkaInstaller.Event.Hook.stop/0.

unregister()

Callback implementation for MishkaInstaller.Event.Hook.unregister/0.

Types

error_return()

@type error_return() ::
  {:error, [%{action: atom(), field: atom(), message: String.t()}]}

okey_return()

@type okey_return() :: {:ok, struct() | map() | module() | [any()]}

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

config()

@spec config() :: keyword()

config(key)

@spec config(atom()) :: any()

enable()

@spec enable() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.enable/0.

get()

@spec get() :: keyword()

Callback implementation for MishkaInstaller.Event.Hook.get/0.

health_check()

@spec health_check() :: :ok | {:degraded, term()} | {:error, term()}

Optional. See MishkaInstaller.Event.Hook.health_check/0. Override to report health.

on_dependency_error(error)

@spec on_dependency_error(term()) :: term()

Optional. See MishkaInstaller.Event.Hook.on_dependency_error/1. Override to react.

register()

@spec register() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.register/0.

restart()

@spec restart() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.restart/0.

start()

@spec start() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.start/0.

start_link(args \\ [])

stop()

@spec stop() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.stop/0.

unregister()

@spec unregister() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.unregister/0.