Skip to content

Latest commit

 

History

History
368 lines (238 loc) · 15.3 KB

Configuration.md

File metadata and controls

368 lines (238 loc) · 15.3 KB
Raw

Site Configuration Information

This document contains information such about installed plugins, custom pages, and admin panel configurations.

Table of Contents

Donut theme settings

  • Check Enable top bar
    • Left text: New here? <a href="https://supportsitetest.tk/register" style="color: inherit;">Create a new account</a>!
    • Right text: Got redirected? <a href="https://supportsitetest.tk/recover-account" style="color: inherit;">Reclaim your existing Paratext Support account</a>!
  • Check Enable sticky header on scroll, Enable back to top button, and Show site status above footer
  • Either uncheck Show home page banner, or configure it to your liking.
  • Uncheck Show social links at footer and Show copyright at footer

General

  • Preferred site URL: Make sure it begins with https://
  • URL structure: /123/why-do-birds-sing (requires htaccess file)
  • Site Theme and Theme for mobiles: Donut
  • Question classification: Tags and Categories

Emails

  • Check Send email via SMTP and Send SMTP username and password
  • Fill in the required fields with the appropriate SMTP credentials

Users

  • Disallowed usernames: anonymous, admin, anon
  • Check Allow Gravatar avatars

Layout

  • Check Show a logo image in the page header
  • URL of logo: /path/to/your/logo
  • Check Custom HTML in sidebar box
    • Support.Bible is a public forum that connects users of Bible translation software, so that they can help one another to find solutions, and discover new ways of working together. We welcome users of all Bible translation software systems to discover how they can help one another to take God’s Word to the world.<hr>
  • Add the following widgets:
    • Search Bar: Main area - Top
    • Related Questions: Main area - Bottom
    • Categories: Side panel - Below sidebar box

Posting

  • Default editor for ...: PUPI DM Editor
  • Check Check for similar questions when asking, Show example tags based on question, and Show matching tags while typing

Viewing

Lists

Categories

  • Add the following categories:
    • Name: General, Slug: general
    • Name: Paratext, Slug: paratext
    • Name: Paratext Lite, Slug: paratext-lite
    • Name: Publishing Assistant, Slug: publishing-assistant
    • Name: FLExTrans, Slug: flextrans
  • Uncheck Allow questions with ...

Permissions

  • Viewing question pages: Anybody
  • Asking questions: Registered users with email confirmed
  • Answering questions: Registered users with email confirmed
  • Adding comments: Registered users with email confirmed
  • Voting on questions: Registered users with email confirmed
  • Voting on answers: Registered users with email confirmed

Pages

  • Check Questions, Unanswered, Tags, Categories, Users, Ask a Question
  • Add the following custom pages:
    • FAQ - Position: After tabs at top
    • Best Practices - Slug: best-practices, Content: here
    • Welcome
    • Paratext Support Redirect - Slug: paratext support redirect, Content: here

Several custom pages are included in the site. While Q2A supports the creation of custom pages through the administration panel, we have also included the HTML in a subdirectory of the site in case the database is cleared.

RSS feeds

Points

  • Set Multiply all points to 1

Spam

  • Check Request confirmation ..., All new users ..., User captcha ...
  • Use captcha module: reCAPTCHA

Caching

Stats

  • Run each of the Database clean-up operations at the bottom of the page

Mailing

Plugins

To do: Add a description for each plugin, a description of the configuration (if there is a stylesheet or some bulk text field the content should be listed or mentioned where to find a copy of it), also if the plugin has been updated from the original in case of future downloads. Any paid plugins also need to be mentioned regardless if they are on the repository or not (i.e. dynamic mentions).

Below is a list of all Q2A Plugins installed for this site. We have omitted the default plugins included with Q2A for the sake of brevity. The default options for most plugins will suffice, unless other options are provided.

account-reclaim

Custom plugin: This plugin was designed specifically for this website. More details can be found at the plugin's README.

Allows users to reclaim their archived accounts from support.paratext.org. "Archived Account" is the term used for an account that was once associated with support.paratext.org but has been anonymized upon the migration to this new site. The process largely mimics the "Forgot Password" process, with a few tweaks.

Configuration

- We recommend checking **Use CAPTCHA on account recovery**

auto-prune-accounts

Custom plugin: This plugin was designed specifically for this website. More details can be found at the plugin's README.

Automatically delete accounts that have not verified their email after a set amount of time. Does not use CRON jobs- rather it just marks accounts for deletion and bulk-deletes them on certain triggers.

Configuration

- A 30 minute "grace period" is plenty of time. Shorten this if you find too many spam accounts are being created.
- Check all *Delete unverified accounts when ...** boxes

badges-Q2A

Assigns users badges for certain (configurable) milestones, such as number of answers posted.

Configuration

- Disable the following badges:
    - Verified Human, Autobiographer, Photogenic
    - Renewal, Revival, Resurrection
    - Commenter, Commentator, Annotator
    - Voter, Avid Voter, Devoted Voter
    - Editor, Copy Editor, Senior Editor
    - Watchdog, Bloodhound, Pitbull
    - Medalist, Champion Olympian
