doc/files/README.html in sdl4r-0.9.4 vs doc/files/README.html in sdl4r-0.9.5
- old
+ new
@@ -1,14 +1,11 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
+<!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" xml:lang="en" lang="en">
<head>
- <title>File: README</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <title>File: README [RDoc: Simple Declarative Language for Ruby]</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
@@ -23,55 +20,72 @@
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
-
+
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
-
+
// Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }<\/style>" )
+
// ]]>
</script>
</head>
<body>
-
<div id="fileHeader">
<h1>README</h1>
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Path:</strong></td>
<td>README
+
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
- <td>Thu Aug 05 23:35:08 +0900 2010</td>
+ <td>2010-08-06 13:03:22 +0900</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
-
-
<div id="contextContent">
<div id="description">
<h1>SDL (Simple Declarative Language)</h1>
+<p>
+SDL version supported: 1.3
+</p>
+<table>
+<tr><td valign="top">Site:</td><td><a
+href="http://www.ikayzo.org/confluence/display/SDL/Home">www.ikayzo.org/confluence/display/SDL/Home</a>
+
+</td></tr>
+<tr><td valign="top">Downloads:</td><td><a
+href="http://www.ikayzo.org/confluence/display/SDL/Downloads">www.ikayzo.org/confluence/display/SDL/Downloads</a>
+
+</td></tr>
+<tr><td valign="top">Users mailing list:</td><td>sdl-users@ikayzo.org
+
+</td></tr>
+<tr><td valign="top">Developers mailing list:</td><td>sdl-developers@ikayzo.org
+
+</td></tr>
+</table>
<h2>Getting Started with <a href="../classes/SDL4R.html">SDL4R</a></h2>
<p>
To get the Ruby Gem:
</p>
<pre>
@@ -112,11 +126,11 @@
<h2>SDL Documents</h2>
<p>
SDL documents are made up of Tags. A Tag contains
</p>
<ul>
-<li>a name (if not present, the name "content" is used)
+<li>a name (if not present, the name “content” is used)
</li>
<li>a namespace (optional)
</li>
@@ -147,13 +161,13 @@
smoker = root.child("smoker").value
</pre>
<p>
A tag is basically a data structure with a list of values, a map of
attributes, and (if it has a body) child tags. In the example above, the
-<tt>values.sdl</tt> file is read into a tag called "root". It has
-two children (tags) called "size" and "smoker". Both
-these children have one value, no attributes, and no bodies.
+<tt>values.sdl</tt> file is read into a tag called “root”. It
+has two children (tags) called “size” and “smoker”.
+Both these children have one value, no attributes, and no bodies.
</p>
<p>
SDL is often used for simple key-value mappings. To simplify things Tag has
the methods getValue and setValue which operate on the first element in the
values list. Also notice SDL understands types which are determined using
@@ -181,22 +195,22 @@
names and attributes. Tag bodies are also optional. SDL identifiers begin
with a unicode letter or an underscore (_) followed by zero or more unicode
letters, numbers, underscores (_), dashes (-) and periods (.).
</p>
<p>
-Tags without bodies are terminated by a new line character (\n) and may be
-continue onto the next line by placing a backslash (\) at the end of the
+Tags without bodies are terminated by a new line character (n) and may be
+continue onto the next line by placing a backslash () at the end of the
line. Tags may be nested to an arbitrary depth. SDL ignores all other white
space characters between tokens. Although nested blocks are indented by
convention, tabs have no significance in the language.
</p>
<h2>Anonymous Tags</h2>
<p>
SDL also supports anonymous tags which are assigned the name
-"content". An anonymous tag starts with a literal and is followed
-by zero or more additional literals and zero or more attributes. The
-examples section below demonstrates the use of anonymous tags.
+“content”. An anonymous tag starts with a literal and is
+followed by zero or more additional literals and zero or more attributes.
+The examples section below demonstrates the use of anonymous tags.
</p>
<pre>
greetings {
"hello" language="English"
}
@@ -207,22 +221,22 @@
</pre>
<h2>String literals</h2>
<p>
There are two ways to write String literals.
</p>
-<h3>Starting and ending with double quotes (")</h3>
+<h3>Starting and ending with double quotes (“)</h3>
<p>
-Double quotes, backslash characters (\), and new lines (\n) within this
-type of String literal must be escaped like so:
+Double quotes, backslash characters (), and new lines (n) within this type
+of String literal must be escaped like so:
</p>
<pre>
file "C:\\folder\\file.txt"
say "I said \"something\""
</pre>
<p>
This type of String literal can be continued on the next line by placing a
-backslash (\) at the end of the line like so:
+backslash () at the end of the line like so:
</p>
<pre>
line "this is a \
long string of text"
</pre>
@@ -247,11 +261,11 @@
a long line
fee fi fo fum`
</pre>
<p>
Note: SDL interprets new lines in `` String literals as a single new line
-character (\n) regarless of the platform.
+character (n) regarless of the platform.
</p>
<h2>Binary literals</h2>
<p>
Binary literals use base64 characters enclosed in square brackets ([]). The
binary literal type can also span lines. White space is ignored.
@@ -274,17 +288,17 @@
</pre>
<h2>Date and Time Literals</h2>
<p>
SDL supports date, time span, and date/time literals. Date and Date/Time
literals use a 24 hour clock (0-23). If a timezone is not specified, the
-default locale‘s timezone will be used.
+default locale’s timezone will be used.
</p>
<p>
Examples:
</p>
<ul>
-<li>create a tag called "date" with a date value of Dec 5, 2005
+<li>create a tag called “date” with a date value of Dec 5, 2005
<pre>
date 2005/12/05
</pre>
</li>
@@ -313,12 +327,12 @@
</p>
<ol>
<li>string (unicode) - examples: <tt>"hello"</tt> or <tt>`aloha`</tt>
</li>
-<li>character (unicode) - example: <tt>’/’</tt> Note: \uXXXX style
-unicode escapes are not supported (or needed because sdl files are UTF8)
+<li>character (unicode) - example: <tt>'/'</tt> Note: uXXXX style unicode
+escapes are not supported (or needed because sdl files are UTF8)
</li>
<li>integer (32 bits signed) - example: <tt>123</tt>
</li>
@@ -461,12 +475,12 @@
# To retrieve the values from the matrix (as a list of lists)
#
# List rows = tag.getChild("matrix").getChildrenValues("content");
</pre>
<p>
-Example of getting the "location" attribute from the
-"daughter" tag above (ignoring exceptions)
+Example of getting the “location” attribute from the
+“daughter” tag above (ignoring exceptions)
</p>
<pre>
root = SDL4R.read(Pathname.new("myfile.sdl"))
daughter = root.child("daughter", true) // recursive search
location = daughter.attribute("location")
@@ -541,11 +555,11 @@
$KCODE = 'u'
require 'jcode'
</pre>
<p>
This will give you correct input and output and correct UTF-8
-"general" sorting. Alternatively you can use the following
+“general” sorting. Alternatively you can use the following
options when launching the Ruby interpreter:
</p>
<pre>
/path/to/ruby -Ku -rjcode
</pre>
@@ -572,35 +586,30 @@
Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
</p>
</div>
-
</div>
</div>
-
<!-- if includes -->
<div id="section">
+ <!-- if method_list -->
-
- <!-- if method_list -->
-
</div>
-
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
-</html>
\ No newline at end of file
+</html>