Docs: Update screenshots

This commit is contained in:
Adam Porter 2021-08-12 15:10:47 -05:00
parent 043b4d45a6
commit 89791d7030
2 changed files with 20 additions and 17 deletions

View file

@ -8,29 +8,14 @@
Ement.el is a new Matrix client for Emacs. It's basic at the moment, but it can be used to send and read messages (including replies and images), join and leave rooms, etc. Ement.el is a new Matrix client for Emacs. It's basic at the moment, but it can be used to send and read messages (including replies and images), join and leave rooms, etc.
* Screenshots The default formatting style resembles IRC clients, with each message being prefixed by the username (which enables powerful Emacs features, like using Occur to show all messages from or mentioning a user). Alternative, built-in styles include an Element-like one with usernames above groups of messages, as well as a classic, no-margins IRC style. Messages may be optionally displayed with unique colors for each user (with customizeable contrast), making it easier to follow conversations. Timestamp headers are optionally displayed where a certain amount of time passes between events, as well as where the date changes.
The default style resembles IRC clients, with each message being prefixed by the username (which enables powerful Emacs features, like using Occur to show all messages from or mentioning a user):
[[images/screenshot5.png]]
Note that the colored message text is off by default, enabled by customizing =M-x customize-option RET ement-room-prism=.
An alternative style, with usernames displayed above groups of messages, is easily selectable in the option ~ement-room-message-format-spec~:
[[images/screenshot2.png]]
The message formatting is highly customizeable (e.g. the timestamp can be displayed in the left or right margin), and timestamp headers are displayed where a certain amount of time passes between events.
With [[#displaying-symbols-and-emojis][proper configuration]], Emacs can even display color emojis:
[[images/reactions.png]]
* Contents :noexport: * Contents :noexport:
:PROPERTIES: :PROPERTIES:
:TOC: :include siblings :TOC: :include siblings
:END: :END:
:CONTENTS: :CONTENTS:
- [[#screenshots][Screenshots]]
- [[#installation][Installation]] - [[#installation][Installation]]
- [[#usage][Usage]] - [[#usage][Usage]]
- [[#bindings][Bindings]] - [[#bindings][Bindings]]
@ -40,6 +25,24 @@ With [[#displaying-symbols-and-emojis][proper configuration]], Emacs can even di
- [[#changelog][Changelog]] - [[#changelog][Changelog]]
:END: :END:
* Screenshots
[[images/emacs-with-fully-read-line.png]]
/#emacs:libera.chat showing colored text from IRC users, replies with quoted parts, messages colored by user, addressed usernames colored by their user color, highlighted mentions, and the fully-read marker line (using the modus-vivendi Emacs theme)./
[[images/screenshot5.png]]
/Four rooms shown at once, with messages colored by user, in the default Emacs theme./
[[images/screenshot2.png]]
/A room at the top in the "Elemental" display style, with sender names displayed over groups of messages, and only self-messages in an alternate color. The lower window shows an earlier version of the rooms list./
[[images/reactions.png]]
/Reactions displayed as color emojis (may need [[#displaying-symbols-and-emojis][proper Emacs configuration]])./
* Installation * Installation
:PROPERTIES: :PROPERTIES:
:TOC: :depth 0 :TOC: :depth 0

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 KiB