[Xrns-php-cvs] xrns-php/htdocs xrns-sf.html,NONE,1.1

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/xrns-php/xrns-php/htdocs
In directory sc8-pr-cvs10.sourceforge.net:/tmp/cvs-serv11589

Added Files:
	xrns-sf.html 
Log Message:
XRNS-SF info page, copied from the XRNS-SF module

--- NEW FILE: xrns-sf.html ---
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta content="text/html; charset=ISO-8859-1" http-equiv="content-type" />
<title>XRNS Script Frontend Documentation</title>
<style type="text/css">
body {
font-family: sans-serif;
}

p {
font-family: monospace;
}

p.code{
border: 1px dotted black;
color:rgb(0,150,0);
background-color:rgb(250,250,250);
}

p.warning{
font-weight:bold;
color:rgb(150,0,0);
}

a {
font-family: monospace;
text-decoration:none;
color:rgb(0,0,128);
}

a:link,a:visited,a:active {
color:rgb(0,0,128);
}

a:hover {
text-decoration:underline;
color:rgb(128,0,0);
}
</style>
</head>

<body>
<h3>XRNS Script Frontend 1.03</h3>
<p>
Developed by Alexander Stoica 2007<br />
<br />
License: Public Domain
<br />
<a href="http://xrns-php.sourceforge.net">http://xrns-php.sourceforge.net</a>
<br /><br />
Use <a href="mailto:in...@be...">in...@be...</a> for feedback or bug reports.
<br /><br />
<a href="http://www.beatslaughter.de">http://www.beatslaughter.de</a><br />
</p>

<h4>What is it?</h4>
XRNS Script Frontend can be used, to provide a graphical user interface for command line
scripts written in PHP on the windows operating system.

<h4>How does it work?</h4>
The frontend includes a stripped down version of the PHP scripting language, which is
known for easy XML programming and is widely used. It's also possible to use external
command line tools without requiring the user to copy them somewhere into a known path.
Each script has a small config file, which defines how the GUI should be build and
also holds some other infos. A more in depth look at this file will follow shortly.
 
The folder "php" holds the PHP commandline interpreter and a windows batch file, which
allows one to generate a phpinfo.txt, which might be of help when developing own scripts.
Any additional scripts go into the "scripts" folder with their corresponding config file.
If a script relies on any extra command line tools, one should put them into the "utils"
folder.
 
Since version 1.02 there are no scripts included anymore. Instead you can download these from the
SourceForge download page.
 
<a href="http://sourceforge.net/project/showfiles.php?group_id=203983">http://sourceforge.net/project/showfiles.php?group_id=203983</a>
 
Alternatively you can download work in progress versions of the scripts. Simply start the file
"get_cvs_dev_version_scripts.cmd" and it will download these from the SourceForge page.

Warning! These are work in progress and probably unstable, use at your own risk.

<h4>Script configuration file format reference</h4>
The script configuration files are just normal *.ini files widely used by other software too.
You should name the configuration file using the same basename as your script. For example,
if the script is named "yourscript.php", the configuration file should be named "yourscript.cfg".
 
The first line should always be the name of the section.
[config]
The following keys are used to provide general information about the script and are self explaining.

caption=Name of the script 
author=Coded by John Doe. 
url=http://www.johndoe.com 
description=Short description, what your script does.

The "gui" key specifies, how the interface will be created. It accepts simple keywords, which are
translated by the frontend. The order of the keywords is important, since all the information the user
selects gets passed in that order as commandline parameters to the PHP script. Mutliple keywords need to be
separated by a semicolon ";".
 
Following the tradition of the first example in other programming languages, here is a simple label
showing "Hello world". The "label" keyword is used to place additional descriptions on the interface
for the user. The text needs to be enclosed by round brackets "()".

gui=label(Hello world)

The "text" keyword can be used to request any type of text to be passed to the script. If you specify the keyword with
optional round brackets "()", one can set a default text show in the textfield.

gui=text 
gui=text(default text)

The "clipboard" keyword will pass the clipboard contents to the script through a temporary file. The script
is responsible for writing back the modified data to this file. When the script has finished executing, the contents
of that temporary file will be shown in the textbox on the interface.

gui=clipboard

The "folder" keyword allows the user to browse for a folder. The chosen path will then be passed to the script.

gui=folder

The "file" keyword allows the user to browse for a file to open. The chosen file will then be passed to the script.
This keyword is usually used to select a source file.

gui=file

It's also possible to specify extensions, including a default one, which will be used when the user leaves the
extension blank when entering or selecting a filename in the file chooser dialog. All extensions are enclosed in round
brackets "()" and each extension will be separated by a comma ",". Prepend a "def:" to the extension, which one wants to define
as default.

gui=file(def:xrns, xrni, zip)

The keyword "output" behaves nearly like the "file" keyword with some exceptions. The current directory will be set to
the path of this file, similar like the user has called the PHP interpreter from this location. This keyword is usually
used to select a destination file.

gui=output 
gui=output(def:xrns, xrni, zip)

The last keyword is "options". It's used to display a combobox, where one can choose one of multiple options.
It's also possible to define a default selected entry.

gui=options(1, 2, def:3, 4, 5, 6, 7, 8, 9, 10)

As a summary, here is an example of how a complete configuration file looks like.

[config] 
caption=Name of the script 
author=Coded by John Doe. 
url=http://www.johndoe.com 
description=Short description, what your script does. 
gui=label(Select an option:); options(1, 2, def:3, 4, 5, 6, 7, 8, 9, 10)

<h4>Thanks and Credits</h4>
This product includes PHP software, freely available from: 
<a href=http://www.php.net/software/>http://www.php.net/software</a>.
 
Xiph.Org Foundation for the flac and ogg encoder/decoder utilities. 
<a href="http://www.xiph.org">http://www.xiph.org</a>
 
Info-ZIP Workgroup for the zip and unzip utilities. 
<a href="http://www.info-zip.org">http://www.info-zip.org</a>
 
gnu.org for the CVS command line utility. 
<a href="http://www.nongnu.org/cvs">http://www.nongnu.org/cvs</a>
 
Pelle Orinius for his excellent C programming IDE and compiler. 
<a href="http://www.smorgasbordet.com/pellesc">http://www.smorgasbordet.com/pellesc</a>
 
Dac Chartrand for his original idea. 
<a href="http://www.trotch.com">http://www.trotch.com</a>

<h4>History</h4>
Version 1.03 (08/31/2007)<br />
<ul>
  <li>Changed: The update redirects now to the SourceForge download page.</li>  
  <li>Changed: The file "update_scripts.cmd" was renamed to "get_cvs_dev_version_scripts.cmd", so that it's more clear that these are work in progress versions.</li>    
</ul>
Version 1.02 (08/29/2007)<br />
<ul>
  <li>Added: New keyword "text", to accept any text input from the user.</li>
  <li>Changed: The frontend has no included scripts anymore, instead it's possible to get all the files with an online update.</li>  
</ul>
Version 1.01 (08/19/2007)<br />
<ul>
  <li>Fixed: Using one of the keywords "options", "file" or "output" with only one parameter made the application hang.</li>
</ul>
Version 1.0 (08/13/2007)<br />
<ul>
  <li>initial release</li>
</ul>
<br />
</body>
</html>