php-deluxe.net - description YAML

YAML

YAML is a .

= Features =

YAML was created with the belief that all data can be adequately represented by combinations of lists, hashes, and scalar data. The syntax is relatively straightforward and was designed with human readability in mind, but also to be easily mapped to data types common to most high-level languages:

YAML streams are encoded using the set of printable unicode characters, either in UTF-8 or UTF-16

Whitespace indenting is used to denote structure; hard tab characters are never allowed as indentation

List members are denoted by a leading hyphen (-) with one member per line, or as comma-separated values enclosed in brackets ([ & ])

Hashes are represented in the form key: value , either one per line or enclosed in curly braces ({ & }) and delimited by commas

Scalars are ordinarily unquoted, but may be double-quoted ( ), single-quoted ( ), or represented by an indented block with optional modifiers to preserve (|) or fold (>) newlines

Multiple documents within a single stream are separated by three hyphens (---); three periods (...) optionally end a document within a stream

Repeated nodes are initially denoted by an ampersand (&) and thereafter referenced with an asterisk (*)

Comments are denoted by the number sign (#) and continue until the end of the line

= Examples =

== Lists ==

--- # Favorite movies, block format - Casablanca - Spellbound - Notorious --- # Shopping list, inline format [milk, bread, eggs]

== Hashes ==

--- # Block name: John Smith age: 33 --- # Inline {name: John Smith, age: 33}

== Block Literals ==

=== Newlines preserved ===

--- | There was a young fellow of Warwick Who had reason for feeling euphoric For he could, by election Have triune erection Ionic, Corinthian, and Doric

=== Newlines folded ===

--- > Wrapped text will be folded into a single paragraph Blank lines denote paragraph breaks

== Lists of Hashes ==

- {name: John Smith, age: 33} - name: Mary Smith age: 27

== Hashes of Lists ==

men: [John Smith, Bill Jones] women: - Mary Smith - Susan Williams

=Implementations=

Bindings for YAML exist for the following languages: *JavaScript *Perl *PHP *Python_programming_language *Ruby programming language (uses YAML as the de facto serialization format; YAML included in standard library since 1.8.) *XML (currently draft only)

=Other simplified markup languages=

*Simple Outline XML *OGDL *BBCode *S-expressions

= External links =

[http://www.yaml.org YAML.ORG]

[http://www.yaml.org/spec/ YAML Specification]

[http://yaml4r.sourceforge.net/cookbook/ YAML Cookbook]

[http://yaml.kwiki.org/YamlInFiveMinutes YAML in Five Minutes]