Documentation • Ultra lightweight website engine

Develop
•
Documentation

Content publishing

These pseudo tags offer special features inside articles and extra contents.

Break

Adds document break and read more link to your article.

<break>

Code

Quotes code and converts special characters to HTML entities.

Function

Calls PHP and module functionality.

<function>function_name|value->array(key => value)</function>

Shortcut keys

Trigger okay action.

CLTR + ALT + O

Trigger cancel action.

CLTR + ALT + C

Trigger submit action.

CLTR + ALT + S

Toggle admin docks.

CLTR + ALT + D

Template markup

Edit corresponding PHTMLHTML page that includes a PHP script files located in your template folder to customize your markup.

Head

Generates dynamic title and metadata inside head tag.

<?php head(); ?>

Styles

Loads needed CSS inside head tag.

<?php styles(); ?>

Scripts

Loads needed Javascript.

<?php scripts(); ?>

Center

Displays main contents and manages default post and routing.

<?php center(); ?>

Extras

Displays extra contents.
Setup $filter by an existing rank (number) or alias (string) to display a single extra only.

<?php extras($filter); ?>

Navigation list

Displays a navigation list.
Setup $table (string) by choosing categories, articles, extras or comments.

<?php navigation_list($table, $options); ?>

Setup $options (array) to customize your navigation list.

array(
	'children' => 1,
	'parent' => 1,
	'class' => 'name',
	'filter_alias' => '"alias", "alias", "alias"',
	'filter_rank' => '1, 2, 3'
	'id' => 'name',
	'limit' => 5,
	'order' => 'asc'
)

Languages list

Displays available languages.

<?php languages_list($options); ?>

Setup $options (array) to customize your languages list.

array(
	'class' => 'name',
	'id' => 'name'
)

Templates list

Displays available templates.

<?php templates_list($options); ?>

Setup $options (array) to customize your templates list.

array(
	'class' => 'name',
	'id' => 'name'
)

Login list

Displays a login list, including several administrative links.

<?php login_list(); ?>

Breadcrumb

Generates a breadcrumb list.

<?php breadcrumb(); ?>

Search

Displays a search form.

<?php search(); ?>

Helper classes

Setup a helper class according to the visitor's browser and version.

<html class="<?php echo MY_BROWSER . MY_BROWSER_VERSION; ?>">

Generate a class according to the current section by using the LAST_PARAMETER constant.

<html class="<?php echo LAST_PARAMETER; ?>">

The on-demand loader handles to join, minify and output multiple CSS and Javascript files as needed. There are two .loader INI files inside template/styles and template/scripts that are responsible to config the loader.

Customize the core files, keep in mind to rename your template folder.

[template]
1 = styles/reset.css
2 = templates/{your-template}/styles/box.css
3 = templates/{your-template}/styles/form.css

Include MY_BROWSER and MY_ENGINE related files.

[msie]
1 = styles/msie.css
2 = templates/{your-template}/styles/msie.css

A couple of settings.

[settings]
deploy = inline
rewrite = false
minify = true

Inherit the configuration from another template.

[inherit]
1 = {your-template}

Extend the template you inherit from.

[template]
1 = templates/{your-template}/styles/extend.css

Cheat sheet

Javascript objects

General	Description
General	Description
l	Languages transport object
r	Global Redaxscript object

PHP gets

General	Example	Description
General	Example	Description
p	develop/documentation	Parameter route string
l	en	Language string
t	default_extend	Template string

PHP constants

General	Example	Description
General	Example	Description
FILE	index.php	Current filename in use
ROOT	http://redaxscript.com	Website's root directory
PREFIX		Database table's prefix
DB_CONNECTED	1	Database connection status
DB_ERROR		Database connection error
LOGGED_IN		Equals TOKEN if logged in
ATTACK_BLOCKED		Blocker's overall counter
RENDER_BREAK		Break template rendering
CENTER_BREAK		Break center routing

Hashes	Example	Description
Hashes	Example	Description
TOKEN	917d00cc2350bb298e646692bd333ed294cd06d8	Session based security key
SALT		Security key stored in config.php

Parameters	Example	Description
Parameters	Example	Description
FIRST_PARAMETER	develop	First route parameter
FIRST_SUB_PARAMETER		First sub route parameter
SECOND_PARAMETER	documentation	Second route parameter
SECOND_SUB_PARAMETER		Second sub route parameter
THIRD_PARAMETER		Third route parameter
THIRD_SUB_PARAMETER		Third sub route parameter
LAST_PARAMETER	documentation	Last route parameter
LAST_SUB_PARAMETER		Last sub route parameter
TOKEN_PARAMETER		Token parameter
ADMIN_PARAMETER		Admin parameter
TABLE_PARAMETER		Table parameter
ID_PARAMETER		ID parameter
ALIAS_PARAMETER		Alias parameter

Routes	Example	Description
Routes	Example	Description
FULL_ROUTE	develop/documentation	Contains all route parameter
FULL_TOP_ROUTE	develop/documentation	Equals FULL_ROUTE, without sub route parameter
REWRITE_ROUTE		Parameter route GET prefix
LANGUAGE_ROUTE	.	Language GET prefix
TEMPLATE_ROUTE	.	Template GET prefix
REFRESH_ROUTE		Route for meta refresh

IDs	Example	Description
IDs	Example	Description
CATEGORY	10	ID of current category
ARTICLE		ID of current article
LAST_ID	10	ID of current content

User	Example	Description
User	Example	Description
MY_IP	107.22.127.92	User's internet protocol address
MY_BROWSER		User's web browser
MY_BROWSER_VERSION		User's web browser version
MY_ENGINE		User's web browser engine
MY_SYSTEM		User's operating system
MY_MOBILE		User's mobile device
MY_ID		User's ID
MY_NAME		User's public name
MY_USER		User's login name
MY_EMAIL		User's E-mail address
MY_GROUPS		User's groups

