From 02e06863e7cb38e7b61fa6d8b0322ee88ba4bc0b Mon Sep 17 00:00:00 2001 From: mihalin Date: Thu, 17 Mar 2022 09:11:15 +0300 Subject: [PATCH] documentation --- docs/source/index.rst | 2 +- docs/source/{threads.rst => options.rst} | 26 +++++++++++++++++++++--- olgram/commands/menu.py | 4 ++-- server/custom.py | 5 ++--- 4 files changed, 28 insertions(+), 9 deletions(-) rename docs/source/{threads.rst => options.rst} (54%) diff --git a/docs/source/index.rst b/docs/source/index.rst index 7d25997..36a4e4f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -15,7 +15,7 @@ about quick_start templates - threads + options developer additional diff --git a/docs/source/threads.rst b/docs/source/options.rst similarity index 54% rename from docs/source/threads.rst rename to docs/source/options.rst index 1431630..8d86274 100644 --- a/docs/source/threads.rst +++ b/docs/source/options.rst @@ -1,6 +1,11 @@ -Потоки сообщений +Опции ============= +.. _threads: + +Потоки сообщений +---------------- + Olgram пересылает сообщения так, чтобы сообщения от одного и того же пользователя оставались в одном и том же потоке сообщений. Тогда по кнопке View Replies можно увидеть диалог с этим пользователем, а все остальные сообщения из чата скрываются: @@ -8,11 +13,26 @@ Olgram пересылает сообщения так, чтобы сообщен .. image:: ../images/thread.gif :width: 300 -Как настроить потоки сообщений ---------------------- +**Как настроить потоки сообщений** Привяжите вашего feedback бота к групповому чату :doc:`quick_start`. В настройках группового чата откройте историю чата для новых участников чата ("Chat history for new members -> Visible"). Изменение этой настройки превращает чат в `супергруппу `_: потоки сообщений работают только в таких группах Включите потоки в настройках бота Olgram Опции->Потоки сообщений + +.. user_info: + +Данные пользователя +------------------- + +При получении входящего сообщения Olgram может пересылать дополнительную информацию об отправителе. Имя, username и +идентификатор пользователя. Например так: + +.. image: ../images/user_info.jpg + :width: 300 + +Эта функция может быть полезной, чтобы отличить одного пользователя от другого. Имя и username можно сменить, но +идентификатор #id остаётся неизменным для одного и того же аккаунта. + +Включить эту функцию можно в настройках бота Olgram Опции->Данные пользователя diff --git a/olgram/commands/menu.py b/olgram/commands/menu.py index 2fa2991..d05ba75 100644 --- a/olgram/commands/menu.py +++ b/olgram/commands/menu.py @@ -170,8 +170,8 @@ async def send_bot_settings_menu(bot: Bot, call: types.CallbackQuery): thread_turn = "включены" if bot.enable_threads else "выключены" info_turn = "включена" if bot.enable_additional_info else "выключена" text = dedent(f""" - Потоки сообщений: {thread_turn} - Дополнительная информация: {info_turn} + Потоки сообщений: {thread_turn} + Данные пользователя: {info_turn} """) await edit_or_create(call, text, reply_markup=keyboard, parse_mode="HTML") diff --git a/server/custom.py b/server/custom.py index f78b959..df05dc5 100644 --- a/server/custom.py +++ b/server/custom.py @@ -38,9 +38,8 @@ def _thread_uniqie_id(bot_id: int, chat_id: int) -> str: async def send_user_message(message: types.Message, super_chat_id: int, bot): """Переслать сообщение от пользователя, добавлять к нему user info при необходимости""" if bot.enable_additional_info: - user_info = "От пользователя: " - if message.from_user.full_name: - user_info += message.from_user.full_name + user_info = "Сообщение от пользователя " + user_info += message.from_user.full_name if message.from_user.username: user_info += " | @" + message.from_user.username user_info += f" | #{message.from_user.id}"