Site announcement configuration

# Site Announcement Configuration

MrDoc supports publishing notifications, update notes, activity information, and other content to site visitors through the **Site Announcement** feature. Administrators can configure the display method, enabled status, validity period, and whether users can close the announcement.

## 1. Feature Entry

Log in to the MrDoc admin panel and go to:

**Site Management → Site Announcement**

After entering the Site Announcement page, you can view created announcements and perform operations such as adding, editing, deleting, and enabling/disabling.

## 2. Adding an Announcement

Click the **"Add Announcement"** button on the page to create a new site announcement.

### 1. Title

Enter the title of the announcement.

For example: `MrDoc New Version Release`

The title is used to identify the announcement content and will be displayed in the announcement display area.

### 2. Content

Enter the specific content of the announcement.

For example: `MrDoc Pro edition v1.5.5 has been released. This update adds the XXX feature and fixes the XXX issue.`

The announcement content is used to display detailed notification information to users.

### 3. Display Method

Used to set the display form of the announcement on the site. The following three methods are currently supported:

* **Top Banner**: The announcement is displayed as a banner at the top of the site page.
* **Popup**: The announcement content is displayed as a popup when users visit the site.
* **Both**: The announcement is displayed using both the top banner and the popup.

You can choose the appropriate display method based on the importance of the announcement.

For example:

* For general version update notifications, you can choose **Top Banner**.
* For important notifications that require user attention, you can choose **Popup**.
* For very important system maintenance or service change notifications, you can choose **Both**.

### 4. Redirect Link

Used to set the redirect address of the announcement.

After filling it in, users can navigate to the specified page through the announcement, for example:

* Version update notes
* Product activity page
* Usage documentation
* External website

This option is optional. If not filled in, the announcement is only used for information display.

### 5. Enabled

Used to control whether the announcement takes effect.

* **Enabled**: The announcement is displayed to users according to the configured display method.
* **Disabled**: The announcement is not displayed to users.

### 6. Closable

Used to control whether users can actively close the announcement.

* **Yes**: Users can close the announcement.
* **No**: Users cannot actively close the announcement.

If the announcement uses the **Popup** or **Both** display method, it is recommended to set whether closing is allowed based on the importance of the announcement.

### 7. Start Time

Used to set the time when the announcement starts being displayed.

This item is optional:

* **Not set**: The announcement is displayed immediately after being enabled.
* **Set time**: The announcement starts being displayed when the specified time is reached.

You can create an announcement in advance and control its official release time through the start time.

### 8. End Time

Used to set the time when the announcement stops being displayed.

This item is optional:

* **Not set**: The announcement continues to be displayed until the administrator manually disables it.
* **Set time**: The announcement automatically stops being displayed when the specified time is reached.

By setting both the start time and end time, you can achieve scheduled publishing and automatic removal of announcements.

## 3. Announcement Display Method Description

The main differences between the three display methods are as follows:

| Display Method | Top Banner | Popup |
| ---- | ---- | --- |
| Top Banner | ✓    | —   |
| Popup  | —    | ✓   |
| Both   | ✓    | ✓   |

**Top Banner** is suitable for regular notifications that do not significantly interrupt user operations; **Popup** is suitable for important notifications that require user attention; if you want to achieve both prominence and continuous reminder effects, you can choose **Both**.

## 4. Announcement Status Management

After creating an announcement, you can view and manage it in the site announcement list.

Common operations include:

* **Edit**: Modify the announcement title, content, display method, and other configurations.
* **Delete**: Delete announcements that are no longer needed.
* **Enable/Disable**: Control whether the announcement takes effect.

For announcements that are temporarily not needed for display but may continue to be used later, you can choose **Disable** instead of deleting them directly.

## 5. Announcement Display Time

Whether an announcement is ultimately displayed is affected by both the **enabled status** and the **start/end time**.

| Configuration              | Display Effect           |
| --------------- | -------------- |
| Enabled, no time set       | Displayed immediately after being enabled        |
| Enabled, only start time set     | Displayed after the start time is reached       |
| Enabled, only end time set     | Displayed after being enabled, stops after the end time |
| Enabled, both start and end time set | Displayed only within the specified time range    |
| Disabled             | Not displayed            |

## 6. Usage Recommendations

Site announcements are suitable for publishing information that users need to know in a timely manner, for example:

* MrDoc version update notifications
* Site maintenance notifications
* Service outage or recovery notifications
* New feature launch notifications
* Activity and operational information
* Important usage instructions

For long-term effective product introductions, feature descriptions, and usage tutorials, it is recommended to use regular documents or help pages instead of site announcements.

### Recommended Configurations

**Regular Version Update Notification**

> Display Method: Top Banner
> Enabled: Yes
> Closable: Yes
> Start Time: Not set
> End Time: Set as needed

**Important System Notification**

> Display Method: Popup
> Enabled: Yes
> Closable: Set based on the importance of the notification
> Start Time: Set as needed
> End Time: Set as needed

**Important Maintenance or Service Change Notification**

> Display Method: Both
> Enabled: Yes
> Closable: Set based on the importance of the notification
> Start Time: Can be set in advance
> End Time: Set to the notification end time

## 7. Notes

1. After an announcement is enabled, it will be displayed to site users according to the configuration. Please confirm that the title and content are correct before enabling it.
2. Announcements with a start time set will not be displayed before the start time is reached.
3. Announcements with an end time set will automatically stop being displayed after the end time is reached.
4. Popups are suitable for announcements of higher importance. It is not recommended to use popups to display regular notifications for a long time, so as not to affect normal user experience.
5. It is recommended to keep announcement content concise and clear. For longer explanations, you can use the **Redirect Link** to guide users to view the complete document.