LSP "Enigma" (v1.0) Documentation

Table of Contents

  • Introduction
  • The Menu
  • The Forum
  • The Admin Center
  • Articles & News
  • Links
  • The Template
  • Modifications
  • Closing
  • This documentation assumes that you know at least something about HTML and coding in general.

    After each section you have the option to go back to the top or go the next section in the documentation.

    With that, please continue on to Introduction. You can scroll down or choose it from the menu on the left.

    There may be a few parts where I lose you but keep in mind you can ask questions freely at the LSP website.

    Also, check Lunabyte Articles for the latest info.


     Introduction

    By now you should have your LS portal installed. You can now log in by typing in the username you input when you made an administrator account and the password into the login block, or click the login button in the menu. Not the database password but the admin password. Everything will then be at your fingertips. As administrator you can control everything in your portal. Now lets move on to the menu.

    ^ Top - Next >

     The Menu

    The menu is like your navigation bar. The following buttons are in the menu by default. They will be accompanied with their definitions and uses. Some member groups can use some buttons and some can not. Here's is the list:

    • home-- the home button take you to either the set home PAGE or the latest news posts. This button can be accessed by everyone. The home page can be viewed by anyone as can the news section. A home page can be set by a administrator in the Site Preferences and Settings section.
    • news-- the news button can be used instead of the home button if a home PAGE is set. It sends you directly to the news section. This button can be accessed by everyone. The news can be viewed by everyone.
    • forums-- the forums button sends the user to the forum. (more on that later) This button can be accessed by everyone. The forum can be used only by members.
    • downloads-- the downloads button sends the user to the downloads section. This button can be accessed by everyone. Downloads can be set by a administrator in the downloads management section.
    • FAQ-- the FAQ button sends the user to the frequently asked questions area. This button can be accessed by everyone. FAQ questions and answers can be set in the FAQ management section.
    • admin-- the admin button sends the user to the administration center. This area controls everything in the portal and is the core maintenance center. This button can be accessed only by administrators. All links within the admin center can also only be accessed by administrators.
    • search-- the search button sends the user to the search form. The user types in a keyword or a username and it searches the forum for posts by that user or posts containing the keyword. This button can be accessed by everyone
    • profile-- the profile button sends the user to their profile. The profile is a large form that the user can fill out, if they wish. The information you fill out can be viewed by all. This button can be accessed only by registered members.
    • notifications-- the notifications button sends the user to their notifications area. In this area the user can set a few things. They can set to receive e-mail notification with new Announcements. They can set to receive topics e-mail notification ONLY in 1st unread reply. And, through the forum, they can set topic notification and have an e-mail sent to them when someone replies to the topic. This button can be accessed only by registered members.
    • login-- the login button sends the user to the login form. It is the same as the login block but you can set how long you want to stay logged in. This button can only be accessed by guests.
    • logout-- the logout button logs the user out. Period. This button can only be accessed by registered members.
    • register-- the register button sends the user to the registration form. When filled out and submitted, the user will be registered and gains access to many features.

      ^ Top - Next >

     The Forum

    The forum is a message board. Members can post threads on boards, reply to threads, set notifications on threads, read threads, etc. It consists of categories and boards. A administrator creates categories and then puts boards in them for different purposes. The following is a list of buttons and functions with their definitions and uses that the forum uses.

  • mark as read-- You can find this in two areas. 1) On the front forum page it is at the bottom of the list of boards. It will mark all boards and the threads within as read. 2) Inside every board you can find it. It will only mark that board and the threads within as read.
  • previous\next-- These buttons send the user to either the next or previous thread on the board.
  • new topic-- This button sends the user to a form that consists of the following.
    Subject line-- sets the subject of the thread
    Message icon-- the icon that will sit next to the title of the thread
    BBC Buttons-- buttons that add bulletin board code to the post
    Smilies-- you can add smiley faces to your post
    Message body-- the main message of the post
    Lock after post-- locks the thread after submitting the post
    Notify of replies-- notifies the poster by e-mail of any replies
    Disable smilies-- disables smilies from the post
    Attach-- sets a file attachment to the post
    Make topic news-- check this box if you want this thread to be marked as news. (more on news here)
    News category-- if it is set as a news item, you can set the category it is to go in.
    Featured news item-- check this box if you would like the news item to be in the frontpage news section.
    Delay publishing-- this box makes the news item not be posted until the button in the news submissions area is clicked.
  • new poll-- This button sends the user to a form similar to the new topic form. The only fields added are the following.
    Question-- the question for the poll that you are making
    Option 1-8-- the options that the user can select for an answer
  • reply-- This button sends the user to a reply form. It is the same as the new topic form but does not make a new topic, but adds a reply to a thread.
  • notify-- This button sends the user to a page that asks if you would like to set an e-mail notification on the thread so if anyone replies, you receive an e-mail about it.
  • send topic-- This button sends the user to a form that allows you to send the thread in text format to someone via e-mail.
  • print-- This button sends the user to a page that has the whole thread in printer friendly text version.
  • quote-- This button sends the user to the reply form. In the message body there is a quote of the previous or whichever post you selected.
  • modify-- This button allows the poster, moderator or administrator to modify the post that they select.
  • delete-- This button allows the poster, moderator or administrator to delete the specified post in the thread.
  • split-- This button allows the moderator or administrator to split the thread in a few different ways.
  • move topic-- This button allows the moderator or administrator to move the thread to a different board.
  • remove topic-- This button allows the moderator or administrator to delete the entire thread.
  • lock/unlock-- This button allows the poster, moderator or administrator to lock or unlock the specified thread.
  • sticky-- This button allows the moderator or administrator to "sticky" the thread at the top of the board the thread is in.
  • merge-- This button allows the moderator or administrator to merge the thread with another.
  • Jump to-- This drop down menu allows the user to quickly jump to a different board without going to the forum index.

    ^ Top - Next >

  •  Instant Messages

    Instant messages are like posts but they are sent directly to the user. There are 2 ways to send instant messages. 1) Go to the persons profile and click on "Send this user an instant message". 2) In a thread the user has posted on, click on the little green scroll under the user's name. Either way, the user is sent to a form that allows a message to be sent to that user. There is also 2 ways to check your instant messages. 1) In the top right there is a message that says how many messages you have (if any). 2) On the forum index there is an info center at the bottom and in YaBB SE Stats there is a section on the right that shows your instant messages (again if any).

    ^ Top - Next >

     The Admin Center

    The administration center is the core control center of LSP. Choose your fellow administrators wisely because they will have access to everything. Again, here is a list of the links and features that the admin center and administrators use with their descriptions and uses.


     Articles & News

    There are 2 ways to manage articles and news as an administrator. We will first deal with articles. The first is to go to the admin center and click on articles management. There is a form at the bottom of the page to add sections. Fill out the section title and if you want a banner you can select an image on the server to add. Set the position and group permissions and click add section. To edit a section there is a link under each banner; likewise for deleting a section. The second way is the submissions area (index.php?op=submissions). There are 2 links in the articles column: Submit article and review article submissions. Click on review article submission. The first thing you see if the filter. There you can sort the list of articles below by their status type and by the section there in. Next and bellow that is the list of submitted articles. It displays the section the articles are in, their heading, who they were submitted by, the date and time of the submission, the reviewer and the date and time modified. If you click on the heading of an article it will take you directly to it and if you click on the submitter or reviewer it will take you to their profile. To see a list of all articles you can go to the articles archive (index.php?op=artarchive). Now to submit an article go back and click on the submit article link. The form is much like a forum post but there are a few more or less fields and whatnot. Something new is the sub-heading. On the article it appears just bellow the heading in italics. At the bottom there are two checkboxes. The featured article checkbox makes the article displayed on the front page (index.php). The delayed delay publishing checkbox makes the article not be published until the publish button is clicked. The summary appears on the front page instead of the article content if the featured article checkbox is selected. When the user click read more s/he will see the whole article there. Now on to the news. There are also 2 ways to do this. One is to go into the submissions area and to click on review news submissions. This will take you to a similar page as the review article submissions link does. Much is the same. But there is one big difference. When clicking on the title the link takes you to the thread the news was made in. You can also look at news through the news archive (index.php?op=newsarchive). Now you can post news by using the create news in submissions or you can post through the forum. The forms are similar to that of articles. Much of the two are the same apart from that news is connected to the forum and articles are not.

    Facts:
    • Visit the articles archive to view all approved articles.
    • Visit the news archive to view all approved articles.
    • No one can edit an article\news item besides the person who submitted it and the administrator.
    • An administrator must "review" and accept a user submitted article\news item before it is approved.
    • A user can submit a normal thread and an administrator can review it as news if need be.
    • A user can still modify a article s/he submitted even before it is approved but it will be marked as re-submitted.
    • When an administrator submits an article\news item it is automatically approved.
    • A user who submitted an article\news item can delete it at any time.
    • If an article is rejected and the user tries to edit it, it will be re-submitted for approval.
    • If an article is rejected and the administrator modifies it, it is automatically set to approved.
    • If an article is set to delayed publication, the submitter can still modify it and such.

      ^ Top - Next >

     Links

    There are 2 ways to manage links as an administrator. The first is to go to the admin center and click on Links management. The first on this page is the link categories list (if there is any in it yet). You can edit and delete categories wit the links to the right of their name. Above the list is a few links: Add/edit link categories and Add/edit links. The link categories just takes you to a page with only the list and the edit links takes you to a page to edit the links in their categories. Bellow the list is a form to add a new links category. Its quite simple for all you must do is fill in its name and description and click add category. The second way is the submissions area (index.php?op=submissions). There are 2 links in the articles column: Submit link and review link submissions. Click on review link submission. This area is a lot like the articles section. It shows who it was submitted and reviewed by, when it was submitted and when it was modified, what category its in, and of coarse what its status is. Though instead of the the article name it shows the link name. The filter is still there so you can use that and again a lot of it is the same. But when you click on the link name it takes you to a page where you can see where the link leads to, the description, how many clicks, the submitter, and of coarse the administrator can edit and delete it if they wish. Now , to submit a link, you may go to the links area (index.php?op=links) or do it via the submissions area. They both lead to the same page (index.php?op=addlink). Select which category you want it to go into, the link name, the url and its description. Click add link and your set.

    Most of the facts stated in the articles section apply to the links as well. So just go by that for reference.

    ^ Top - Next >

     The Template
     

    With the release of Enigma, our first official Lunabyte Systems Portal release, there have been some changes in the layout of your site.  These changes may seem daunting at first, but most changes are as logical as can be.

    The first thing to note is the addition of the following "mini" templates:

    • archiveTemplate.php - this controls the general structure of your News Archive page, and your Article Archive page.
    • articleTemplate.php - this controls the general structure of the "Featured Articles" portion of the new front page, and also the general structure of your actual Articles.
    • emailTemplate.php - the HTML email mod is now officially a feature of Enigma\LSP.  The emailTemplate.php controls both the structure, and because of email client limitations, the appearance of emails sent from your site.
    • newsTemplate.php - this controls the general structure of your front page news posts.
    In addition to these new mini-templates, you will notice each skin has it's own "css" subdirectory.  Inside this directory are the css files for the skin.  These files are pretty self explanatory, and each controls the actual appearance - colors, fonts, backgrounds - of each skin.  In the CSS directory, you find the following files:
    • archive.css - this controls the actual appearance - colors, fonts, backgrounds - of your News Archive and Article Archive pages.
    • articles.css - this controls the actual appearance - colors, fonts, backgrounds - of your front page "Featured Articles" section, and the actual articles themselves.
    • blocks.css - this controls the actual appearance - colors, fonts, backgrounds - of your blocks.
    • main.css - this controls the actual appearance - colors, fonts, backgrounds - of the forum portion of the portal software, except for one notable exception.
    • news.css - this controls the actual appearance - colors, fonts, backgrounds - of your front page news posts.
    • posts.css - this controls the actual appearance - colors, fonts, backgrounds - of the posts themselves.  windowbg and windowbg2 now control only visuals of the board index and message index.

    Feel free to not only experiment with the included skins, but also to make sure you post your site in the Showcase portion of the forum!


    ^ Top - Next >


     Modifications

    In the world of bulletin boards and content management systems there has always been mods. Mods are modifications or additions to the LSP code base that extend its capabilities or alter how the code operates. There are many types of mods to improve performance, features, ease of use, and to update security problems. Mods are usually written by the Mod-Team and the community, not by the developers of the standard code base, although sometimes there is a crossover.

    You may ask where you can find mods. LSP is currently based off YaBB SE. You can find many mods in their Completed Mods forum but be careful because they have not been verified to interoperate with LSP. The main area though is LSP's Completed Mods forum which resides right now in the PfaBB code base. These mods generally have fewer problems then mods you will find at YaBB SE, because people have taken the time to work out any issues with LSP. However, you may have problems if you have other mods already installed.

    You must remember that no one, officially, supports mods. However, usually the mod writer does their best to help people make it work. People are usually doing all this in their spare time, so do not get upset if no one is able or willing to help. Usually, you will find there are many people who are, though.

    Mods can be very dangerous, which is why you should always BACKUP your site and SQL database before attempting even a minor modification. While new to LSP, wait for others (who are more experienced) to install the mod first, so any common issues are resolved. Some mods can conflict with each other, so be sure to understand exactly what the mod is doing and whether it is a feature that necessitates the risk of installation. Be especially careful with mods that change your SQL DB, these mods could potentially destroy all the data your site relies on. As long as you perform the correct BACK-UPs before applying the mod you should have nothing to worry about, other than perhaps a few hours of down time.

    Now to address a few frequently asked questions about modding.

    A. How do I backup LSP before attempting to install a mod?
    1. Copy the full LSP directory structure to another location....preferably a different computer than the current site is hosted at. Be sure to preserve permissions on all files when copying.
    2. Using phpMyAdmin or the "Dump Database" tool in the admin center of LSP, backup the SQL DB to a secure location.

    B. How do I restore my backup of a LSP site if a mod messes something up?
    1. Delete all the old directory structure on your server.
    2. Upload or copy your backup directory and all files to the same location on your server as before.
    3. Using phpMyAdmin or some other SQL DB tool restore your SQL DB backup.

    C. How do I install a mod?
    NOTE: LSP developers suggest everyone release and use YaBBpaks for mods to facilitate easier installations.
    1. Always be sure you have completed a backup of your code base and SQL DB before attempting the mod.
    2. Always make sure you have the latest updates that are posted in the LSP downloads section. (or the version that the mod writer wrote the mod for which should be in the post or readme file).
    3. Be sure to read all notes regarding each mod and it's installation. Specifically, any special notes regarding known bugs or if that particular mod will interfere with any other mods.

    YaBBpak: This is a built in Mod installer, called Package Manager (PacMan for short). You can find it in your admin center. It's under the >>Forum Controls >>YaBBpak Center. This uses package files created by users to download and install/uninstall mods. Package servers are run by individuals and LSP. You can find LSP's server here. LSP official code updates are usually released as YaBBpaks. These mods will have .yp extensions. You can also upload a .yp file to your "./Packages" directory and then run the YaBBpak from the YaBBpak center.

    Manual: These mods are usually made because the Mod editor is unfamiliar with how to write a Boardmod/PacMan mod file, or the mod is so easy and short they feel it can be installed easily by hand. This method of installing a mod requires the installer to open up a file usually located in their source directory and manually search and replace codes in the file. This method has a great margin for errors. Once you are familiar with editing the source files this method is easy, but it can be scary at first. Always backup the source files before editing them by hand.

    Boardmod: These mods are made for use with Boardmod. (Boarmod mods will have .mod extensions.) This uses a system of and tags designed to be installed with a program called Boardmod. Boardmod software is designed by Michael Prager and his crew. You can read about Boardmod Mod Software at the FAQ page or you can download it here. Linux and Win32 versions are available. Please read the "instructions" that come with the software on how to use it.

    D. How do I uninstall a particular mod?
    YaBBpak: Go to the Admin Center under the >>Forum Controls >>YaBBpak Center, click "[ View Installed YaBBpaks / Uninstall YaBBpaks ]". Find the mod you want un-installed and click the corresponding "[ Uninstall ] [ Test Uninstall ]" You should always test an uninstall before actually proceeding.

    Manual: Simply restore the previously backup source files before manually editing. Also remove any extra files that the mod required since they are not used anymore.

    Boardmod: Please see the Boardmod website for full instructions. Essentially very similar to Yabbpak...you simply find the particular mod, and click uninstall within Boardmod.

    E. What is the difference between an LSP code update and a mod?
    Very little... LSP code updates are usually released as YaBBpaks. Code updates are released to stay current with YaBB SE's forum code base, and to resolve any bugs or update new features. Always check LSP's website to stay current with the code base and patches. This can be critical if security issues are found and fixed.

    F. How do I get help with a mod if I have a problem?
    1. If you have problems with installation, PLEASE read through the entire thread for that mod to see if someone else has had a similar problem and a fix has already been posted which may solve the problem(s) you are having.
    2. If you can't find any solutions for your particular problem or error, then post a message with specific information, either screenshots or copy/paste the errors and a short, detailed description of what's happening (or not happening) with a list of any other mods you are currently using.
    3. Always be sure to post the question in the thread for the mod you are having problems with.
    4. Do not feel as though your question is stupid. Everyone was new at one time or another and had weird little problems at first. If you have followed all of these suggested guidelines, NO ONE will call you stupid for asking a question when you are having problems. The mod writer him/herself is not always the only person that can help you. There are plenty of other users that are willing to help.

    NOTE: Don't ask for help unless you've actually tried to fix the problem yourself. A lot of you aren't coders and don't know everything about programming, but when people tell you that something doesn't work and you ask them what the error was, and they tell you they don't know... that's really frustrating and isnít very practical for providing help. You have to at least read the error message and apply a little logic to it.

    MOD WRITER NOTES:
    1. Always be sure to post which version of LSP/YaBB your mod is created for and any known problems/bugs or conflicts with any other mods.
    2. Please release your mods as YaBBpaks when/if possible.
    3. Please use the naming convention below when posting a mod:
    [STATUS = (ALPHA, BETA, DONE) LSP ver = (LSP ver/YabbSE ver)][MOD TYPE = Yabbpak, boardmod, CODE] Mod name
    Example: [BETA LSP 1.0/Yabbse 1.5.4][Yabbpak] Sweet example mod name!
    4. All LSP specific functions should be placed in eSubs.php instead of Subs.php. This will greatly benefit the mod developer when upgrading to new versions of the software.

    Section compiled by Zarsky99. Many portions of it were borrowed from previous documents and/or messages written by CrazyC, Haase, Nemesis, the YaBB SE Dev Team and the LSP Dev Team. Section edited by Ian.

    ^ Top - Next >

     Closing

    In closing, I ask you to remember, if you ever need any help with Enigma, you are always welcome at the official web page\forum, go here. But if you need help with a modification you've made to your portal, always search the forum first before you post a question about the mod.

    < Back - Top ^

    Powered by MySQL LSP "Enigma" 1.0 Documentation | Provided by Lunabyte Systems
    © 2003, LSP Dev Team. All Rights Reserved.
    Powered by PHP