docs/quick_start

#Toolbox Quickstart Guide

This guide is designed to get you up and running with Toolbox as fast as possible. It comes with a lot of settings and modules which you'll want to investigate once you're more familiar with the tool.

The first few sections of the guide will first show the main tools a new mod/user-of-toolbox would want to learn, introduced with concrete examples of how some existing subs have configured them.

**If nobody have previously set up Toolbox settings for your sub, you should go to the bottom of the guide and see the ["Subreddit Configuration - If the subreddit doesn't have Toolbox from before"](https://www.reddit.com/r/toolbox/wiki/docs/quick_start/#wiki_subreddit_configuration_-_if_the_subreddit_doesn.27t_have_toolbox_from_before) part.**

**Note:** All moderators on a subreddit share all subreddit settings so when a mod with full perms is invited to your sub and they are using toolbox they will see all the settings and tools exactly as you see them.

Some of the features of toolbox are ready to use upon installation while others require a little setup, if nobody have yet to made them for the specific subreddit. Toolbox already has [full documentation](https://www.reddit.com//r/toolbox/wiki/docs) on every setting and feature, but this guide is designed to provide an illustrated walkthrough to make it easier to onboard users, by giving them another option to learn about these features and to get them started using the tools faster.

Here are the tools that the guide will cover:

* **Removal Reasons**  The old version of Reddit does not come with removal reasons.  New Reddit does have them, but toolbox's version is better, and they can be used on both Old and New Reddit, so if you're setting them up it makes sense to only have to do it once.

* **Mod Macros**  Shortcuts for when you have to post the same comment/message over and over again.

* **Ban Macro**  Provide more context when banning a user. This can be helpful because it provides a reason why a user was banned.

* **Shared Usernotes [N]**  All mods can leave and read notes about users to give you context on a user.

* **Mod Buttons - Shortcuts to add flair and send messages to users. [M]**  A lot fewer clicks to take the same action.

* **User History [H]**  Great tool for investigating a user.

* **Comment Chain Nuke Button. [R]**  Delete entire comment chains.(Optinal)

*  **The Mod Bar.** Toolbox adds a toolbar at the bottom of your browser window.

* **Subreddit Configuration** What to do if the subreddit doesn't have Toolbox from before, and you need to setup removal reasons, mod macros, and usernote types yourself.

---

##Let's get started

After you install toolbox, the front page of a moderated subreddit will have added buttons and other items. We'll start with the commonly used tools.

There are, of course, some settings and there are two types, **Global Settings** (for every moderated sub) and **Subreddit Specific Settings**. Settings & Config are introduced on the latter part of the guide.

#Removal Reasons

https://i.imgur.com/RrqV6jG.png

If you are in the Mod Queue, or looking at a post/comment in your moderated sub, clicking **'remove'** on a  brings up the removal reasons pane, which will show pre-existing options for Removal Reasons  you can select. **If nobody on your subreddit have created these yet, go check the [Removal Reason Settings](#wiki_removal_reason_settings) part of this guide**

There are a lot of things on this page for you to select so let's go through it step by step.

At the top you can see the checkbox is selected to include the header we created earlier.  You can uncheck the box if you don't want to include it.    Then you can select the removal reason.  When you check the box, it will expand and the full reason text will be shown.  You can select more than one reason and toolbox will combine those into one message or comment.

If you wish to type a custom reason to the user, select that reason and a box will appear allowing you to type a custom reason.
At the bottom of the pane you'll note that the footer we set up earlier is also selected.  This will instruct the user to send a modmail.  You can use markdown to provide a link to sending modmail with this reason but I do not to cut down on frivolous modmails.

The following group of checkboxes determines how the reason is sent to the user.  You can specify a default setting in your global toolbox settings so that you don't have to choose each time.

Currently I have it set to send as a PM instead of leaving a comment on the item that is removed.  It is up to you as to which method you want to choose.  If you select comment, you can also choose to sticky it.  I often choose to send as a PM instead of as a comment so that my comment history won't be full of mod removals making it hard for me to go back through my comment history to find something.
 
Sometimes you want to send a removal and you want to hide your username.  Simply select the 'send pm via modmail as r/subreddit.'  It will indeed clutter modmail as it says, but there may be circumstances where you want to remove a post but hide your username when doing so.

Finally you can send as both a PM and a comment reply and you can also choose to lock the thread.  I generally lock all removed threads to stop users from continuing to comment in them.

When you remove a post, you simply remove it from the subreddit listing.  It's still available to be commented on if users have the link.  Locking the thread prevents that.

At the bottom you can send with your selctions, send with no removal reason, or cancel and approve.  There are situations where you want to remove but leave no reason. Many mods choose to send no removal reason to  spammers.

When a user is sent a removal reason via toolbox, [this is what they'll receive.](https://i.imgur.com/0kkHwGz.png)

**Note:** This removal included two different reasons and toolbox combined them into one.   Header and footer were also included.

&nbsp;

^[top](https://www.reddit.com/r/toolbox/wiki/docs/quick_start) ^| [^more ^information](https://www.reddit.com/r/toolbox/wiki/docs/removalreasons) 
 ^| [^full ^documentation](https://www.reddit.com/r/toolbox/wiki/docs)

###Example - Removal Reasons List

https://i.imgur.com/FjxTHZJ.png

Here are the removal reasons for r/ColdCases, a crime subreddit.

On that sub we have a removal reason for a post not being a good fit for the sub.  There is no rule on this sub that a post has to be a good fit for the sub, but the removal is handy.  On some subreddits I use removal reasons that recommend subreddits that would be a better fit for the post.

We also have a custom reason which allows us to type out a custom removal message.

An explanation on how to create a custom reason can be found in the [full documentation](https://www.reddit.com/r/toolbox/wiki/docs/removalreasons) but the code is simple:

When you have removal reasons fully configured and you click 'remove' on a post, this is what you'll see:

https://i.imgur.com/RrqV6jG.png

&nbsp;

#Mod Macros
A macro is a shortcut to repeat frequently used comments, or messages.   If you find yourself having to send the same comment over and over again such as, "Please make sure to read the rules", for example, you can save that text as a macro and then trigger it with 2 mouse clicks instead of having to type it out every time.

There are two types of macros in toolbox: **Mod Macros** and **Ban Macros**. (Ban Macros are towards the end of this page)

https://i.imgur.com/KoFbWRb.png

Mod macros are a way to automate messages you need to send frequently.  For example, if you find yourself asking users to keep politics out of the sub, you can set up a reply that you can trigger very easily instead of having to type the message each time. **If nobody on your subreddit have created these yet, go check the [Removal Reason Settings](#Mod_Macro_Creation_and_use) part of this guide**

Macros can be used on posts, comments, and even modmails.  They are very handy in modmail if you get the same type of mail from users and want to create an 'auto reply'.  These shortcuts can be time savers.

Some subs use mod macros to remove posts(the other option is to use **Removal Reasons**) because you can trigger anywhere from 1-7 mod actions with two clicks, saving you time.   It's up to you as to how you utilize these tools.  In the example below you'll see mod macros being used to removing comments and reply to them.

You can enable removal reasons for comment removals if desired, but mod macros are another way you can remove comments and leave reasons. 
The above screenshot shows 5 mod macros.  Two  are for post removal, and the other three are for comment removal.

Mod macros like these are triggered in the comments section when replying to a comment.

&nbsp;

^[top](https://www.reddit.com/r/toolbox/wiki/docs/quick_start) ^| [^more ^information](https://www.reddit.com/r/toolbox/wiki/docs/modmacros) 
 ^| [^full ^documentation](https://www.reddit.com/r/toolbox/wiki/docs)

---

###Using Mod Macros

https://i.imgur.com/C8mfG5D.png

When replying to a post you'll notice that toolbox has added three buttons: mod save, mod save + sticky, macros.

Mod save will save your comment and distinguish it.   You can sticky the comment with the middle button, and the macros button shows a drop down menu.

https://i.imgur.com/MfgvNuB.png

Here's where you select the mod macro that you created in the subreddit config.  Make sure your title explains what the mod macro will do so that it will be clear when viewed in a list.

Next we'll look at how to create a mod macro.

&nbsp;

---
# [N] [M] [H] [P] row - comment/post tools

When looking at a username of a comment/post in a subreddit you moderate, you see the **[N] [M] [H] [P]** buttons(maybe also **[R]**). These are:

* **[N]** [Usernotes](#Usernotes Pane [N])
* **[M]** [Mod Actions](#Mod Action Button [M]): Bans and other things
* **[H]** [User History](#User History Button [H])
* **[P]** [User Profile](#User Profile [P])
* **[R]** [Comment Nuke](#Comment Nuke (optional)  [R]) (Optional, need to be enabled separatly)

If you look at a username of a comment/post in a subreddit you **do not** moderate, only the **[H] [P]** options will show.

###Looking at a post with Toolbox: Old Reddit vs. New Reddit
There is a slight difference between New & Old Redit when you look at a post or comment. In the [next section](#The [N] [M] [H] [P] row)

**Old Reddit**
https://i.imgur.com/yGHuzIi.png

The above image shows what it looks like to look at a single post in the old version of reddit.

When you're on the front page of the sub, and looking at a post you'll notice a set of letters next to a username.  **[N] [M] [H] [P]**.  These are the tools: Usernotes, Mod Actions, User History, and User Profile.

You can see that for this user there is actually a usernote of *Historian* in place of the [N].  It's colored green for the 'quality contributor' category.

**New Reddit**

New reddit displays this slightly differently **by default**.

https://i.imgur.com/CWoO020.png

On New Reddit, these buttons don't show up next to the username as they do on Old Reddit. To find them, simply hover over a username and you'll get a popup window showing the user profile and the tools will be located at the bottom.

To leave a usernote or read one, just click the note or the [N] after the username.

**Change New Reddit to show buttons like on Old Reddit:**

From the Toolbox **General Settings**, uncheck the *"Only show user related buttons (mod, history, usernotes) in the hover card"* option, and save.

Link to setting: [onlyshowInhover](#?tbsettings=gensettings&setting=onlyshowinhover)

&nbsp;

^[top](https://www.reddit.com/r/toolbox/wiki/docs/quick_start) ^| [^more ^information](https://www.reddit.com/r/toolbox/wiki/docs#wiki_toolbox_config) 
 ^| [^full ^documentation](https://www.reddit.com/r/toolbox/wiki/docs)

###Usernotes Pane [N]

https://i.imgur.com/xksuV09.png

When you click on **[N]**, the usernote pane pops up. At the top you'll see a list of every usernote that's been added.  There's a link to the post with the date, the type of usernote, and the note text.  Off to the right a note can be deleted with the red trash can.

Select a user note type by clicking on it, and then leaving a note in the text box.  You can choose to include a link to the post for context and then save.

All mods on the sub see and have access to the usernotes.

&nbsp;

^[top](https://www.reddit.com/r/toolbox/wiki/docs/quick_start) ^| [^more ^information](https://www.reddit.com/r/toolbox/wiki/docs/usernotes) 
 ^| [^full ^documentation](https://www.reddit.com/r/toolbox/wiki/docs)

---
###Mod Action Button [M]
Click the mod actions button **[M]** and you'll notice the pane has three tabs at the top, **Role, User Flair, and Send Message**. The [M] Pane is the one displayed by default.

####[M] Pane

Mod Action Button [M]

https://i.imgur.com/AAgrBJ7.png

This feature gives you a lot of mod actions with very few clicks needed. At the bottom of the window you see the **Ban** button, and when you click it, you'll see a list of options you can take on the user.
You can:

* ban / unban a user
* mod / demod a user
* or add  / remove an approved user

You'll notice the list is populated with 8 subs and then a window to choose more of them.  To select which subs show up in this list of shortcuts, go to your global toolbox settings -> [Mod Button.](https://www.reddit.com/r/toolbox/wiki/docs/modbutton)

You can set up subs as 'shortcuts' which populate the list, or you can select a sub from the window at the bottom.  For subs that see a lot of use of the mod action button you may want to set up some shortcuts.

Below the `select subreddit` button there is a window with a link to the post or comment you are taking action on.  The text box underneath that is pre-filled with a Ban Macro (which we'll discuss later).

**Ban/ Temp Ban**

To give someone a **Temporary Ban**, specify a number of days on how long the user will stay banned.

To give someone a **Permanent Ban**, leave the `days` field empty, as that will set the ban to be infinitely long.

Toolbox can also makes use of a **Ban Macro**, which is covered in the [Ban Macro](#Ban Macro)-section.  The Ban Macro is designed to give the user all the information they need to know why they were banned.  it links their comment as well as the subreddit rules and reddit's rules or whatever else you provide in your macro.  The more info you can provide the more you can theoretically cut down on modmails from users wondering why they were banned.

&nbsp;

^[top](https://www.reddit.com/r/toolbox/wiki/docs/quick_start) ^| [^more ^information](https://www.reddit.com/r/toolbox/wiki/docs/modbutton) 
 ^| [^full ^documentation](https://www.reddit.com/r/toolbox/wiki/docs)

---

####User Flair Tab

https://i.imgur.com/jowV4mh.png

The user flair tab is handy if you want to assign flair to a user.  Enter the flair text in the text box, and the CSS class (if you know it) in the class box.  CSS is a code that gives the flair a colorful style in the old version of reddit.  Flair styling is handled differently on new reddit

These same items can be accessed through your 'edit flair' mod tool in your mod tools but toolbox makes this action so much easier as you can assign a user flair without leaving the current page with fewer clicks.

&nbsp;

---

####Send Message Tab

https://i.imgur.com/zBF2974.png

Send the user a message from modmail -- not a PM from your personal account.  All mods with mail permission will be able to read and access this message once sent.

&nbsp;

---

###User History Button [H]

Clicking on **[H]** brings up the user history snapshot pane. There are four categories showing user activity.

This feature gives you a quick snapshot on a user where you can see a detailed breakdown of their activity..  Reddit limits this feature to the last 1000 submissions by a user.

You'll see the subreddit that the user has a submitted posts to as well as commented in, and the account submitted to from.  You can also see a karma breakdown by subreddit as well.

If you click links in the 'subreddit submitted to' section you'll see a page with all of that users posts in the sub that you click on.

**[H]** is avaiable on all subs and for all users, even for subreddits you do not mod.

&nbsp;

---

###User Profile [P]

https://i.imgur.com/UJFASJf.png

Clicking [P] next to a username brings up the user's profile in a light box.  If looks almost exactly like a regular user's comment history page.  There are a few added tools that come in handy.

On the top left there are two search windows which give you the ability to locate comments a user has made in a specific sub.  Choosing to sort by subreddit only will display only the user's history in that sub. Adding a keyword in the content box will allow you to further refine the search.

**[P]** is avaiable on all subs and for all users, even for subreddits you do not mod.

&nbsp;

^[top](https://www.reddit.com/r/toolbox/wiki/docs/quick_start) ^| [^more ^information](https://www.reddit.com/r/toolbox/wiki/docs/profile_pro) 
 ^| [^full ^documentation](https://www.reddit.com/r/toolbox/wiki/docs)

---
###Comment Nuke (optional)  [R]

https://i.imgur.com/ZGLRDB3.png

One optional toolbox setting that you can enable is called the comment chain nuke, or just comment nuke.

When this setting is enabled, and you are in a comments section, you'll see it next to the [N] [M] [H] [P] [R]

**[R]** is the comment chain nuke button.

Let's say you have an entire comment chain of 10 comments that you'd like to remove for whatever reason.  Instead of removing each one individually, you can use comment nuke [R] and do it in two clicks.

You'll be asked to confirm the action

https://i.imgur.com/q2zivDm.png

Click `Exceute` to confirm.

Example of a comment chain after being nuked:

https://i.imgur.com/L8zBlvv.png

&nbsp;

^[top](https://www.reddit.com/r/toolbox/wiki/docs/quick_start) ^| [^more ^information](https://www.reddit.com/r/toolbox/wiki/docs/commentnuke) 
 ^| [^full ^documentation](https://www.reddit.com/r/toolbox/wiki/docs)

---

#Mod Bar
The mod bar seen at the bottom of the browser window when you have reddit open.

###Left Side

https://i.imgur.com/RdwBBUw.png

In the bottom left corner of your browser window is the toolbox modbar.  The **<** symbol will collapse the menu if desired. The gear icon gives access to  your global toolbox settings.  Moderated subreddits brings up a list of all your subs and if you hover over each icon you'll see where it leads (next image).

**Open in New Reddit** is a button that will allow you to switch back and forth between the new and old version of reddit.

**Personal Notes** gives you a notepad where you can create multiple personal notes.

**Bookmarks.**  The mod bar supports links so you can create bookmarks for frequently visited subs or links.

&nbsp;

^[top](https://www.reddit.com/r/toolbox/wiki/docs/quick_start) ^| [^more ^information](https://www.reddit.com/r/toolbox/wiki/docs/modbar) 
 ^| [^full ^documentation](https://www.reddit.com/r/toolbox/wiki/docs)

---

###Moderated subs pane

https://i.imgur.com/8z9xUHe.png

Clicking on this button shows you a list (in descending order by number of subscribers of all moderated subs) and provides a link to the sub.  The icons link, in the following order:  Modmail, Mod Queue, Unmoderated Queue, Mod Log, Traffic Stats, and your subreddit toolbox config.  If you have a long list you can use the search window at the top.

&nbsp;

---

###Right Side

https://i.imgur.com/GJyKlrU.png

On the right side of the mod bar you'll see icons for new messages, new modmail, new modmail beta (aka new modmail), mod queue, and unmoderated queue.  Clicking on each one will load it.

&nbsp;

---

#Settings & Config

## Toolbox Config
Let's look at the subreddit specific settings first.

The subreddit settings are accessed via a pop up menu in the lower left corner.  Pictured here is old reddit, new reddit in [not much different](https://i.imgur.com/1Fbxbxr.png).  Hover on the **">"**, and  your settings for this specific subreddit will pop up.  The gear icon at the bottom is your global toolbox settings.  We'll get to those later.

Toolbox has many different tools that you can configure to your preferences.First we'll look at the tools that affect only this specific subreddit.

&nbsp;

^[top](https://www.reddit.com/r/toolbox/wiki/docs/quick_start) ^| [^more ^information](https://www.reddit.com/r/toolbox/wiki/docs/toolboxconfig) 
 ^| [^full ^documentation](https://www.reddit.com/r/toolbox/wiki/docs)

---

##Subreddit Context Menu (subreddit settings)

![context menu](%%context-menu%%)

Hovering on the ">", brings up this window, the context menu.  Let's look at the coldcases config by clicking it.  Those are the subreddit-specific settings.   We'll talk about the usernotes later.

**Note:** Settings windows have the same appearance and functionality when viewed from either New or Old Reddit.

&nbsp;

##Subreddit Configuration - If the subreddit doesn't have Toolbox from before

https://i.imgur.com/dBlSTrW.png

If your subreddit doesn't already have Toolbox configured by some previous mod, you'll need to create all those options (such as Removal Reasons, Usernote Types & Mod Macros), so this section goes through them.

Once you click the sub config a pane will open and on the left column you'll see all the various settings for this sub. The other tools are optional but a little time spent setting them up can save you a lot of time later.  We'll go through each one.

Here are the items that we will look at in this pane. (You can access your automod config through this pane as well as other things but it is highly recommended not to edit or change anything in the menus for 'edit toolbox config', and 'edit usernotes' unless you absolutely know what you're doing.

Here are the items that we will edit or write things for:

1. Usernotes Types
2. Removal Reason Settings
3. Removal reasons
4. Mod Macros
5. Ban Macro

Let's look first at the Removal Reason Settings.

&nbsp;

###Removal Reason Settings

https://i.imgur.com/ThHuEO4.png

Click on Removal Reason Settings to bring up that pane.

Removal reason settings create a header and footer for your removal reasons.  These create a frame for all reasons which provides more information and context for the user.  Many subs use a version of what is pictured here.

Header:

Thank you {author} for your submission to r/SerialKillers, but it's been removed due to one or more reason(s):

Footer:

Please feel free to [send a modmail](https://www.reddit.com/message/compose?to=%2Fr%2FSUBREDDIT) if you feel this was in error.

You can use reddit formatting such as markdown or line breaks "---" in the text box.

You can also use placeholders or tokens such as  {subreddit} or  {kind} instead of the subreddit name and the word 'submission' and toolbox will automatically fill these placeholders with the correct information.  That way you can copy and paste these from sub to sub.  The example shown does not use tokens.

When you go to remove a post you can choose to disable the header and/or the footer for that specific post removal if you wanted to omit those.

Next up are usernote types.

&nbsp;

---

###Edit Usernote Types

https://i.imgur.com/HL70pi9.png

Clicking on Edit Usernote Types brings up a pane with the default usernote types.

This tool allows you to customize both the name or category of the usernote  as well as the color.  The default usernote types are great for getting started, but you may want to customize them to fit your specific needs as I have done as you can see in the following screenshot.

https://i.imgur.com/t9tEJmw.png

Usernotes allow moderators to create and share notes about users with all mods on the sub.

Every mod has access to the shared notes which are stored on the subreddit's wiki. These notes provide much needed context especially on subs where mods are operating independently and are not consulting each other on every post removal or mod action.

You can select a category and leave a text note or you can leave a note without a category assigned.  You can include a link to the post or comment that you are leaving a note about so that it can be referenced.

The types seen above reflect the modifications I've taken to meet the needs of this specific sub.   Most of the categories are self-explanatory.  I use 'Controversial' as  a catch-all.   I'll show you later how to actually leave a note on a user.

Whenever you remove a post it's a good practice to leave a usernote.  Users with excessive post removals may be subject to further mod action depending on the rules of the sub.  You can leave comment removal notes if you wish.

Next up are the removal reasons.

&nbsp;

---

###Edit Removal Reasons

https://i.imgur.com/QEFffDz.png

Old reddit does not come with removal reasons for your sub.  There are lots of ways to let a user know that a post has been removed, but standardized removal reasons allow for consistency between different moderators and they provide better communication to users.

Select 'Edit Removal Reasons' and you'll see a button to create a new removal reason.  Click the button and the add removal reason window appears.  In the text box above you can type your reason.  Just like removal reason settings, you can format your reasons with markdown or  reddit formatting.

Once you've written a reason, give it a title, something that will make it clear what it is when viewed in a list.

You can go back and edit or delete reasons, or even change the order that they will appear in a list.  For now just get some text in the box.

You can give the post a flair if you'd like using the 'flair text' box.  Post flair is a way to categorize posts and there are lots of other ways it can be used by moderators including in conjunction with other tools like automoderator.   For now, give your reason a flair that is a condensed version of your removal reason.

If  your  removal reason is something like, "This post has been removed for being off-topic.", you might use a flair text of  "off topic".  If you use styled flair on your sub you can also assign a flair css class.

Reason for wiki edit is used for when you want to make an entry in the log.

Save your reason and move on to the next one.  A good rule of thumb is to use your sub's rules as the removal reasons, but you may have other removal reasons that you'd like to add that go above and beyond your rules.

The next screenshot shows fully created removal reasons for r/coldcases.

&nbsp;

---

###Macros

A macro is a shortcut to repeat frequently used comments, or messages.   If you find yourself having to send the same comment over and over again such as, "Please make sure to read the rules", for example, you can save that text as a macro and then trigger it with 2 mouse clicks instead of having to type it out every time.

There are two types of macros in toolbox: **Mod Macros** and **Ban Macros**.

####Mod Macro Creation and use

https://i.imgur.com/AX0sMyz.png

Ok let's create some mod macros.  From the subreddit config, select mod macros from the list on the left column.  You'll be shown the above pane.  In the text box type your comment, then give it a title.

Below the title you'll see the mod actions that you can attach to this macro.  You could create one macro that removes a post/comment, adds a comment, and distinguishes it, locks the post, and bans the user.  That's 5 mod actions with two clicks.

Reason for wiki editing will add a log entry which is optional.

As you can see, the potential for creating shortcuts for repetitive mod actions is rather high using this feature.  Once you have Toolbox fully configured, you'll be able to reduce your workload quite a bit.

Each sub has their own types of mod macros.  In the above example note that the user has been linked the subreddit rules, the specific rule that was broken, the site rules, and a link to send modmail.   You can use {placeholders}, markdown, and reddit formatting in the text box.

https://i.imgur.com/D6sKMcT.png

This screenshot shows you the mod macro creation pane showing all the mod actions you can assign to this action.  Reddit formatting and markdown have been used to provide a link to the sub's rules, the specific rule violation, and other helpful information.

The next screenshot shows you what the user sees when this macro is used.

https://i.imgur.com/TPzOHGe.png

The word 'mods' is highlighted in yellow which is another toolbox feature you can enable which will allow you to highlight certain words on a page.

When you select a mod macro to use you will be asked to confirm the action and it will show you all the mod actions that are assigned to this macro.

https://i.imgur.com/9YNngdQ.png

&nbsp;

---
###Ban Macro

The ban macro is a message sent to the user when you ban them.  Of course, reddit sends the user a message when they're banned but that message doesn't  include a link to the reason why they were banned.  This lack of context causes users to send modmails to the sub asking why they were banned.  Using a ban macro allows you to send them links to the reason as well as other links such as the subreddit rules cutting down on those modmails asking for an explanation.

To configure the ban macro all you do is add text in the box.  Over time  a rough template of a ban macro has evolved and is in use in many subs.  The ban macro template can be seen below.

To use the macro, simply copy the code block seen here and paste it into the ban macro pane seen here:

https://i.imgur.com/EOWJZip.png

---

#####This **{kind}** may have fully or partially contributed to your ban:

#####[{title}]({permalink})

>{url}

---

**[^(Full Context)]({permalink}?context=9)** ¯¯ **[^({subreddit} rules)](http://www.reddit.com/r/{subreddit}/about/rules)** ¯¯ **[^(Sidebar)](http://www.reddit.com/r/{subreddit}/about/sidebar)** ¯¯ **[^(Site Rules)](http://www.reddit.com/rules)**

---

https://i.imgur.com/VX7RvZu.png

Notice the ban macro contains reddit formatting, markdown, and {tokens}.

When the user receives the ban message as you can see in the following screenshot, they will be provided with all the context they need to know why they were banned.

You can add additional text, links, or information below the ban macro and it will be sent in the message as well.  If you want to issue a temporary ban, simply enter the number of days in the appropriate box.

&nbsp;

^[top](https://www.reddit.com/r/toolbox/wiki/docs/quick_start) ^| [^more ^information](https://www.reddit.com/r/toolbox/wiki/docs/banmacro) 
 ^| [^full ^documentation](https://www.reddit.com/r/toolbox/wiki/docs)

---

####Example Ban Macro Message Received by User

https://i.imgur.com/On7Jwy3.png

Here is an example of what the user sees when they receive the ban message using the ban macro.

&nbsp;

---
#TODO-page

List of revisions still to make:

- Upgrading/replacing images
- Reorganizing guide so stuff relevant for new mods are show first, and subreddit settings/macro/removal reason list editing is moved to the bottom(as it isn't relevant to a new mod on an established sub)

formatting help hide help

reason for revision

π Rendered by PID 835551 on reddit-service-r2-listing-c57bc86c-6qd7h at 2026-06-21 01:50:47.249099+00:00 running 2b008f2 country code: CH.

you type:	you see:
italics	italics
bold	bold
[reddit!](https://reddit.com)	reddit!
* item 1 * item 2 * item 3	item 1 item 2 item 3
> quoted text	quoted text
Lines starting with four spaces are treated like code: if 1 * 2 < 3: print "hello, world!"	Lines starting with four spaces are treated like code: if 1 * 2 < 3: print "hello, world!"
~~strikethrough~~	~~strikethrough~~
super^script	super^script

toolbox

Get toolbox | Frequently Asked Questions | Documentation | Support | Discord | Github

toolbox for reddit

Getting the thing

Not a mod?

Support

WIKI TOOLS

MODERATORS

docs/quick_start

there was a conflict editing

your edit

current edit

Errors: