Skip to content

Commit 7fa0158

Browse files
delphidabblerdelphidabbler
committed
Formatting changes to database file format documentation
Two changes: replaced breaking hyphens with non-breaking hyphens where needed - and used new "value" CSS class to format some values
1 parent 62f4f0b commit 7fa0158

File tree

1 file changed

+15
-17
lines changed

1 file changed

+15
-17
lines changed

‎Docs/Design/FileFormats/database.html

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ <h2>
8080

8181
<p>
8282
These files are stored in binary format. Text included in within the binary
83-
data is stored in UTF-8 format.
83+
data is stored in UTF&#8209;8 format.
8484
</p>
8585

8686
<h2>
@@ -121,14 +121,14 @@ <h2>
121121
<kbd>SizedString</kbd>
122122
</dt>
123123
<dd>
124-
This is a variable length UTF-8 string that is preceded by its length as a
124+
This is a variable length UTF&#8209;8 string that is preceded by its length as a
125125
<kbd>Word</kbd>.
126126
</dd>
127127
<dt>
128128
<kbd>SizedLongString</kbd>
129129
</dt>
130130
<dd>
131-
This is a variable length UTF-8 string that is preceded by its length as a
131+
This is a variable length UTF&#8209;8 string that is preceded by its length as a
132132
<kbd>LongWord</kbd>.
133133
</dd>
134134
<dt>
@@ -143,7 +143,7 @@ <h2>
143143
<kbd>FixedString[<em>X</em>]</kbd>
144144
</dt>
145145
<dd>
146-
This is a chunk of UTF-8 text whose length is specified by
146+
This is a chunk of UTF&#8209;8 text whose length is specified by
147147
<kbd><em>X</em></kbd>.
148148
</dd>
149149
<dt>
@@ -159,10 +159,10 @@ <h2>
159159
<dd>
160160
This is a UTC date in <a
161161
href="http://www.cl.cam.ac.uk/~mgk25/iso-time.html"
162-
>ISO-8601 format</a> written as a <kbd>SizedString</kbd> value. The string
162+
>ISO&#8209;8601 format</a> written as a <kbd>SizedString</kbd> value. The string
163163
will always have the format
164-
<kbd>YYYY-MM-DD&quot;T&quot;HH:MM:SS.XXX&quot;Z&quot;</kbd> or
165-
<kbd>YYYY-MM-DD&quot;T&quot;HH:MM:SS,XXX&quot;Z&quot;</kbd>.
164+
<kbd>YYYY&#8209;MM&#8209;DD&quot;T&quot;HH:MM:SS.XXX&quot;Z&quot;</kbd> or
165+
<kbd>YYYY&#8209;MM&#8209;DD&quot;T&quot;HH:MM:SS,XXX&quot;Z&quot;</kbd>.
166166
</dd>
167167
</dl>
168168

@@ -185,16 +185,15 @@ <h3>
185185
</dt>
186186
<dd>
187187
Identifies the file as a master database file. The field always has the
188-
value &quot;<kbd>CSDB-MASTER-0562C0E6F20B4C2F945D1FDEC6393C4C</kbd>&quot;
189-
(without the quotes).
188+
value <kbd class="value">CSDB&#8209;MASTER&#8209;0562C0E6F20B4C2F945D1FDEC6393C4C</kbd>.
190189
</dd>
191190
<dt>
192191
<em>FileVersion</em> (<kbd>FixedString[4]</kbd>)
193192
</dt>
194193
<dd>
195194
The version of the database as a four character string of digits. At present
196195
only version 7 is supported and the field always has the value
197-
&quot;<kbd>0007</kbd>&quot; (without the quotes).
196+
<kbd class="value">0007</kbd>.
198197
</dd>
199198
<dt>
200199
<em>LastModificationDate</em> (<kbd>Date</kbd>)
@@ -244,7 +243,7 @@ <h3>
244243
<em>Reserved</em> (<kbd>LongWord</kbd>)
245244
</dt>
246245
<dd>
247-
A 32 bit field reserved for future use. Must be zero.
246+
A 32 bit field reserved for future use. Must be <kbd class="value">0</kbd>.
248247
</dd>
249248
</dl>
250249
</dd>
@@ -280,16 +279,15 @@ <h4>
280279
</dt>
281280
<dd>
282281
Identifies the file as a snippet file. The field always has the value
283-
&quot;<kbd>CSDB-SNIPPET-0562C0E6F20B4C2F945D1FDEC6393C4C</kbd>&quot;
284-
(without the quotes).
282+
<kbd class="value">CSDB&#8209;SNIPPET&#8209;0562C0E6F20B4C2F945D1FDEC6393C4C</kbd>.
285283
</dd>
286284
<dt>
287285
<em>FileVersion</em> (<kbd>FixedString[4]</kbd>)
288286
</dt>
289287
<dd>
290288
The version of the database as a four character string of digits. At
291289
present only version 7 is supported and the field always has the value
292-
&quot;<kbd>0007</kbd>&quot; (without the quotes).
290+
<kbd class="value">0007</kbd>.
293291
</dd>
294292
</dl>
295293

@@ -311,7 +309,7 @@ <h4>
311309
<em>PropertyID</em> (<kbd>Byte</kbd>)
312310
</dt>
313311
<dd>
314-
A unique code that identifies the property. Property IDs must be in the range <kbd>0x00..0xFE</kbd>. The special value <kbd>0xFF</kbd> is used to terminate the sequence of property records.
312+
A unique code that identifies the property. Property IDs must be in the range <kbd class="value">0x00</kbd>..<kbd class="value">0xFE</kbd>. The special value <kbd class="value">0xFF</kbd> is used to terminate the sequence of property records.
315313
</dd>
316314
<dt>
317315
<em>PropertyData</em> (type is property dependent)
@@ -452,7 +450,7 @@ <h4>
452450
</li>
453451
</ol>
454452
<div>
455-
This property is never written when origin source is <em>local</em>. <em>Default: local.</em>
453+
This property is never written when origin source is <kbd class="value">local</kbd>. <em>Default: <kbd class="value">local</kbd>.</em>
456454
</div>
457455
</dd>
458456
<dt>
@@ -467,7 +465,7 @@ <h4>
467465
</dt>
468466
<dd>
469467
A <kbd>Byte</kbd> representation of a Boolean value that determines if
470-
the snippet is starred. <em>Default: un-starred.</em>
468+
the snippet is starred. <em>Default: <kbd class="value">0</kbd> (i.e. <kbd class="value">False</kbd>).</em>
471469
</dd>
472470
<dt class='todo pullout'>
473471
TODO: Consider adding an <em>Origin property</em> to denote where snippet was obtained from. Replacement for the <em>LinkInfo</em> property? <em>Default: local.</em>

0 commit comments

Comments
 (0)