OUGC Show In Portal

---

Allow moderators to choose what threads to display in the portal.

📜 Table of Contents

• About
• Getting Started
  • Dependencies
  • File Structure
  • Install
  • Update
  • Template Modifications
• Settings
• Usage
• Built Using
• Authors
• Acknowledgments
• Support & Feedback

🚀 About

An essential tool empowering forum moderators with enhanced control over thread visibility in the portal landing page. This intuitive plugin allows specific moderator groups to easily mark threads for display in the portal. Users benefit from a 'read more' tag that links to the complete full thread to continue reading and participate in the discussion. Additionally, you will have the option to send private messages or MyAlerts notifications to thread authors, informing them about their thread's status on the portal. With added functionality to filter portal threads by forum and custom moderation tools, this plugin ensures efficient and effective thread management for a dynamic forum experience.

Go up to Table of Contents

📍 Getting Started

The following information will assist you into getting a copy of this plugin up and running on your forum.

Dependencies

A setup that meets the following requirements is necessary to use this plugin.

• MyBB >= 1.8
• PHP >= 7.0
• PluginLibrary for MyBB >= 13
• MyAlerts >= 2.0.4 (Optional)

File structure

 .
 ├── inc
 │ ├── plugins
 │ │ ├── ougc
 │ │ │ ├── ShowInPortal
 │ │ │ │ ├── Hooks
 │ │ │ │ │ ├── Admin.php
 │ │ │ │ │ ├── Forum.php
 │ │ │ │ ├── Templates
 │ │ │ │ │ ├── editPost.html
 │ │ │ │ │ ├── newReply.html
 │ │ │ │ │ ├── newThread.html
 │ │ │ │ │ ├── quickReply.html
 │ │ │ │ ├── settings.json
 │ │ │ │ ├── Admin.php
 │ │ │ │ ├── Core.php
 │ │ ├── ougc_showinportal.php
 │ ├── languages
 │ │ ├── espanol
 │ │ │ ├── admin
 │ │ │ │ ├── ougc_showinportal.lang.php
 │ │ │ ├── ougc_showinportal.lang.php
 │ │ ├── english
 │ │ │ ├── admin
 │ │ │ │ ├── ougc_showinportal.lang.php
 │ │ │ ├── ougc_showinportal.lang.php

Installing

Follow the next steps in order to install a copy of this plugin on your forum.

1. Download the latest package from the MyBB Extend site or from the repository releases.
2. Upload the contents of the Upload folder to your MyBB root directory.
3. Browse to Configuration » Plugins and install this plugin by clicking Install & Activate.

Updating

Follow the next steps in order to update your copy of this plugin.

1. Browse to Configuration » Plugins and deactivate this plugin by clicking Deactivate.
2. Follow step 1 and 2 from the Install section.
3. Browse to Configuration » Plugins and activate this plugin by clicking Activate.

If you are updating to 1.8.36 from any previous version:

1. After following the above steps, make sure to review your settings and templates as they were updated for this version.

Template Modifications

To display the moderation option it is required that you edit the following templates for each of your themes.

1. Open the editpost_postoptions template for editing.
2. Add <!--OUGC_SHOWINPORTAL--> after {$signature}.
3. Save the template.
4. Open the newreply_modoptions template for editing.
5. Add <!--OUGC_SHOWINPORTAL--> after {$stickoption}.
6. Save the template.
7. Open the newthread_postoptions template for editing.
8. Add <!--OUGC_SHOWINPORTAL--> after {$disablesmilies}.
9. Save the template.
10. Open the showthread_quickreply template for editing.
11. Add <!--OUGC_SHOWINPORTAL--> after {$closeoption}.
12. Save the template.

Go up to Table of Contents

🛠 Settings

Below you can find a description of the plugin settings.

Global Settings

• Allowed Groups select
  • Select the groups allowed to use this feature.
• Enabled Forums select
  • Select the forums where this feature should be enabled in.
• Enable Read More Tag yesNo Default: yes
  • Enable users using a tag to cut portal messages.
• Read More Tag String text Default: [!--more--]
  • Insert the string used to build the read more feature.
• Send PM Notification yesNo Default: no
  • Send a PM to authors when moderators add or remove their threads from the portal.
• Send MyAlerts Notification yesNo Default: no
  • Send an alert to authors when moderators add or remove their threads from the portal.
• Enable Forum Filtering yesNo Default: no
  • Enable this to allow portal threads to be filtered by forum. Query parameter is forumID, example: ./portal.php?forumID=2.

Go up to Table of Contents

📖 Usage

Custom Moderation Tools

It is possible to change the status of threads using custom moderation tools. For this follow the next steps.

1. Go to the Administrator Control Panel, add a new custom moderation tool from Home » Moderator Tools » Add New Thread Tool.
2. Fill down the form, go down below to the Show in Portal row under the Thread Moderation table.
3. Select one of the presented options.
   • No Change Default
   • Show Adds threads to the portal.
   • Hide Removes threads from the portal.
   • Toggle Toggles the status of threads.

Forum display thread list and Search results page

You will now be able to change or toggle the status of multiple threads using the Inline Thread Moderation dropdown menu.

Show thread page

You will now be able to change or toggle the status of a threads using the Moderation Options dropdown menu.

Go up to Table of Contents

⛏ Built Using

• MyBB - Web Framework
• MyBB PluginLibrary - A collection of useful functions for MyBB
• PHP - Server Environment

Go up to Table of Contents

✍️ Authors

• @Omar G - Idea & Initial work

See also the list of contributors who participated in this project.

Go up to Table of Contents

🎉 Acknowledgements

• The Documentation Compendium

Go up to Table of Contents

🎈 Support & Feedback

This is free development and any contribution is welcome. Get support or leave feedback at the official MyBB Community.

Thanks for downloading and using our plugins!

Go up to Table of Contents