[Scummvm-cvs-logs] CVS: web/docs/specs aary.php,1.7,1.8 char.php,1.5,1.6 glossary.php,1.6,1.7 index.php,1.6,1.7 introduction.php,1.9,1.10 scrp-v5.php,1.6,1.7 scrp-v6.php,1.7,1.8 scrp.php,1.6,1.7
Eugene Sandulenko
sev at users.sourceforge.net
Wed Nov 30 17:31:22 CET 2005
- Previous message: [Scummvm-cvs-logs] CVS: web demos.php,1.68,1.69
- Next message: [Scummvm-cvs-logs] CVS: web demos.php,1.69,1.70 documentation.php,1.18,1.19 downloads.php,1.149,1.150 screenshots.php,1.22,1.23
- Messages sorted by:
[ date ]
[ thread ]
[ subject ]
[ author ]
Update of /cvsroot/scummvm/web/docs/specs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv2858/docs/specs
Modified Files:
aary.php char.php glossary.php index.php introduction.php
scrp-v5.php scrp-v6.php scrp.php
Log Message:
o Made all pages really movable, i.e. added $file_root everywhere
o Unified navigation items for code simplicity
o Transferred "The inComplete SCUMM Reference Guide" to new layout
Index: aary.php
===================================================================
RCS file: /cvsroot/scummvm/web/docs/specs/aary.php,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -r1.7 -r1.8
--- aary.php 2 Sep 2004 19:23:23 -0000 1.7
+++ aary.php 1 Dec 2005 01:30:38 -0000 1.8
@@ -5,19 +5,22 @@
require($file_root."/include/"."incl.php");
// start of html
-html_header("SCUMM Reference Guide :: AARY Arrays and Strings", '<link href="specs.css" rel="stylesheet" type="text/css">');
-sidebar_start(true);
+html_page_header("ScummVM :: SCUMM Reference Guide :: AARY Arrays and Strings", '<link href="specs.css" rel="stylesheet" type="text/css">');
//display welcome table
-echo html_round_frame_start("AARY: Arrays and Strings","");
+echo html_content_begin("AARY: Arrays and Strings","");
?>
- <p>
- <big><b>AARY: Arrays and Strings</b></big><br>
- <? echo html_line(); ?>
- </p>
+<div class="par-item">
+ <div class="par-head">
+ AARY: Arrays and Strings
+ </div>
+ <div class="par-content">
-<H2>Introduction</H2>
+ <br/>
+ <?php html_subhead_start("Introduction"); ?>
+
+ <div class="par-subhead-content">
<p>Arrays are used for storing arbitrary blocks of data. They are accessible by
the scripts, and so can be used for storing anything that might be useful;
@@ -28,13 +31,21 @@
<p>The way Arrays work was redesigned completely between V5 and V6.</p>
-<H2>V5 chunk format</H2>
+ </div>
+
+ <?php html_subhead_start("V5 chunk Format"); ?>
+
+ <div class="par-subhead-content">
<p>V5 Arrays are not stored in the data file. 32 Arrays are available for
access using the <tt>arrayOps</tt> opcode. V5 Arrays (sometimes also referred
to as Strings) are one-dimensional.</p>
-<H2>V6 chunk format</H2>
+ </div>
+
+ <?php html_subhead_start("V6 chunk Format"); ?>
+
+ <div class="par-subhead-content">
<pre class=box>
<u>Size</u> <u>Type</u> <u>Description</u>
@@ -62,7 +73,13 @@
<tr><td>5</td> <td>Array of integers</td></tr>
</table>
-<H2>V8 chunk format</H2>
+ </div>
+
+<br/>
+
+ <?php html_subhead_start("V8 chunk Format"); ?>
+
+ <div class="par-subhead-content">
<pre class=box>
<u>Size</u> <u>Type</u> <u>Description</u>
@@ -79,15 +96,19 @@
an entry of 0 means a size of 1. One dimensional arrays are simply a
special case, where one dimension has size 1.</p>
+</div>
+
<HR><P STYLE="font-size: smaller; text-align: center">
All material © 2000-2002 David Given, unless where stated otherwise.
</P>
+ </div>
+</div>
+
<?
-echo html_round_frame_end(" ");
// end of html
-sidebar_end();
-html_footer();
+html_content_end();
+html_page_footer();
?>
Index: char.php
===================================================================
RCS file: /cvsroot/scummvm/web/docs/specs/char.php,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- char.php 2 Sep 2004 19:23:23 -0000 1.5
+++ char.php 1 Dec 2005 01:30:38 -0000 1.6
@@ -5,20 +5,22 @@
require($file_root."/include/"."incl.php");
// start of html
-html_header("SCUMM Reference Guide :: CHAR Character Sets", '<link href="specs.css" rel="stylesheet" type="text/css">');
-sidebar_start(true);
+html_page_header("ScummVM :: SCUMM Reference Guide :: CHAR Character Sets", '<link href="specs.css" rel="stylesheet" type="text/css">');
//display welcome table
-echo html_round_frame_start("CHAR: Character Sets","");
+html_content_begin('CHAR: Character Sets');
?>
- <p>
- <big><b>CHAR: Character Sets</b></big><br>
- <? echo html_line(); ?>
- </p>
+<div class="par-item">
+ <div class="par-head">
+ CHAR: Character Sets
+ </div>
+ <div class="par-content">
+ <br/>
+ <?php html_subhead_start("Introduction"); ?>
-<H2>Introduction</H2>
+ <div class="par-subhead-content">
Character sets define the fonts used by SCUMM to draw text, such as dialogue,
on the screen. They are stored in <tt>CHAR</tt> chunks, and
@@ -32,7 +34,11 @@
<p> Character glyphs may be 1, 2 or 4 bits per pixel, and can be masked.
-<h2>Chunk Format</h2>
+ </div>
+
+ <?php html_subhead_start("Chunk Format"); ?>
+
+ <div class="par-subhead-content">
<p><pre class=box>
<u>Size</u> <u>Type</u> <u>Description</u>
@@ -92,15 +98,18 @@
Bit position: 7 0 7 1 ...
Words of data: 00001111 22223333
</pre>
+ </div>
+
<HR><P STYLE="font-size: smaller; text-align: center">
All material © 2000-2002 David Given, unless where stated otherwise.
</P>
+ </div>
+</div>
+
<?
-echo html_round_frame_end(" ");
// end of html
-sidebar_end();
-html_footer();
+html_content_end();
+html_page_footer();
?>
-
Index: glossary.php
===================================================================
RCS file: /cvsroot/scummvm/web/docs/specs/glossary.php,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- glossary.php 2 Sep 2004 19:23:23 -0000 1.6
+++ glossary.php 1 Dec 2005 01:30:38 -0000 1.7
@@ -5,17 +5,17 @@
require($file_root."/include/"."incl.php");
// start of html
-html_header("SCUMM Reference Guide :: Glossary", '<link href="specs.css" rel="stylesheet" type="text/css">');
-sidebar_start(true);
+html_page_header("ScummVM :: SCUMM Reference Guide :: Glossary", '<link href="specs.css" rel="stylesheet" type="text/css">');
//display welcome table
-echo html_round_frame_start("Glossary","");
+echo html_content_begin("Glossary");
?>
- <p>
- <big><b>Glossary</b></big><br>
- <? echo html_line(); ?>
- </p>
+<div class="par-item">
+ <div class="par-head">
+ Glossary
+ </div>
+ <div class="par-content">
<dl>
<DT>
@@ -66,11 +66,12 @@
All material © 2000-2002 David Given, unless where stated otherwise.
</P>
+ </div>
+</div>
+
<?
-echo html_round_frame_end(" ");
// end of html
-sidebar_end();
-html_footer();
+html_content_end();
+html_page_footer();
?>
-
Index: index.php
===================================================================
RCS file: /cvsroot/scummvm/web/docs/specs/index.php,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- index.php 2 Sep 2004 19:23:23 -0000 1.6
+++ index.php 1 Dec 2005 01:30:38 -0000 1.7
@@ -5,20 +5,20 @@
require($file_root."/include/"."incl.php");
// start of html
-html_header("The inComplete SCUMM Reference Guide", '<link href="specs.css" rel="stylesheet" type="text/css">');
-sidebar_start(true);
+html_page_header("ScummVM :: The inComplete SCUMM Reference Guide", '<link href="specs.css" rel="stylesheet" type="text/css">');
+
+html_content_begin('The inComplete SCUMM Reference Guide');
// add
//display welcome table
-echo html_round_frame_start("The inComplete SCUMM Reference Guide","");
?>
- <p>
- <big><b>The inComplete SCUMM Reference Guide</b></big><br>
- <? echo html_line(); ?>
- </p>
-
+<div class="par-item">
+ <div class="par-head">
+ The inComplete SCUMM Reference Guide
+ </div>
+ <div class="par-content">
<p>
<i>being a Partially Complete and Mostly Accurate guide to the SCUMM Engine data file Format for Versions Five and Six (and above)</i>
@@ -37,10 +37,12 @@
All material © 2000-2002 David Given, unless where stated otherwise.
</P>
+ </div>
+</div>
+
<?
-echo html_round_frame_end(" ");
// end of html
-sidebar_end();
-html_footer();
+html_content_end();
+html_page_footer();
?>
Index: introduction.php
===================================================================
RCS file: /cvsroot/scummvm/web/docs/specs/introduction.php,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -d -r1.9 -r1.10
--- introduction.php 2 Sep 2004 19:23:23 -0000 1.9
+++ introduction.php 1 Dec 2005 01:30:38 -0000 1.10
@@ -5,20 +5,51 @@
require($file_root."/include/"."incl.php");
// start of html
-html_header("SCUMM Reference Guide :: Introduction", '<link href="specs.css" rel="stylesheet" type="text/css">');
-sidebar_start(true);
+html_page_header("ScummVM :: SCUMM Reference Guide :: Introduction", '<link href="specs.css" rel="stylesheet" type="text/css">');
//display welcome table
-echo html_round_frame_start("Introduction","");
+html_content_begin("Introduction");
?>
- <p>
- <big><b>Introduction</b></big><br>
- <? echo html_line(); ?>
- </p>
+<div class="par-item">
+ <div class="par-head">
+ Introduction
+ </div>
-<H2>Changes</h2>
+ <div class="par-intro">
+ <br/>
+
+ <div class="navigation">
+ Navigation
+
+ <div class="nav-dots">
+
+ </div>
+
+<table border=0>
+
+<?php
+ html_nav_item("#changes", "Changes");
+ html_nav_item("#whatis", "What is SCUMM?");
+ html_nav_item("#versions", "What versions of SCUMM are there available?");
+ html_nav_item("#engines", "Engines");
+?>
+
+</table>
+<br/>
+ </div>
+ </div>
+
+<br/>
+
+ <div class="par-content">
+
+<a name="changes"></a>
+
+ <?php html_subhead_start("Changes"); ?>
+
+ <div class="par-subhead-content">
<dl>
<dt>
@@ -43,7 +74,16 @@
<DD>Initial version
</dl>
-<h2>What is SCUMM?</h2>
+ </div>
+ </div>
+</div>
+
+<a name="whatis"></a>
+<div class="par-item">
+ <div class="par-head">
+ What is SCUMM?
+ </div>
+ <div class="par-content">
SCUMM, the <B>S</B>cript <B>C</B>reation <B>U</B>tility for
<B><EM>M</EM></B><EM>aniac</EM> <B><EM>M</EM></B><EM>ansion</EM>, is an engine
@@ -102,7 +142,15 @@
Revisited</a>. If you are at all interested in SCUMM files, this is an
essential tool.
-<H2>What versions of SCUMM are there available?</H2>
+ </div>
+</div>
+
+<a name="versions"></a>
+<div class="par-item">
+ <div class="par-head">
+ What versions of SCUMM are there available?
+ </div>
+ <div class="par-content">
<p>Many.
@@ -178,7 +226,15 @@
?>
<p>This document will only concern itself with SCUMM versions 5-8.
-<h2>Engines</h2>
+ </div>
+</div>
+
+<a name="engines"></a>
+<div class="par-item">
+ <div class="par-head">
+ Engines
+ </div>
+ <div class="par-content">
<p>The SCUMM virtual machine is made up of a number of sub engines working together. Strictly, the term SCUMM only refers to the scripting language itself. The official term for the virtual machine as a whole is SPUTM --- but getting people to change is probably a lost cause.
@@ -208,11 +264,11 @@
All material © 2000-2002 David Given, unless where stated otherwise.
</P>
+ </div>
+</div>
+
<?
-echo html_round_frame_end(" ");
-
-// end of html
-sidebar_end();
-html_footer();
+html_content_end();
+html_page_footer();
?>
Index: scrp-v5.php
===================================================================
RCS file: /cvsroot/scummvm/web/docs/specs/scrp-v5.php,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- scrp-v5.php 2 Sep 2004 19:23:24 -0000 1.6
+++ scrp-v5.php 1 Dec 2005 01:30:38 -0000 1.7
@@ -5,17 +5,18 @@
require($file_root."/include/"."incl.php");
// start of html
-html_header("SCUMM Reference Guide :: V5 opcode list", '<link href="specs.css" rel="stylesheet" type="text/css">');
-sidebar_start(true);
+html_page_header("ScummVM :: SCUMM Reference Guide :: V5 opcode list", '<link href="specs.css" rel="stylesheet" type="text/css">');
//display welcome table
-echo html_round_frame_start("V5 opcode list","");
+echo html_content_begin("V5 opcode list");
?>
- <p>
- <big><b>V5 opcode list</b></big><br>
- <? echo html_line(); ?>
- </p>
+<div class="par-item">
+ <div class="par-head">
+ V5 opcode list
+ </div>
+ <div class="par-content">
+
<p>The following conventions are used in the encoding descriptions.
@@ -930,11 +931,12 @@
All material © 2000-2002 David Given, unless where stated otherwise.
</p>
+ </div>
+</div>
+
<?
-echo html_round_frame_end(" ");
// end of html
-sidebar_end();
-html_footer();
+html_content_end();
+html_page_footer();
?>
-
Index: scrp-v6.php
===================================================================
RCS file: /cvsroot/scummvm/web/docs/specs/scrp-v6.php,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -r1.7 -r1.8
--- scrp-v6.php 2 Sep 2004 19:23:24 -0000 1.7
+++ scrp-v6.php 1 Dec 2005 01:30:38 -0000 1.8
@@ -5,17 +5,17 @@
require($file_root."/include/"."incl.php");
// start of html
-html_header("SCUMM Reference Guide :: V6 opcode list", '<link href="specs.css" rel="stylesheet" type="text/css">');
-sidebar_start(true);
+html_page_header("ScummVM :: SCUMM Reference Guide :: V6 opcode list", '<link href="specs.css" rel="stylesheet" type="text/css">');
//display welcome table
-echo html_round_frame_start("V6 opcode list","");
+echo html_content_begin("V6 opcode list");
?>
- <p>
- <big><b>V6 opcode list</b></big><br>
- <? echo html_line(); ?>
- </p>
+<div class="par-item">
+ <div class="par-head">
+ V6 opcode list
+ </div>
+ <div class="par-content">
<p>The following conventions are used in the encoding descriptions:
@@ -982,7 +982,7 @@
<h4>Stack</h4>( <i>bool</i> : -)<br>
<br>
-<h4> Operation</h4>if <i>bool</i> <font face=symbol>¹</font> 0, pc := pc + <i>offset</i> <br>
+<h4> Operation</h4>if <i>bool</i> <font face=symbol> </font> 0, pc := pc + <i>offset</i> <br>
<br>
Pops the top value off the stack. If non-zero, then <i>offset</i>
is added to the current program counter after the instruction has
@@ -1177,7 +1177,7 @@
<h4>Stack</h4>( <i>value</i><sub><font size=2>1</font></sub> , <i>value</i><sub><font size=2>2</font></sub> : <i>bool</i> )<br>
<br>
-<h4> Operation</h4>If <i>value</i><sub><font size=2>1</font></sub> <font face=symbol>¹</font> <i>value</i><sub><font size=2>2</font></sub> , set <i>bool</i>
+<h4> Operation</h4>If <i>value</i><sub><font size=2>1</font></sub> <font face=symbol> </font> <i>value</i><sub><font size=2>2</font></sub> , set <i>bool</i>
to 1, otherwise set it to 0<br>
<br>
Tests the top two values on the stack to see if they are not equal.<br>
@@ -2008,11 +2008,12 @@
All material © 2000-2002 David Given, unless where stated otherwise.
</p>
+ </div>
+</div>
+
<?
-echo html_round_frame_end(" ");
// end of html
-sidebar_end();
-html_footer();
+html_content_end();
+html_page_footer();
?>
-
Index: scrp.php
===================================================================
RCS file: /cvsroot/scummvm/web/docs/specs/scrp.php,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- scrp.php 2 Sep 2004 19:23:24 -0000 1.6
+++ scrp.php 1 Dec 2005 01:30:38 -0000 1.7
@@ -5,24 +5,31 @@
require($file_root."/include/"."incl.php");
// start of html
-html_header("SCUMM Reference Guide :: SCRP Scripts", '<link href="specs.css" rel="stylesheet" type="text/css">');
-sidebar_start(true);
+html_page_header("ScummVM :: SCUMM Reference Guide :: SCRP Scripts", '<link href="specs.css" rel="stylesheet" type="text/css">');
//display welcome table
-echo html_round_frame_start("SCRP: Scripts","");
+echo html_content_begin("SCRP: Scripts");
?>
- <p>
- <big><b>SCRP: Scripts</b></big><br>
- <? echo html_line(); ?>
- </p>
+<div class="par-item">
+ <div class="par-head">
+ SCRP: Scripts
+ </div>
+ <div class="par-content">
-<H2>Introduction</H2>
+ <br/>
+ <?php html_subhead_start("Introduction"); ?>
+
+ <div class="par-subhead-content">
<p>Insert here
</p>
-<h2>The SCUMM virtual machine</h2>
+ </div>
+
+ <?php html_subhead_start("The SCUMM virtual machine"); ?>
+
+ <div class="par-subhead-content">
<p>The SCUMM virtual machine was given a complete rewrite between version 5 and
version 6. Both virtual machines are simple byte-code machines with built-in
@@ -44,7 +51,11 @@
can be used as a dynamic heap.
</p>
-<H2>Pointers</H2>
+ </div>
+
+ <?php html_subhead_start("Pointers"); ?>
+
+ <div class="par-subhead-content">
<p>Both V5 and V6 use a common system of encoding the address of something in
memory. These are referred to as pointers. These come in several forms,
@@ -104,7 +115,11 @@
</p>
-<H2>Threads</H2>
+ </div>
+
+ <?php html_subhead_start("Threads"); ?>
+
+ <div class="par-subhead-content">
<p>Both engines have automatic cooperative threading. Instructions will be
executed out of a single script until it suspends for some reason; the flow of
@@ -169,7 +184,11 @@
however, even unfreezable threads can be frozen with the appropriate code (see
the <tt>freezeScripts</tt> and <tt>freezeUnfreeze</tt> opcodes).
-<h2>Version 5 instruction encoding</h2>
+ </div>
+
+ <?php html_subhead_start("Version 5 instruction encoding"); ?>
+
+ <div class="par-subhead-content">
<p>Unfortunately, there is no set V5 instruction encoding. In the general form,
instructions take a fixed number of parameters and return an optional value.
@@ -200,7 +219,11 @@
many parameters and have a supplementary opcode byte to contain the extra
parameter bits. You have been warned.
-<H2>Version 6 instruction encoding</H2>
+ </div>
+
+ <?php html_subhead_start("Version 6 instruction encoding"); ?>
+
+ <div class="par-subhead-content">
<p>After V5, the byte-code engine was rewritten completely. The new engine is
far more orthogonal and considerably easier to understand.
@@ -213,7 +236,11 @@
<p>As a result of this more efficient encoding, the V6 engine actually has more
instructions than the V5 one, despite using fewer entries in the opcode map.
-<H2>Arrays</H2>
+ </div>
+
+ <?php html_subhead_start("Arrays"); ?>
+
+ <div class="par-subhead-content">
<p>Both V5 and V6 allow Array resources to be used as a dynamic heap. V5
allows up to 32 one-dimensional arrays, also referred to as Strings; V6 allows
@@ -226,15 +253,20 @@
The specified Array is initialised to zero. V6 does it with the <tt>dim</tt>,
<tt>dim2</tt> or <tt>arrayOps/208</tt> opcodes, depending on the type of array
and how it is to be initialised.
+
+</div>
+
<HR><P STYLE="font-size: smaller; text-align: center">
All material © 2000-2002 David Given, unless where stated otherwise.
</P>
+
+ </div>
+</div>
+
<?
-echo html_round_frame_end(" ");
// end of html
-sidebar_end();
-html_footer();
+html_content_end();
+html_page_footer();
?>
-
- Previous message: [Scummvm-cvs-logs] CVS: web demos.php,1.68,1.69
- Next message: [Scummvm-cvs-logs] CVS: web demos.php,1.69,1.70 documentation.php,1.18,1.19 downloads.php,1.149,1.150 screenshots.php,1.22,1.23
- Messages sorted by:
[ date ]
[ thread ]
[ subject ]
[ author ]
More information about the Scummvm-git-logs
mailing list