ipuz Support in Sympathy

Sympathy Crossword Construction Home

ipuz is an open standard format for publishing and transferring puzzle information. This page describes how a crossword formatted as ipuz is imported into Sympathy Crossword Construction and how a Sympathy crossword is exported in the ipuz format.

The tables below must be read in conjunction with the ipuz Specification (a shadow copy of the master specification at ipuz.org). Our ipuz Test Example illustrates how the various crossword features supported by Sympathy are represented in the ipuz format.

ipuz is a trademark of Puzzazz, Inc., used with permission

Top Level Fields

Supported ipuz fields in the Common Puzzle Fields and Crossword Puzzles sections of the ipuz Specification mostly map onto equivalently named fields in the Field Properties Dialog:

ipuz Field	Notes
version	Maps to IpuzVersion in the Field Properties Dialog. If the field is absent, defaults to `"http://ipuz.org/v1"` when exporting.
kind	Maps to IpuzKind in the Field Properties Dialog. If the field is absent, defaults to `["http://ipuz.org/crossword#1"]` when exporting.
copyright	Maps to Copyright in the Field Properties Dialog.
publisher	Maps to Publisher in the Field Properties Dialog.
publication	Maps to Publication in the Field Properties Dialog.
url	Maps to URL in the Field Properties Dialog.
uniqueid	Maps to UniqueID in the Field Properties Dialog.
title	Maps to Title in the Field Properties Dialog.
intro	Maps to Intro in the Field Properties Dialog.
explanation	Maps to Explanation in the Field Properties Dialog.
annotation	Maps to Annotation in the Field Properties Dialog.
author	Maps to Author in the Field Properties Dialog.
editor	Maps to Editor in the Field Properties Dialog.
date	Maps to Date in the Field Properties Dialog.
notes	Maps to Notes in the Field Properties Dialog.
difficulty	Maps to Difficulty in the Field Properties Dialog.
origin	Set to `Sympathy Crossword Construction by Crossword Man` when exporting. Ignored when importing.
block	Always generated when exporting. Changed to `"-"` (or further possibilities) if `"#"` is not possible because it is used in an answer.
empty	Always generated when exporting. Changed to `"-"` (or further possibilities) if `"0"` is not possible because it is used to label a cell.
styles	Named styles are supported when importing, but not generated when exporting.
showenumerations	Always generated when exporting; set to `false` if Enumeration Style on the Grid Properties Enumerations Tab is set to No Enumerations Shown. Ignored when importing (enumerations are assigned for individual lights where present - see below).

Note that the <big>, ,  and  tags are not supported when importing HTML text fields.

Style Fields

Supported fields in the style for a cell mostly map onto settings in the Cell Properties Dialog:

ipuz Field	Notes
shapebg	Maps to the Marker setting on the Cell Properties Appearance Tab.
highlight	Not generated when exporting. When importing, cells with `"highlight": true` are given different Highlight color or Background color settings on the Cell Properties Appearance Tab.
mark	NE Number, SE Number and SW Number (see Cell Properties Numbering Tab) map to `TR`, `BL` and `BR` labels in the ipuz file when both exporting and importing. When importing, the `TL` label becomes the cell's number, if it doesn't have a ClueNum field in the ipuz file.
barred	Supported.
dotted	Map to the North edge (etc.) settings on the Cell Properties Appearance Tab. When exporting, a Sympathy edge with 1 to 5 dashes per cell becomes dashed in ipuz (6+ dashes per cell is considered dotted). When importing, a dotted edge in ipuz becomes an 8 dashes per cell edge in Sympathy; a dashed edge becomes a 3 dashes per cell edge.
dashed
color	Maps to the Highlight color and Background color settings on the Cell Properties Appearance Tab. When importing, if unique color values are used (rather than 6-digit hex values) these are mapped onto a palette of 14 standard Windows colors.
colortext	Maps to the Color for the Text font setting on the Cell Properties Appearance Tab.

Clue Fields

Supported fields for the clues mostly map onto settings on the Light Properties Text Tab:

ipuz Field	Notes
number	Supported; used to associate clue information with the appropriate Light when importing.
clue	Maps to the Clue setting on the Light Properties Text Tab.
answer	Maps to the Answer setting on the Light Properties Text Tab. When exporting, this field is only generated if Answer and grid entry are not linked is checked. When importing, if this field is present, Answer and grid entry are not linked is checked for the Light.
enumeration	Maps to the Enumeration setting on the Light Properties Text Tab. When exporting, this is output for every Light unless Enumeration Style on the Grid Properties Enumerations Tab is set to No Enumerations Shown. When importing, a customized Enumeration setting is generated for any clue where this field is present.

Note that the <big>, ,  and  tags are not supported when importing HTML text fields.