Files
scummvm-web/documentation.php
T
Eugene Sandulenko 5a68f85a1c 0.8.2 release
svn path=/web/trunk/; revision=20432
2006-02-08 23:45:08 +00:00

92 lines
2.4 KiB
PHP

<?php
/*
* Documentation Page for ScummVM
* by Jeremy Newman <jnewman@dracowulf.com>
*
*/
// set this for position of this file relative
$file_root = ".";
// load libraries
require($file_root."/include/"."incl.php");
// start of html
html_page_header('ScummVM :: Documentation');
html_content_begin('ScummVM Documentation');
echo '<div class="par-item">';
$view = $HTTP_GET_VARS['view'];
if ($view and file_exists($file_root."/docs/".$view.".xml")) {
echo ' <div class="par-head">';
echo display_xml($file_root."/docs/".$view.".xml",'NAME');
echo ' </div>';
echo ' <div class="par-content">';
// extract the body from the XML file
$html = display_xml($file_root."/docs/".$view.".xml",'BODY');
// Now evaluate any PHP code embedded into it, and output the result
echo eval("?>" . $html . "<?php ");
echo "<br/>";
echo " </div>\n";
} else {
?>
<div class="par-intro">
<br />
Click the title of the section of the documentation you want to read.
<br />
<br />
</div>
<div class="par-content">
<br/>
<a href='http://cvs.sourceforge.net/viewcvs.py/scummvm/scummvm/README?rev=release-0-8-2'>README 0.8.2</a><br />
The ScummVM README, for version 0.8.2<br /><br />
<?php
// get list of documentation items
$docs = get_files($file_root."/docs","xml");
sort($docs);
// loop and display docs
$c = 0;
while (list($key,$item) = each($docs)) {
$c++;
list($file,$ext) = split("\.",$item,2);
echo "<a href='?view=$file'>".display_xml($file_root."/docs/".$item,'NAME')."</a><br />\n";
echo display_xml($file_root."/docs/".$item,'DESC')."<br /><br />\n";
} // end of docs loop
?>
<a href='http://cvs.sourceforge.net/viewcvs.py/*checkout*/scummvm/scummvm/TODO?rev=HEAD'>ScummVM current areas of focus</a><br />
This page is the current TODO list for ScummVM.<br /><br />
<?php
echo "<a href='$file_root/docs/doxygen/html/index.php'>Source code documentation</a><br />\n";
?>
Cross referenced source code documentation for ScummVM, generated using
<a href='http://www.doxygen.org'>Doxygen</a>.<br /><br />
<?php
// Hard code link to specs for now...
echo "<a href='$file_root/docs/specs/index.php'>The inComplete SCUMM Reference Guide</a><br />\n";
echo "being a Partially Complete and Mostly Accurate guide to the SCUMM Engine data file Format for Versions Five and Six (and above)<br /><br />\n";
echo " </div>\n";
}
echo "</div>\n";
html_content_end();
html_page_footer();
?>