Documentation of SFT&U

Simple Forum Tags and Utilities offers unique Tag and Forum features for Discord servers. This documentation provides an overview of the features and how to use them effectively.

Special Tags

Special Tags are custom behavior modifiers that affect how a post with the tag behaves. These tags can be applied to any forum post, changing how users can interact with the post.

NOTE: These tags rely on the tag's name. The tag must be added to a forum post either by manually adding a tag with the exact same name as the Special Tag created, or by using the /specialtags add command.
Available Properties
Property Description
Read Only Makes the post read-only. No one can reply to the post except for the OP, collaborators and Forum Staff.
Images When enabled, forces users to post images in the post, can be combined with 'Videos' and 'Links'. OP, collaborators and Forum Staff bypass this restriction.
Videos When enabled, forces users to post videos in the post, can be combined with 'Images' and 'Links'. OP, collaborators and Forum Staff bypass this restriction.
Links When enabled, forces users to post links in the post, can be combined with 'Images' and 'Videos'. OP, collaborators and Forum Staff bypass this restriction.
Reinforce Lock Reinforces post locked state, if unlocked and a message is sent the message is deleted and the post is locked. Also locks the post on creations.
Administrators Only Only administrators can interact with posts having this tag, deletes Regular Users and Moderators messages and keeps the post locked.
Prevent Close If closed, it is re-opened.
Lock on Close Automatically locks the post when it gets closed.
Delete on Close Automatically deletes the post when it gets closed.
Property Conflicts

Some properties conflict with each other and will be automatically adjusted when combined:

  • Read Only overrides all other properties. If enabled, all other properties will be automatically disabled.
  • Administrators Only takes precedence over Reinforce Lock. If both are enabled, only Administrators Only will remain active.
  • Prevent Close takes precedence over Lock On Close. If both are enabled, only Prevent Close will remain active.
  • Delete On Close takes precedence over both Prevent Close and Lock On Close. If Delete On Close is enabled along with either of these properties, only Delete On Close will remain active.

These conflict resolutions are handled automatically when creating or editing tags.

Toggle Tags

Toggle Tags are special tags that can be toggled on or off in a forum post when a user sends a message in the Post.

How Toggle Tags Work
  • Each forum channel can have up to 2 toggle tags.
  • Toggle tags are useful for marking posts as "Pending", "In Progress", "Solved", etc.
  • When a Close Tag is applied to a post (/close), any active Toggle Tags on that post are automatically removed.
Common Uses

Toggle tags are commonly used for:

  • Support forums (Resolved/Unresolved)
  • Project tracking (In Progress/Completed)
  • Question forums (Answered/Unanswered)

Auto Tags

Auto Tags are automatically applied to new posts in a forum channel. Each forum channel can have one auto tag.

How Auto Tags Work
  • When a user creates a new post in a forum channel with an Auto Tag configured, the tag is automatically applied.
  • This tag must be one of the tags available in that Discord forum channel.
  • Auto tags help ensure consistent tagging across all posts in a forum.
Note:

Auto tags must be created as tags in the Discord forum settings first before they can be configured in the dashboard.

Close Tags

Close Tags are automatically applied when using the /close command, which is available to the Original Poster (OP), users with Tag Manager roles, and Forum Staff.

How Close Tags Work
  • When a post is closed (using the /close command), the configured close tag is applied.
  • Each forum channel can have one close tag.
  • This tag must be one of the tags available in that Discord forum channel.

Close tags can be combined with special tag properties like "Delete on Close" for comprehensive thread management.

Auto Messages

Auto Messages are automated responses that are sent by the bot when a new thread is created in a forum channel. This feature is particularly useful for providing immediate guidance, instructions, or resources to users when they create new posts.

How Auto Messages Work
  • When a user creates a new thread in a forum channel with Auto Messages enabled, the bot automatically sends the configured message as the first reply
  • Each forum channel can have one auto message
  • Auto messages are sent with a disclaimer indicating they're from server staff, not the SFT&U team
Character Limits and Message Formatting

When creating auto messages, keep in mind the following:

  • Character Limit: Auto messages are limited to 1250 characters maximum
  • Message Formatting Variables: You can use special variables in your auto messages for dynamic content:
Variable Description Example
{user} Mentions the thread creator Hello {user}, welcome to your thread!
{reply} Makes the auto message a reply to the original post instead of a new message {reply}Thanks for posting!
{line} Inserts a line break in the message Line 1{line}Line 2
{da=seconds} Automatically deletes the message after specified number of seconds (max: 900 seconds/15 minutes) {da=300}This message will self-destruct after 5 minutes
Formatting Example

Here's an example combining multiple variables:

{reply}Hello {user}!{line}{line}Thanks for creating this thread. A staff member will assist you shortly.{line}{line}Please make sure to follow our guidelines while you wait.{line}{da=600}

This message will reply to the thread creator's post, address them by mention, include multiple line breaks for readability, and delete itself after 10 minutes.

