Things You Must Have:

These are prerequisites for Forumwise.

• Lernen: 2.1.1

Download & Installation

Follow these steps to install the Forumwise add-on in your Lernen project:

• Step 1: Download the Package

  When downloading the zip package file from CodeCanyon, you'll have all the files you need inside. The zip package contains the following files:

  • Forumwise.zip contains the Forumwise Add-on
  • documentation.zip folder (It contains documentation for the add-on)

• Step 2: Extract the Package
  • Extract the downloaded zip file i.e. Forumwise.zip
• Step 3: Install Forumwise
  • Goto Admin > Manage Addons and click on Add new.
  • Choose the Forumwise.zip file and click on Install.
• Alternatively, Manually Installation

  If you prefer to manually install the ForumWise add-on, follow these steps:

  • Extract the downloaded zip file i.e. Forumwise.zip in Modules/ directory
  • After uploading you need to execute the following commands in the website root directory through CLI
    • Execute this – php artisan module:enable Forumwise
    • Execute this – php artisan module:migrate Forumwise
    • Execute this – php artisan module:seeder Forumwise
    • Execute this – php artisan module:publish Forumwise

Admin Settings

• Global Settings Overview:
  • In the ForumWise section, you can access the Global Settings panel. It contains various settings for customizing your forum's appearance and functionality:
  • Heading: Set the main heading for your forum's front page.
  • Description: Provide a description for your forum using the rich text editor. You can format text (e.g., bold, italics) and add HTML elements for better presentation.
  • Search Button Text: Customize the text displayed on the forum's search button.
  • Shape Images: Upload images to customize visual elements:
    • Shape Image: Set a general shape image for the forum.
    • Left Shape Image: Upload a shape image for the left side of the forum’s design.
    • Right Shape Image: Upload a shape image for the right side of the forum’s design.
  • Save Changes: After customizing the settings, click the Save changes button to apply the updates.
  • Reset Options: You can reset specific sections or all settings using the Reset section or Reset all buttons.

• Email Settings Overview:
  • Access the Email Settings section from the left-hand sidebar under Site management.
  • In this section, you can manage email templates for various notifications, including when users are invited to private topics.
  • Add New Template:
    • To create a new email template, select a template type from the dropdown menu and click the Add new template button.
    • Customize the template based on the notification type, such as invitations, session requests, or booking confirmations.
  • Managing Existing Templates:
    • All existing templates are listed under the All Email Templates section, displaying details like:
      • Email Title: The name of the template (e.g., "Invite User").
      • Role Type: The role associated with the template (e.g., Tutor, Student, Admin).
      • Status: Shows whether the template is Enabled or Disabled.
      • Actions: Edit or delete templates using the icons provided.
    • Invite User Templates: Special templates used when inviting users to private topics. Make sure these templates are enabled for sending out invitations based on user roles.
  • Using Templates for Private Topics:
    • When a private topic is created, the Invite User feature sends an email using these templates.
    • The platform selects the appropriate template based on the recipient’s role (e.g., Tutor or Student) to ensure the message is relevant.
    • Admins can edit these templates to include personalized messages, instructions for accessing private topics, and any other necessary details.
    • Ensure that these templates are Enabled so that users receive invitations when invited to participate in private discussions.

• Manage Community Categories:
  • Add Category: Enter the name of the category in the input field.
  • Label Color: Choose a label color for the category to distinguish it visually.
  • Category List: View the existing categories in the list along with their label colors.
  • Edit Category: Use the edit button to modify the details of an existing category.
  • Delete Single Category: Use the delete button to remove a specific category from the list.
  • Select Multiple Categories: Use the checkboxes beside each category to select multiple categories.
  • Delete Multiple Categories: After selecting multiple categories using the checkboxes, click the delete option to remove all selected categories at once.

• Navigate to Forum Management:
  • From the dashboard, locate and click on ForumWise from the left-hand sidebar.
• Click on 'Create Forum':
  • In the Forum section, you will see a Create Forum button on the right-hand side. Click on it to open the forum creation form.