Access	Example	Description
Access	Example	Description
CATEGORIES_NEW		Permission to create categories
CATEGORIES_EDIT		Permission to edit categories
CATEGORIES_DELETE		Permission to delete categories
ARTICLES_NEW		Permission to create articles
ARTICLES_EDIT		Permission to edit articles
ARTICLES_DELETE		Permission to delete articles
EXTRAS_NEW		Permission to create extras
EXTRAS_EDIT		Permission to edit extras
EXTRAS_DELETE		Permission to delete extras
COMMENTS_NEW		Permission to create comments
COMMENTS_EDIT		Permission to edit comments
COMMENTS_DELETE		Permission to delete comments
GROUPS_NEW		Permission to create groups
GROUPS_EDIT		Permission to edit groups
GROUPS_DELETE		Permission to delete groups
USERS_NEW		Permission to create users
USERS_EDIT		Permission to edit users
USERS_DELETE		Permission to delete users
USERS_EXCEPTION		Permission exception for profile
MODULES_INSTALL		Permission to install modules
MODULES_EDIT		Permission to edit modules
MODULES_UNINSTALL		Permission to uninstall modules
SETTINGS_EDIT		Permission to edit settings
FILTER	1	Filter untrusted users
TABLE_NEW		Permission to create for current table
TABLE_INSTALL		Permission to install for current table
TABLE_EDIT		Permission to edit for current table
TABLE_DELETE		Permission to delete for current table
TABLE_UNINSTALL		Permission to uninstall for current table

Time	Example	Description
Time	Example	Description
GMDATE	Sat, 18 May 2013 13:10:22 GMT	Current GMT date
GMDATE_PLUS_WEEK	Sat, 25 May 2013 13:10:22 GMT	Current GMT date plus one week
GMDATE_PLUS_YEAR	Sun, 18 May 2014 13:10:22 GMT	Current GMT date plus one year
NOW	2013-05-18 15:10:22	Current time
DELAY	2013-05-18 15:11:22	NOW plus one minute
TODAY	2013-05-18	Current date
UPDATE		Time for next update

Detection	Example	Description
Detection	Example	Description
LANGUAGE	en	Detected language
TEMPLATE	default_extend	Detected template
CONTENT_ERROR	0	Detected content error

Metadata	Example	Description
Metadata	Example	Description
TITLE		Overrides meta title
DESCRIPTION		Overrides meta description
KEYWORDS		Overrides meta keywords
ROBOTS		Overrides meta robots

Module hooks

General	Description
General	Description
render_start	Before template render
render_end	After template render
center_start	Before center routing
center_end	After center routing

Loader	Description
Loader	Description
loader_start	Start of loader
loader_end	End of loader
loader_styles_transport_start	Start of loader style transport
loader_styles_transport_end	End of loader style transport
loader_scripts_transport_start	Start of loader scripts transport
loader_scripts_transport_end	End of loader scripts transport

Head	Description
Head	Description
head_start	Start of head
head_end	End of head
styles_start	Start of styles
styles_end	End of styles
scripts_start	Start of scripts
scripts_end	End of scripts

Contents	Description
Contents	Description
contents_start	Start of contents
contents_end	End of contents
article_start	Start of each article
article_end	End of each article
comments_start	Start of comments
comments_end	End of comments
comment_start	Start of each comment
comment_end	End of each comment
extras_start	Start of extras
extras_end	End of extras
extra_start	Start of each extra
extra_end	End of each extra
infoline_start	Start of infoline
infoline_end	End of infoline
pagination_start	Start of pagination
pagination_end	End of pagination
notification_start	Start of notification
notification_end	End of notification

Forms	Description
Forms	Description
search_form_start	Start of search form
search_form_end	End of search form
comment_form_start	Start of comment form
comment_form_end	End of comment form
login_form_start	Start of login form
login_form_end	End of login form
reminder_form_start	Start of reminder form
reminder_form_end	End of reminder form
registration_form_start	Start of registration form
registration_form_end	End of registration form

Interface	Description
Interface	Description
breadcrumb_start	Start of breadcrumb
breadcrumb_end	End of breadcrumb
pagination_start	Start of pagination
pagination_end	End of pagination
navigation_list_start	Start of navigation list
navigation_list_end	End of navigation list
languages_list_start	Start of languages list
languages_list_end	End of languages list
templates_list_start	Start of templates list
templates_list_end	End of templates list

Admin contents	Description
Admin contents	Description
admin_dock_start	Start of admin dock
admin_dock_end	End of admin dock
admin_notification_start	Start of admin notification
admin_notification_end	End of admin notification

Admin forms	Description
Admin forms	Description
admin_contents_form_start	Start of admin contents form
admin_contents_form_end	End of admin contents form
admin_groups_form_start	Start of admin groups form
admin_groups_form_end	End of admin groups form
admin_users_form_start	Start of admin users form
admin_users_form_end	End of admin users form
admin_modules_form_start	Start of admin modules form
admin_modules_form_end	End of admin modules form
admin_settings_form_start	Start of admin settings form
admin_settings_form_end	End of admin settings form

Admin interface	Description
Admin interface	Description
admin_contents_list_start	Start of admin contents list
admin_contents_list_end	End of admin contents list
admin_groups_list_start	Start of admin groups list
admin_groups_list_end	End of admin groups list
admin_users_list_start	Start of admin users list
admin_users_list_end	End of admin users list
admin_modules_list_start	Start of admin modules list
admin_modules_list_end	End of admin modules list
admin_panel_list_start	Start of admin panel list
admin_panel_list_end	End of admin panel list
admin_panel_list_modules	Modules list in admin panel