Commands for Auto Messages
Command Description Required Permission
/automsg set Sets an auto message for a specific forum channel Administrator
/automsg remove Removes the auto message from a forum channel Administrator
/automsg view Views the current auto message for a forum channel Administrator
Best Practices for Auto Messages

Effective auto messages typically include:

  • Welcome: A brief welcome to the new thread creator
  • Guidelines: Basic rules or formatting expectations for the forum
  • Resources: Links to helpful resources or documentation
  • Next steps: What the user should do after creating their thread
  • Support information: How to get additional help if needed
Important Note

Auto messages are automatically cleaned up when a forum channel is deleted to keep the database tidy.

Tag Managers

Tag Managers are authorized roles with special permissions to manage tags and post states in forum channels. They have elevated permissions beyond regular users but don't need full moderator privileges.

Important Changes

Please note the following important changes to Tag Managers:

  • Roles Only: Tag Managers can only be roles now, not individual users
  • Authorization Required: Tag Managers have no tags by default and MUST be authorized before they can manage any tags
  • /close Command Enhancement: The /close command now accepts an override tag parameter, allowing you to specify a different tag than the default close tag
Tag Manager Permissions

Users with Tag Manager roles can:

  • Close forum posts using the /close command
  • Access the /manage commands to add, remove, and replace tags
  • Lock and or Close forum posts when using /manage add/remove/replace commands
  • Provide reasons for their actions that are visible to other users
Authorized Tags

Administrators must specify which tags a Tag Manager role can manage:

  • By default, Tag Managers cannot manage any tags until they are specifically authorized
  • Administrators must configure Authorized Tags to grant Tag Managers permissions to manage specific tags
  • Different Tag Manager roles can be authorized for different sets of tags
Command Description Required Permission
/authorizetag assign Assigns up to 5 tags to the authorized Tag Manager, can be used multiple times and accepts more than 5 tags (i.e. you can have 10 or more tags authorized) Administrator
/authorizetag revoke Revokes authorization for up to 5 tags from a Tag Manager role Administrator
/authorizetag list Lists all tags that a Tag Manager role is authorized to manage Administrator
Available Commands
Command Description
/close [tag] Closes the post and applies a tag. If a default close tag is configured, it will be applied automatically. You can specify an override tag parameter to use a different tag than the default. A default close tag is not required for this command to work.
/manage add Adds a specific tag to the post with an optional reason and options to close and lock the post.
/manage remove Removes a specific tag from the post with an optional reason and options to close and lock the post.
/manage replace Replaces one tag with another on the post with an optional reason and options to close and lock the post.
Setting up Tag Managers

Tag Managers are managed through the following commands:

Command Description Required Permission
/tagmanager add Adds a role as a Tag Manager (remember that roles must be authorized before they can manage any tags) Administrator
/tagmanager remove Removes a role from Tag Managers Administrator
/tagmanager list Lists all roles configured as Tag Managers Administrator

Assign the Tag Manager role to trusted roles and remember to authorize specific tags for these roles using the /authorizetag commands.

Best Practices for Tag Managers

Consider these approaches when implementing Tag Managers:

  • Topic-based management: Create different Tag Manager roles for different forum categories, with each authorized for relevant tags
  • Hierarchy: Junior moderator roles might only be authorized for basic tags, while senior moderator roles have access to more tags
  • Specialization: Some Tag Manager roles might only be authorized to manage technical tags, while others handle support-related tags

Guidelines Command

The /guidelines command allows moderators to post forum guidelines directly in a thread (post). This helps enforce rules and provide context for users within an active discussion.

How Guidelines Work

When used within a forum post, this command will post the guidelines that have been set in the forum channel's "Post Guidelines" field. There are three ways to use this command:

  • Post a specific section by name: /guidelines section:rulename - Posts just the section with a heading matching the name provided
  • Post a specific section by number: /guidelines section:1 - Posts the section by its numerical index (first header is 1, second is 2, etc.)
  • Post all guidelines: /guidelines entire:True - Posts the complete forum guidelines
Formatting Forum Guidelines

For section-based posting to work properly, format your forum guidelines with clear markdown headers:

# General Rules
This section contains general rules...

## Posting Format
This section explains how to format posts...

### Support Guidelines
This section explains how to ask for help...

With the examples above, you could access the sections as follows:

  • /guidelines section:0 - Any content before "General Rules" (if any)
  • /guidelines section:1 or /guidelines section:general rules - "General Rules" section
  • /guidelines section:2 or /guidelines section:posting format - "Posting Format" section
  • /guidelines section:3 or /guidelines section:support guidelines - "Support Guidelines" section
Permissions

The /guidelines command can only be used by tag managers and users with the "Manage Threads/Posts" permission. This ensures that only authorized users can post forum rules.

Logging

Logging allows server administrators to set up a designated channel where the bot will log all important actions performed by users. This provides transparency and accountability for moderation actions and tag management.

Setting Up Logging

Administrators can configure a log channel using either the dashboard or Discord commands:

Dashboard Method (Recommended)