• Fill in Forum Details:
  • Title: Enter the forum title in the input field.
  • Topic Role:Select the topic role from the dropdown options. Only users assigned to this role will be able to create topics in the forum.
  • Category: Choose the appropriate category from the dropdown list.
  • Description: Write a brief description of the forum. There is a character limit of 150 characters.
  • Status: Toggle the switch to activate or deactivate the forum.
  • Upload Image (Optional): You can drag and drop or upload an image (jpg, jpeg, png, gif) with a max size of 2MB for the forum.
• Save or Cancel:
  • Once all fields are filled, click "Save" to create the forum.
  • If you wish to discard the changes, click "Cancel".
  • After saving, the new forum will appear in the Forums section on the dashboard.
• Update Forum:
  • If you want to edit an existing forum, locate the forum in the list and click on the Edit button next to it.
  • The current forum details will be loaded into the form. Make the necessary changes, such as updating the title, topic role, category, description, or image.
  • After making changes, click "Save" to apply the updates.
  • If you want to discard the changes, click "Cancel".

• Forum Listing Overview:
  • Once forums are created, they will appear in the forum listing section on the dashboard, grouped by categories like Food or Marketing.
  • Each forum entry in the listing displays:
    • Forum Title: The title of the forum, such as "Food & Beverage".
    • Description: A brief summary that describes the forum’s purpose.
    • Topics and Posts: Shows the number of topics and posts available within that forum, helping you monitor activity.
    • Edit Button: Allows admins to click and edit the forum details directly from the listing.
    • View Thread Button: Opens the forum’s thread view where discussions and interactions take place.
  • On the right side, you will also find a summary box displaying total numbers, such as the total Forums, Topics, Posts, and Members within the forum system.

• Create a New Topic:
  • To create a new topic within a forum, click on the Create a New Topic button in the forum view.
  • This will open a form where you can input details for the new topic, such as:
    • Title: Enter the topic’s title.
    • Type: Toggle between making the topic public or private.
    • Status: Set the topic as active or inactive.
    • Tags: Add tags that are relevant to the topic for easy categorization.
    • Description: Provide a brief description of the topic (up to 150 characters).
    • Upload Image (Optional): You can drag and drop or click to upload an image (jpg, jpeg, png, gif) with a max size of 2MB.
  • Once the details are filled in, click Save to create the topic, or click Cancel if you wish to discard the changes.

• Topics Section Overview:
  • After creating topics, they will appear in the Topics section of the forum view, as shown in the image.
  • In this section, you can:
    • Browse and view existing topics within the forum.
    • Filter topics using the All and My Topics tabs.
    • Search for specific topics using the search bar provided above the topic listings.
    • View details for each topic, such as:
      • Title: The name of the topic (e.g., "Figma Slide - Typography Styles").
      • Description: A brief overview of what the topic is about.
      • Author: The user who created the topic.
      • Replies and Views: The number of replies and views for the topic.
      • Last Activity: The date and time of the most recent activity in the topic.
  • On the right side of the page, additional information is displayed, including:
    • Top Users: A list of the most active and engaged forum members.
    • Popular Topics: Shows trending discussions within the community.

• Topic Detail and Replies Overview:
  • When a topic is selected, you can view its details and interact with other members through the reply system.
  • The topic detail page includes:
    • Topic Title and Description: Displays the title, author, and a brief description of the topic.
    • Statistics: Shows total views, replies, and posts count, as well as the last activity date.
    • Contributors: A list of users who have participated in the discussion.
    • Related Topics: Highlights other related discussions in the community to explore further engagement.
    • Tags: Shows tags associated with the topic for easier navigation and categorization.
  • The reply section allows users to:
    • Like or Reply to comments made by other users.
    • View nested replies, providing a threaded discussion view.
    • Use rich text formatting tools when submitting replies, including bold, italic, and list options.
  • Admins and users can add their responses using the Submit Reply button located below the reply input area.

