CMS Developer
BestWebs.org
Home     PackChat     Forums     News     Documentation  ·  Support
> Macros Documentation
Macros

System macros:

//you	is replaced by the members name (Guest)
	(can be used globally! templates and posts for example)

sections:	the macro

part,function,display		'part' can be one of the following
root, root-v 		- displays the root menu horizontally or
			  (-v) vertically ('function' ignored)
sub menu			- displays the submenu tree of the currently active root

all, all-v			- display root- and submenus
			  (if 'all': 'function' uses 'fly' or 'fade' only)

	'function' can be one of the following

normal		- default display mode (folds by loading a page)
-blocks			- completely expanded blocks
-fold			- folding blocks
-tree			- a folding tree (like Windows Explorer)
-fly			- DHTML menu
-fade			- same as 'fly', but fading in (not out)

	'display' can be one of the following

text			- displays the raw title
template			- wraps the title in the local template
			  (the local template can contain anything)

title,where		'where' can be 'root' or 'current'

system:	the macro

navpath,separator		displays the navpath ('separator' [->] can be replaced, in the demo

	I'm using the IPB macro  » )

more			displays 'more...' can be used for a link
			(there's an automatic one for most purposes though)
member,panel		displays the members control center
member,panel_title		displays control centers title
member,id			displays the members id when online
member,name		displays the members name when online

member,last_visit[,opt]	displays last visit date of the member when online.

[,opt] (optional) 'short', 'long' or format string (PHP date)

member,last_action[,opt]	displays last action date of the member when online.
[,opt] see above

member,group		displays the members name when online
member,usercp		displays the User CP link when needed
member,modcp		displays the Mod CP link when needed
member,admincp		displays the Admin CP link when needed
member,revalidate		displays the revalidate link
member,logout		displays the Logout link
member,newmsgs		displays the New Messages link
member,newposts		displays the New Posts link

stats,birthdays,#,mode	-lists mems who celebrate their b-day.
			 # see below, 'mode' (optional) can be 'block' or 'list' (default)

stats,online,#,mode		lists members who are online.
			# is a number, how many names to list max. 'mode'
			can be 'block' or 'list' (default)

stats,online,members		number of members online.
stats,online,guests		number of guests online
stats,online,anon		number of hidden members online
stats,online,total		total number of users online
stats,count,articles		total amount of articles
stats,count,posts		total amount of posts
stats,count,topics		total amount of topics
stats,count,replies		total amount of replies
stats,count,members		total amount of members
stats,count,most		max users ever online
stats,count,most_date[,opt]	date most users were online.
[,opt] see above

system_stats		displays bottom stats (execution time and stuff)

System Inline Macros:

container			(Used in Container Wrappers only.)
container:content		Content that is wrapped.
container:title		Title of the container that is wrapped.

Skin macros:

skin:
quick_login 		displays the quick login form
member_login		alias for system:member,panel (login only)
member_panel		alias for system:member,panel (for valid members only)
separator,title,style		displays a separator 'title' can be one of the
			following; a freely definable string

lang(indexname)		- loaded from the language file
title(cur_section)		- title of the current section
title(page)  		- title of the current page
title(sel_section)		- the title of the currently selected section
template(macro_name)	- from the tempate by macro name

'style' (optional)		is the classname of the default IPB style sheets,
			usually '.pformstrip' or '.titlemedium'

Board macros:

board_sections:
function			displays categories and forums. functions are
			described in 'sections' (vertical style only!)

board:		the macro

control,text,help		displays the help link as text
control,icon,help		displays the help link with icon and text
control,text,search		displays the help link as text
control,icon,search		displays the help link with icon and text
control,text,members		displays the members link as text
control,icon,members		displays the members link with icon and text
control,text,calendar		displays the calendar link as text
control,icon,calendar		displays the calendar link with icon and text
control,text,chat		displays the chat link as text
control,icon,chat		displays the chat link with icon and text
	
news:			displays news from the forums news section

#[-#],template		displays news fully formatted by 'template' (macro name).

Use the macros below to format the news.

# is the index of the news or when #-# the index of the first news item
[-#] (optional) to make a list of news and means 'to index' (number of items)

			(for the single view template only)
title			displays the title of the news
title_link			displays the title of the news as link
subtitle			displays the description of the news
date			displays the date of the news
author			displays the author of the news
content[,len]		displays the content of the news. 'len' (optional means to
			cut content off at a max of 'len' characters.)
			A 'more...' link will be inserted on demand

forum			displays the name of the forum where the news is at
forum_link			same as above, but as link

topics:

#[-#],template		displays topic fully formatted by 'template' (macro name).

	Use the macros below to format the topic.

# is the index of the topic or when #-# the index of the first topic
[-#] (optional) to make a list of topics and means 'to index'

			(for the single view template only)
title			displays the title of the topic
title_link			displays the title of the topic as link
subtitle			displays the description of the topic
date			displays the date of the topic
author			displays the author of the topic
forum			displays the name of the forum where the topic is in
forum_link			same as above, but as link

NOTE: (#) Indexes are 1-based and cannot be higher than 10.

	The setting for the highest index can be adjusted if needed.
	This is valid for both, 'news:' and 'topics:' macros.

board_hcontrolbar		displays ipb control bar horizontal
			(help, search and stuff. alternative board:control functions)
board_vcontrolbar		displays ipb control bar vertical
			(help, search and stuff. alternative board:control functions)
board_menubar		displays ipb menu bar
			(alternative: system:member, panel or other system:member functions)
board_chat			displays chat link if needed (in control bar for example)
board_rules		displays board rules if needed

	(Board Wrapper Only)

board_main		displays the forum boards
board_navigation		displays ipb navpath

User definable macros:
Macros named for templates and containers can be applied anywhere. 

IPB macros are applied everywhere!! <{MACRO}>
IPB style images directory can be used as well <#IMG_DIR#> = ffspirit-987
 

Webmaster@packcat.org
  packcat.org © 1996-2009

web site conversion 97% complete!