Index - Septum

Septum

A site templating engine

Septum Reference

Source Code

Everything

Index

$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z

A
	Author
B
OPTION_	BASE_PATH
CONST_	BEGINNING_QUOTES
C
OPTION_	CACHE_DOCUMENT
OPTION_	CACHE_TIME
	Constants
	Creating a page
D
	Download
E
CONST_	ENDING_QUOTES
OPTION_	ERROR_PAGE
fn	ExpandComplexToken
F
	Functions
G
fn	GetFile
fn	GetPage
fn	GetTokens
I
	Information
	Instructions
K
CONST_	KEYWORDS_END
L
	Loading the page
M
fn	Main
	Main file
	Miscellaneous
O
	Options
P
OPTION_	PAGE_EXTENSION
OPTION_	PAGE_NAME
CONST_	PARAM_KEYWORD
fn	ParseTokens
	Program
Q
	Quick start
R
fn	ReplaceParameters
fn	ReplaceTokens
OPTION_	RETURN_FULL_PAGE
S
	Septum Reference
	Syntax
T
OPTION_	TEMPLATE_NAME
CONST_	TOKEN_END
	Tokens

The program and documentation were written by Poromenos.

This will be prepended to the page filename.

The type of beginning token quotes to use.

Specifies whether or not to use document caching.

Specifies the number of seconds to cache the page.

The page you create should be called name.pg, for example index.pg.

The type of ending token quotes to use.

The page to be returned when the requested page could not be found.

function fnExpandComplexToken( $strToken,
$strValue )

Replaces a complex token with its value.

function fnGetFile( $strPage,
$intMethod )

Returns a file through the method specified (file, MySQL page, etc).

function fnGetPage( $strFile )

Returns the page section of a file.

function fnGetTokens( $strFile )

Returns the tokens section of a file.

You can download Septum from SourceForge (http://sourceforge.net/project/showfiles.php?group_id=125013&package_id=137225&release_id=286887).

The tokens ending keyword.

To load a page, you need to specify its name.

function fnMain()

The main function.

This is the implementation of Septum.

Specifies the extension that each page will have.

Specifies the variable to use when GETting the page, for example www.myserver.com/index.php?page=index.

The token parameter keyword.

function fnParseTokens( $strFile )

Parses the tokens section of a file.

This program is released under the GNU GPL.

Using Septum is easy.

function fnReplaceParameters( $strToken,
$strValue,
$strText )

Replaces a token with its value taking into account that it may contain other tokens within it.

function fnReplaceTokens( $strFile,
$arrTokens )

Replaces tokens in $strFile with the text specified in $arrTokens.

Specifies what to return when the page has no KEYWORDS_END token.

This is the Septum reference.

Specifies the name of the template file.

The token ending keyword.

Tokens are placeholders for your text.