• Private Topic and Send Invite Feature:
  • When a private topic is selected, only invited members can view and engage with the discussion.
  • Admins or topic authors can invite others by clicking the Send Invite button, which opens a pop-up form.
  • The invite form includes:
    • Email: Enter the email address of the person to invite.
    • Message: An optional message to accompany the invitation (up to 150 characters).
  • Once the details are entered, click Send to dispatch the invitation, granting access to the recipient.
  • Other details available in the private topic view:
    • Contributors Panel: Shows a list of users who have access or have participated.
    • Related Topics: Lists discussions related to the current topic.
    • Tags: Helps categorize the topic for easy navigation.

Tutor Settings

• Navigate to Forum Management:
  • From the dashboard, locate and click on ForumWise from the left-hand sidebar. This section allows tutors to engage with the community, create new topics, and participate in discussions.
• ForumWise Overview:
  • The ForumWise section is designed to connect tutors and students. It provides a comprehensive space for sharing knowledge, asking questions, and participating in discussions.
  • The main panel displays a welcome banner that highlights the purpose of the forum and encourages interaction among tutors and learners.

• Forum Summary Panel:
  • On the right side of the section, there is a summary panel displaying important statistics about the forums:
    • Forums: Shows the total number of forums available (e.g., 5 forums).
    • Topics: Displays the total number of topics created across all forums (e.g., 4 topics).
    • Posts: Indicates the number of posts or replies made in the forums (e.g., 2 posts).
    • Members: The total count of active members participating in forum discussions (e.g., 19 members).
• Forum Categories:
  • The forums are categorized for easy navigation. Categories such as Food and Marketing group relevant forums, making it easier for tutors to locate topics of interest or relevance to their expertise.
  • Each forum category displays the number of topics and posts it contains, providing tutors with an insight into the activity level within each category.
• Individual Forum Cards:
  • Each forum within a category is presented as a card that includes:
    • Forum Name: The name of the forum (e.g., "Food & Beverage").
    • Description: A brief description explaining the purpose of the forum (e.g., "A practical forum to take your cooking skills from dull to delicious").
    • Activity Stats: Displays the number of topics and posts within each forum, providing a quick overview of how active the forum is.
    • View Thread Button: A button on the right side of each card labeled "View thread" allows tutors to enter the forum and participate in or view discussions.
• Topics Page and Create Topic Modal:
  • When a tutor selects a specific forum (e.g., "Food & Beverage"), they are directed to the Topics Page, which displays all discussions related to that forum.
  • The page includes a "Create a New Topic" button at the top, allowing tutors to start a new discussion.
  • Create Topic Modal:
    • Clicking the "Create a New Topic" button opens a modal for setting up a new topic. This modal includes fields and options such as:
      • Title: A required field where tutors input the name of the new topic.
      • Type: Tutors can choose between a Public or Private topic, determining visibility.
      • Status: An option to toggle the topic as Active or Inactive.
      • Tags: Add relevant tags for easier categorization and searchability.
      • Description: A brief summary or explanation of the topic, required for clarity.
      • Image Upload: Tutors can upload an image (jpg, jpeg, png, gif) with a max size of 2MB. The modal supports drag-and-drop or click-to-upload functionality.
    • Save and Cancel Options:
      • Save: Publishes the new topic once all fields are filled correctly.
      • Cancel: Closes the modal without saving changes, discarding any input made.

• Topics Overview Section:
  • The main topics section shows a list of topics related to the forum. Each topic card includes:
    • Topic Title: The name of the discussion, such as "Figma Slide - Typography styles."
    • Topic Description: A brief summary provided by the creator to explain what the topic is about.
    • Creator Information: The profile of the tutor or user who created the topic, along with their post count.
    • Replies and Views: Shows the number of replies and views each topic has gathered, helping tutors gauge activity and engagement levels.
    • Last Activity Timestamp: Displays the time of the most recent interaction, giving tutors insight into the activity timeline.
  • The Top Users panel on the right highlights the most active and engaged forum members, encouraging more participation.
  • The Popular Topics section shows trending discussions, making it easier for tutors to join ongoing and popular conversations.

