F A K E S S I
(a ServerSideInclude - replacement for phpCMS with additional features)
current version: 1.4.5
changes:
now not only perl but also all oher serversided scripts can be executed
if an error occurs, a message is placed into your content
the performance of the plugin was improved!
a short description
special features in FAKESSI:
- predefined parts of files can be included
- preformation of the files which are marked for inclusion
- full control over the plugin-output with its parameters
- the output of the plugin is available at any position in your content
- simple executions of perl-scripts.
::.. NOTE :: ATTENTION ..::
- !FAKESSI does not completly support perl!
only the first output of a perl-script can be included in your content with
FAKESSI. any further actions are not controlled by the plugin. the first output
of yabb for instance can be included in your content.
- if you include a perl-script with fakessi no other inclussions are allowed!
- "\n" (the end of a line) is not replaced with "<br>" by FAKESSI !
- FAKESSI does not check the html-syntax of a file which is marked for
inclusion!
description of the plugin
parameters and the
use in a content-file
FAKESSI-specific parameters must be written in the same way as described below:
PARAMETER must be in uppercase
describtion is not
case sensitive; value is casesensitive
{PARAMETER}
describtion1:=value
describtion2:=value
aso.....
{FAKESSI_FILE}
path_to_your_documentroot/filename1.xyz
path_to_your_documentroot/filename2.xyz
path_to_your_documentroot/filename3.xyz
path_to_your_documentroot/filename4.xyz
below you find a description of all parameters:
- {FAKESSI_TITLE}
REPLACE := TRUE oder FALSE
the title of your
content page will be replaced with the last found title in the include-file(s).
- {FAKESSI_FILE}
demo/Frunlog.txt
demo/ssitest.html
with the
FAKESSI_FILE parameter you can include as many as desired files. the path starts
at your documentroot (note: no leading / ).
- {FAKESSI_SCANRANGE}
BEGIN:= [#BEGRANGE#]
END:= [#ENDRANGE#]
all between [#BEGRANGE#]
and [#ENDRANGE#] will be included.
TIP:
- at least [#BEGRANGE#] must be in the file you want to include.
( if the
plugin doesn't find this value, no output will be done.)
- if you set BEGIN := <body , FAKESSI starts with including by the next line.
if any javascript-actions are set in <body>, FAKESSI ignore this.
- if you set END:=</body, FAKESSI stops including lines the line before.
- {FAKESSI_SCANPRE}
BEGIN:=<i>
END :=</i><br>
each line
will be formated with your choosen values.
this parameter can be combined with {FAKESSI_SCANRANGE} (see the
example below).
- {FAKESSI_RESULT}
TAG :=<#FAKESSI#>
The
plugin replaces the TAG in your content-file with the output of FAKESSI. If
you don't use this parameter the output is appended to the end of your
content.
definition of the plugin in the content-file
it doesn't matter if you put the FAKESSI parameters before or after the
definition for the plugin.
{PLUGIN FILE="$home/path_to_plugin/fakessi.php" TYPE="DYNAMIC"}
or
{PLUGIN FILE="$home/path_to_plugin/fakessi.php" TYPE="STATIC"}
differences between DYNAMIC and STATIC:
if set to STATIC FAKESSI includes only at the first run. so whenever
you change a value or parameter of FAKESSI you have to clear the parser-cache.
(for detail describtion see the phpCMS documentation).
if you set the type of the plugin to DYNAMIC the content is updated on the fly
with the parameters and values of FAKESSI.
it is recommended to use the
script DYNAMIC.
example for positioning in the content
using the {FAKESSI_RESULT}parameter
{CONTENT}<br>
your text. foofoofoo.blabla.what a beautiful day!<br>
now let' see the plugin in action!<br>
<#FAKESSI#><br>
wow, the plugin replaced the tag with the content of your included file(s) !<br>
examples
- a simple example:
{FAKESSI_FILE}
demo/Frunlog.txt
demo/ssitest.html
{PLUGIN FILE="$home/path_to_plugin/fakessi.php" TYPE="DYNAMIC"}
both files are included at the end of the content.
- an example with {FAKESSI_SCANRANGE}:
{FAKESSI_FILE}
demo/Frunlog.txt
demo/ssitest.html
{FAKESSI_SCANRANGE}
BEGIN:= [#BEGRANGE#]
END:= [#ENDRANGE#]
{PLUGIN FILE="$home/path_to_plugin/fakessi.php" TYPE="DYNAMIC"}
the range values must be set in every file marked for inclusion.
eg:
[#BEGRANGE#]FirstRunScreens:Start
Intl:INTL:0:
GetUserInfo:INIT
VcpClose:About to close
VcpClose:About to End
[#ENDRANGE#]VcpClose:About to Terminate
DoPreInstallWork:Auditmode :0:
the plugin adds the text "FirstRunScreens ... to End" to the content.
- an example with {FAKESSI_SCANPRE}:
{FAKESSI_SCANPRE}
BEGIN:=<i>
END :=</i><br>
{FAKESSI_FILE}
demo/Frunlog.txt
demo/ssitest.html
{PLUGIN FILE="$home/path_to_plugin/fakessi.php" TYPE="DYNAMIC"}
each line will be formated with the given values (the plugin doesn't care about
text or html files).
- an example with {FAKESSI_SCANPRE} and{FAKESSI_SCANRANGE}:
{FAKESSI_SCANPRE}
BEGIN:=<i>
END :=</i><br>
{FAKESSI_FILE}
demo/Frunlog.txt
demo/ssitest.html
{FAKESSI_SCANRANGE}
BEGIN:= [#BEGRANGE#]
END:= [#ENDRANGE#]
{PLUGIN FILE="$home/path_to_plugin/fakessi.php" TYPE="DYNAMIC"}
the plugin reads the files within the given range, formats each line and appends
them to your content-file.
- an example with all parameters:
{FAKESSI_TITLE}
{FAKESSI_RESULT}
{FAKESSI_SCANPRE}
BEGIN:=<font face="VERDANA,ARIAL,HELVETICA" color="#FF0080" size="1">
END :=</font><br>
{FAKESSI_FILE}
demo/bingo.html
demo/ssitest.html
{FAKESSI_SCANRANGE}
BEGIN:= <body
END:= </body
{PLUGIN FILE="$home/path_to_plugin/fakessi1_4.php" TYPE="DYNAMIC"}
- the plugins starts scaning after the first body and ends bevore
the last body; then each line is formated.
- the title of ssitest.html becomes the new title of the content-file.
- the plugin replaces the TAG <#fakessi#> with the formated output.
serversided-scripts
NEWS:
now, not only perl-scripts, but also all other serversided scripting languages can be included.
Therefore I renamed rhe tag, the syntax and added more opions!
- new syntax for the parameters
- now, you can execute as many scripts as you like
- new: you can combine files and scripts
SYNTAX:
{SERVERSCRIPT}
1,http://www.yourhost.com/cgi-bin/perldiver.cgi
2,http://www.yourhost.com/cgi-bin/hello.cgi
3,http://www.yourhost.com/$home/setdate.asp+http://www.yourhost.com/$home/php/greetings.php?text=hallo
- choose an ID you want to use for your tag followed by a comma!
- write down the full path to your serversided-script
- NEW: to combine the output of two scripts, write a plus "+" inbetween.
- NEW: you can use the specific $home variable of phpCMS. (note: $home has to be defined in your projectfile. for more infos read the phpCMS docu.)
that's all! now place the tags with the ID in your content.
EXAMPLE for a contentfile:
{PLUGIN FILE="$home/fakessi/fakessi.php" TYPE="DYNAMIC"}
{SERVERSCRIPT}
1,http://www.yourhost.com/cgi-bin/perldiver.cgi
2,http://www.yourhost.com/cgi-bin/hello.cgi
3,http://www.yourhost.com/$home/setdate.asp+http://www.yourhost.com/$home/php/greetings.php?text=hallo
and so on...
{CONTENT}
<B>here is the output from the first script:</B><BR>
<BR><SERVERSCRIPT,1><BR>
and here is your second ouput:<BR>
<SERVERSCRIPT,2> <BR>
and here is the ouput of the asp and php script:
<BR>
<SERVERSCRIPT,3> <BR>
todo-list
- {FAKESSI_DIR} TO SCAN ALL FILES WITHIN DIRECTORIES
- {FAKESSI_COMBO} TO PUT OUTPUT AS A LIST OF FILES IN A DROPDOWN
- {FAKESSI_LIST} TO PUT OUTPUT AS A LIST OF FILES IN A LISTBOX
- {FAKESSI_TABLE} TO PUT OUTPUT IN A TABLE
- {FAKESSI_TEMPLATE} TO PUT OUTPUT IN A SPECIAL TEMPLATE
contact
wernhard ch. kempinger, thevoice@chello.at
if you have any questions, comments, flames please feel free to email me.you
can always check the forum at the phpCMS
hompage for updates, news and help also.
Thank You for choosing FAKESSI 1.4