logo
  Wiki
Advanced search
         




Recent articles

URL Format

By default, EoS alpha is using a standard URL format where requests are built of several components:

  • The default script URL - typically http://your.domain.com/index.php
  • a request string that tells the forum what to do. A request string always begins with ?action=, topic= or board= describing the main action, followed by one or more parameters in the form name=value, separated by semicolons. A full URL therefore looks like http://your.domain.com/index.php?topic=2101.msg101 or http://your.domain.com/index.php?action=profile;u=10.


While this is sufficient, many prefer a more descriptive and readable URL format, where things like topic- or member names are actually part of the URL. This is usually known as the "pretty" or SEO-friendly URL format and is what most blogs or CMS-driven sites use nowadays. EoS Alpha supports such a URL format through a modified version of the SimpleSEF plugin, originally written for SMF. This component is integral part of the software, but its functionality is disabled by default, because, on most servers, additional configuration is needed to enable such an URL format.

Posted by Nightwish, May 18, 2014, at 03:57 AM read more...


SphinxSupport

EoS Alpha supports the Sphinx search deamon fulltext search engine.

Posted by Nightwish, October 23, 2012, at 09:50 PM read more...


EoS Alpha Overview

Eos_default.png: 1173x814, 196k (July 29, 2012, at 05:09 AM)
EoS Alpha main page

EoS Alpha is a forum software, written in PHP, using the MySQL database as storage engine. It is a fork of the popular and well-known forum software Simple Machines Forum version 2.0 which was released in 2011 as open source.

For a quick overview of all document pages, look here.

Differences between EoS and SMF

While EoS Alpha shares a lot of code and uses almost the same database layout, it differs a lot from SMF in that it features:

  • a new template system, using the Smarty 3 template engine
  • a plugin architecture that tries to avoid file edits for installing modifications (additional features). Plugins use hooks, both in the backend code and in the template system to add functionality to the software.
  • A completely new theme with a new layout, including a side bar.
  • A couple of new features, like a rating system, topic prefixes, user tagging, new bb codes, post caching and much more
  • Built-in "pretty" URLS (sometimes called SEO friendly)
  • Support for the Sphinx search daemon as replacement for the (slow) MySQL fulltext search.



Posted by Nightwish, October 23, 2012, at 04:50 PM read more...


TemplateHooks

Template hooks is a mechanism that allows plugins to insert generated output at specific locations. Plugins can register template fragments, which are chainable so that multiple plugins can populate the same hook position.

Lets assume, a plugin wants to extend the user block in the sidebar (the small block where the member's avatar, nick name and stats appear). First, the plugin must use a code hook (not discussed here, but the method is very similar to SMF) to generate the output. For example, a plugin could hook load_userdata to extend the $user_info array with its own data ,child?.

Of course, collecting data is fine, but we also need a way to display it. The typical method in SMF (and other forum systems) is to modify the template code and add a few lines of code to display our new data. While this works fine, it is complex and bears a lot of problems. So, there must be an easier way and template hooks are exactly what we need here.



Posted by Nightwish, October 23, 2012, at 03:56 PM read more...


DocIndex



Posted by Nightwish, July 31, 2012, at 08:02 PM read more...


Installation and configuration

Right now, there is no installer, so there isn't much to say here. This page will be updated when progress is made in the installer / updater scripts.

System requirements

This may change in the future, but basically, here is what you'll need to run EoS Alpha.



Posted by Nightwish, July 31, 2012, at 07:43 PM read more...


Rewrite rules for Pretty URLs

If you want to use Pretty URLs, the configuration is a two step process. First, you must setup your web server to perform the necessary URL rewriting. For EoS that's actually pretty easy, because all requests are routed through index.php, so a single rewrite rule should be sufficient.

Note that it is absolutely crucial to set up URL rewriting properly. Failing to do so can make your forum unaccessible, the admin panel, however should always work, because admin URLs are never using the pretty format.


Rewrite rules will not stop non-pretty URLs from working. EoS only uses pretty URLs for a couple of things like topics, boards, member profiles but not everywhere. Here are example rewrite rules for two of the most popular web servers, Apache and nginx. These are only examples though, pretty URLs should be able to work with any web server that supports simple URL rewriting.

Posted by Nightwish, July 31, 2012, at 03:53 PM read more...


Themes



Posted by Nightwish, July 30, 2012, at 03:07 AM read more...


Hooks in EoS Alpha

Hooks is a mechanism that allows to extend the functionality without modifying existing code. Basically, plugins? use hooks to "inject" their own code into the flow of execution for a given operation (for example, displaying a topic page). To make this possible, the software executes calls to a hook function in various locations. If no plugin has subscribed to a given hook, nothing happens and the hook function will return immediately. If, however, a plugin has indicated the intention to use a hook, its code will be executed when the hook function is called.

Hooks are chainable which means that multiple plugins can execute code in the same hook. Each hook has a clearly identifiable and descriptive name, for example boardindex is a valid hook name. To use a hook, a plugin must do the following things:

  • Indicate the hook(s) it wants to use.
  • Provide a piece of code (usually a function) that shall execute when the hook is called.


Hooks are persistently stored in the database when a plugin is activated and deleted when a plugin is deactivated. A deactivated plugin will therefore never execute any code.

Posted by admin, July 29, 2012, at 03:09 PM read more...


hooks



Posted by admin, July 29, 2012, at 04:39 AM read more...


10 Results – Page 1

Page generation time: 0.192 seconds