• Forum Topics and Comments:
  • Once inside a forum, tutors can view a list of topics created within that forum. They can click on any topic to engage in the discussion by replying, liking, or viewing replies from other users.
  • Top Users and Popular Topics: The right-hand panel displays the most active users in the forum as well as popular topics, helping tutors connect with influential members and trending discussions.
  • The forum allows for nested replies, where users can engage directly with specific comments, encouraging interactive discussions.
  • Related topics are also shown on the right side, enabling quick access to discussions with similar themes or subject matters.

• Reply to Topic:
  • At the bottom of each topic page, tutors can find a "Reply to the Topic" text box. This allows them to contribute to the discussion by posting comments, including formatted text options such as bold, italics, and lists.
  • Once they’ve composed their reply, they can click the "Submit Reply" button to add their comment to the discussion thread.

• Send Invite Modal:
  • Tutors can invite others to join the discussion by clicking the "Send Invite" button available on the topic page.
  • This opens a modal where tutors enter the email address of the recipient and a personalized message (limited to 150 characters).
  • Once all details are filled in, tutors can click the "Send" button to dispatch the invitation.
  • The modal ensures that only valid email entries are accepted, helping maintain the integrity of invites.

• Private Forum Access:
  • When tutors or users attempt to access a private forum, a notification is displayed, indicating that the content is restricted.
  • A lock icon with the label "Private Forum" is shown, notifying users that they need proper access to view the full details.
  • The message reads: "This content is restricted. Please gain access to view the full details."

Student Settings

• Navigate to Forum Engagement:
  • From the dashboard, locate and click on ForumWise from the left-hand sidebar. This section allows students to explore forums, join discussions, and connect with peers and tutors.
• ForumWise Overview:
  • The ForumWise section is designed to connect students and tutors. It provides a collaborative space for learning, sharing knowledge, and engaging in discussions.
  • The main panel displays a welcome banner that highlights the purpose of the forum and encourages participation among students and tutors.

• Forum Summary Panel:
  • On the right side of the section, there is a summary panel displaying important statistics about the forums:
    • Forums: Shows the total number of forums available (e.g., 5 forums).
    • Topics: Displays the total number of topics created across all forums (e.g., 4 topics).
    • Posts: Indicates the number of posts or replies made in the forums (e.g., 2 posts).
    • Members: The total count of active members participating in forum discussions (e.g., 19 members).
• Forum Categories:
  • The forums are categorized for easy navigation. Categories such as Food and Marketing group relevant forums, making it easier for students to locate topics of interest or relevance to their studies.
  • Each forum category displays the number of topics and posts it contains, providing students with an insight into the activity level within each category.
• Individual Forum Cards:
  • Each forum within a category is presented as a card that includes:
    • Forum Name: The name of the forum (e.g., "Food & Beverage").
    • Description: A brief description explaining the purpose of the forum (e.g., "A practical forum to take your cooking skills from dull to delicious").
    • Activity Stats: Displays the number of topics and posts within each forum, providing a quick overview of how active the forum is.
    • Join Discussion Button: A button on the right side of each card labeled "Join Discussion" allows students to enter the forum and participate in or view discussions.
• Topics Page and Join Discussion Modal:
  • When a student selects a specific forum (e.g., "Food & Beverage"), they are directed to the Topics Page, which displays all discussions related to that forum.
  • The page includes a "Join the Discussion" button at the top, allowing students to participate in ongoing discussions.
  • Join Discussion Modal:
    • Clicking the "Join the Discussion" button opens a modal for participating in a discussion. This modal includes fields and options such as:
      • Title: A required field where students input the title of their response.
      • Visibility: Students can see if the discussion is Public or Private.
      • Status: Displays whether the topic is Active or Inactive.
      • Tags: Add relevant tags for easier categorization and searchability.
      • Description: A brief summary or explanation of the student’s response, required for clarity.
      • Image Upload: Students can upload an image (jpg, jpeg, png, gif) with a max size of 2MB to support their response. The modal supports drag-and-drop or click-to-upload functionality.
    • Submit and Cancel Options:
      • Submit: Adds the student’s contribution to the topic once all fields are filled correctly.
      • Cancel: Closes the modal without saving changes, discarding any input made.

