IPUZ
Dan Tobias (Talk | contribs) |
(Category:JSON based file formats) |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 4: | Line 4: | ||
|extensions={{ext|ipuz}} | |extensions={{ext|ipuz}} | ||
}} | }} | ||
| − | ''' | + | '''ipuz''' is intended as an openly-documented format for data files of puzzles 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. It was created and released by the puzzle technology company [http://www.puzzazz.com Puzzazz], which was the first company to use it. |
| + | |||
| + | == Format == | ||
| + | |||
| + | ipuz data is expressed in [[JSON]] format. | ||
| + | |||
| + | == Identification == | ||
| + | |||
| + | ipuz files should specify the version within legal JSON. Expected values include: <code><nowiki>"version": "http://ipuz.org/v1"</nowiki></code> and <code><nowiki>"version": "http://ipuz.org/v2"</nowiki></code>. | ||
| + | |||
| + | == Puzzle types == | ||
| + | |||
| + | Although ipuz is not an [[XML]]-based format, its creators borrowed the "namespaces designated by [[URL|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: | ||
| + | |||
| + | * <code>http://ipuz.org/crossword</code> | ||
| + | * <code>http://ipuz.org/sudoku</code> | ||
| + | * <code>http://ipuz.org/fill</code> (grid puzzle to fill in) | ||
| + | * <code>http://ipuz.org/acrostic</code> | ||
| + | * <code>http://ipuz.org/block</code> (moving-block puzzle) | ||
| + | * <code>http://ipuz.org/answer</code> (question/answer quizzes) | ||
| + | * <code>http://ipuz.org/wordsearch</code> | ||
== Official spec == | == Official spec == | ||
| − | * [http://www.ipuz.org/ | + | * [http://www.ipuz.org/ ipuz spec] |
== Sample data == | == Sample data == | ||
| − | * [http://www.ipuz.org/example | + | * [http://www.ipuz.org/example ipuz example] |
== Software == | == Software == | ||
| − | * [http://sourceforge.net/projects/jpz2ipuz/ JPZ to | + | * [http://sourceforge.net/projects/jpz2ipuz/ JPZ to ipuz converter] |
== Other links == | == Other links == | ||
| − | * [http://www.crosswordman.com/ipuz/support.html | + | * [http://www.crosswordman.com/ipuz/support.html ipuz support in Sympathy] |
| + | * [http://www.crossword-compiler.com/WhatsNew.html ipuz support in Crossword Compiler] | ||
| + | |||
| + | [[Category:JSON based file formats]] | ||
Latest revision as of 16:11, 23 April 2017
ipuz is intended as an openly-documented format for data files of puzzles 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. It was created and released by the puzzle technology company Puzzazz, which was the first company to use it.
Contents |
[edit] Format
ipuz data is expressed in JSON format.
[edit] Identification
ipuz files should specify the version within legal JSON. Expected values include: "version": "http://ipuz.org/v1" and "version": "http://ipuz.org/v2".
[edit] 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
