Table of Contents
1. Installation and Configuration
Requirements
All software which has to be installed to set up spunQ.
Installation
Download, extract and set up vHosts.
Database Creation - PostgreSQL specific
Get a spunQ database in PostgreSQL.
Database Creation - mySQL specific
Get a spunQ database in mySQL.
Configuration
Setting important system variables.
File Permissions
Some directories have to be writable by the webserver's user.
Running the sample site
After installation, check out the system!
2. How spunQ works
> Software Architecture
Layer Model
The software is strictly separated into different layers.
Data Structure
How classes, members and metadata is stored.
Permissions - "System Groups"
Description of spunQ's "System Groups".
Permissions - Content Groups
Description of spunQ's "Content Groups" system.
Relations between Objects
A Description of how relations are stored in the database.
Backend and Frontend
All you need to know about the separation of backend and frontend.
Multilingual Projects
The ability of spunQ to create multilingual projects.
3. The spunQ Backend
> General Information
Navigation in the Backend
The navigation parts of the spunQ backend interface.
> Classes, Objects and Folders
Displaying Classes
The class view along with its functionalities.
Editing Class Objects and Folders
The "Edit Object" screen in brief.
Creating Relations
How spunQ objects can be associated.
Creating Translations
The translation of objects in the backend.
Creating Bookmarks
Save often used objects in your spunQ bookmarks.
Object Folders
The creation and editing of folders inside a class.
Class Tree View
The folder structure of a class at a glance.
> Search functions
AJAX Live Quick Search
The fastest way to search for an object in spunQ.
AJAX Class Full-Text Search
Search within the metadata of all objects inside a class.
The Advanced Search
For more control on how the search is performed.
> The "Tools" Menu
ProjectsAdmin
You can manage more than one projects with one spunQ instance.
Object Statistics
How many objects have I created? How many are already translated? Get the info here!
RSS Feeds
Update your RSS feeds and see their current content.
DB Backup
Nothing is more frustrating than loosing valuable data.
Preferences
Change your user data and password here.
> The "System Settings" Menu
DB Config - Creating Classes
The first step to get content into spunQ.
DB Config - Editing Classes
Change the metadata for each spunQ class.
User
Management of the spunQ user accounts.
System Groups
Grant permissions and edit the user interface for creating objects.
Content Groups
Managing rights on class objects.
Controls
spunQ's interface elements for input forms.
4. The spunQ Frontend
General Information about the Frontend
Basic ideas on the spunQ frontend.
Frontend Generation
What happens when your spunQ frontend is called.
Smarty Template Structure
The very basics on how to structurize your templates.
5. Advanced Topics
Configuring RSS Feeds
Design spunQ's RSS feeds to fit your needs.
Creating your own AJAX Form Validations
New AJAX validation elements can easily be added.
Adding Controls
Create your own interface elements for forms in spunQ.
Personalizing the Backend Menu
You may want modify the menu items in the backend.
6. Files and Tables
File Structure - Backend
Where code, classes, templates etc. reside in the backend.
File Structure - Frontend
Where code, classes, templates etc. reside in the frontend.
File Structure - additional Files
The location of FCKeditor, Smarty and update scripts.
Database Structure
All needed tables with explanation of their contents.