P. 1
MODx Cheat Sheet

MODx Cheat Sheet

|Views: 2,260|Likes:
Published by Yahya Nursalim

More info:

Published by: Yahya Nursalim on Feb 28, 2010
Copyright:Attribution Non-commercial

Availability:

Read on Scribd mobile: iPhone, iPad and Android.
download as XLS, PDF, TXT or read online from Scribd
See more
See less

05/22/2013

pdf

text

original

Copyright, 2009, by Brandon Booth. All rights reserved.

Permission is granted to make copies of this spreadsheet for private use only.
Please visit my ebsite at! .lucidgreen.net
PLEASE NOTE:
Official Docs: http!""svn.mod#cms.com"docs"display"$%&#09'"(ome
Wiki: http!""iki.mod#cms.com"inde#.php"$ain)Page
Site Settings Tags
*+site)start,- &ocument .& of the site/s starting page
*+site)url,- the url to the site! http!"".mysite.com"mod#
*+base)url,- sites relative base url i.e. "mod#"
Template Variables
http!""svn.mod#cms.com"docs"display"$%&#09'"&ocument01pecific23esource24ields
*5pagetitle5- Page title from manager
*5longtitle5- 6ong title from manager
*5description5- &escription form manager
*5introte#t5- .ntro te#t from manager
*57content5- &ocument content, the 7 allos this variable to edited ith 8uickedit.
*5parent5-
*5id5- current page/s id
*5type5- 9hether document, folder or eblink
*5alias5- document alias
*5link)attributes 0 :he 6ink Attributes of the page, eg. rel;, target; etc.
*5published 0 *0<=- 9hether or not the document is published.
*5pub)date
*5unpub)date 0 &ate the document is to be unpublished. 1ee /pub)date/.
*5parent 0 :he .& of the document/s parent.
*5isfolder 0 *0<=- 9hether or not the document is a folder.
*5richte#t
*5template 0 :he .& of the template to used for the document.
*5menuinde# 0 :he order in hich the document is to be listed in the menu.
*5searchable 0 *0<=- 9hether or not the document is to be searchable.
*5cacheable 0 *0<=- 9hether or not the document is to be cached.
*5createdby 0 :he user .& of the creator of the document.
*5createdon 0 :he date the document as created. 1ee pub)date.
*5editedby 0 :he .& of the user ho last edited the document.
*5editedon 0 :he date the document as last edited. 1ee pub)date.
*5deleted
*5deletedon 0 :he date the document as deleted. 1ee pub)date.
7 deletedby 0 :he .& of the user ho deleted the document.
7 menutitle 0 :he title to be shon in the menu. .f empty, the pagetitle is used.
7 donthit 0 *0<=- &isable page hit count for the document.
7 haskeyords 0 *0<=- 9hether or not the document has links to keyords.
7 hasmetatags 0 *0<=- 9hether or not the document has links to meta tags
:his document applies to $od# 0.9.'. $ore documentation can be
found at the folloing links!
:hese may be used in templates, documents, snippets, chunks and in snippet calls +e.g. **9ayfinder>
?start.&;@*+site)start,-@--
:emplate Aariables +aka :As, can be used in templates, and directly in documents. :hey can also be
called ithin snippets and chunks
Built in Document Specific
!esources
.& of parent document +e.g. link to parent document ith!
*B*5parent5-B-,
0 &ate the document is to be published. :his is not a CnormalC date,
and must be processed by a script for meaningful output.
0 *0<=- 9hether or not a 3ich:e#t Dditor is to be used hen editing the
document.
0 *0<=- 9hether or not the document has been deleted +but not yet
completely removed from the database by emptying the trash,.
7 privateeb
7 privatemgr
7 content)dispo
7 hidemenu 0 *0<=- 9hether or not the document is to be hidden in the menu.
"ustom template #ariables
*5custom name5- Any custom template variable
$B%ND%N&S
E&.3DC:%3F path)to)folder
E.G(D3.:
E4.6D file)path
E&%CH$DG: document)id
EC(HGI chunk)name
E1D6DC: sJl)statement
EDAA6 php)code
Snippets
**snippetname-- Cached format +output only updated hen page is re0cached,
*KsnippetnameK- Hncached format +output is updated on every page call,
A snippet call ith a setting variable.
"'unks
LLchunknameMM Basic format
manipulate chunks ith AP. in snippet
links
*B7B- links to document hose .& ; 7, e.g. *BNB-
0 *0<=- 9hether or not this document has been assigned to a private
eb document group.
0 *0<=- 9hether or not this document has been assigned to a private
manager document group.
0 *0<=- 9hether the document/s content0disposition is attachment or
inline.
O:Aarray ; Omod#0
Pget:emplateAar%utput+array+/:A
GA$D/,,Q
Calling :As in a snippet
:he content of the :A is no in the array O:Aarray*/:A GA$D/- by
character. +e.g. O:Aarray*/:A GA$D/-*=- is the second character in the
string.
&ata 1ources can be tied +or RboundS, to a :emplate Aariable for
formatting and displaying in document. these can be used to fill a
template variable +even a default value, ith e#ternal data, other
documents from the document tree, etc.
Binds the variable to a folder, here path)to)folder) is the path to the
folder. .t returns the list of files in the specified folder.
default content cascades from parent document/s tv.
:his binding takes advantage of the hierarchical structure of the
document tree by alloing :emplate Aariable content to CcascadeC
don the document tree. 9hat this means is that you can apply
content to hole sections of your site by editing Tust one :A.
Binds the variable to a file, here file)path is the path and name of
the file. :he return value is a string containing the content of the file.
:he file path is the abosulte path from the root of the server or your
particular installation.
Binds the variable to a document. 9here document)id is the numeric
id of the document. :he returned value is a string containing the
content of the document.
Binds the variable to a document. 9here chunk)name is the name of
the chunk. :he returned value is a string containing the content of the
chunk.
Binds the variable to a database Juery that returns a recordset.
9here sJl)Juery is the actual database Juery. :he return value is a
recordset.
Dvaluates a string of php codes and process the returned value from
the code. 9here php)code is the actual php code to be evaluated.
:he returned value can be either a string, array or a recordset.
**snippet>
?settingAariable;@value@--
Omod#0Prun1nippet+ snippetGame,
array+Oparams,,Q
Calling a snippet in code for another snippet or module
DUA$P6D!
Oditto%utput ; Omod#0Prun1nippet+
C&ittoC,
array+
CtplC ;P
CVpostPVtitleP*2title2-V"titlePVsummaryP*2summary2-V"summaryPV"po
stPC
,
,Q
see! http!""iki.mod#cms.com"inde#.php"AP.!run1nippet
Chunks can contain basic te#t, (:$6, or template data for snippets. :hey cannot contain P(P code, but
they can contain calls to snippets
Omod#0PgetChunk+/chunkGame/,Q
Omod#0PputChunk+/chunkGame/,Q
Copyright, 2009, by Brandon Booth. All rights reserved. Permission is granted to make copies of this spreadsheet for private use only.
Site Settings Tags
Template Variables
http!""svn.mod#cms.com"docs"display"$%&#09'"&ocument01pecific23esource24ields
http!""iki.mod#cms.com"inde#
.php"Adding):A)9idgets)it
hout)hacking)the)core
Wa(fin)er Snippet
complete documentation ver. '
*seful Sample "alls
*K9ayfinder> ?start.d;@0@K- $inimum callQ start id 0 inde# from site root
Parameters list
Parameters T'at Determine W'ic' Documents to List
Parameter Description Value T(pe
?start.d integer
?level integer
?limit integer
?display1tart boolean
?ignore(idden boolean
?hide1ub$enus boolean
?include&ocs
?e#clude&ocs
Parameters T'at Specif( T'e Or)er in W'ic' to List Documents
Parameter &escription Aalue :ype
?sortBy
?sort%rder
Parameters T'at Determine t'e Values of "ertain Place'ol)ers
Parameter &escription Aalue :ype
?te#t%f6inks
?title%f6inks
?use9eblinkHrl boolean
?full6ink boolean
?ro.dPrefi# te#t string
?sho1ub&ocCount boolean
Some *tilit( Parameters
Parameter &escription Aalue :ype
?removeGe6ines boolean
?ph te#t string
?debug boolean
?config te#t string
?css:pl te#t string
?Ts:pl te#t string
Parameters T'at Assign "SS "lassnames
Parameter &escription Aalue :ype
T'e follo+ing appl( to output generate) b( ro+ templates:
?roClass te#t string
?firstClass C
,a-i&aller( scroll rig't
./
http!"".lucidgreen.net"mod#Wuides"ayfin
der200)docs)v'.html
*K9ayfinder> ?start.d;@0@ ?level;@=@
?outerClass;@nav@K-
:his is the only parameter that is alays
reJuired +it can be set inline in
the snippet call, or in a configuration file, but
either ay it/s reJuired,.
:his parameter specifies the .& of the
document hose descendants ill be
listed in 9ayfinder/s generated output.
:his parameter tells 9ayfinder the ma#imum
number of levels of hierarchy
that it may include in its output. A value of 0
+Xero,, or the absence of
this parameter, leaves the amount unlimited.
:his parameters tells 9ayfinder the
ma#imum number of items that it may
include in any list or sub0list. A value of 0
+Xero,, or the absence of this
parameter, leaves the amount unlimited.
Gormally 9ayfinder only lists the
descendants of the document specified in
?start.d. But hen you set this parameter to
:3HD, and if ?start.d is
set to a value other than Xero, then 9ayfinder
ill use the template
specified in the parameter ?start.tem:pl to
display information about the
start document. :his is particularly useful
hen using 9ayfinder to generate
a subsidiary menu hose header or title
block needs to display information
from the starting document.
Gormally 9ayfinder does not include in its
listings documents hose Csho in
menuC checkbo# has been unchecked. But
setting this parameter to :3HD
overrides this behavior and causes 9ayfinder
to include these documents in
its listings.
Gormally 9ayfinder ill list all levels of all
descendants of the starting
document. But by setting this parameter to
:3HD you can change this behavior
so that 9ayfinder only displays the
immediate children +if any, of the
currently displayed page. :his has the effect,
as you click don through a
menu hierarchy, of only shoing the path
from the top don to the current
level and then one level further.
:his ill sho a menu of only the documents
you ant included and no others. Comma0separated
list.
By default 9ayfinder lists all documents that
$%&# thinks should be visible
to the current user. But if there are certain
documents you don/t ant
listed under any condtion, then you can list
them in this parameter and
9ayfinder ill e#clude them from its output.
comma separated
list.
By default 9ayfinder sorts lists and sub0lists
by the value of the
menuinde# document field. But ith this
parameter you can choose from a
variety of other fields to sort by. Gote that all
lists and sub0lists +all
levels, ill be sorted by the field you choose
here.
one of the folloing
predefined terms.
By default 9ayfinder sorts each list and sub0
list in ascending order. 9ith
this parameter you can change to descending
order. Gote that in either case
the sort order is the same for all lists and sub0
lists +all levels, in the
generated output.
%ne of the folloing
predefined terms.
By default 9ayfinder uses the menutitle field
of each document as the
visible name of each (:$6 link it outputs.
:his parameter lets you specify a
different field as the source of this te#t. .f you
create you/re on
templates, the field specified by this
parameter becomes the value of the
*2f.linkte#t2- placeholder.
one of the folloing
predefined terms.
By default 9ayfinder uses the pagetitle field
of each document as the
value of the title attribute of each (:$6 link it
outputs. :his parameter
lets you specify a different field as the source
of this te#t. .f you create
you/re on templates, the field specified by
this parameter becomes the
value of the *2f.title2- placeholder.
one of the folloing
predefined termsone
of the folloing
predefined terms.
* C.f eblinks are used in the output,
9ayfinder ill output the link
specified in the eblink instead of the normal
$%&# link. :o use the
standard display of eblinks +like any other
document, set this to 4A61D.C
Cif set to :3HD the link specified in the
eblink ill be output to the
placeholder *2f.link2- 000 9hat the heck do
these descriptions, copied from
other documentation, mean>>>-
if set to :3HD outputs the full url instead of a
relative path.
.f you/re riting custom templates and need
an uniJue identifier for each
ro, then this is the parameter for you. 4or
each document that 9ayfinder
lists, the value you set in this parameter ill
be prepended to the document
.& then placed in the *2f.id2- placeholder.
:his placeholder can then be
used in any ro0level template.
.f this parameter is set to :3HD, then for
each document 9ayfinder ill fill
the placeholder *2f.subitemcount2- ith the
number of immediate children
of that document. :his placehold can be used
in any custom ro0level
template.
By default 9ayfinder includes in its output
any line breaks present in the
templates from hich the output is produced.
(oever setting this parameter
to C:3HDC ill cause 9ayfinder to strip out all
those line breaks and to
deliver it/s output in a long, unbroken line.
By &efault 9ayfinder inserts its output into
the location ithin the current
page/s template from hich it as called.
:hat is, the snippet call is
replaced by the snippet/s output. :his is the
normal behavior of snippets.
But by including this parameter in the call to
9ayfinder, you can tell
9ayfinder the name of a placeholder +a
name that you create, into hich it
should instead place its output. :his allos
you to place the call to
9ayfinder in one location ithin the page/s
template, and to have it/s
output appear in a different *or even
multiple>- location+s,.
9hen you set this parameter to :3HD, then
immediately folloing the normal
output 9ayfinder ill add a long, detailed
listing of all the internal
settings, values, templates, etc. that ere
used in the generation of its
output.
0 9ayfinder allos you to preload all of the
parameters and templates you
ant for a given 9ayfinder call into a single
configuration file. :hen by by
calling 9ayfinder ith *Kayfinder>
?config;@filename@K- you get all
the parameters and templates set at once.
0 1o, if this parameter e#ists then 9ayfinder
ill interpret the value
given as the part of a 9ayfinder
configuration file, here the full name of
the file must be .config.php and the file
must be in the directory
"assets"snippets"ayfinder"configs".
0 .f you specify a file that 9ayfinder can/t
find, then it ill look
instead for the default config file!

"assets"snippets"ayfinder"configs"default.co
nfig.php.
0 .f 9ayfinder can/t find either of these files,
then it ill ignore the
?config parameter.
0 1ee the Configuration 4ile section belo
for more details.
.f your use of 9ayfinder/s output reJuires a
C11 stylesheet you can do the
folloing to insure that the C11 is available!
=. Create a C11 file, and place all your
style defintions ithin.
2. Create a chunk, and place ithin it the
H36 of the C11 file.
N. 1et the ?css:pl parameter to the name
of the chunk.
:hen, hen 9ayfinder runs, it ill place a link
to the C11 file in the (DA&
section of the current ebpage. :he link ill
look like this! .
.f your use of 9ayfinder/s output reJuires
Yava1cript you can do the
folloing to insure that the Yava1cript is
available!
=. Create a Yava1cript file, and place all
your Yava1cript ithin.
2. Create a chunk, and place ithin it the
H36 of the Yava1cript file.
N. 1et the ?Ts:pl parameter to the name of
the chunk.
:hen hen 9ayfinder runs it ill place a link
to the Yava1cript file in the
(DA& section of the current ebpage. :he
link ill look like this! .
:he C11 class name specified in this
parameter ill appear in the
*2f.classes2- and *2f.classnames2-
placeholders of every ro.
:he C11 class name specified in this
parameter ill appear in the
*2f.classes2- and *2f.classnames2-
placeholders of the first ro of each
list and sub0list +i.e. at every level, in the
generated output.
?lastClass C
?selfClass C
?hereClass C
?parentClass C
?levelClass *. don/t kno hat this does.- C
?eb6inkClass C
T'e follo+ing appl( to output generate) b( container templates:
?outerClass C
?innerClass C
Parameters T'at Tell Wa(fin)er W'at Templates to *se
Parameter Description Value T(pe
:hese are the ro0level templates! +=,
?start.tem:pl te#t string
?ro:pl C
?inner3o:pl C
?here:pl C
?inner(ere:pl C
?parent3o:pl C
?parent3o(ere:pl C
?activeParent3o:pl >>> C
?category4olders:pl C
T'ese are t'e ro+.le#el templates: 012
?outer:pl C
?inner:pl C
Place'ol)ers T'at "an be *se) Wit'in Wa(fin)er Templates
Parameter &escription Comments
*2template)variable)name2-
*2document)field)name2-
*2f.rapper2-
*2f.classnames2-
*2f.classes2-
*2f.link2-
*2f.title2-
*2f.linkte#t2-
*2f.subitemcount2-
:he C11 class name specified in this
parameter ill appear in the
*2f.classes2- and *2f.classnames2-
placeholders of the last ro of each
list and sub0list +i.e. at each level, in the
generated output. By default
9ayfinder sets this parameter to ClastC.
:he C11 class name specified in this
parameter ill appear in the
*2f.classes2- and *2f.classnames2-
placeholders of the ro corresponding
to the current document. :hus it can only
appear once in any instance of
9ayfinder output.
:he C11 class name specified in this
parameter ill appear in the
*2f.classes2- and *2f.classnames2-
placeholders of the ro+s,
corresponding to! the current document, and
its parent, and its grandparent,
etc. all ay up to the level Tust belo the
starting document. :his allos
you to apply a distinctive set of style rules to
the chain of documents
that leads from the top of the menu structure
don to the current document
00 no matter ho many levels deep it might
be. Gote that these are the same
documents that ould be listed in a
breadcrumb trail.
:he C11 class name specified in this
parameter ill appear in the
*2f.classes2- and *2f.classnames2-
placeholders of every ro that
corresponds to a document that is a parent
+i.e. has children,.
:he C11 class name specified in this
parameter ill appear in the
*2f.classes2- and *2f.classnames2-
placeholders of all ros that represent
eb links rather than eb pages.
:he C11 class name specified in this
parameter ill appear in the
*2f.classes2- and *2f.classnames2-
placeholders of the ?outer:pltemplate.
:he C11 class name specified in this
parameter ill appear in the
*2f.classes2- and *2f.classnames2-
placeholders of the ?inner:pltemplate.
0 .f the ?display1tart parameter is set to
:3HD, then 9ayfinder ill
need a template for displaying information
from the starting document.
9ayfinder has a default template built in
+as shon belo,, but you can
optionally create your on.
0 Gote that, if ?display1tart parameter is set
to :3HD, then 9ayfinder
ill place the output of ?outer:pl +hich
contains the entire menu
structureK, into the *2f.rapper2-
placeholder of the ?start.tem:pl,
so be sure to include this placeholder in
your custom templateK
:his is the default template used for all ro0
level items e#cept the start
item.
0 .f specified, then this ill be used as the
generic template for every
ro shon in every sub0menu.
0 .f not specified then ?ro:pl ill be used.
*. assume that all the
foregoing is true regardless of hether
?inner:pl is specified>-
0 Dven if specified, this template ill be
overriden by other ro0level
templates here appropriate.
:his template ill be used for the ro
corresponding to the current
document, and its parent, and its
grandparent, etc. all ay up to the level
Tust belo the starting document. :his allos
you to apply a distinctive set
of style rules to the chain of documents that
leads from the top of the
menu structure don to the current document
00 no matter ho many levels
deep it might be. Gote that these are the
same documents that ould be
listed in a breadcrumb trail.
1ame as for ?here:pl, e#cept applies to all
submenus. .f this template is
defined, then the ?here:pl template ill only
be used for the highest
level of the menu hierarchy. .f this template is
not defined, then the
?here:pl template ill be used for all ros.
.f defined, then this template ill define the
output for ros that are
parents.
.f defined, then this template ill define the
output of all ros in the
ChereC chain that are above the last"loest
level +i.e. for all the
parents,.
.f defined, then this template ill define the
output for ros that +a, are
parents, and that +b, have no associated
document template or +c, have
their link attributes fields set to rel;CcategoryC.
:his is useful because sometimes eb
designers use CemptyC parents to
provide category header information for a set
of subsidiary pages, and you
don/t ant active links to these header pages
that have no eb page
template.
0 :he ?outer:pl template is one of the to
templates that are alays
reJuired. :his template provides the outer
CcontainerC for the ros that
comprise the menu 00 hich are all placed
in this template/s
*2f.rapper2- placeholder +so don/t forget
to include it,.
0 9ayfind has a built in template that it uses
to construct its default,
unordered list output.
0 .f you do not define an ?inner:pl, then the
?outer:pl ill be used
herever the ?inner:pl ould otherise be
used.
0 3emember that the ?inner:pl and ro0
level templates nest inside this
template, so make sure that you/ve
designed your ?outer:pl, ?inner:pl,
and ro0level templates to ork together to
create correct (:$6 hen they
nest inside each other.
0 .f a given document has children, and if
those children are to appear
in the output, then a sub0menu must be
created for them belo the parent
document. :he ?inner:pl is used as the
CcontainerC for the ros in this
sub0menu.
0 .f the ?inner:pl is specified, then it it used
for all the sub0menus
in 9ayfinder/s output, no matter ho
deeply nested, and the ?outer:plis used only
for the highest level of the menu structure.
0 %n the other hand, if the ?inner:pl is not
specified then the
?outer:pl ill be used as the container for
all levels of the menu
structure.
T'e follo+ing are place'ol)ers t'at
Wa(fin)er in'erits from t'e page
in
+'ic' it3s calle):
Any template variable used by the current
eb page/s template can be
referenced from ithin a 9ayfinder template.
Any standard document field can be
referenced from ithin a 9ayfinder
template.
T'e follo+ing are t'e a))itional place'ol)ers )efine) an) use) b( t'e
Wa(fin)er snipppet:
$ost +all>, of the templates potentially have
subsidiary content. 4or
e#ample, the ?outer:pl template normally
contains all the ros that make
up the menu. .t is the *2f.rapper2-
placeholder in each template that
tells 9ayfinder here to place the template/s
subsidiary content.
A 1PACD0separated list of any C11 class
names that apply ithin the conte#t
of the current template ill be placed ithin
this template. 9hich C11
classnames apply depend on three things!
=. 9hat is the nature of the current
template +container0level or
ro0level,>
2. 9hich C11 class names have you
specified ith 9ayfinder/s
class0defintion parameters>
N. And hat are the properties +parent, self,
here, etc., of the relevant
document +if in a ro template,>
:he content of this placeholder is the result of
this code!
class;C*2f.classnames2- . :his is is Tust a
list of the applicable C11
classnames, pre0packaged into an (:$6
CclassC attribute.
0 :his placeholder is intended to be used to
provide the value of the
ChrefC attribute of an (:$6 link.
0 :he H36 of the document corresponding
to this ro ill be placed in
this placeholder.
0 :his placeholder is intended to be used to
provide the value of the
CtitleC attribute of an (:$6 link.
0 :he ?title%f6inks parameter determines
the value of this placeholder.
.t defaults to the pagetitle field of the
document corresponding to
this ro.
0 :his placeholder is intended to be used to
provide the te#t that is
displayed on a ebpage for an (:$6 link.
0 :he ?te#t%f6inks parameter determines
the value of this placeholder.
.t defaults to the menutitle field of the
document corresponding to
this ro.
:he number of immediate children +0 or a
positive integer,, of the document
corresponding to this ro, ill be placed in
this placeholder.
Parameters list
Legal Values Default Value "omments
0
0
:3HD, 4A61D 4A61D
:3HD, 4A61D 4A61D
:3HD, 4A61D 4A61D
+empty,
+empty,
Parameters T'at Specif( T'e Or)er in W'ic' to List Documents
6egal Aalues &efault Aalue Comments
menuinde#
A1C
Parameters T'at Determine t'e Values of "ertain Place'ol)ers
6egal Aalues &efault Aalue Comments
menutitle
pagetitle
:3HD, 4A61D 4A61D
:3HD, 4A61D 4A61D
+empty,
:3HD, 4A61D 4A61D
Some *tilit( Parameters
6egal Aalues &efault Aalue Comments
:3HD, 4A61D 4A61D
+empty,
:3HD, 4A61D 4A61D
default
+empty,
+empty,
Parameters T'at Assign "SS "lassnames
6egal Aalues &efault Aalue Comments
+empty,
C C
0, or a positive
integer
corresponding to the
.& of a document in
the $%&#
document tree.
:he .& of the current
document +i.e. of the
eb page in hich
the 9ayfinder
call occurs,.
0, or a positive
integer.
0, or a positive
integer.
0 :his parameter
as added in
9ayfinder 2.0.
0 :his parameter
must be used in
concert ith the
?start.tem:plparam
eter.
0 :his parameter is
ignored if ?start.d is
0 +Xero,.
Positive integers
that are the
document .&s of the
documents you ish
to
have included.
Positive integers
that are the
document .&s of the
documents you ish
to
have e#cluded. >>>
:his parameter as
added in 9ayfinder
2.0.
0 random +on each
run, randomiXes the
order of the output,
*hy isn/t
this in
?sort%rder >>>-
0 id
0 menutitle
0 pagetitle
0 introte#t
0 menuinde#
0 published
0 hidemenu
0 parent
0 isfolder
0 description
0 alias
0 longtitle
0 type
0 template
0 A1C +for an
ascending sort,
0 &D1C +for a
descending sort,
0 menutitle
0 pagetitle
0 longtitle
0 description
0 introte#t
0 id
0 menuinde#
0 parent *hat kind
of values does this
return>-
0 alias
0 published
0 hidemenu
0 isfolder
0 type *returns a
value of CdocumentC,
>>> or >>>-
0 template *hat
kind of values does
this return>-
0 menutitle
0 pagetitle
0 longtitle
0 description
0 introte#t
0 id
0 menuinde#
0 parent *hat kind
of values does this
return>-
0 alias
0 published
0 hidemenu
0 isfolder
0 type *returns a
value of CdocumentC,
or >>>-
0 template *hat
kind of values does
this return>-
any short te#t string
*that contains no
spaces or
punctuation>-
any short te#t string!
0 :hat contains no
spaces or
punctuation>
0 :hat/s not in use
as the name of any
other placeholder
ithin the same
template>
0 :hat/s not the
name of any of
9ayfinder/s internal
variables>
0 :hat/s not the
name of any
template variable
used by the current
page/s template>
0 :hat/s not the
name of a standard
document field>
the initial part of a
configuration file/s
filename.
:his parameter as
added in 9ayfinder
2.0.
the name of a chunk
that contains the
H36 of a C11 file.
the name of a chunk
that contains the
H36 of a Yava1cript
file.
the name of a C11
class that you have
defined for this eb
page.
C C
C C
C C
C C
C C
C C
T'e follo+ing appl( to output generate) b( container templates:
C C
C C
Parameters T'at Tell Wa(fin)er W'at Templates to *se
Legal Values Default Value "omments
02
C 0N
C +empty,
C +empty,
C +empty,
C +empty, 0Z
C +empty, 0Z
C +empty, 0Z
C +empty, +Z,>
T'ese are t'e ro+.le#el templates: 012
C 0[
C +empty,
Place'ol)ers T'at "an be *se) Wit'in Wa(fin)er Templates
:he name of the
chunk that contains
the corresponding
template. +1ee note
+', for additional
options.,
:here can be at
most one instance of
output from this
template per
9ayfinder
Call.
,a-i&aller( Snippet
http!""iki.mod#cms.com"inde#.php"$a#iWallery
*seful Sample calls:
Parameter Lists
Parameter
?admin)ebusers
?bigimg)linkstyle
?big)mask)bgcolor
?big)mask)img
?big)mask)position
?big)shado)bgcolor
?big)shado)path
?big)use)dropshado
?big)use)imagemask
?big)use)atermark
?big)atermark)font
?big)atermark)halign
?big)atermark)img
?big)atermark)t#t
?big)atermark)t#t)color
?big)atermark)t#t)hmargin
?big)atermark)t#t)vmargin
?big)atermark)type
?big)atermark)valign
?childgalleries)ids
?childgalleries)level)limit
?childgalleries)limit
?childgalleries)order)by
?childgalleries)order)direction
?childgallery:pl
?clearer:pl
?css
?debug
?disable)Ts)libs
?disable)rightclick
?display
?draggable:pl
?embedtype
**$a#iWallery> ?display;@embedded@
?embedtype;@slimbo#@ ?pics)per)ro;@N@
?ma#)thumb)siXe;@==0@ ?ma#)pic)siXe;@0@
?thumb)use)dropshado;@=@--
**$a#iWallery> ?pics)per)ro;@N@
?ma#)thumb)siXe;@==0@ ?ma#)pic)siXe;@[00@
?keep)bigimg;@=@ ?big)img)linkstyle;@popup@
?thumb)use)atermark;@=@
?thumb)atermark)t#t;@1ome atermarkK@
?pic)use)atermark;@=@
?pic)atermark)type;@image@--
*K$a#iWallery> ?gal)Juery)ids;@'Z,2N,[@
?display;@embedded@ ?embedtype;@slimbo#@
?order)by;@date@ ?limit;@\@K-
*K$a#iWallery> ?pic)Juery)ids;@N2,[2,\2,'=@
?display;@embedded@ ?embedtype;@smoothgallery@K-
?admin)ebgroups
?ftp)base)dir
?ftp)pass
?ftp)port
?ftp)server
?ftp)user
?gal)Juery)ids
?gallery%uter:pl
?galleryPicture:pl
?gtable
?is)target
?Ts
?keep)bigimg
?keep)date
?lang
?limit
?manage)gallery
?manage)target
?manage%uter:pl
?managePicture:pl
?manager)ebgroups
?manager)ebusers
?manageButton:pl
?manageHpload:pl
?ma#)big)siXe
?ma#)pic)number
?ma#)pic)siXe
?ma#)thumb)siXe
?offset
?order)by
?order)direction
?pageGumber:pl
?pic)mask)bgcolor
?pic)mask)img
?pic)mask)position
?pic)Juery)ids
?pic)shado)bgcolor
?pic)shado)path
?pic)use)dropshado
?pic)use)imagemask
?pic)use)atermark
?pic)atermark)font
?pic)atermark)halign
?pic)atermark)img
?pic)atermark)t#t
?pic)atermark)t#t)color
?pic)atermark)t#t)hmargin
?pic)atermark)t#t)vmargin
?pic)atermark)type
?pic)atermark)valign
?pics)per)page
?pics)per)ro
?picture)target
?picture:pl
?picturevie)start)id
?picturevie)start)pos
?Juality)big
?Juality)pic
?Juality)thumb
?Juery)level)limit
?random)filenames
?smoothgallery)carousel$a#imiXed%pacity
?smoothgallery)carousel$inimiXed(eight
?smoothgallery)carousel$inimiXed%pacity
?smoothgallery)delay
?smoothgallery)embed6inks
?smoothgallery)fade&uration
?smoothgallery)height
?smoothgallery)id
?smoothgallery)preloader
?smoothgallery)shoArros
?smoothgallery)shoCarousel
?smoothgallery)sho.nfopane
?smoothgallery)slide.nfo]one%pacity
?smoothgallery)te#t1hoCarousel
?smoothgallery)thumb(eight
?smoothgallery)thumb1pacing
?smoothgallery)thumb9idth
?smoothgallery)timed
?smoothgallery)idth
?thumb)mask)bgcolor
?thumb)mask)img
?thumb)mask)position
?thumb)shado)bgcolor
?thumb)shado)path
?thumb)use)dropshado
?thumb)use)imagemask
?thumb)use)atermark
?thumb)atermark)font
?thumb)atermark)halign
?thumb)atermark)img
?thumb)atermark)t#t
?thumb)atermark)t#t)color
?thumb)atermark)t#t)hmargin
?thumb)atermark)t#t)vmargin
?thumb)atermark)type
?thumb)atermark)valign
?upload)field)count
?use)ftp)commands
?vie)gallery
,a-i&aller( Snippet
http!""iki.mod#cms.com"inde#.php"$a#iWallery
9ith 9atermark on thumbnails
Parameter Lists
Description Possible #alues Default #alue
e#ternal
3WB (e#adecimal 444444
path
resiXe
3WB (e#adecimal 444444
path
Hse a dropshado on big pictures. 0
Hse an imagemask on big pictures. 0
9atermark big images. 0
4ont siXe for the atermark te#t. \
(oriXontal alignment of the atermark. right
path
te#t Copyright
Color of the atermark te#t. 3WB (e#adecimal 444444
(oriXontal margin of the atermark te#t +in pi#els,. Gumber +p#, =\
Aertical margin of the atermark te#t +in pi#els,. Gumber +p#, =\
te#t
Aertical alignment of the atermark. bottom
Parent documents to search,looking for childgalleries. Current document
Gumber 0
Gumber 0
$%&# document obTect field. menuinde#
A1C
0
0
0
1elect the gallery display mode. normal
:he template used for drag sort popup.
Basic call ith parameters! displays the gallery in
slimbo# style ith N pictures per ro, a auto created
thumbnail siXe of ==0pi#s ide, and thumbnails use
drop shado.
8uery other galleries by id and sho latest \ images
from each.
&isplays pictures ith id N2,[2,\2 and '= in a
smoothgallery
9eb usergroup names that have admin user privileges
and ho are alloed to manage all pictures in the
gallery.
Comma delimited list of eb
usergroup names
9eb usernames that have admin user privileges and
ho are alloed to manage all pictures in the gallery.
Comma delimited list of eb
user names.
&isplay type for big images that are opened from
brose mode.
0 slidebo#
0 lightbo#v2
0 popup
0 e#ternal
$ask background color for big pictures. .t should be
the same color as the page background color.
Path to the image that you ish to be applied as an
imagemask to the big pictures.
assets"snippets"
ma#igallery"
imagemask"
demomask^
frame2.png
:he .magemask position. :he resiXe option resiXes the
imagemask to the siXe of the picture.
0 top
0 topleft
0 topright
0 left
0 center
0 right
0 bottom
0 bottomleft
0 bottomright
0 resiXe
1hado background color for big pics. :his should be
the same color as the page background color.
Path to your shado images, if you do not ant to use
the default shado images.
assets"snippets
"
ma#igallery"dropsha
do"
0 0
0 =
0 0
0 =
0 0
0 =
0 =
0 2
0 N
0 [
0 \
0 left
0 center
0 right
Path to the atermark image. .t can be a transparent
png. $ake the margins of the atermark as
transparent areas.
assets"snippets"
ma#igallery"aterma
rk"
atermark.png
4or te#t atermarks, this is the te#t that ill be applied
to the picture.
:ype of atermark to use! a te#t atermark or an
image atermark . +user provided image,.
0 image
0 te#t
0 top
0 center
0 bottom
0 Comma delimited list of
document .&/s to search for
childgalleries.
0 CallC to list all galleries.
&efines ho many levels deep to list childgalleries from
parent document. ]ero for unlimited, eg. all levels.
&efines ho many childgalleries to list. ]ero for
unlimited number.
:he field name to use to order the childgalleries
display.
:he display direction for the childgalleries! ascending
or descending.
0 A1C
0 &D1C
:he template used for a child gallery element +image,
in the gallery overvie.
0 Chunk name
0 E4.6D!
0 EC%&D!
E4.6D!assets"snipp
ets
"
ma#igallery"template
s
"childgallerytpl.html
:he template to use hen using ?pics)per)ro
parameter as a ro clearer.
0 Chunk name
0 E4.6D!
0 EC%&D!
E4.6D!assets"snipp
ets
"
ma#igallery"template
s
"clearertpl.html
:he path to link a css file that styles this gallery, or
chunk name
containing the css, or css as a string.
D#amples!
assets"css"gallery.css
$a#igalleryCss
0 Chunk name
0 path to a file
0 template string
assets"snippets"ma#
igallery"
css"default.css
1hos some debug information in the $a#iWallery
page. +feature not fully
implemented yet,.
0 0
0 =
Hsed hen $oo:ools, Prototype or 1criptaculous
Tavascript libraries are
linked in the head of the site template and you ant to
prevent $a#iWallery
from calling them also.
0 0
0 =
Dnables a Tavascript to disable /right clicking/ on page
to save the images.
0 0
0 =
0 normal
0 embedded
0 childgalleries
0 picturevie
0 Chunk name
0 E4.6D!
0 EC%&D!
E4.6D!assets"snipp
ets
"
ma#igallery"template
s
"draggabletpl.html
.f ?display mode is set to CembeddedC, this defines the
gallery display
type. D#ternal ill open the image in a ne indo.
0 slidebo#
0 lightbo#v2
0 slimbo#
0 smoothgallery
0 popup
0 e#ternal
path
4:P account passord passord
number 2=
4:P address
username
te#t ma#igallery
0
0
=
en
9999999
&ocument id
&ocument id
=02[
Gumber 0
[\0
=N0
Gumber of ros to skip. 0
pos,date
&D1C
3WB (e#adecimal 444444
path
resiXe
3WB (e#adecimal 444444
path
0
0
0
N
right
path
te#t Copyright
3WB (e#adecimal 444444
Gumber +p#, =0
Gumber +p#, =0
te#t
bottom
Gumber 0
Gumber [
&ocument id Current document
Picture id
Path to go from 4:P root to $%&# installation root. Dg.
if your 4:P root
directory is
Port number for the 4:P service.
4:P address to the server running $%&#.
4:P account username
.&/s of the documents from hich you ant to retrieve
pictures.
0 Comma delimited list of
document .&/s
0 CallC to get pictures from
all galleries
:he outer template for the gallery overvie.
0 Chunk name
0 E4.6D!
0 EC%&D!
E4.6D!"assets"snip
pets
"
ma#igallery"template
s
"galleryoutertpl.html
:he template for each picture element +thumbnail, in
the gallery overvie.
0 Chunk name
0 E4.6D!
0 EC%&D!
E4.6D!"assets"snip
pets
"
ma#igallery"template
s
"
gallerypicturetpl.html
Game of the database table for the gallery +mod# table
prefi# is added,
&etermines if the document is to be the target for
picture brosing mode or
picture manager mode.
0 0
0 =
6ink to an e#tra Tavascript file supporting a gallery or
chunk name or
Tavascript code as te#t.
0 path
0 chunk name
0 te#t
Ieep an additional larger or original siXe version of the
image.
0 0
0 =
9hen modifying an image title or description, keep the
original upload date.
0 0
0 =
1ets the gallery language.
Gote! 6anguage files are not fully implemented yet.
4eel free to add your
language+s,. +1ee lang)en.php for e#amples.,
0 en
0 fi
6imit value to use for the Juery result set.
$a#imum number of ros for
Juery.
.& of the gallery to be managed. :he .& of the
document +page, that has the
gallery call. Hse this to avoid going to the gallery page.
1et the same
parameters as used in the gallery itself.
.& of the document that ill be used for managing the
pictures. Hse the same
snippet call in that target document and add the
parameter! ?is)target;@=@
to the call.
:he outer template for gallery management.
0 Chunk name
0 E4.6D!
0 EC%&D!
E4.6D!"assets"snip
pets
"
ma#igallery"template
s
"
manageoutertpl.html
:he template for a single picture element in the gallery
management.
0 Chunk name
0 E4.6D!
0 EC%&D!
E4.6D!"assets"snip
pets
"
ma#igallery"template
s
"
managepicturetpl.ht
ml
Comma delimited eb groups that can post pictures to
this gallery and can
manage their on pictures.
Comma delimited list of eb
groups.
Comma delimited eb user names that can post
pictures to this gallery and
can manage their on pictures.
Comma delimited list of eb
users.
:he template for the manage pictures button.
0 Chunk name
0 E4.6D!
0 EC%&D!
E4.6D!"assets"snip
pets
"
ma#igallery"template
s
"
managebuttontpl.ht
ml
:he template for the file upload ros in gallery
management.
0 Chunk name
0 E4.6D!
0 EC%&D!
E4.6D!"assets"snip
pets
"
ma#igallery"template
s
"
manageuploadtpl.ht
ml
1iXe of the big image. Pi#el siXe of largest dimension,
or Xero to use
original image dimensions.
0 Gumber +p#,
0 9idth#(eight +p#, +eg.
200#[00,
$a#imum number of images alloed in this gallery.
Hse Xero for an unlimited
number of images.
$a#imum siXe in pi#els of the normal picture. +largest
dimension,. ]ero for
unlimited siXe.
0 Gumber +p#,
0 9idth#(eight +p#, +eg.
200#[00,
$a#imum siXe in pi#els of the thumbnail pictures.
+largest dimension,
0 Gumber +p#,
0 9idth#(eight +p#, +eg.
200#[00,
%ffset value to use for the Juery result set.
:he database field name to use to order the pictures
by. .f RrandomS is used
ma#igallery ill sho pictures in a random order or ill
display a random
picture in the childgalleries display mode.
0 date
0 pos
0 filename
0 title
0 id
0 random
1ort order direction! ascending or descending.
0 A1C
0 &D1C
:he template to display page numbers in the gallery
overvie.
0 Chunk name
0 E4.6D!
0 EC%&D!
E4.6D!"assets"snip
pets
"
ma#igallery"template
s
"pagenumbertpl.html
$ask background color for normal pics. :his should be
the same color as the
page background color.
Path to the image to be applied as an imagemask to
the normal pictures.
assets"snippets
"
ma#igallery"imagem
ask
"demomask0
frame2.png
:he .magemask position. :he resiXe option resiXes the
imagemask to the siXe
of the picture.
0 top
0 topleft
0 topright
0 left
0 center
0 right
0 bottom
0 bottomleft
0 bottomright
0 resiXe
.&/s of single pictures to retrieve.
Comma delimited list of
picture .&/s
1hado background color for normal pics. :his should
be the same color as
page background color.
Path to the shado images to be used, if you don/t
ish to use the default
shado images.
assets"snippets
"
ma#igallery"dropsha
do"
Apply a dropshado to normal pictures.
0 0
0 =
Apply an imagemask to normal pictures.
0 0
0 =
9atermark normal images.
0 0
0 =
4ont siXe for te#t atermarks.
0 =
0 2
0 N
0 [
0 \
(oriXontal alignment of the atermark.
0 left
0 center
0 right
Path to a atermark image. Hse a png image ith a
transparent background
alpha layer.
assets"snippets
"
ma#igallery"aterma
rk
"atermark.png
:e#t that ill be applied to the images as a atermark.
Color of the atermark te#t.
(oriXontal margin in pi#els of the atermark te#t.
Aertical margin in pi#els of the atermark te#t.
&etermines the type of the atermark to be used,
either te#t or image.
+image is user supplied.,
0 image
0 te#t
Aertical alignment of the atermark.
0 top
0 center
0 bottom
:he number of thumbnail pictures to sho per page in
the gallery overvie.
]ero for unlimited pictures.
:he number of thumbnail pictures to sho in a ro in
the gallery overvie.
.& of the document that ill be used for brosing the
pictures. Hse the same
snippet call in that target document and add the
parameter! ?is)target;@=@
to the call.
:he template for the picture vie.
0 Chunk name
0 E4.6D!
0 EC%&D!
E4.6D!"assets"snip
pets
"
ma#igallery"template
s
"picturetpl.html
.f picturevie display mode is used, this parameter can
be used to define
the picture id from hich to start automatically.
Picture number to start from 4irst picture
Gumber +_, =00
Gumber +_, Z0
Gumber +_, Z0
Gumber =
0
Gumber 0.Z
Gumber +p#, 20
Gumber 0.[
Gumber +ms, 9000
:3HD
Gumber +ms, \00
Gumber +p#, ma#)pic)siXe
:e#t Wallery id
:3HD
:3HD
:3HD
:3HD
Gumber 0.Z
te#t
Gumber +p#, Z\
Gumber +p#, =0
Gumber +p#, =00
4A61D
+p#, ma#)pic)siXe
3WB (e#adecimal 444444
path
resiXe
3WB (e#adecimal 444444
path
0
0
0
=
right
path
te#t Copyright
3WB (e#adecimal 444444
Gumber +p#, 2
Gumber +p#, 2
te#t
bottom
Gumber =0
0
&ocument .&
.f picturevie display mode is used, this parameter can
be used to define
the position from hich to start automatically.
:he Juality of the big picture. A percentage beteen 00
=00 for the big
images.
:he Juality. Percentage beteen 00=00 for the normal
images.
:he Juality percentage beteen 00=00 for the
thumbnail images.
&efines ho many levels deep to go from the parent in
gal)Juery)ids
documents.
.f enabled, this ill apply generated random filenames
to uploaded pictures.
0 0
0 =
%pacity value for the carousel hen it is ma#imiXed.
9here!
0 ; is transparent +not visible, and =.0 ; is totally
opaJue
(eight in pi#els of the minimiXed carousel.
%pacity value for the carousel hen it is minimiXed.
9here!
0 ; is transparent +not visible, and =.0 ; is totally
opaJue
&elay in milliseconds for the timed slidesho picture
change.
%pen picture by clicking on the slide.
G%:D! if you remove this parameter, also remove the
link tags from
galleryPicture:pl
0 true
0 false
&uration in milliseconds of the fade effect.
(eight in pi#els for the smoothgallery div. %verflo ill
be hidden, so this
should be the height of biggest picture +eg. same as
ma#)pic)siXe,.
.ndividual id for the smoothgallery instance. :his allos
to have multiple
smoothgalleries in one page.
Preload the pictures.
0 true
0 false
1ho the ne#t 0 back arros in the slidesho.
0 true
0 false
1ho the thumbnails in carousel mode hen using
slidesho.
0 true
0 false
1ho the info pane +this is the picture title and
description,.
0 true
0 false
%pacity value in _ for the info pane. :his determines
the visibility of the
infopane.
9here!
0 ; is transparent +not visible, and =.0 ; is totally
opaJue
:e#t that is shon in the carousel.
/pictures/ te#t from
the the language file
(eight of the thumnails, in pi#els, in the 1moothWallery
carousel.
1pace in pi#els beteen thumbnails in the
1moothWallery carousel.
9idth in pi#els of the thumbnails in 1moothWallery
carousel.
Change the image in a timed slidesho mode.
0 true
0 false
9idth in pi#els, for the smoothgallery div. %verflo +of
the picture, ill
be hidden, so this should be the ma#imum idth of the
biggest picture +eg.
same as ma#)pic)siXe,.
$ask background color for thumbnail pics. .t should be
the same as color as
the page background color.
Path to an imagemask image that is to be applied to
the thumbnail pictures.
assets"snippets
"
ma#igallery"imagem
ask
"demomask0
frame=.png
.magemask position. :he resiXe option resiXes the
imagemask to the siXe of
the picture.
0 top
0 topleft
0 topright
0 left
0 center
0 right
0 bottom
0 bottomleft
0 bottomright
0 resiXe
:he shado background color for thumbnail pics. :his
should be the same
color as page background color.
:he path to the dropshado images. .f you do not ish
to use the default
shado images, set this to the path to your shado
images.
assets"snippets
"
ma#igallery"dropsha
do"
Apply a dropshado to thumbnail pictures.
0 0
0 =
Apply an imagemask to thumbnail pictures.
0 0
0 =
9atermark the thumbnail images.
0 0
0 =
4ont siXe of the atermark te#t.
0 =
0 2
0 N
0 [
0 \
(oriXontal alignment of the atermark.
0 left
0 center
0 right
Path to a atermark image. Hse a png image ith a
transparent background
alpha layer.
assets"snippets
"
ma#igallery"aterma
rk
"atermark.png
:e#t that ill be applied to the images as a atermark.
Color of the atermark te#t.
(oriXontal margin of the atermark te#t.
Aertical margin of the atermark te#t.
:ype of the atermark to use. Dither te#t or a user
supplied image.
0 image
0 te#t
Aertical alignment of the atermark.
0 top
0 center
0 bottom
:he number of upload fields to sho in the manager
vie.
.f enabled, $a#iWallery uses P(P 4:P commands to
create filesystem folders
for the gallery pictures. :his is needed in certain server
environments.
0 0
0 =
1ho a childgallery from a document +page, other than
the gallery parent
document. Hse the .& of the document that contains
the childgallery call of
the childgallery you ish to use.
Ditto Snippet
E4A,PLE "ALL
Parameters )escription
?config 6oad a custom configuration
?date4ormat 4ormat the *2date2- placeholder in human readable form
?date1ource 1ource of the *2date2- placeholder
?debug %utput debugging information
5)ept' Gumber of levels deep to retrieve documents , 0 is infinite
?display Gumber of documents to display in the results
?ditto)base 6ocation of &itto files
?documents .&s of documents for &itto to retrieve
?e#tenders 6oad an e#tender hich adds functionality to &itto
?filter
?filters
?format %utput format to use
?global4ilter&elimiter 4ilter delimiter used to separate filters in the filter string
?hidden4ields
?hide4olders &on`t sho folders in the returned results
?hidePrivate
?id
?.&s .nternal variable hich holds the set of .&s for &itto to fetch
?id:ype type of .&s providedQ can be either parents or documents
?item*#- .ndividual items rendered output
?keyords
?language language for defaults, debug, and error messages
?local4ilter&elimiter
?no3esults :e#t or chunk to display hen there are no results
?orderBy An array that holds all criteria to sort the result set by.
?orderBy 1ort the result set
?paginate Paginate the results set into pages of ?display length.
?paginateAlays1ho6inks &etermine hether or not to alays sho previous ne#t links
?paginate1plitterCharacter 1plitter to use if alays sho is disabled
5parents
?ph# Hse P(# formatting
?placeholders
?Juery6imit
?randomiXe 3andomiXe the order of the output
?removeChunk
?save
?see:hruHnpub
?sho.n$enu%nly 1ho only documents visible in the menu
?shoPublished%nly 1ho only published documents
?sortBy
?sort&ir change sort direction. &D1C or A1C. default is &D1C
?start Gumber of documents to skip in the results
?total Gumber of documents to retrieve
?tpl Hser defined chunk to format the documents
Aggregates documents to create blogs, article"nes
collections, and more,ith full support for templating. :hese
lists ere pulled from the mod# iki
*K&itto> ?start.&;@=aN@ ?sortBy;@createdon@ ?display;@\@
?tpl;@story)summary@K-
3emoves items not meeting a critera. :hus, if pagetitle ;; Toe
then it ill be removed. Hse in the format Cfield,criteria,modeC
ith the comma being the local delimiter
(olds both the custom filters array for configs or e#tenders to
add to and the parsed filters array.
Allo &itto to retrieve fields its template parser cannot handle
such as nested placeholders and *fields-
&on`t sho documents the guest or user does not have
permission to see
HniJue .& for this &itto instance for connection ith other
scripts +like 3eflect, and uniJue H36 parameters
Dnable fetching of associated keyords for each document
Can be used as *2keyords2- or as a tag&ata source
&elimiter used to separate individual parameters ithin each
filter string
.&s of containers for &itto to retrieve their children to ?depth
depth
.nitialiXe custom placeholders array for configs or e#tenders to
add to
Gumber of documents to retrieve from the database, same as
$y186 6.$.:
Game of chunks to be stripped from content separated by
commas
1aves the ditto obTect and results set to placeholders for use
by other snippets
1ee through unpublished folders to retrive their children Hsed
hen depth is greater than =
set the template variable or document attribute to sort by,
default is publish date
?tplAlt Hser defined chunk to format every other document
?tplCurrent&ocument Hser defined chunk to format the current document
?tpl4irst Hser defined chunk to format the first document
?tpl6ast Hser defined chunk to format the last document
?tplPaginateCurrentPage :emplate for the current page link
?tplPaginateGe#t :emplate for the ne#t link
?tplPaginateGe#t%ff :emplate for the inside of the ne#t link
?tplPaginatePage :emplate for the page link
?tplPaginatePrevious :emplate for the previous link
?tplPaginatePrevious%ff :emplate for the previous link hen it is off
?here Custom $y186 9(D3D statement
?summariXe
depreciated +. think, number of documents to sho in list, use
?display instead.
Ne+s Publis'er scroll rig't ./
possible #alues E-ample *sage 6elpful links
http!"".php.net"strftime
http!""iki.mod#cms.com"inde#.
php"&itto
SdefaultS default blank config file
C%G4.W)GA$D %ther configs
installed in the configs folder or in
any folder ithin the $%&# base
path via E4.6D
any strftime format string see link
to right 0P
7 of documents to display or CallC
for all documents
Any e#tender in the e#tenders
folder or in any folder ithin the
$%&# base path via E4.6D
http!""ditto.mod#cms.com"files"s
nippet0ditto0php.html7filter
Any character not used in the filters
&efault! C<C
Any combination of characters a0X,
underscores, and numbers 009
Any character not used in the filter
itself
&efault! S,S
Ne+s Publis'er Snippet
?folder folder id here blog posts are stored
?makefolder
?postid
?canpost
?badords comma delimited list of ords not alloed in post
?template name of template to use for nes post
?headertpl
?footertpl
?formtpl form template +chunk name,
?rtcontent name of a richte#t content form field
?rtsummary name of a richte#t summary form field
?shoinmenu
?aliastitle set to = to use page title as alias suffi#. &efaults to 0 0 date created.
?clearcache
set to = to automatically convert the parent document to a folder.
&efaults
to 0
document id to load after posting nes item. &efaults to the page
created
comma delimited eb groups that can post comments. 6eave blank for
public
posting
header template +chunk name, to be inserted at the beginning of the
nes
content
footer template +chunk name, to be inserted at the end of the nes
content
sets the flag to true or false +=<0, as to hether or not it shos in the
menu. &efaults to false +0,
hen set to = the system ill automatically clear the site cache after
publishing an article.
Ne+s,anager
Parameter Description
?folder folder id here documents are stored
?makefolder set to = to automatically convert the parent document to a folder.
?postid document id to load after orking ith a nes item.
?editformid
?template name of template to use for nes post
?headertpl
?footertpl
?rotpl template used to display a single post +chunk name,
?clearcache
?nrposts number of posts to sho per page
?paginate paginate
?prv chunk to be used inside the previous link
?n#t chunk to be used inside the ne#t link
?alayssho
?prevne#tsplitter
?sho chunk to be used for the sho action
?edit chunk to be used for the edit action
?delete chunk to be used for the delete action
?refresh chunk to be used for the Cmove on topC action
?publish chunk to be used for the publish action
?unpublish chunk to be used for the unpublish action
?shoinmenu chunk to be used for the C1ho in menuC action
?hideinmenu chunk to be used for the C(ide in menuC action
?emptyte#t te#t to use hen no nes items are found
3eJuest variables +via WD:, P%1:, or C%%I.D,
!e7uest #ariables Description
deleteid id of post to delete
refreshid
hidemenuid id of post for hich the /hidemenu/ property must be changed
hidemenuvalue value to hich /hidemenu/ must be set
publishid id of post for hich the /published/ property must be changed
publishvalue value to hich /published/ must be set
1nippet placeholders
Place'ol)er Description
*2sepchar2-
*2editformid2- .d of page to use for editing a post
*2pagetitle2- current post/s page title
*2longtitle2- current post/s article title
*2id2- current post/s id
*2edit2- te#t for edit action
*2delete2- te#t for delete action
*2sho2- te#t for sho action
*2refresh2-
*2hidemenu2-
*2pubish2-
*2ne#t2- te#t for ne#t action
&isplay all oned articles in a table together ith buttons that permit to
edit"delete"hide"publisch etc. every single article in a blog. KKK Hse only one snippet per
page KKK
document id used to modify an article +O)3D8HD1:*/editid/- ill hold
the id of the document to modify,
header template +chunk name, to be inserted at the begining of the
nes content
footer template +chunk name, to be inserted at the end of the nes
content
hen set to = the system ill automatically clear the site cache after
updating an article
alays sho previous or ne#t links +if enabled, hyperlink ill be
removed hen prev"ne#t page is not available, < delimiter ill not be
inserted,
character delimiter to use to separate previous ne#t links if
alayssho is 0
id of post for hic the /createdon/ property is set to no, thus
effectively putting it at the top of the list
separator beteen a document H36 and parameters +for e#ample
*B*5id5-B-*2sepchar2-param=;value=?param2;value2,
te#t for refresh action +update the creation date to no so the post is
first in the list,
te#t for hide menu action or sho menu action +dependent of the
current state of the post,
te#t for publish action or unpublish action +dependent of the current
state of the post,
*2previous2- te#t for previous action
*2prevne#tsplitter2- splitter if alays sho is 0
*2pages2- page list
*2totalpages2- total number of pages
*2start2- the 7 of the first item shon
*2stop2- the 7 of the last item shon
*2total2- the total 7 of items on the page
GesDditor
Default #alue Parameter Description
?folder folder id here comments are stored
0 ?makefolder
current page ?postid document id to load after posting nes item.
?canpost
?badords
?template name of template to use for nes post
?headertpl
?footertpl
?formtpl form template +chunk name,
=0 ?rtcontent name of a richte#t content form field
0 ?rtsummary name of a richte#t summary form field
CV PreviousC ?shoinmenu
CGe#t PC ?aliastitle set to = to use page title as alias suffi#
0 ?clearcache
C<C ?dateformat format to use for the dates
C1hoC
CDditC Place'ol)ers
C&eleteC Placeholder &escription
C$ove on topC editid .d of nes document
CPublishC pagetitle Ges page title
CHnpublishC longtitle Ges title
C1ho in menuC description Ges description
C3emove from menuC introte#t Ges summary
alias Ges page alias
parent Ges parent folder +the folder ith the blog,
createdon &ate in hich the nes as first created
createdby Hser id of creator
published Ges is published +0<=,>
pub)date
unpub)date
hidemenu Ges isn/t displayed in menu +0<=,>
menuinde#
template
content Ges content
http!""lucidgreen.net"mod#Wuides"ne
s$anager&ocs.html
set to = to automatically convert the parent
document to a folder
comma delimitted eb groups that can post
comments. leave blank for public posting
comma delimited list of ords not alloed in
post
header template +chunk name, to be inserted at
the begining of the nes content
footer template +chunk name, to be inserted at
the end of the nes content
sets the flag to true or false +=<0, as to hether
or not it shos in the menu.
hen set to = the system ill automatically clear
the site cache after publishing an article
CVpPGo entries
found.V"pPC
&ata on hich the nes must be published
+format _d0_m0_F _(!_$!_1,
&ata on hich the nes must be unpublished
+format _d0_m0_F _(!_$!_1,
.f hidemenu ;; 0, gived the place of the nes in
the menu
.d of template for this nes +note! not the name
of the template,
Default #alue
0
//
/content/
/introte#t/
0
0
0
.d of page created
or edited
/_d0_m0_F _(!
_$!_1/
8ot
template parameters ../
parameter #alue
?action yes
?docid yes +docid as integer,
?tagid yes +tagid as string *A0]a0X009-,
?subscribe yes
?moderated yes
?notify yes
?subTect1ubscribe yes +string,
?subTect$oderate yes +string,
?captcha yes
?badords yes
?b yes
?customfields yes
?authorid yes +id of source author,
?title yes +title of source,
?css yes
?css4ile yes
?sortby yes +comma seperated sort string,
?numdir yes
?validate yes +comma seperated validate string,
?guestname yes +string,
?postdelay yes +seconds as integer,
?pagination yes +number of comments per page,
?placeholders yes
?output yes
?debug yes
?trusted yes +comma delimitted eb groups,
?canpost yes +comma delimitted eb groups,
?canvie yes +comma delimitted eb groups,
?canedit yes +comma delimitted eb groups,
?canmoderate yes +comma delimitted eb groups,
?notifyAuthor yes
?subTectAuthor yes +string,
optio
nal
0 default +form ? comments,
0 count0comments
0 count0subscriptions
0 comments
0 form
0 0 +default,
0 =
0 0 +default,
0 =
0 0
0 = +default,
0 2
0 0 +default,
0 =
0 2
+comma delimited list of ords not
alloed in post,
0 0
0 = +default,
0 2
+comma seperated list of e#tra form
fieldnames,
0 0
0 = +default,
+relative path from mod# root to C11
file,
0 0
0 = +default,
0 0
0 =
0 0
0 =
0 0
0 =
0 0 +&efault,
0 =
8ot Template Parameters
)escription parameter
Controls hat to display ?tpl4orm yes
?tplComments yes
?tpl$oderate yes
?tplGav yes
?tpl1ubscribe yes
?tplGotify yes
1ubTect for subscription notification email. ?tplGotify$oderator yes
1ubTect for moderator notification email. ?tplGotifyAuthor yes
?css3oAlt yes
?css3o$e yes
?css3oAuthor yes
defaults to author value for the current document.
default to location of the included Tot.css
1ubTect for author notification email +v =.=.N2,
optio
nal
6ink instance to this document, defaults to parent
document id.
D#tra tag to use hen to instances use the same
docid.
0 0 ; disable subscriptions.
0 = ; enable subscriptions.
0 0 ; ne comments ill be published
0 = ; ne comments ill be unpublished a
moderator"manager user can
revie before publishing.
Gotify moderators specified by 5?canmoderate5 by
email
0 0 ; do not notify
0 = ; notify on ne unpublished reply
0 2 ; notify on every ne reply
0 0 ; disable captcha hen posting.
0 = ; enable captcha hen posting.
0 2 ; enable captcha hen posting, but disable it for
logged in users.
best practise is to create a chunk ith bad ords
seperated by a comma and
call Yot like!
?badords;@LL$yBadordsChunkMM@
to allo central administration of your badords list.
Hse the 5?b5 parameter to specify the reJuired action
on detection.
9hen a ord specified by 5?badords5 is detected!

0 0 ; do nothing.
0 = ; do not publish the comment.
0 2 ; reTect the comment.
Hsing this command ill save the specified fields hen
posting.
defaults to Cname,emailC. +Gote! Be sure not to have
spaces in comma
separated list of custom fields in the Yot call.,
defaults to longtitle value for the current document.
used for subTect hen left empty.
0 0 ; do not auto0include Tot stylesheet in header
0 = ; auto0include Tot stylesheet in header
synta#!
fieldname!a +for ascending, or fieldname!d +for
descending, defaults to
Ccreatedon!dC.
0 0 ; first comment loest number.
0 = ; first comment highest number.
synta#! fieldname!message+!validation,
if a field name is entered in validate it automatically
becomes a reJuired
field. if validation is omitted it assumes CreJuiredC. other
validations
are!
0 number
0 email
0 custom regular e#pression
e#amples!
0 reJuired field!
0 C$y3eJuired4ield!:his field is reJuiredKC
0 to validate an email field!
0 C$yDmail4ield!Got a valid e0mail address.!emailC
0 to validate a number!
0 C$yGumber4ield!Got a number.!numberC
0 to validate an hyphen seperated H1 phonenumber
by using custom regular
e#pression!
0 C$yPhone4ield!Got a valid phonenumber!b*20
9-cdL2M0cdLNM0cdL[MOC
0 Combinations of multiple validations!
0 C$y3eJuired4ield!:his field is
reJuiredK,$yDmail4ield!Got a valid
e0mail address.!email,$yGumber4ield!Got a
number.!numberC

defaults to Ccontent!Fou forgot to enter a comment.C
:he anonymous authorname to use hen none is
specified.
defaults to! anonymous.
number of seconds there must be beteen posts from
the same user.
Dnter 0 to disable, defaults to! =\.
0 0 ; disable, sho all comments on one page +default,
0 = P enable paging ith specified number.
0 0 ; no placeholders are created +default,
0 = ; placeholders are created for every debug value
+see 5?debug5parameter,
0 if no tagid is specified the placeholders are
created like this!

*2Tot.html.form2-

0 if the tagid is specified the placeholders are
created like this!

*2Tot.html.form.tagid2-
0 0 ; hide output +can be used in combination ith
5?placeholder5parameter,
0 = ; sho output +default,
0 0 ; disable output of Tot ChiddenC variables. +default,
0 = ; enable output of Tot ChiddenC variables.
Comma delimitted eb groups that are trusted and
have their comments
published by default hen 5?moderated5 is set =.
Badords also does not
apply for trusted ebgroups. $anager users are
alays trusted.
Comma delimitted eb groups that can post
comments.
6eave blank for public posting.
Comma delimitted eb groups that can vie
comments.
6eave blank for public vieing.
Comma delimitted eb groups that can edit their %9G
comments.
6eave blank for no editing by users.
Comma delimitted eb groups that can moderate
comments.
6eave blank for no ebuser moderation +;moderation
by using manager
account,.
1end the author of the document an email notification
hen someone posts a
comment +v =.=.N2,
8ot Template Parameters
)escription
:emplate +(:$6, for user form.
C11 style classname for alternate ro.
C11 style classname for current user ro.
C11 style classname for author ro.
:emplate +(:$6, for comment. :his templates
gets repeated for each comment.
:emplate +(:$6, for moderation block. :his
templates gets included once
+top, in comment vie
:emplate +(:$6, for navigation bar. :his
templates gets included tice +top
and bottom, in default comment vie.
:emplate +(:$6, for subscriptions block. :his
templates gets included once
+top, in comment vie
:emplate +:U:, for notification email for
subscribers.
:emplate +:U:, for notification email for
moderators.
:emplate +:U:, for notification email for author +v
=.=.N2,
WebLoginPE 9:;:9
9eb6oginPD documentation
http!"".lucidgreen.net"mod#Wuide
s"lpedocs"inde#.html
Eform
!e7uire) parameters
1ample call
?formid
?tpl
?report
Optional parameters
Cauto1enderGame +ne in =.[.[, +optional,
?allohtml +%ptional,
?automessage +%ptional,
?autosender +%ptional,
?bcc +%ptional,
?category +%ptional,
?cc +%ptional,
?ccsender +%ptional,
?css1tyle +optional,
?debug +%ptional,
?from +%ptional,
?fromname +%ptional,
?gotoid +%ptional,
?invalidClass +optional,
?T1cript +optional,
?keyords +%ptional,
?language +%ptional,
?mailselector +%ptional,
?mobile +%ptional,
?mobilete#t +%ptional,
?noemail +%ptional,
?post%verides +optional,
?protect1ubmit+optional, defaults to = +on,
?replyto +%ptional,
?reportAbuse +optional,
?reJuiredClass +optional,
?run1nippet +ne in =.[.[, +optional,
?sendAs(tml +optional,
?sendAs:e#t +optional,
?sendirect +%ptional,
?sessionAars +optional,
?snip4older +ne in =.[.[, +optional,
?subTect +%ptional,
?submit6imit +optional, off +0, by default
?thankyou +%ptional,
?to +%ptional,
?vericode +%ptional,
P6P E#ent <unctions:
?e4orm%nBefore4orm$erge +optional,
?eform%nBefore4ormParse +optional,
?e4orm%nBefore$ail1ent +optional,
?e4orm%n$ail1ent +optional,
?e4orm%nAalidate +optional,
Description
Game to display as sender of the auto0respond message.
1et to = to allo user to enter html tags. &efaults to 0
email to display as sender of the auto0respond message e.g. no0replyEmydomain.com
1ame as ?emailbut for Bcc!
1ame as ?emailbut for Cc!
1ets the email address to appear in the 4rom section of the email
1ets the name of the sender in the 4rom section of the email
document id to load after sending message. 1ee also ?thankyou
*Ke4orm> ?formid;@Contact4orm@ ?subTect;@*2subTect2-@ ?to;@youEyouremail.com@
?ccsender;@=@ ?tpl;@Contact4orm@ ?report;@Contact4orm3eport@ ?gotoid;@=@ K-
:his is a uniJue id used to identity a form during postbacks. :his is useful in cases here
more than one form e#ists on a page. Four form template should either have a hidden field
ith the same formid Vinput type;ChiddenC name;CformidC value;CformGameC "P or +from
e4orm =.[.#, you can set the the id in the form tag itself! Vform id;CformGameC...PQ
chunk name +non0numeric, or document id +numeric, to use as a form template +ne in
=.[.[, Fou can no also use a snippet as the template source. Go parameters are forarded
to the snippet call in this version. 4or the regular form fields you do not normally need to add
placeholders, they automatically get inserted by e4orm. :he esception to this rule are in the
case of event functions here you ant to set specific values. 1pecial placeholders available
are! *2validationmessage2-, *2postdate2-,*2verimageurl2- ? *2debug:e#t2-. Fou should have
the *2validatiomessage2- placeholder in all your forms. :he others you may need depending
on other parameters.
chunk name +non0numeric, or document id +numeric, to use hen generating reports.
:ags! 1ame as for ?tplplus *2fieldname2-, here fieldname stands for the name of each form
field you ish to include.
chunk name +non0numeric, or document id +numeric, to use as an auto0responder
message Can include *2form fields2-. D.g. *2firstname2- 0 tags! *form)fields-,*postdate- 0 note!
e4orm ill send the auto0respond message to the email address specified inside the *email-
form field.
Category .& or name used to categoriXe e4orms. .f category is not found a ne category
ill beb created :his ill appear in the subTect of the email sent to the user
1et to = to send the user a copy of the submitted form. &efaults to 0 e4orm ill look for
the user/s email address inside a field called email.
Adds a style declaration to the VheadP section of the page hen either the form is displayed
or the thank you page is displayed +only if the ?thankyou parameter is set,. Aalues can be a
document id +numeric,, chunk name or +relative or absolute, url to css file. $ultiple values can
be separated by a comma +in fact all three values can be mi#ed,.
*Ke4orm ?css1tyle;@assets"site"forms.css,chunkGame@ ... K-
*Ke4orm ?css1tyle;@chunkGame@ ... K-
*Ke4orm ?css1tyle;@http!""mysite.com"assets"styles"forms.css@ ... K-
Chunks +and documents if a doc id is given, can return a values in the form of!
=. an inline style block, eg. Vstyle type;Cte#t"cssCP"some styles"V"styleP
2. a link to stylesheet+s,, eg. Vlink href;Cassets"site"forms.cssC rel;CstylesheetC
type;Cte#t"cssCP
N. a comma separated list of urls, eg.
assets"site"forms.css,assets"site"more.css,assets"site"gone)overboard.css
1et to = for e#tended error messages in form validation. $ostly for debugging 76.1: and
71D6DC: validation.
Css class name. 9ill add class in invalid form fields on validation. D#isting classes ill be
preserved.
1imilar to ?css1tyle but for adding Tavascript to the VheadP of the page document.
Currently Yavascript is only added hen the form is displayed.
Comma delimited keyords or *2formfields2- used hen searching databank D.g.
*2firstname2-, *2lastname2-, *2email2-
1upport for multilingual validation and error messages. Hses same language names as
$%&#.
1ets the name of the form field to use as a selector to select a single email from the
comma +,, delimited emails assigned the ?toparameter. :his selector field ill act like a
numeric inde# to select an email. .t ill start at = for the first email and ends at G for the last
email in the list.
$obile email address. :his email is used to send a short notification message to a mobile
device.
:e#t message to send to mobile device Can include *.form fields.-. D.g. %rder for
*.firstname.-
Prevents eform from sending emails e.g. no0replyEmydomain.com 1et to = to disable
emails. &efaults to 0
4or e#ample! ?to ;@salesEme.com,supportEme.com,billingEme.com@
?mailselector;@topic@
%n the eb form the topic fields is actually a dropdon menu. hen the user selects a
topic from the list the value =,2 or N ill be sent to e4orm hich ill then be used to select
one of the three emails assigned to the ?toparameter. :his email address ill be the address
used to send the email to.
Hsed in combination of ?sessionAars. Gormally session variables ill overide posted
values. By setting ?post%verides;@=@ posted values ill take precedence.
Protects against submitting a form multiple times ith the same data. 1ubmitting the form
becomes disabled after the first successful submit hile the value from key form fields
remains the same. :his is achieved by setting +and comparing, a session variable ith an
md\ hash from these key fields. 9hich fields are compared depends on the value of
?protect1ubmit.Possible values are 0 +off,, = +all /reJuired/ fields are used, or you can set a
comma separated list of field names. :o ensure that the session variable orks separatedly
for different forms the session variable name is based on ?formid +LformidM)hash,.
Dmail address or fieldname containing email address 1ets the email address to appear in
the 3eply:o section of the email
1etting ?reportAbuse;@=@ ill send an email to the system specified email address if
email inTection attempts are noticed by e4orm. +Hse sparingly...,
Css class name. 9ill add class in +empty, reJuired form fields on validation. D#isting
classes ill be preserved.
.f you have already set a class for a field or label and you get une#pected css results
check the order in hich you have declared the classes. :he ?reJuiredClass is added to the
beginning of any classes already set.
D#pects a snippet name. 1nippet ill be run before any e4orm handling. %ne parameter,
the ??formid ill be passed to the snippet. Any return value from the snippet is discarded.
:his can be used to insert functions as an alternative to declaring a separate snippet in the
document. 1adly e4orm ill silently ignore a snippet that does not e#ist due to the ay
Omod#0Prun1nippet handles snippet return values.
4orce email messages to be in (tml. Possible values! ?sendAs(:$6;@=@0 send all
messages as html, ?sendAs(:$6;@report,autote#t,mobile@0 send specified messages as
html
4orce email message to be in plain te#t. Possible values! ?sendAs:e#t;@=@0 send all
messages as te#t only, ?sendAs:e#t;@report,autote#t,mobile@0 send specified messages as
te#t only
:his ill use the form field called email to supply the email address to send the message
to. 1et to = to activate send direct. &efaults to 0
Comma delimited list of O)1D11.%G variable names. :hese ill be added to the list of
field values before the form is displayed and can for instance be used to populate +hidden,
fields. 9hen using this parameter make sure you are not disclosing sensitive information from
the sessionKK +a hidden field is not all that hidden afterall,
As e4orm does not parse the complete form =st time around you ill have to have the
same placeholders in the form template so the form can receive the values. 1o for e#ample! *K
e4orm ?sessionAars;@Tob.&@ ... K-and Vinput type;ChiddenC value;C*2Tob.&2-C "P
4or those that ant to keep different versions of e4orm active. Fou can no save all of
e4orm/s files in a different directory and set the ?snip4older accordingly. Fou can for instance
save version =.[.[ in the /assets"snippets"eform"=.[.[/ folder and set
?snip4older;@eform"=.[.[@. :he value of ?snip4older is added to the basic snippets folder
/assets"snippets"/..t should not include a closing slash +",K
1ubTect to appear in email Can include *.form fields.-. D.g. Purcase %rder for *.firstname.-
*.lastname.-
Dnforces a time limit +in minutes, beteen form submits. After the form has been
submitted successfully it can not be submitted again for ?submit6imit minutes irrespective of
the form data. 9hen used in combination ith ?protect1ubmit submit6imit takes precedence,
meaning that hen the time limit has e#pired the form can be submitted again regardless of
the setting of ?protect1ubmit +it ill unset the session variable,. As ith ?protect1ubmit this
parameter uses a session variable ith a variable name based on ?formid.
chunk name +non0numeric, or document id +numeric, to use as a thank you message
displayed to the user after a successful submit. :ags! same as for ?tpl
Dmail address to send e4orm information to 4or multiple recipients separate emails ith a
comma +,, .f omitted the site settings email address ill be used
Dnables verification code. :he template contain a vericode field and a *2vericode2-
placeholder
D#pects a function name. :his function ill only be called henever the form is displayed
and Tust before all placeholders are merged. :he function should accomodate the folloing
parameter! ?Ofields 0 +as reference, an associative array of field and placeholder values.
D#pects a function name. :he function is called after the templates are loaded and the
formid is found valid. :he function should accomodate the folloing parameter! ?Otemplates 0
+as reference, an associative array of loaded templates ith inde#es /tpl/, /report/,/thankyou/ ?
/autote#t/. Be aare that the latter three ill only have a value if the form has been postedK
D#pects a function name. :his function ill be called after the form has been validated
and before the report and thankyou templates have been parsed and any emails have been
sent out. 1ee this e#ample on ho to use the events.
D#pects a function name. :his function is called after all templates have been parsed and
any emails ere sent.
D#pects a function name. :his function ill be called directly after the form validation has
taken place. Fou can use this event to add your on e#tra validation logic. :he function
should accomodate the folloing parameters
o ?Ofields 0 +as reference, an associative array of field and placeholder values.
o ?Ov$sg 0 +as reference, a numeric array of validation error messages.
o ?Or$sg 0 +as 3eference, a numeric array of missing reJuired fields.
basic re7uire) c'unks
basic contact form c'unk: cop( an) past belo+
Basic !eport "'unk : cop( an) paste belo+
Vp class;CerrorCP*2validationmessage2-V"pP
Vform method;CpostC action;C*B*5id5-B-C id;CDmail4ormCP
VfieldsetP
VhNP Contact HsV"hNP
Vinput name;CformidC type;ChiddenC value;CContact4ormC "P
Vlabel for;CcfGameCPFour name!
VpPVinput name;CnameC id;CcfGameC class;Cte#tC type;Cte#tC eform;CFour Game!!=!C "PV"pPV"labelP
Vlabel for;CcfDmailCPFour Dmail Address!
VpPVinput name;CemailC id;CcfDmailC class;Cte#tC type;Cte#tC eform;CDmail Address!email!=C "PV"pP V"labelP
Vlabel for;Ccf3egardingCP3egarding!
VpPVinput name;CsubTectC id;Ccf3egardingC class;Cte#tC type;Cte#tC eform;C4orm 1ubTect!!=C "PV"pP V"labelP
Vlabel for;Ccf$essageCP$essage!
VpPVte#tarea name;CmessageC id;Ccf$essageC eform;C$essage!te#tarea!=CPV"te#tareaPV"pP
V"labelP
VlabelP?nbspQV"labelPVpPVinput type;CsubmitC name;CcontactC id;CcfContactC class;CbuttonC value;C1end :his $essageC "PV"pP
V"fieldsetP
V"formP
VpP:his is a response sent by VbP*2name2-V"bP using the feedback form on this ebsite. :he details of the message follo belo!V"pP
VpPGame! *2name2-V"pP
VpPDmail! *2email2-V"pP
VpP3egarding! *2subTect2-V"pP
VpPComments!Vbr "P*2message2-V"pP
VpPFou can use this link to reply! Va href;Cmailto!*2email2->subTect;3D! *2subTect2-CP*2email2-V"aPV"pP
6an)( plugins=snippets t'at aren3t installe) b( )efault
Name Description
(ide Dditor
&oc.nfo
CustomiXe $anager fields
$anager$anager
WetChunk:emplate
.nherit 1elected :emplate
Curr&oc%ut
get4ield
WoogleDvents
:ableau
4ile&onloadPD
4ile &etails
php:humb Package
Possibly handy plugins"snippet
Automatic :emplate
(ides the content editor hen using a template that doesn/t
contain the content0variable
4inds and gives every element of the document. such as
CPagetitleC+default,, CaliasC, ClongtitleC and etc. very convenient
to find the template variables +:As,
Hsed to hide, change, or inherit document obTect fields in the
manager. Can change, hide, or inherit based on specific
templates or manager user roles.
Allos you to hide, change and inherit document obTect fields
plus a hole lot more.
:his snippet returns the contant of the Chunk hose name is
build from the concatenation of the name of the current
template and the parameter chunk, separated by the
underscor character!
.nherit 1elected :emplate is a replacement for the C.nherit
Page :emplateC plugin. By default nely created child
documents ill inherit the parents template +as ith the
original plugin, (oever, selecting a template in the parent
container/s /.nherit :emplate/ :A ill make all ne child
documents +of that parent, inherit the selected template
instead. :his orks recursively through the document tree.
:his is a snippet to output a certain string or chunk hen it
meets certain criteria, such as the current document id is listed
on Oid parameter, or the current document parent id is listed
on Oparent parameter. .t can react to Onotid or Onotparent
parameter as ell, hich is the opposite from the previous
e#ample.
3eturns any field or template variable from any document or
any of its parents.
Wrab the events from your Woogle Calendar and display them
as a list and or in a Calendar. 1upposedly can even mash
multiple calendars together
:ableau orks like other list0makers such as &itto or
9ayfinder, but is designed to build tables. :his is ideal for
product category pages such as on 9eb stores here you
ant, say, a N#N grid of products, ith prev"ne#t page controls.
4ile&onloadPD +Pirate Ddition, is a secure file donloading
snippet for the $%&# C$1"4. 4ile&onloadPD is secure as it
hides the actual path to your file. 4ile&onloadPD keeps track
of ho many times each file has been donloaded and lets
you display that number herever you ant.
P(# +Placeholders
D#tended
P(# +Placeholders Utended, ill add the capability of output
modifiers hen using placeholders, template variables and
settings tags. :he recursive parser allos for nested tags.
Custom modifiers can be added by creating Cmini0snippetsC in
the $%&# resource manager.
Create a file archive or output file information for a supplied file
path.
A snippet +a P(# e#tension, and a plugin to use php:humb
ithin $%&#.
1pecify in the parent container, the templates you ant to use
for your documents. 1top teaching your client hat a template
is !,
6an)( plugins=snippets t'at aren3t installe) b( )efault
Direct Link Possible use
Possibly handy plugins"snippet
http!""mod#cms.com"(ide0Dditor0
=[=0.html
http!""mod#cms.com"&oc.nfo0
22''.html
http!""mod#cms.com"CustomiXe0
$anager04ields0=N[2.html
http!""mod#cms.com"$anager$ana
ger0=\'\.html
http!""mod#cms.com"WetChunk:em
plate020N=.html
Could potentially avoid the use of template variables
hich can be confusing to end users, but since it is
template specific this might tempt you to create more
templates than you need.
http!""mod#cms.com".nherit0
1elected0:emplate022[a.html
Allo parent template to be different from the default
inherited templates of child documents. :his ay
clients do not need to think about templates and a
document tree can be much cleaner.
http!""mod#cms.com"Curr&oc%ut0
\\'.html
http!""mod#cms.com"get4ield0
''Z.html
http!""mod#cms.com"Woogle0
Dvents0=N0=.html
http!""mod#cms.com":ableau0
=\'a.html
http!""mod#cms.com"4ile&onload
PD020aa.html
http!""iki.mod#cms.com"inde#.php"
P(#
http!""mod#cms.com"4ile&etails0
\a0.html
http!""mod#cms.com"php:humb0
Package00.20=\2[.html
Allos for image resiXing on the fly. Hsers can upload
pictures and the pictures ill be resiXed on the fly.
http!""mod#cms.com"automatic:pl0
2=\\.html
6an)( AP% calls
"o)e
Omod#0Pget:emplateAar+/:AGame/,
Omod#0Pdocument%bTect*/documentfield":Aname/- ,
orking ith tables
Omod#0Pget4ull:ableGame+,
&atabase AP.
"o)e
db0Pconnect+,
Omod#0Pdb0Pdelete+,
Omod#0Pdb0Pdisconnect+,
Omod#0Pdb0Pescape+,
Omod#0Pdb0PgetAffected3os+,
Omod#0Pdb0PgetColumn+,
Omod#0Pdb0PgetColumnGames+,
Omod#0Pdb0Pget(:$6Wrid+,
Omod#0Pdb0Pget.nsert.d+,
Omod#0Pdb0Pget6astDrror+,
Omod#0Pdb0Pget3ecordCount+,
Omod#0Pdb0Pget3o+,
Omod#0Pdb0Pget:able$eta&ata+,
Omod#0Pdb0PgetAalue+,
Omod#0Pdb0PgetU$6+,
Omod#0Pdb0Pinit&ata:ypes+,
Omod#0Pdb0Pinsert+,
Omod#0Pdb0PmakeArray+,
Omod#0Pdb0Pprepare&ate+,
Omod#0Pdb0PJuery+,
Omod#0Pdb0Pselect+,
Omod#0Pdb0Pupdate+,
O:Aarray ; Omod#0Pget:emplateAar%utput+array+/:A
GA$D/,,Q
Description
Wet/st the value of a template variable for current document
3eturns the full table name based on db settings.
Description
mi#ed Juery+1tring OsJl,
boolean update+1tring Ofields, 1tring Otable, 1tring Ohere,
Wet/s the value of a document field +e.g. /created/ on or
/introte#t/,, can also return template variable, but returns them
as an array ith its value in second slot. i.e. Ovalue*=-
Calling :As in a snippet
:he content of the :A is no in the array O:Aarray*/:A GA$D/-
by character. +e.g. O:Aarray*/:A GA$D/-*=- is the second
character in the string.
mi#ed makeArray+Array Ors ,
:his function takes a recordset and turns it into a multi0
dimensional associative array, hich is much easier to ork
ith in your scripts. Dach array element represents a ro in the
recordset, in the form of Iey ;P Array+ 4ieldGame ;P Aalue ,.
string prepare&ate+integer Otimestamp, string Ofield:ype ;
/&A:D:.$D/,
resource select+*string Ofields *, string Ofrom *, string Ohere *,
string Oorderby *, string Olimit-----,
e-ample
6ink
Otable ; Omod#0Pget4ull:ableGame+ /eb)user)attributes/ ,Q
e-ample link
http!""iki.mod#cms.
com"inde#.php"Addi
ng):A)9idgets)it
hout)hacking)the)c
ore
function sho)members+, L
global Omod#Q
Ooutput ; //Q
Otable ; Omod#0Pget4ull:ableGame+ /members/ ,Q
Oresult ; Omod#0Pdb0Pselect+ /id, name, picture/, Otable, //, /name
A1C/, // ,Q
Omembers ; Omod#0Pdb0PmakeArray+ Oresult ,Q
foreach+ Omembers as Op)val , L
foreach+ Op)val as Om)key ;P Om)val , L
Ooutput .; /VstrongP/ . Om)key . /!V"strongP / . Om)val .
/Vbr "P/Q
M
M
M
*edit-
http!""iki.mod#cms.
com"inde#.php"AP.!
&BAP.!makeArray
function getDvents+ Odate , L
global Omod#Q
Ooutput ; //Q
Ofulldate ; Omod#0Pdb0Pprepare&ate+ Odate, /&A:D/ ,Q ""Converts
the timestamp into a human0readable &A:D.
Oresult ; Omod#0Pdb0Pselect+ /event)name/, /events/, /timestamp
; / . intval+ Odate , ,Q
hile+ Oro ; Omod#0Pdb0Pget3o+ Oresult , , L
Ooutput .; Oro*/event)name/- . / on / . Ofulldate . /./Q
""9ould output something like Cthe &eclaration of
.ndependence as signed on =ZZ'0Z0[C
M
M
Ooutput ; //Q
Oresult ; Omod#0Pdb0PJuery+ /1D6DC: id, name, Toined 43%$
@user)table@ W3%HP BF @member)type@ %3&D3 BF name A1C/ ,Q

hile+ Oro ; Omod#0Pdb0Pget3o+ Oresult , , L
Ooutput .; /Vbr "P .&! / . Oro*/id/- . /Vbr "P Game! / . Oro*/name/- .
/Vbr "P Yoined! / . Oro*/Toined/-
. /Vbr "P000000000Vbr "P/Q
M
echo OoutputQ
http!""iki.mod#cms.
com"inde#.php"AP.!
&BAP.!Juery
Ores ; Omod#0Pdb0Pselect+CidC, Otable)prefi#.C.mod#)eb)usersC,
Cusername;/Ousername/ AG& passord;/C.md\+Opassord,.C/C,Q
function update)username+ Oid, Ousername , L
global Omod#Q
Otable ; Omod#0Pget4ull:ableGame+ /user)table/ ,Q
Oresult ; Omod#0Pdb0Pupdate+ /username ; C/ . Ousername . /C/,
Otable, /userid ; C/ . Oid . /C/ ,Q
return OresultQ "" 3eturns /true/ on success, /false/ on
failure.
M
http!""iki.mod#cms.
com"inde#.php"AP.!
&BAP.!update
$iscellaneous snippets, and or template hacks etc.
Game
formatdate snippet
include&ocContent
login3edirect
$iscellaneous snippets, and or template hacks etc.
Code, hack, etc.
V>php
"5
Created by Brandon Booth! bboothElucidgreen.net
6ast updated! &ecember =[, 200a
Parameters!
?date4ield! select standard document date field or custom tv date field by name. &efaults to createdon date.
?date4ormat! set format for date in ith standard P(P date formatting. &efaults to _A, _&.
5"
""Begin code, the rest should take care of itself.
Odate4ield ; isset+Odate4ield, > Odate4ield ! /createdon/Q
Odate4ormat ; isset+Odate4ormat, > Odate4ormat ! /_A, _&/Q
if +Odate ; Omod#0Pdocument%bTect*Odate4ield- , L
if+is)array+Odate,,L
Odate%utput ; Odate*=-Q
if+empty+Odate%utput,, return //Q ""bail out if no value
Odate%utput ; mktime+Odate%utput,Q
return strftime+Odate4ormat, Odate%utput,Q
M else L
return strftime+Odate4ormat, Odate,Q
M
M
return //Q
>P
V>php
"5
Created by Brandon Booth! bboothElucidgreen.net
6ast updated! &ecember =[, 200a
Parameters!
?doc.&! the document id from hich to pull the fundraisers longtitle and content. &efaults to =a
D#ample call!
**include&ocContent> ?doc.&;@.&@--
5"
""Begin code, the rest should take care of itself.
Odoc.& ; isset+Odoc.&, > Odoc.& ! /=a/Q
if+Odoc ; Omod#0Pget&ocuments+array+Odoc.&,, =, 0, /longtitle, content/,, L
return CVdiv class;/right0content/PVh[PC.Odoc*0-*/longtitle/-.CV"h[PVulPVliPC.Odoc*0-*/content/-.CV"liPV"ulPV"divPCQ
M
return //Q
>P
>P
V>php
Orefresh ; /V$D:A http0eJuiv;CrefreshC content;C\QH36;/.Omod#0PmakeHrl+',./CP /Q
if+Omod#0Pget6oginHser.&+,,L
Omod#0PregClient1tartup(:$6Block+Orefresh,Q
M else L
return / /Q
M
>P
$iscellaneous snippets, and or template hacks etc.
&escription
:his code as ritten to format the date the same
ay hether it as taken from the standard
createdon field or from a special variable . created.
:his code ill take the content and longtitle from
another document in the tree and format it into a
div. to be included in a template. :% BD &%GD!
need to make this format templateable ith a
chunk or inline.
1nippet to redirect any logged in user to another
page. Be sure to call it uncached *Klogin3edirectK-

You're Reading a Free Preview

Download
scribd
/*********** DO NOT ALTER ANYTHING BELOW THIS LINE ! ************/ var s_code=s.t();if(s_code)document.write(s_code)//-->