Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 5a55965

Browse files
author
Hanno Klein
committed
Fixed typos and XML layout issues
1 parent 9958a9d commit 5a55965

File tree

6 files changed

+43
-63
lines changed

6 files changed

+43
-63
lines changed

‎v1-0-STANDARD/doc/02FieldEncoding.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -775,7 +775,7 @@ value, then the entire field is considered null.
775775
|----------------------------------|----------------|----------------:|-----------:|
776776
| Year | uint16 | 2 | 65535 |
777777
| Month (1-12) | uint8 | 1 | — |
778-
| Day of the month(1-31) optional | uint8 | 1 | 255 |
778+
| Day of the month(1-31) optional | uint8 | 1 | 255 |
779779
| Week of the month (1-5) optional | uint8 | 1 | 255 |
780780

781781

@@ -820,7 +820,7 @@ with time zone to be reported (see time zone encoding below).
820820

821821
### Epoch
822822

823-
Each time type has an epoch, or start of a time period to count values.
823+
Each time type has an epoch or start of a time period to count values.
824824
For timestamp and date, the standard epoch is the UNIX epoch, midnight
825825
January 1, 1970 UTC.
826826

@@ -1080,7 +1080,7 @@ In a message schema, the choices are specified a `<validValue>` members
10801080
of an `<enum>`. An `<enum>` specification must contain at least one
10811081
`<validValue>`.
10821082

1083-
The name and value of a validValue element must be unique within an
1083+
The name and value of a `<validValue>` element must be unique within an
10841084
enumeration.
10851085

10861086
An `<enum>` element must have an encodingType attribute to specify the
@@ -1204,7 +1204,7 @@ unsigned primitive type should be selected that can contain the number
12041204
of valid choices.
12051205

12061206
| Primitive type | Description | Length (octets) | Maximum number of choices |
1207-
|----------------|-------------------------|----------------:|--------------------------:|
1207+
|----------------|-------------------------|:---------------:|:-------------------------:|
12081208
| uint8 | 8-bit unsigned integer | 1 | 8 |
12091209
| uint16 | 16-bit unsigned integer | 2 | 16 |
12101210
| uint32 | 32-bit unsigned integer | 4 | 32 |
@@ -1227,21 +1227,21 @@ than to set all bits off when no choices are selected.
12271227
### Encoding specification of multi-value choice
12281228

12291229
In a message schema, the choices are specified as `<choice>` members of
1230-
an `<set>` element. Choices are assigned values as an ordinal of bits in
1230+
a `<set>` element. Choices are assigned values as an ordinal of bits in
12311231
the bit set. The first Choice "0" is assigned the least significant bit;
12321232
choice "1" is the second bit, and so forth.
12331233

12341234
The name and value (bit position) must be unique for element of a set.
12351235

12361236
A `<set>` element must have an encodingType attribute to specify the
1237-
wire format of its values. Two formats of encodingType are recognized:
1237+
wire format of its values. Two formats of encodingType are recognized:
12381238

12391239
- In-line style: the value of encodingType is its primitive datatype.
12401240

12411241
- Reference style: the value of encodingType is the name of a `<type>`
12421242
element that specifies the wire format.
12431243

1244-
The length of a `<type>` associated to an bitset must be 1. That is,
1244+
The length of a `<type>` associated to a bitset must be 1. That is,
12451245
bitsets should not be specified as arrays.
12461246

12471247
### Multi-value example

‎v1-0-STANDARD/doc/03MessageStructure.md‎

