changeset 1644:8a09eea9003f default tip

doc (user): Add doc for forum feature: fix 463
author Goffi <goffi@goffi.org>
date Sat, 06 Sep 2025 17:28:07 +0200
parents 0e11dbbcefe7
children
files doc/index.rst doc/user/forums.rst
diffstat 2 files changed, 66 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/index.rst	Sat Sep 06 16:30:48 2025 +0200
+++ b/doc/index.rst	Sat Sep 06 17:28:07 2025 +0200
@@ -24,6 +24,7 @@
    installation.rst
    user/chat.rst
    user/calls.rst
+   user/forums.rst
    web_framework/quick_start.rst
    web_framework/css_framework.rst
 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/user/forums.rst	Sat Sep 06 17:28:07 2025 +0200
@@ -0,0 +1,65 @@
+======
+Forums
+======
+
+Libervia includes a forum feature that allows you to participate in discussions organized
+into categories and subcategories. This section will guide you on how to use this feature
+effectively.
+
+Accessing the Forum Feature
+---------------------------
+
+1. Navigate to the main menu.
+2. Select the **Forums** option.
+
+Panels
+------
+
+There are two main panels for navigating the forums:
+
+- **Left Panel**: Use this panel to change forums. You can open a different forum by
+  entering its identifier (JID) in the field and then pressing :kbd:`ENTER` or clicking
+  the ``Go to Forum`` button.
+- **Main Panel**: This panel displays the content of the selected forum, including its
+  categories and subcategories.
+
+If a forum exists on the current server, you will see a hierarchical structure of
+categories and subcategories. Clicking on a subcategory will open a new page listing the
+topics within that category.
+
+Clicking on a topic opens a page displaying the messages within that topic.
+
+Topic Messages
+--------------
+This page displays all messages related to a specific topic.
+
+Main Panel Header
+~~~~~~~~~~~~~~~~~
+
+At the top of the main panel, you'll find several elements:
+
+- A button to show or hide the left panel.
+- The title of the topic.
+- A search field for full-text searching within the current thread.
+- A button to subscribe or unsubscribe to the current topic.
+
+Messages are displayed below these elements.  At the bottom of the page, you'll find an
+editor for posting a reply, and below that, a "Send Message" button.
+
+Editor
+~~~~~~
+
+The editor provides various formatting options for your messages:
+
+1. **Title Size**: A dropdown menu to select the heading level for your message title (1,
+   2, 3, or "normal").
+2. **Text Formatting**: Buttons for applying **bold**, *italic*, underline,
+   strike-through, ``inline-code``, and hyperlinks.
+3. **Block Elements**: Buttons for creating `blockquote` and `block-code` elements.
+4. **Lists**: Buttons to create ordered and unordered lists.
+5. **Clear Formatting**: A button to remove formatting from selected text.
+6. **Tags**: Add tags to the message.
+7. **Attachments**: Add attachments to the message.
+
+When typing in the editor, you can press `@` to mention another user. A notification
+message will be sent to that user.