- Set the `Notify Duration` to 0 (disabled)
- Check **Add badges to profile pages** and **Show badges on main profile field**
- Uncheck `Show list of ...` boxes

category-logo

Custom plugin: This plugin was designed specifically for this website. More details can be found at the plugin's README.

Display a image next to category names, such as logos for categories that represent products.

Configuration

  • Check Add specific logo to corresponding categories
  • Add the following paths:
    • Paratext: /assets/ParatextCenter.png
    • Publishing Assistant: /assets/PublishingAssistant.png
    • Paratext Lite: /assets/ParatextLiteCenter.png
    • General: /assets/logo.png
    • FLExTrans: /assets/FLEXTransIcon.png

dynamic-mentions

Premium Plugin: This plugin is proprietary. It was purchased during development, and is not included in this repository in honor of the purchase.

Support for dynamically-suggested @mentions in posts.

google-analytics

Support for Google Analytics. Requires a tracking code from Google Analytics.

Configuration

- Add the **[Google Global Site Tag](https://developers.google.com/analytics/devguides/collection/gtagjs)**

hashtagger

Convert #tags to hyperlinks in posts. Similar to the dynamic mentions plugin, but does not dynamically suggest tags.

Configuration

  • Uncheck Keep "#" symbol for tag names
  • Check everything else

on-site-notifications

Notification icons similar to social media.

Configuration

  • Enable the plugin

post-validator

Custom plugin: This plugin was designed specifically for this website. More details can be found at the plugin's README.

Warns users if they attempt to post identifying information.

Configuration

  • User Fetch Type: Remote
  • Type of editor for ...: Full
  • Minimum mention user permit: Registered users
  • Check Enable On-Site Notifications integration
  • Check Enable email notifications

pretty-tags

Auto-suggest and auto-complete tags as you type them.

This plugin has been modified to be more appropriate for this site, including UI changes.

q2a-faq

Adds a Frequently Asked Questions page, fully configurable through the admin panel.

Configuration

  • Default configuration is acceptable
  • You can add FAQ entries from this section

q2a-style

Custom plugin: This plugin was designed specifically for this website. More details can be found at the plugin's README.

Various UI alterations, such as relocating the search bar, hiding redundant titles, highlighting the selected page name, etc.

random-avatar

Custom plugin: This plugin was designed specifically for this website. More details can be found at the plugin's README.

All new accounts get a Gravatar image, generated uniquely from their email address.

random-verse

Custom plugin: This plugin was designed specifically for this website. More details can be found at the plugin's README.

Selects a random verse to display in the sidebar in order to welcome users to the site.

Configuration

  • Add verses you want to display in this plugin. Pay attention to the formatting of the verses.

role-markers

Custom role names and markers adjacent to users with them.

This plugin has been modified to be more appropriate for this project. Most notably, the ability to add custom roles to users has been implemented. Administrators can now assign a unique role to users by visiting their profile. This custom role will display next to the user's display name across the site, and the color for custom titles can be configured via CSS in the admin panel.

Configuration

  • Check all boxes

send-account-reclaim

Custom plugin: This plugin was designed specifically for this website. More details can be found at the plugin's README.

Send emails to users in the archived database table through the admin panel. Toggleable support for HTML in email body.

simple-sticky-sidebar

Sidebar stays on the screen when you scroll down.

This plugin has been slightly modified according to the theme of the website.

spam-registration-stopper

Provides spam control through multiple well-known spam checking services.

Configuration

  • Enter API key of the spam checking services want to be used

sso-authentication

Custom plugin: This plugin was designed specifically for this website. More details can be found at the plugin's README.

This plugin allows single sign on for Facebook and Google. Support for Paratext Registry SSO is not yet configured, as this requires external support.

Configuration

  • Add Client id and Client secret for each service selected

tagging-tools

Enforce min/max length for post tags and allows you to create "tag synonyms" which map similar tags to each other. For example, the synonym pt,paratext would automatically convert the tag pt to paratext when a post is submitted. It also has the ability to retroactively apply these synonyms. Lastly, it can remove tags altogether by placing them on standalone lines. During the migration from the old site to this one, we are automatically generating tag data for posts, so it will be useful to apply these synonyms retroactively.

Configuration

  • Minimum tag length: 2
  • Maximum tag length: 25
  • Do not check Add 301 redirects for tag synonyms

To see a list of all tag synonyms used in development (and thus, the synonyms we suggest using), refer to the TagSynonyms file. Copy and paste all desired rules into the Tagging Tools' admin form.

title-length-counter

Display title length and prevent typing past the max length.

This plugin has been slightly modified to also display when editing questions. It also displays warning colors when the post's title is below the minimum or at the maximum length.

user-info

Hover over a username to see information.

This plugin has been modified to be more appropriate for this site, including UI changes.