Allowed Key Name Characters Test

Overview

This test exercises the way that tools interpret the DITA 1.2 (and 1.3) rule for key names, which says simply "characters allowed in URIs". That turns out to be a fairly fuzzy definition that is open to a lot of interpretation.

Expected Results

The following table contains references to keys using different characters and indicates how they should be handled.

Table 1. Key Name Tests
Test Description	Key Reference
Key with only alphabetic characters, dash, and dot. Should always work.	"Alpha only with dash ("-") and dot (".")"
Key containing a "[" (left square bracket). This character is explicitly disallowed by the DITA spec.	"Key with left square bracket (should not work)"
Key containing characters way outside the ASCII range ("寺田寅彦-空想日録") Whether this is allowed or not depends on how you interpret "allowed in URIs".	"Key with Japanese characters: "寺田寅彦-空想日録""

Relevant Specification Language

See http://docs.oasis-open.org/dita/dita/v1.3/os/part1-base/langRef/attributes/thekeysattribute.html#thekeysattribute

Test Results

Describe the results of running the tests with different processors. Include the processor version and option details so that others can reproduce your tests.

Table 2. Test Results
Processor	Test Result	Notes
DITA Open Toolkit 2.2.3	Accepts the alpha-only key. Correctly reports the key containing "[" as invalid. Reports the Japanese key as invalid.	This behavior reflects the most conservative interpretation of the DITA specification language. Even though the OT reports the keys as invalid, it still resolves them all.
DITA Open Toolkit 1.8.5	Accepts the alpha-only key. Correctly reports the key containing "[" as invalid. Reports the Japanese key as invalid.	This behavior reflects the most conservative interpretation of the DITA specification language. Even though the OT reports the keys as invalid, it still resolves them all.
oXygenXML Editor 18 beta	Accepts the alpha-only key. Correctly reports the key containing "[" as invalid. Accepts the Japanese key.	Map validator does not report the bad key but the main editor validator does.
XMetaL 11	Resolves the alpha-only and Japanese keys in the main editor view. Does not resolve the invalid key. The key space manager flags the bad key as invalid and reports the issue in the Key Space Manager log.
FrameMaker 13	Accepts all keys in the UI, does not report any keys as being invalid.
ditac 2.5.x	Not tested
DFST Link Manager 0.9.x	Not tested