• Topics Overview Section:
  • The main topics section shows a list of topics related to the forum. Each topic card includes:
    • Topic Title: The name of the discussion, such as "Figma Slide - Typography styles."
    • Topic Description: A brief summary provided by the creator to explain what the topic is about.
    • Creator Information: The profile of the tutor or user who created the topic, along with their post count.
    • Replies and Views: Shows the number of replies and views each topic has gathered, helping students gauge activity and engagement levels.
    • Last Activity Timestamp: Displays the time of the most recent interaction, giving students insight into the activity timeline.
  • The Top Users panel on the right highlights the most active and engaged forum members, encouraging more participation.
  • The Popular Topics section shows trending discussions, making it easier for students to join ongoing and popular conversations.

• Forum Topics and Comments:
  • Once inside a forum, students can view a list of topics created within that forum. They can click on any topic to engage in the discussion by replying, liking, or viewing replies from other users.
  • Top Users and Popular Topics: The right-hand panel displays the most active users in the forum as well as popular topics, helping students connect with influential members and trending discussions.
  • The forum allows for nested replies, where users can engage directly with specific comments, encouraging interactive discussions.
  • Related topics are also shown on the right side, enabling quick access to discussions with similar themes or subject matters.

• Reply to Topic:
  • At the bottom of each topic page, students can find a "Reply to the Topic" text box. This allows them to contribute to the discussion by posting comments, including formatted text options such as bold, italics, and lists.
  • Once they’ve composed their reply, they can click the "Submit Reply" button to add their comment to the discussion thread.

• Send Invite Modal:
  • Students can invite others to join the discussion by clicking the "Send Invite" button available on the topic page.
  • This opens a modal where students enter the email address of the recipient and a personalized message (limited to 150 characters).
  • Once all details are filled in, students can click the "Send" button to dispatch the invitation.
  • The modal ensures that only valid email entries are accepted, helping maintain the integrity of invites.

• Private Forum Access:
  • When students attempt to access a private forum, a notification is displayed, indicating that the content is restricted.
  • A lock icon with the label "Private Forum" is shown, notifying students that they need proper access to view the full details.
  • The message reads: "This content is restricted. Please gain access to view the full details."

Guest Forum Access

• Viewing Forum Discussions Without Login:
  • When a user who is not authenticated visits a forum topic, they can view the ongoing discussions but cannot interact directly with the content.
  • The topics, replies, and the overall thread structure are visible, providing insight into the community discussions.
  • Users can see the following information:
    • Topic Title: The title of the discussion (e.g., "Figma Slide - Typography styles").
    • Author Information: Details about the creator of the topic (e.g., "Admin Admin").
    • Total Views and Replies: Statistics showing the total number of views, replies, and posts within the topic.
    • Contributors Panel: A list of users who have contributed to the topic.
    • Related Topics: A sidebar with similar topics and discussions within the forum for easy navigation.
    • Tags: Tags that categorize the topic and help in filtering and searching relevant discussions.
• Restricted Interaction:
  • Unauthenticated users are able to view all replies and comments made by other users within the topic but cannot participate in the conversation unless they log in.
  • Nested replies are visible, showing the full depth of discussions and engagement among authenticated users.
  • Actions like "Like" or "Reply" are disabled for unauthenticated users, indicating the need to log in for full interaction.

• Login Prompt:
  • At the bottom of the discussion thread, unauthenticated users are shown a login prompt with a message: "Sign in to reply".
  • This prompt includes a "Login" button that directs users to the login page where they can authenticate themselves to participate in the discussion.
  • The login prompt is designed to encourage users to become part of the community and engage with the content more actively.
• Private Forum Access:
  • When unauthenticated users or those without the necessary permissions try to access a private topic, they are shown a restriction message.
  • The notification indicates that the content is restricted, and users need appropriate permissions or login access to view the full details.
  • The message reads: "This content is restricted. Please gain access to view the full details."