From 2ab6b6d6ca261196a3bb3a14c978994fb84e600f Mon Sep 17 00:00:00 2001 From: tastytea Date: Thu, 27 Jan 2022 00:54:50 +0100 Subject: [PATCH 1/3] Fix documentation for --profile; add completers to man page --- man/nheko.1.adoc.in | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/man/nheko.1.adoc.in b/man/nheko.1.adoc.in index cbd35432..57734da5 100644 --- a/man/nheko.1.adoc.in +++ b/man/nheko.1.adoc.in @@ -1,6 +1,6 @@ = nheko(1) :doctype: manpage -:Date: 2022-01-01 +:Date: 2022-01-27 :Revision: @PROJECT_VERSION@ :man source: nheko :man manual: General Commands Manual @@ -33,9 +33,28 @@ Displays version information. *--debug*:: Enables debug output. -*-p*, *--profile*:: +*-p* __, *--profile* __:: Creates a unique profile, which allows you to log into several accounts at the -same time and start multiple instances of nheko. +same time and start multiple instances of nheko. Use _default_ to start with the +default profile. + +== COMPLETERS + +Completers spawn a popup with completion candidates when you type them in +the input line. + +*@*:: +Open username completer. + +*#*:: +Open room completer. + +*:*:: +Open unicode emoji picker. + +*~*:: +Open custom emoji picker. Requires an image pack with custom emojis. Selecting +an emoji will add HTML code for the inline image into the input line. == KEYBOARD SHORTCUTS @@ -84,6 +103,8 @@ Submit message. == COMMANDS +Commands only work when they are used at the beginning of text. + === Custom messages */me* __:: From 0db486d0c87624f8441ba4c01fbad25c9b29b201 Mon Sep 17 00:00:00 2001 From: tastytea Date: Thu, 27 Jan 2022 13:00:33 +0100 Subject: [PATCH 2/3] Add FAQ to manpage, add sticker and custom emoji Q&A --- man/nheko.1.adoc.in | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/man/nheko.1.adoc.in b/man/nheko.1.adoc.in index 57734da5..fe3ff3b3 100644 --- a/man/nheko.1.adoc.in +++ b/man/nheko.1.adoc.in @@ -38,6 +38,27 @@ Creates a unique profile, which allows you to log into several accounts at the same time and start multiple instances of nheko. Use _default_ to start with the default profile. +== FAQ + +=== How do I add stickers and custom emojis? + +Stickers and custom emojis are organized in image packs. There is one user image +pack that only your account has access to and there are room image packs that +are accessible by everyone in the room they are defined in. You can activate a +room image pack globally to use it in any room. + +To manage image packs in nheko, go to the room settings and enter the Sticker & +Emote Settings. You will see the Private pack (your user image pack) and can +edit it there. The Shortcode is a unique identifier you use to select the image +with and the Body is the alternate text that is displayed on clients that don't +support images (like the alt tag in HTML images). + +If you have the necessary permissions you can create new room packs with the +button at the bottom of the image pack list. They are the same as the user pack +but you can create as many as you want and everyone in the room can use them. It +might be a good idea to create an extra room just for your image packs to make +sharing easier. + == COMPLETERS Completers spawn a popup with completion candidates when you type them in From 47b9668ccfdcfb9892be9ff3a6e31fffc65b1f2c Mon Sep 17 00:00:00 2001 From: tastytea Date: Thu, 27 Jan 2022 11:31:39 +0100 Subject: [PATCH 3/3] Add sticker and custom emoji Q&A to readme FAQ --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 616ed7f7..43b864e0 100644 --- a/README.md +++ b/README.md @@ -162,6 +162,27 @@ choco install nheko-reborn --- +**Q:** How do I add stickers and custom emojis? + +**A:** Stickers and custom emojis are organized in image packs. There is one +user image pack that only your account has access to and there are room image +packs that are accessible by everyone in the room they are defined in. You can +activate a room image pack globally to use it in any room. + +To manage image packs in nheko, go to the room settings and enter the Sticker & +Emote Settings. You will see the Private pack (your user image pack) and can +edit it there. The Shortcode is a unique identifier you use to select the image +with and the Body is the alternate text that is displayed on clients that don't +support images (like the alt tag in HTML images). + +If you have the necessary permissions you can create new room packs with the +button at the bottom of the image pack list. They are the same as the user pack +but you can create as many as you want and everyone in the room can use them. It +might be a good idea to create an extra room just for your image packs to make +sharing easier. + +--- + ### Build Requirements - Qt5 (5.15 or greater). Required for overlapping hover handlers in Qml.