Lines changed: 14 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Recommended message header encoding
9393
<type name="templateId" primitiveType="uint16"/>
9494
<type name="schemaId" primitiveType="uint16"/>
9595
<type name="version" primitiveType="uint16"/>
96-
<type name="numGroups" primitiveType="uint16" />
96+
<type name="numGroups" primitiveType="uint16" />
9797
<type name="numVarDataFields" primitiveType="uint16" />
9898
</composite>
9999
```
@@ -190,11 +190,9 @@ sum of the sizes of prior fields, as they are defined by the message
190190
schema.
191191

192192
```xml
193-
<field name="ClOrdID" id="11" type="string14"
194-
semanticType="String"/>
193+
<field name="ClOrdID" id="11" type="string14" semanticType="String"/>
195194
<field name="Side" id="54" type="char" semanticType="char"/>
196-
<field name="OrderQty" id="38" type="intQty32"
197-
semanticType="Qty"/>
195+
<field name="OrderQty" id="38" type="intQty32" semanticType="Qty"/>
198196
<field name="Symbol" id="55" type="string8" semanticType="String"/>
199197
```
200198

@@ -223,18 +221,14 @@ business data. They should be filled with binary zeros.
223221
Example of fields with specified offsets
224222

225223
```xml
226-
<field name="ClOrdID" id="11" type="string14" offset="0"
227-
semanticType="String"/>
228-
<field name="Side" id="54" type="char" offset="14"
229-
semanticType="char"/>
230-
<field name="OrderQty" id="38" type="intQty32" offset="16"
231-
semanticType="Qty"/>
232-
<field name="Symbol" id="55" type="string8" offset="20"
233-
semanticType="String"/>
224+
<field name="ClOrdID" id="11" type="string14" offset="0" semanticType="String"/>
225+
<field name="Side" id="54" type="char" offset="14" semanticType="char"/>
226+
<field name="OrderQty" id="38" type="intQty32" offset="16" semanticType="Qty"/>
227+
<field name="Symbol" id="55" type="string8" offset="20" semanticType="String"/>
234228
```
235229

236230
| Field | Size | Padding preceding field | Offset |
237-
|----------|------|------------------------:|-------:|
231+
|----------|:-----|:-----------------------:|:------:|
238232
| ClOrdID | 14 | 0 | 0 |
239233
| Side | 1 | 0 | 14 |
240234
| OrderQty | 4 | 1 | 16 |
@@ -258,7 +252,7 @@ Extra octets specified for padding should be filled with binary zeros.
258252
Example of blockLength specification for 24 octets
259253

260254
```xml
261-
<message name="ListOrder" id="2" blockLength="24">
255+
<message name="ListOrder" id="2" blockLength="24"/>
262256
```
263257

264258
## Repeating Groups
@@ -271,7 +265,7 @@ group. That is, the entries are homogeneous. Position of a given
271265
field within any entry is fixed, with the exception of variable-length
272266
fields.
273267

274-
A message may have no groups or an unlimited number of repeating groups
268+
A message may have no groups, or an unlimited number of repeating groups
275269
specified in its schema.
276270

277271
### Schema specification of a group
@@ -284,10 +278,8 @@ Example repeating group encoding specification
284278

285279
```xml
286280
<group name="Parties" id="1012" blockLength="16">
287-
<field name="PartyID" id="448" type="string14"
288-
semanticType="String"/>
289-
<field name="PartyIDSource" id="447" type="char"
290-
semanticType="char"/>
281+
<field name="PartyID" id="448" type="string14" semanticType="String"/>
282+
<field name="PartyIDSource" id="447" type="char" semanticType="char"/>
291283
<field name="PartyRole" id="452" type="uint8" semanticType="int"/>
292284
</group>
293285
```
@@ -406,7 +398,7 @@ unsigned integer types.
406398
By default, the minimum number of entries is zero, and the maximum number is the largest value of the primitiveType of the counter.
407399

408400
| Primitive type | Description | Length (octets) | Maximum number of entries |
409-
|----------------|-------------------------|----------------:|--------------------------:|
401+
|----------------|-------------------------|:---------------:|--------------------------:|
410402
| uint8 | 8-bit unsigned integer | 1 | 255 |
411403
| uint16 | 16-bit unsigned integer | 2 | 65535 |
412404

@@ -476,7 +468,7 @@ specified with this sequence of message body elements:
476468

477469
1. Fixed-length fields that reside at the root level of the message
478470
(that is, not members of repeating groups), including any of the
479-
following, in the order specified by the message schema::
471+
following, in the order specified by the message schema:
480472

481473
a. Fixed-length scalar fields, such as integers
482474

‎v1-0-STANDARD/doc/04MessageSchema.md‎

Lines changed: 14 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Conventionally, the URI of the XML schema is aliased by the prefix
1919
*Caution:* Users should treat the SBE XML namespace as a URI (unique identifier),
2020
not as a URL (physical resource locator). Firms should not depend on
2121
access to the FIX Trading Community web site to validate XML schemas at
22-
run-time
22+
run-time.
2323

2424
## Name convention
2525

@@ -154,13 +154,9 @@ but if it is, the two values must match.
154154
Simple type examples
155155

156156
```xml
157-
<type name="FLOAT" primitiveType="double"
158-
semanticType="float"/>
159-
<type name="TIMESTAMP" primitiveType="uint64"
160-
semanticType="UTCTimestamp"/>
161-
<type name="GeneralIdentifier" primitiveType="char"
162-
description="Identifies class or source
163-
of the PartyID" presence="constant">C</type>
157+
<type name="FLOAT" primitiveType="double" semanticType="float"/>
158+
<type name="TIMESTAMP" primitiveType="uint64" semanticType="UTCTimestamp"/>
159+
<type name="GeneralIdentifier" primitiveType="char" description="Identifies class or source of the PartyID" presence="constant">C</type>
164160
```
165161

166162
### Composite encodings
@@ -194,8 +190,7 @@ constant exponent, which is not sent on the wire.
194190
```xml
195191
<composite name="decimal32" semanticType="Price">
196192
<type name="mantissa" primitiveType="int32" />
197-
<type name="exponent" primitiveType="int8"
198-
presence="constant">-4</type>
193+
<type name="exponent" primitiveType="int8" presence="constant">-4</type>
199194
</composite>
200195
```
201196

@@ -251,7 +246,7 @@ In this example, a futuresPrice is encoded as 64-bit integer mantissa, 8-bit ex
251246

252247
**Reference to a composite type**
253248

254-
In this example, a nested composite is formed by using a reference to another composite type. It supports the expresson of a monetary amount with its currency, such as USD150.45. Note that a reference may carry an offset within the composite encoding that contains it.
249+
In this example, a nested composite is formed by using a reference to another composite type. It supports the expression of a monetary amount with its currency, such as USD 150.45. Note that a reference may carry an offset within the composite encoding that contains it.
255250

256251
```xml
257252
<composite name="price">
@@ -419,13 +414,13 @@ that they are encoded on the wire.
419414
| id | Unique message template identifier | unsignedInt | required | Must be unique within a schema |
420415
| description | Documentation | string | optional | |
421416
| blockLength | Reserved size in number of octets for root level of message body | unsignedInt | optional | If specified, must be greater than or equal to the sum of field lengths. |
422-
| semanticType | Documents value of FIX MsgTypefor a message | token | optional | Listed in FIX specifications |
417+
| semanticType | Documents value of FIX MsgType(35) field for a message | token | optional | Listed in FIX specifications |
423418
| sinceVersion | Documents the version of a schema in which a message was added | nonNegativeInteger | default = 0 | |
424419
| deprecated | Documents the version of a schema in which a message was deprecated. It should no longer be sent but is documented for back-compatibility. | nonnegativeInteger | optional | Must be less than or equal to the version of the message schema. |
425420

