The Protocol Syntax
Following is the syntax for the
arbortext-editor protocol presented in the RFC format defined in
RFC 4395 by the
Internet Assigned Numbers Authority (IANA):
arbortexturi = scheme ":" resource [ "?" query] [ "#" anchor]
scheme = "arbortext-editor" | "arbortext-editor-embed"
query = query-pair *["&" query-pair]
query-pair = key "=" value
resource = utf8 url encoded resource
key = utf8 url encoded query component
value = utf8 url encoded query component
anchor = utf8 url encoded resource
In the syntax, resource must be the encoded full path to a document that can be opened with Arbortext Editor.
utf8 url encoded resource refers to the standard rules for encoding a resource referenced from a URI. The following rules apply in this case:
• The alphanumeric characters "a" through "z", "A" through "Z" and "0" through "9" remain the same.
• The special characters " . ", " - ", " * " and " _ " remain the same.
• The space character is converted into "%20".
• All other characters are first converted into one or more bytes using UTF-8, and then each byte is represented by the character string "%xy", where xy is the two-digit hexadecimal representation of the byte.
For example, the string The string ü@foo-bar would get converted to The%20string%20%C3%BC%40foo-bar, because in UTF-8 the character ü is encoded as two bytes C3 (hex) and BC (hex), and the character @ is encoded as %40 and spaces are encoded as %20.
utf8 url encoded query component refers to the optional query string, which must be encoded according to the
application/x-www-form-urlencoded mime type (defined in the W3C
HTML 4.01 Specification). The basic encoding rules are the same in this case, but space characters are represented by a plus sign ( + ).
Following are some examples of legal uses of the protocol:
|
arbortext-editor:http%3A%2F%2Fserver%2Fpath%2Ffile.xml
|
|
Protocol
|
arbortext-editor
|
|
Unencoded Resource
|
http://server/path/file.xml
|
|
arbortext-editor:c%3A%5Ctemp%20dir%5Cfile%CE%A8.xml?name=Robert+Smith#Terrier
|
|
Protocol
|
arbortext-editor
|
|
Unencoded Resource
|
c:\temp dir\fileΨ.xml
|
|
Unencoded Query Name
|
name
|
|
Unencoded Query Value
|
Robert Smith
|
|
Anchor
|
Terrier
|