Skip to content

Latest commit

 

History

History
246 lines (166 loc) · 8.23 KB

README.md

File metadata and controls

246 lines (166 loc) · 8.23 KB
Raw
icon

GitHub release (latest by date including pre-releases) GitHub Release Date GitHub License GitHub last commit GitHub repo size GitHub code size hits

GitHub all releases

简体中文 | English

SiYuan Inbox Plugin

A Siyuan Note plugin that allows you to share information among different devices in a local area network through a browser, just like in an online chat room.

Preview

Preview Image

Frequently Asked Questions

  • How can other devices access the inbox application?

    • Other devices need to access the URL http(s)://host[:port]/plugin/inbox/apps/inbox.html
    • The http(s)://host[:port] should be filled with the Siyuan core service address, such as http://192.168.1.2:6806

  • Where are the uploaded files saved in the inbox?

    • The uploaded files are saved in the default directory 思源工作空间/data/assets/inbox/
    • The uploaded group/user avatars are saved in the default directory 思源工作空间/data/public/inbox/avatar/

Introduction

Function Introduction

  • Application Management

    • Logout

      • Access Steps

        • Group Panel → Panel Menu in the Upper Right Corner → Logout

      • Function

        • Logout the user and refresh the page

      • Notes

        • If the user has not set the Siyuan access authorization code, only the page will be refreshed

    • Reset Application

      • Access Steps

        • Group Panel → Panel Menu in the Upper Right Corner → Reset Application

      • Function

        • Delete all inbox application data and initialize the inbox application

          • Disband all groups except the Main Inbox group
          • Delete all group messages

      • Notes

        • Confirmation is required for reset

  • Group Management

    • Create Group

      • Access Steps

        • Group Panel → Panel Menu in the Upper Right Corner → Create Group

      • Function

        • Create a new group

      • Notes

        • Group ID cannot be changed
        • The created group initially has only one member (the current user)

    • Show All Groups

      • Access Steps

        • Group Panel → Panel Menu in the Upper Right Corner → Show All Groups

      • Function

        • Display all groups in the group panel

          • Including groups that the current user has not joined

        • Used for group management

      • Notes

        • Unjoined groups are hidden by default

    • Hide Unjoined Groups

      • Access Steps

        • Group Panel → Panel Menu in the Upper Right Corner → Hide Unjoined Groups

      • Function

        • Hide all unjoined groups in the group panel

      • Notes

        • Unjoined groups are hidden by default

    • Group Settings

      • Access Steps

        • Group Panel → Group Menu on the Right → Group Settings
        • Message Panel → Click on the Group Icon or Group Name Above

      • Function

        • View the group ID
        • Set/upload the group icon
        • Modify the group name
        • Manage group members

      • Notes

        • Group ID cannot be changed
        • After modification, click the Confirm button in the lower right corner to save the changes

    • Leave Group

      • Access Steps

        • Group Panel → Group Menu on the Right → Leave Group

      • Function

        • Remove the current user from the member list of the specified group

      • Notes

        • If the current user is the last member of the specified group, they cannot leave

    • Disband Group

      • Access Steps

        • Group Panel → Group Menu on the Right → Disband Group

      • Function

        • Delete the specified group

      • Notes

        • The disbanded group cannot be viewed in the group panel
        • The group name, member list, and other data will be deleted
        • The messages in the group will not be deleted but cannot be viewed

  • User Management

    • Member Settings

      • Access Steps

        • Message Panel → Panel Menu in the Upper Right Corner → Member Settings

      • Function

        • Modify the user's identity information in the group
        • View the user's ID
        • Modify/upload the user's avatar in the group
        • Modify the user's nickname in the group

      • Notes

        • The user's ID is consistent and cannot be changed in all groups
        • The user's avatar and nickname can be configured separately in different groups
        • The user's avatar and nickname in the main group Inbox are the default avatar and nickname for the current user
        • After modification, click the Confirm button in the lower right corner to save the changes

    • Delete Current User

      • Access Steps

        • Group Panel → Panel Menu in the Upper Right Corner → Delete Current User

      • Function

        • Delete the current user's user information and create a new user

      • Notes

        • Confirmation is required for deletion
        • After deleting the current user, the messages sent by them will be considered as messages sent by other users

  • Message Management

    • Reload Messages

      • Access Steps

        • Message Panel → Panel Menu in the Upper Right Corner → Reload Messages

      • Function

        • Reload the message list of the group

    • Clear Messages

      • Access Steps

        • Message Panel → Panel Menu in the Upper Right Corner → Clear Messages

      • Function

        • Delete all messages in the group

      • Notes

        • Confirmation is required for deletion
        • The deleted messages cannot be viewed

  • Message Operations

    • Access Steps

      • Message Panel → Message Menu on the Right

    • Copy

      • Copy the message as Markdown text, which can be directly pasted into Siyuan

    • Forward

      • Forward the message to other groups

    • Multi-select

      • Select multiple messages for batch copying/forwarding

    • Reply

      • Quote a specified message

    • Edit

      • Edit the message again

    • Delete

      • Delete the message, the deleted message will still be visible, but its content will be displayed as deleted

  • Editing Operations

    • Text

      • Use ** symbols for bold text
      • Use _ symbols for italics
      • Use ° symbols for underline
      • Use ~ symbols for strikethrough
      • Use ` symbols for inline code
      • Use ``` symbols for multi-line code

    • Voice Recording

    • Emoji

    • File

    • Take Photo

    • Record Video

Settings Introduction

Changelog

CHANGELOG.md