Variable: erc--message-speaker-catalog

erc--message-speaker-catalog is a variable defined in erc-backend.el.gz.

Value

-speaker

Documentation

The "speaker" catalog symbol used to format PRIVMSGs and NOTICEs.

This symbol defines a "catalog" of variables and functions whose names reflect their membership via a corresponding CATALOG component, as in "erc-message-CATALOG-KEY". Here, KEY refers to a common set of interface members (variables or functions), that an implementer must define:

- statusmsg and statusmsg-input: PRIVMSGs whose target is a
   status-prefixed channel; the latter is the "echoed" version

- chan-privmsg, query-privmsg, chan-notice, query-notice:
   standard chat messages traditionally prefixed by a <nickname>
   indicating the message's "speaker"

- input-chan-privmsg, input-query-privmsg, input-query-notice,
  input-chan-notice: "echoed" versions of the above

- ctcp-action, ctcp-action-input, ctcp-action-statusmsg,
  ctcp-action-statusmsg-input: "CTCP ACTION" versions of the
   above

The other part of this interface is the per-key collection of format-spec parameters members must support. For simplicity, this catalog currently defines a common set for all keys, some of which may be assigned the empty string when not applicable:

  %n - nickname
  %m - message body
  %p - nickname's status prefix (when applicable)
  %s - current target's STATUSMSG prefix (when applicable)

As an added means of communicating with various modules, if this catalog's symbol has the property erc--msg-prop-overrides, consumers calling erc-display-message will see the value added to the erc--msg-props "environment" in modification hooks, like erc-insert-modify-hook.

Source Code

;; Defined in /usr/src/emacs/lisp/erc/erc-backend.el.gz
;; This variable can be made public if the current design proves
;; sufficient.
(defvar erc--message-speaker-catalog '-speaker
  "The \"speaker\" catalog symbol used to format PRIVMSGs and NOTICEs.

This symbol defines a \"catalog\" of variables and functions
whose names reflect their membership via a corresponding CATALOG
component, as in \"erc-message-CATALOG-KEY\".  Here, KEY refers
to a common set of interface members (variables or functions),
that an implementer must define:

- `statusmsg' and `statusmsg-input': PRIVMSGs whose target is a
   status-prefixed channel; the latter is the \"echoed\" version

- `chan-privmsg', `query-privmsg', `chan-notice', `query-notice':
   standard chat messages traditionally prefixed by a <nickname>
   indicating the message's \"speaker\"

- `input-chan-privmsg', `input-query-privmsg', `input-query-notice',
  `input-chan-notice': \"echoed\" versions of the above

- `ctcp-action', `ctcp-action-input', `ctcp-action-statusmsg',
  `ctcp-action-statusmsg-input': \"CTCP ACTION\" versions of the
   above

The other part of this interface is the per-key collection of
`format-spec' parameters members must support.  For simplicity,
this catalog currently defines a common set for all keys, some of
which may be assigned the empty string when not applicable:

  %n - nickname
  %m - message body
  %p - nickname's status prefix (when applicable)
  %s - current target's STATUSMSG prefix (when applicable)

As an added means of communicating with various modules, if this
catalog's symbol has the property `erc--msg-prop-overrides',
consumers calling `erc-display-message' will see the value added
to the `erc--msg-props' \"environment\" in modification hooks,
like `erc-insert-modify-hook'.")