File: erc-nicks.el.html

This file provides the nicks module for automatic nickname highlighting. Add nicks to erc-modules to get started.

Use the command erc-nicks-refresh to review changes after adjusting an option, like erc-nicks-contrast-range. To change the color of a nickname in a target buffer, click on it and choose
"Edit face" from the completion interface, and then perform your
adjustments in the resulting Customize menu. Non-Customize users on Emacs 28+ can persist changes permanently by clicking on the face's "location" hyperlink and copying the generated code snippet
(defface or use-package) to their init.el. Customize users
need only click "Apply and Save", as usual.

Defined variables (17)

erc-nicks--create-pool-functionFilter function for initializing the pool of colors.
erc-nicks--downcased-skip-nicksCase-mapped copy of ‘erc-nicks-skip-nicks’.
erc-nicks--face-tableHash table mapping nicks to unique, named faces.
erc-nicks--max-skip-searchMax number of faces to visit when testing ‘erc-nicks-skip-faces’.
erc-nicks-backing-faceFace to mix with generated one for emphasizing non-speakers.
erc-nicks-bg-colorBackground color for calculating contrast.
erc-nicks-color-adjustmentsTreatments applied to improve aesthetics or visibility.
erc-nicks-colorsPool of colors.
erc-nicks-contrast-rangeDesired range of contrast as a cons of (MIN . MAX).
erc-nicks-ignore-charsTrailing characters in a nick to ignore while highlighting.
erc-nicks-key-suffix-formatTemplate for latter portion of keys to generate colors from.
erc-nicks-modeNon-nil if Erc-Nicks mode is enabled.
erc-nicks-mode-hookHook run after entering or leaving ‘erc-nicks-mode’.
erc-nicks-saturation-rangeDesired range for constraining saturation.
erc-nicks-skip-facesFaces to avoid highlighting atop.
erc-nicks-skip-nicksNicks to avoid highlighting.
erc-nicks-track-facesShow nick faces in the ‘track’ module’s portion of the mode line.

Defined functions (38)

erc-nicks--adjust-contrast(COLOR TARGET &optional DECREASE)
erc-nicks--anon-face-p(FACE)
erc-nicks--anon-face-p--inliner(INLINE--FORM FACE)
erc-nicks--check-normals(CURRENT CONTENDER CONTENDERS NORMALS)
erc-nicks--colors-from-faces(PREFIX)
erc-nicks--create-coerced-pool(ADJUSTMENTS COLORS)
erc-nicks--create-culled-pool(ADJUSTMENTS COLORS)
erc-nicks--create-defface-template(FACE)
erc-nicks--determine-color(KEY)
erc-nicks--gen-color(STRING)
erc-nicks--gen-key-from-format-spec(NICKNAME)
erc-nicks--get-contrast(FG &optional BG)
erc-nicks--get-face(NICK KEY)
erc-nicks--get-luminance(COLOR)
erc-nicks--highlight(NICKNAME &optional BASE-FACE)
erc-nicks--highlight-button(NICK-OBJECT)
erc-nicks--init-pool()
erc-nicks--list-faces-help-button-action(FACE)
erc-nicks--oursp(FACE)
erc-nicks--oursp--inliner(INLINE--FORM FACE)
erc-nicks--redirect-face-widget-link(ARGS)
erc-nicks--reduce(COLOR)
erc-nicks--reject-uninterned-faces(CANDIDATE)
erc-nicks--remember-face-for-track(FACE)
erc-nicks--revive(NEW-FACE OLD-FACE NICK NET)
erc-nicks--setup-track-integration()
erc-nicks--skip-p(PROP OPTION LIMIT)
erc-nicks--trim(NICKNAME)
erc-nicks-add-contrast(COLOR)
erc-nicks-cap-contrast(COLOR)
erc-nicks-customize-face(NICK)
erc-nicks-disable(&optional ARG)
erc-nicks-enable(&optional ARG)
erc-nicks-ensaturate(COLOR)
erc-nicks-invert(COLOR)
erc-nicks-list-faces()
erc-nicks-mode(&optional ARG)
erc-nicks-refresh(DEBUG)

Defined faces (0)