426421
Note that there need not be a one-to-one relationship between message
427422
template (identified by `id` attribute) and `semanticType` attribute. You
428-
might design multiple templates for the same FIX MsgType to optimize
423+
might design multiple templates for the same FIX MsgType(35) value to optimize
429424
different scenarios.
430425

431426
Example `<message>` element
@@ -444,7 +439,7 @@ These are the common attributes of all field types.
444439
| Schema attribute | Description | XML type | Usage | Valid values |
445440
|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|------------------------------------|-------------------------------------------------------------------------------------------------------|
446441
| name | Name of a field | symbolicName\_t | required | Name and id must uniquely identify a field type within a message schema. |
447-
| id | Unique field identifier (FIX tag) | unsignedShort | required | |
442+
| id | Unique field identifier (FIX tag number) | unsignedShort | required | |
448443
| description | Documentation | string | optional | |
449444
| type | Encoding type name, one of simple type, composite type or enumeration. | string | required | Must match the name attribute of a simple `<type>`, `<composite>` encoding type, `<enum>` or `<set>`. |
450445
| offset | Offset to the start of the field within a message or repeating group entry. By default, the offset is the sum of preceding field sizes, but it may be increased to effect byte alignment. | unsignedInt | optional | Must be greater than or equal to the sum of preceding field sizes. |
@@ -461,12 +456,10 @@ Field that uses a composite encoding
461456
```xml
462457
<composite name="intQty32" semanticType="Qty">
463458
<type name="mantissa" primitiveType="int32" />
464-
<type name="exponent" primitiveType="int8"
465-
presence="constant">0\</type>
459+
<type name="exponent" primitiveType="int8" presence="constant">0\</type>
466460
</composite>
467461

468-
<field type="intQty32" name="OrderQty" id="38" offset="16"
469-
description="Shares: Total number of shares" />
462+
<field type="intQty32" name="OrderQty" id="38" offset="16" description="Shares: Total number of shares" />
470463
```
471464

