==========
 bogoYAML
==========

:Author:        Haruki Setoyama
:Contact:       haruki@planewave.org
:Date:          $Date: 2005/03/21 01:37:03 $
:Revision:      $Revision: 1.1 $


What's bogoYAML
===============

`YAML`_ is good, but it has too many features, at least for some simple use, 
like configration, etc. bogoYAML deliberately lacks some features:

- All scalars are treated as string.
- Only one indexed or associative array can exist per a line.
- "---" is always necessary. No strings except comments can be before "---". 
- There is no "...".
- There is no Numeric and Additional Escape code.
- There is no Block scalar indicator, Folded scalar indicator.
- There is no Transfer indicator.
- There is no Alias indicator.
- There is no Key indicator. 

.. _YAML: http://www.yaml.org/ 

This liblary is based on the java version of the original `bogoYAML` which 
was written by shinichiro.h. Poor quality in this liblary would be of course 
blamed for me, not for him. The PHP version may be or will be incompatible to 
the original. 

.. _bogoYAML: http://shinh.skr.jp/bogoyaml/index_en.html


Usage
=====

::

    require_once 'BogoYaml.php';
    $parser = new BogoYaml;
    $data = $parser->load($yaml_text);
    $yaml_dumped = $parser->dump($data);


License
=======

Copyright (c) 2005, Haruki SETOYAMA <haruki@planewave.org>
All rights reserved.

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions 
are met:

1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright 
   notice, this list of conditions and the following disclaimer in the 
   documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holders nor the names of its 
   contributors may be used to endorse or promote products derived from 
   this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.

