IPUZ
Dan Tobias (Talk | contribs) |
Dan Tobias (Talk | contribs) |
||
| Line 5: | Line 5: | ||
}} | }} | ||
'''IPUZ''' is intended as an openly-documented format for data files of puzzle games such as crosswords and sudoku. In contrast to "proprietary" formats such as [[PUZ (crossword puzzles)|PUZ]], there is an official spec available freely and released under a Creative Commons license ([http://creativecommons.org/licenses/by-nd/3.0/ BY-ND 3.0]), instead of the format having to be discovered by reverse engineering subject to possible hassles by intellectual-property owners. | '''IPUZ''' is intended as an openly-documented format for data files of puzzle games such as crosswords and sudoku. In contrast to "proprietary" formats such as [[PUZ (crossword puzzles)|PUZ]], there is an official spec available freely and released under a Creative Commons license ([http://creativecommons.org/licenses/by-nd/3.0/ BY-ND 3.0]), instead of the format having to be discovered by reverse engineering subject to possible hassles by intellectual-property owners. | ||
| + | |||
| + | == Format == | ||
| + | |||
| + | IPUZ data is expressed in [[JSON]] form, preferably in the JSONP variant in which the JSON data is surrounded by code to make it valid JavaScript, in this case a <code>ipuz()</code> function call. | ||
| + | |||
| + | == Identification == | ||
| + | |||
| + | IPUZ version 1 files contain the text line <code>"version": "http://ipuz.org/v1",</code> (perhaps with whitespace padding). | ||
== Puzzle types == | == Puzzle types == | ||
Revision as of 14:53, 16 February 2014
IPUZ is intended as an openly-documented format for data files of puzzle games such as crosswords and sudoku. In contrast to "proprietary" formats such as PUZ, there is an official spec available freely and released under a Creative Commons license (BY-ND 3.0), instead of the format having to be discovered by reverse engineering subject to possible hassles by intellectual-property owners.
Contents |
Format
IPUZ data is expressed in JSON form, preferably in the JSONP variant in which the JSON data is surrounded by code to make it valid JavaScript, in this case a ipuz() function call.
Identification
IPUZ version 1 files contain the text line "version": "http://ipuz.org/v1", (perhaps with whitespace padding).
Puzzle types
Although IPUZ is not an XML-based format, its creators borrowed the "namespaces designated by URIs" concept for identifying subtypes of the format for different sorts of puzzles. Several puzzle types, with associated URIs in ipuz.org, are defined in the spec, and others may define puzzle types of their own and assign them identifying URIs within their own websites. The spec requires that anybody defining a puzzle type and assigning it a URL actually own the site within which that URL resides, but doesn't mandate that it actually resolve to anything useful; however, it is suggested that it lead to a description of the puzzle format in question. The URIs referenced in the original spec all seem to redirect to the spec document itself, rather than any more specific part of it related to a particular puzzle type.
The types defined in the spec are:
-
http://ipuz.org/crossword -
http://ipuz.org/sudoku -
http://ipuz.org/fill(grid puzzle to fill in) -
http://ipuz.org/acrostic -
http://ipuz.org/block(moving-block puzzle) -
http://ipuz.org/answer(question/answer quizzes) -
http://ipuz.org/wordsearch