472465
## Repeating group schema
@@ -499,8 +492,7 @@ The number of members of each type is unbound.
499492
```xml
500493
<composite name="groupSizeEncoding">
501494
<type name="blockLength" primitiveType="uint16"/>
502-
<type name="numInGroup" primitiveType="uint16"
503-
semanticType="NumInGroup"/>
495+
<type name="numInGroup" primitiveType="uint16" semanticType="NumInGroup"/>
504496
</composite>
505497

506498
<group name="Parties" id="1012" >
@@ -536,8 +528,7 @@ following.
536528
### Message with a repeating group
537529

538530
```xml
539-
<message name="ListOrder" id="2" description="Simplified
540-
NewOrderList. Demonstrates repeating group">
531+
<message name="ListOrder" id="2" description="Simplified NewOrderList. Demonstrates repeating group">
541532
<field name="ListID" id="66" type="string14" semanticType="String"/>
542533
<field name="BidType" id="394" type="uint8" semanticType="int"/>
543534
<group name="ListOrdGrp" id="2030" >
@@ -559,8 +550,7 @@ following.
559550
<field name="UserName" id="553" type="string14" semanticType="String"/>
560551
<field name="Password" id="554" type="string14" semanticType="String"/>
561552
<field name="NewPassword" id="925" type="string14" semanticType="String"/>
562-
<field name="EncryptedPasswordMethod" id="1400" type="uint8" description="This should be an enum but values undefined."
563-
semanticType="int"/>
553+
<field name="EncryptedPasswordMethod" id="1400" type="uint8" description="This should be an enum but values undefined." semanticType="int"/>
564554
<field name="EncryptedPasswordLen" id="1401" type="uint8" semanticType="Length"/>
565555
<field name="EncryptedNewPasswordLen" id="1403" type="uint8" semanticType="Length"/>
566556
<field name="RawDataLength" id="95" type="uint8" semanticType="Length"/>

‎v1-0-STANDARD/doc/05SchemaExtensionMechanism.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ If the *received version is greater than the decoder's version* (that is, the pr
114114

115115
Also, an old decoder may encounter unexpected enumeration values. The application layer determines whether an unexpected value is a fatal error. Probably so for a required field since the business meaning is unknown, but it may choose to allow an unknown value of an optional field to pass through. For example, if OrdType(40)=J (Market If Touched (MIT)) is added to a schema, and the consumer does not recognize it, then the application returns an order rejection with reason "order type not supported", even if it does not know what "J" represents. Note that this is not strictly a versioning problem, however. This exception handling is indistinguishable from the case where "J" was never added to the enum but was simply sent in error.
116116

117-
If the *received version is less than the decoder's version* (that is, the producer's encoder is older than the consumer's decoder), then only the fields of the older version may be parsed. This information is available through metadata as "sinceVersion" attribute of a field. If sinceVersion is greater than received schema version, then the field is not available. How a decoder signals an application that a field is unavailable is an implementation detail. One strategy is for an application to provide a default value for unavailable fields.
117+
If the *received version is less than the decoder's version* (that is, the producer's encoder is older than the consumer's decoder), then only the fields of the older version may be parsed. This information is available through metadata as sinceVersion attribute of a field. If sinceVersion is greater than received schema version, then the field is not available. How a decoder signals an application that a field is unavailable is an implementation detail. One strategy is for an application to provide a default value for unavailable fields.
118118

119119
## Message schema extension example
120120

‎v1-0-STANDARD/doc/06UsageGuidelines.md‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,19 @@ a certain size.
88

99
Optionally, a message schema may restrict such identifiers to numeric
1010
encodings.
11-
12-
Example of an identifier field with character encoding
11+
\
12+
**Example of an identifier field with character encoding**
1313

1414
```xml
1515
<type name="idString" primitiveType="char" length="16" />
1616

17-
<field name="QuoteReqId" id="131" type="idString"
18-
semanticType="String"/>
17+
<field name="QuoteReqId" id="131" type="idString" semanticType="String"/>
1918
```
20-
21-
Example of an identifier field with numeric encoding
19+
\
20+
**Example of an identifier field with numeric encoding**
2221

2322
```xml
2423
<type name="uint64" primitiveType="uint64" />
2524

26-
<field name="QuoteReqId" id="131" type="uint64"
27-
semanticType="String"/>
25+
<field name="QuoteReqId" id="131" type="uint64" semanticType="String"/>
2826
```

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /