What are Modules?
- small scripts that teach FuSE how to display certain kinds of content
- can "wrap" output from other web applications/scripts into the FuSE content area
- may function independently from FuSE, but offer additional functionality when used with it
- require a three or four-letter "tag" used to activate them from the URL
- certain "special" modules are built-in to FuSE (i.e. articles)
- easy to author! only basic PHP knowledge required!
Articles (ART)
No screenshot - this page is a FuSE article!
You can see the source of this page here!
Description - Articles are the primary form of FuSE content. They are merely plain text and/or HTML files copied into the content area, with newlines automatically converted to <br /> tags.
Configuration - There are four configurable options: the path to the articles, the path to the images, and the default file extension for articles (.txt or .htm/.html) and for images (.jpg, .gif, or .png)
Operation - Call with ?articlename or ?articlename;ART. FuSE will search the specified article path for a file named articlename with the default file extension, and if it exists, its' contents will be displayed in the content area. If an image called articlename exists in the specified image path with the default image extension, it will be displayed alongside the article. If the article does not exist, an error is shown.
Note - The article "module" is not truly modular, as it is built into the FuSE engine. Configuration for the article module is performed through the fuse.conf.php file alongside the site information. Also, the article module will get automatically called if no module is specified on the URL passed to FuSE.
Preformatted Text (PRE)
Description - Treats an article as preformatted text.
Configuration - See article module.
Operation - Call with ?articlename;PRE. FuSE will operate the same way as the article parser, however it will display the text of the article in a monospaced font (ignoring the fonts the template uses to format the content area) and not automatically convert linebreaks.
Blogs (BLOG)
Description - Add a simple blog or news posting area to your site! The FuSEblog module supports unlimited blogs, unlimited posts per blog, template-specific blog display settings, and avatar pictures for each blog.
Configuration - Create a folder (i.e. "fuseblog") and edit the fuseblog.mod.php file containing the path to this folder. Inside the "fuseblog" folder, you can create any number of folders, each of these is considered to be a blog. Adding a plain text file to one of these folders equates to adding a new post to that specific blog. You also have the option of creating another "fuseblog" folder within your article images directory, and any image placed within this folder with the same name as a blog will be displayed alongside the blog contents when that blog is accessed. Finally, you have the option of creating bloghead.tmpl.php and blogfoot.tmpl.php files for your templates, the contents of which will be displayed above and below blogs in the content area of your site.
Operation - Call with ?blogname;BLOG. FuSE will search the "fuseblog" folder for a folder called blogname and then display the contents of all plain text files contained within that folder in the content area of your site. The content of each text file is seperated by a divider line and preceeded by the last modified date of the text file (though this behaviour can be modified template-wise if a blog.tmpl.php file is created for each template). An appropriate error message is displayed in the event that blogname does not exist, or has no posts to it.
Galleries (GAL)
Description - Add a photo gallery to your site! The FuSEgal module supports unlimited galleries, unlimited photos per gallery, and template-specific gallery display settings.
Configuration - Create a folder (i.e. "galleries") and edit the fusegal.mod.php file containing the path to this folder. Here you may also specify the number of images per row, and the number of rows per page (multiply the two numbers together to get the total number of images per page). Inside the "galleries" folder, you can create any number of folders, each of these is considered to be a gallery. Add an image to one of these folders to add it to that specific gallery. Finally, you have the option of creating galhead.tmpl.php and galfoot.tmpl.php files for your templates, the contents of which will be displayed above and below galleries in the content area of your site. If a folder titled "thumbs" exists within one of the gallery folders, the images used within "thumbs" will be displayed as thumbnails for your images, otherwise FuSE will resize the full-size images to a configurable thumbnail size.
Operation - Call with ?galname;GAL. FuSE will search the "gallery" folder for a folder called galname and then display thumbnails of all images contained within that folder in the content area of your site (the thumbnails are linked to full-size images). An appropriate error message is displayed in the event that galname does not exist, or has no images contained within.
Miniplayers (MPL)
Description - Want to add music/karaoke to your FuSE site? Do it with style! Do it with a MiniPlayer! This module wraps the excellent MiniPlayer script created by So-You.net into the FuSE content area, provides a simple configuration file, and adds an optional lyrics display.
Configuration - Create a folder (i.e. "miniplayer") and edit the miniplayer.mod.php file containing the path to this folder. Inside the "miniplayer" folder, you can create any number of folders, each of these is considered to be a miniplayer and must contain a file called "miniplayer.conf.php". This file must contain the following information: artist, title, path to song to play, background image, button color, and image to scroll at the base of the player.
Operation - Call with ?playername;MPL. FuSE will search the "miniplayer" folder for a folder called playername and dynamically build a miniplayer based upon the configuration set in "miniplayer.conf.php" located within that folder. Any text located in a file called "lyrics.txt" within the "playername" folder will be displayed beneath the miniplayer.
MyTopix Forums (MTX)
Description - "Wraps" the output of the MyTopix (or its' predecessor, Thema Topico), skin and all, into the FuSE content area.
Configuration - There are three configuration options for this module: they are the title to display in the FuSE content area, the path to your MyTopix installation, and a toggle switch between "MyTopix mode" and "Topico mode".
Operation - Call with ?a (or any ordinary MyTopix URL). The content of the requested MyTopix page will be shown in FuSE.
Note - In order to provide direct URL translation between FuSE and MyTopix, if this module is installed, FuSE will reserve the following URL queries so they may NOT be used to request as content names by any other module: ?a, ?getforum, ?gettopic, ?getuser, ?getevent