The easiest way to set up logging is through the bot dashboard:

  1. Go to https://diggsly.ca/dashboard
  2. Select your server from the server list
  3. Navigate to the "settings" tab
  4. Select a text channel from the dropdown menu
  5. Click "Save Changes"

Alternatively, you can use the following Discord commands:

Command Description Required Permission
/admin log set Sets the specified text channel as the guild's log channel Administrator
/admin log show Shows the current log channel configuration Administrator
/admin log delete Removes the log channel configuration Administrator
What Gets Logged

The following actions are logged to the configured log channel:

Action Information Logged
Forum Post Closed
  • User who closed the post
  • Thread name and link
  • Forum channel name and link
  • Tags applied or removed
  • Reason (if provided)
Tag Added
  • User who added the tag
  • Thread affected
  • Tag name
  • Reason (if provided)
  • Additional actions (locked/closed)
Tag Removed
  • User who removed the tag
  • Thread affected
  • Tag name
  • Reason (if provided)
  • Additional actions (locked/closed)
Tag Replaced
  • User who replaced the tag
  • Thread affected
  • Old and new tag names
  • Reason (if provided)
  • Additional actions (locked/closed)
Special Tag Created
  • User who created the tag
  • Tag name
  • Enabled properties
Tag Manager Added/Removed
  • Administrator who made the change
  • User or role affected
  • Action (added/removed)
Bulk Tag Operations
  • User who performed the operation
  • Operation type (add/remove)
  • Tags affected
  • Number of threads modified
Tag Property Executions
  • Administrators Only: When a non-admin message is deleted from a thread with this property
  • Reinforce Lock: When a thread is locked and unauthorized messages are deleted
  • Read Only: When messages from non-OP/collaborators are deleted in a read-only thread
  • Images/Videos/Links: When messages without required attachments are deleted
  • Prevent Close: When a thread is automatically reopened after being closed
  • Lock on Close: When a thread is locked upon being closed
  • Delete on Close: When a thread is deleted upon being closed
Toggle Tags
  • Forum channel name and link
  • Thread name and link
  • Tags added or removed during toggling
Autotag Application
  • Tag name that was auto-applied
  • Forum channel name and link
  • Thread name and link
Thread Locked on Creation
  • Tags that triggered the lock
  • Properties enforced (admin_only or reinforce_lock)
  • Forum channel and thread details
Required Permissions & Recommendations

For logging to function correctly, ensure the bot has the following permissions in the designated log channel:

  • View Channel: Allows the bot to see and access the channel.
  • Send Messages: Allows the bot to post log entries.
  • Embed Links: Allows the bot to format log entries properly using embeds.

Recommendation: Create a dedicated channel (e.g., #sftu-logs) for logging. Restrict access to this channel to administrators and moderators (or whoever should have access to this info) to keep logs private and organized.

Tools

The Tools module provides powerful commands for efficient management of forum posts..

Available Tool Commands
Command Description
/tool remove tags Removes specified tags from multiple forum posts in bulk using post IDs. Must have "manage_threads"
/tool set tags Adds specified tags to multiple forum posts in bulk using post IDs. Must have "manage_threads"
How Tool Commands Work
  • These commands operate on multiple forum posts at once using post IDs
  • If a post is closed, the command will temporarily open it, perform the tag operation, and then close it again
  • Tool commands are especially useful for forum reorganization, applying new tagging systems, or cleaning up outdated tags
Permissions

Tool commands can be used by Tag Managers (sometimes) or users with the "Manage Threads/Posts" permission. Use these commands carefully as they affect multiple posts at once.

Utility

These utility commands provide helpful features for users in a variety of contexts.

Available Utility Commands
Command Description
/top Gets a link to the very first message in the current channel, thread, or forum post. This is useful for quickly navigating to the beginning of a long discussion.
/help Provides links to this documentation and the support server for additional assistance.
Using the /top Command

The /top command helps users quickly navigate to the beginning of long discussions:

  • Works in text channels, threads, forum posts, and voice channel text chats
  • Returns a direct link to the very first message
  • Response is only visible to the user who ran the command (ephemeral message)
  • While threads and forum posts have built-in Discord functionality to jump to the top, this command is especially useful in regular text channels where no such option exists
Tip for Long Channels

The /top command is particularly valuable in regular text channels with extensive history, where Discord doesn't provide a native "jump to top" button. While it's also available in threads and forum posts for consistency across all channel types, regular text channels benefit the most from this functionality.

OP Commands

OP Commands are special actions available via the context menu (right-click on a message) that can be used by the Original Poster (the creator of a forum post), collaborators, and moderators. These commands provide thread creators with additional control over messages within their posts.

Available OP Context Menu Commands
  • Delete Message: Allows the OP, collaborators, or staff to delete a specific message within the thread if the message author is not the OP, a collaborator, staff, or a bot.
  • Clear Reactions: Allows the OP, collaborators, or staff to clear all reactions from a specific message if the reactions were added by users who are not the OP, a collaborator, staff, or a bot.
Enabling OP Commands

OP Commands must be enabled for each server in the Dashboard settings. When enabled, original posters can manage their own threads without moderator intervention.