Debian Codegraph @

format_docs/pdb/plucker.html

raw
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <HTML>
3 <HEAD>
4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5 <TITLE>The Plucker Document Format</TITLE>
6 </HEAD>
7 <BODY>
8 <H1>The Plucker Document Format</H1>
9
10 <H2>Introduction</H2>
11
12 <p>
13 This document is the official description of the
14 <a href="http://www.plkr.org/">Plucker</a> format.</p>
15
16 <HR><H2>Overview</H2>
17 <p>
18 The Plucker document format supports a multi-page (in the Web sense of 'page') hyperlinked information structure containing both 'rich' text and images. Links may be internal to the document or link to other documents. External links, in standard URL form, may be included and displayed, but not followed. Images may either be embedded in a text page, as with HTML, or be included as separate stand-alone pages.</p>
19 <p>
20 Plucker documents are structured so that they can be used both with a file-system-oriented operating system such as Unix or Windows, and with the PalmOS, a non-file-system-oriented OS. To this end, they always begin with a standard PalmOS record database prefix, which consists of four parts: the <i><A HREF="#database_header">database header</a></i>, a <i><a href="#record_id_list">record-id list</a></i>, an <i><a href="#appinfo_block">AppInfo block</a></i>, and a <i>SortInfo block</i>. The Plucker format does not use the SortInfo block, which is therefore null, and consequently occupies no space in the document prefix.</p>
21 <p>
22 The record database prefix is then followed by a sequence of application-specific records. In a Plucker document, this sequence consists of one <a href="#index_record">index record</a>, followed by a series of <a href="#data_records">data records</a>. The index record contains information about the data records, along with some global information, such as the type of compression used. Each data record contains either a page, an image, or data about the document, such as bookmarks or URL data.</p>
23 <p>
24 The format is big-endian; any multi-byte numeric values specified in this document are big-endian. Images are stored in the Palm image format; for more information on this format please consult <A HREF="http://www.palmos.com/dev/tech/docs">http://www.palmos.com/dev/tech/docs/</A>.</p>
25 <HR><H2>The Database Prefix</H2>
26
27 <H3><a name="database_header">The Database Header</a></H3>
28 <p>
29 The database header is a fixed-size structure of 72 bytes. It contains the name of the database, the Plucker version number, various timestamps (creation, modification, last backup), and several flags. All timestamps are given using the PalmOS standard, seconds since 12:00 AM on January 1, 1904.</p>
30 <p>
31 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
32
33 <tr BGCOLOR="#99CCCC">
34 <td><b><font color="#000000">Field</font></b></td>
35 <td align="center"><b><font color="#000000">Bytes</font></b></td>
36 <td><b><font color="#000000">Type</font></b></td>
37 <td><b><font color="#000000">Notes</font></b></td>
38 </tr>
39
40 <tr>
41 <td><b>docName</b></td>
42 <td align="center">32</td>
43 <td>String</td>
44 <td>Must contain a NUL-terminated 7-bit ASCII string (only character codes 0x20-0x7E are valid) giving the name of the document. Because of the terminating NUL character at end, only 31 bytes can actually be used for the name of the document. The first 26 bytes of this string are used by Plucker as a unique ID for the document; names should be unique in the first 26 characters.</td>
45 </tr>
46
47 <tr>
48 <td><b>flags</b></td>
49 <td align="center">2</td>
50 <td>Bitfield</td>
51 <td>Most bits in this field are unused. Unused bits should be set to zero on document creation, but reader software should not expect them to stay at this value.
52
53 <p>Valid bits are as follows. All numeric values given are big-endian.</p>
54 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="100%" >
55 <tr BGCOLOR="#BBDDDD">
56 <td><b><font color="#000000">Name</font></b></td>
57 <td><b><font color="#000000">Value</font></b></td>
58 <td><b><font color="#000000">Meaning</font></b></td>
59 </tr>
60
61 <tr>
62 <td>CopyPrevention</td>
63 <td>0x0040</td>
64 <td>Indicates that system should not allow copying of this document.</td>
65 </tr>
66
67 <tr>
68 <td>Launchable</td>
69 <td>0x0200</td>
70 <td>Indicates that this document should be presented as a first-class object on desktop renderings. If this bit is set, an AppInfo block must be included.</td>
71 </tr>
72
73 <tr>
74 <td>Backup</td>
75 <td>0x0008</td>
76 <td>Indicates that this document should be backed up, if the system includes such a capability.</td>
77 </tr>
78
79 </table>
80 </td>
81 </tr>
82
83 <tr>
84 <td><b>version</b></td>
85 <td align="center">2</td>
86 <td>Numeric</td>
87 <td>Version of the Plucker format used in this document. Must have the value 1.</td>
88 </tr>
89
90 <tr>
91 <td><b>creationDate</b></td>
92 <td align="center">4</td>
93 <td>Timestamp</td>
94 <td>Time of document creation</td>
95 </tr>
96
97 <tr>
98 <td><b>modificationDate</b></td>
99 <td align="center">4</td>
100 <td>Timestamp</td>
101 <td>Time document last modified</td>
102 </tr>
103
104 <tr>
105 <td><b>unused1</b></td>
106 <td align="center">8</td>
107 <td>Numeric</td>
108 <td>Must be zero at document creation, but any specific value should not be relied upon.</td>
109 </tr>
110
111 <tr>
112 <td><b>appInfoOffset</b></td>
113 <td align="center">4</td>
114 <td>Numeric</td>
115 <td>Either zero, if no appInfo is present, or the offset from the beginning of the document to the start of the appInfo block.
116 </tr>
117
118 <tr>
119 <td><b>sortInfoId</b></td>
120 <td align="center">4</td>
121 <td>Numeric</td>
122 <td>Must be zero.</td>
123 </tr>
124
125 <tr>
126 <td><b>magic</b></td>
127 <td align="center">8</td>
128 <td>String</td>
129 <td>Must be the 8 ISO Latin-1 characters "DataPlkr". No terminating NUL character.</td>
130 </tr>
131
132 <tr>
133 <td><b>unused2</b></td>
134 <td align="center">4</td>
135 <td>Numeric</td>
136 <td>Must be zero at document creation, but any specific value should not be relied upon.</td>
137 </tr>
138
139 </table>
140
141 <H3><a name="record_id_list">The Record-ID List</a></H3>
142 <p>
143 This list consists of a six-byte list header, followed by one ID entry for each data record in the document. The list header has the structure:</p>
144 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
145 <tr BGCOLOR="#99CCCC">
146 <td><b><font color="#000000">Field</font></b></td>
147 <td align="center"><b><font color="#000000">Bytes</font></b></td>
148 <td><b><font color="#000000">Type</font></b></td>
149 <td><b><font color="#000000">Notes</font></b></td>
150 </tr>
151
152 <tr>
153 <td><b>nextRecordListID</b></td>
154 <td align="center">4</td>
155 <td>Numeric</td>
156 <td>Must be zero.</td>
157 </tr>
158
159 <tr>
160 <td><b>numRecords</b></td>
161 <td align="center">2</td>
162 <td>Numeric</td>
163 <td>Number of records in the document, including the index record.</td>
164 </tr>
165 </table>
166
167 <p>This is then followed by <b>numRecords</b> entries of the following structure:</p>
168 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
169 <tr BGCOLOR="#99CCCC">
170 <td><b><font color="#000000">Field</font></b></td>
171 <td align="center"><b><font color="#000000">Bytes</font></b></td>
172 <td><b><font color="#000000">Type</font></b></td>
173 <td><b><font color="#000000">Notes</font></b></td>
174 </tr>
175
176 <tr>
177 <td><b>recordOffset</b></td>
178 <td align="center">4</td>
179 <td>Numeric</td>
180 <td>Number of bytes from the start of the document to the beginning of the record</td>
181 </tr>
182
183 <tr>
184 <td><b>attributes</b></td>
185 <td align="center">1</td>
186 <td>Bitfield</td>
187 <td>Record attributes -- should be zero.</td>
188 </tr>
189
190 <tr>
191 <td><b>uniqueID</b></td>
192 <td align="center">3</td>
193 <td>Numeric</td>
194 <td>A local (document-specific) unique ID for the record. This is not used by Plucker (because it is not preserved by PalmOS through beaming of a document), but must still be different for each record.</td>
195 </tr>
196 </table>
197
198 <p>
199 Finally, there are two bytes of zero-padding to bring the structure alignment back to 4 bytes.</p>
200
201 <H3><a name="appinfo_block">The AppInfo Block</a></H3>
202 <p>
203 Typically, this is only present when the <i>launchable</i> flag is set in the flags field of the database header. No Plucker data aside from icon display information and a versioning string is stored in this block. This block has the following structure:</p>
204 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
205 <tr BGCOLOR="#99CCCC">
206 <td><b><font color="#000000">Field</font></b></td>
207 <td align="center"><b><font color="#000000">Bytes</font></b></td>
208 <td><b><font color="#000000">Type</font></b></td>
209 <td><b><font color="#000000">Notes</font></b></td>
210 </tr>
211
212 <tr>
213 <td><b>signature</b></td>
214 <td align="center">4</td>
215 <td>Numeric</td>
216 <td>Must contain the value 0x6C6E6368.</td>
217 </tr>
218
219 <tr>
220 <td><b>hdrVersion</b></td>
221 <td align="center">2</td>
222 <td>Numeric</td>
223 <td>Must have the value 3.</td>
224 </tr>
225
226 <tr>
227 <td><b>hdrEncoding</b></td>
228 <td align="center">2</td>
229 <td>Numeric</td>
230 <td>Must have the value 0.</td>
231 </tr>
232
233 <tr>
234 <td><b>verStrWords</b></td>
235 <td align="center">2</td>
236 <td>Numeric</td>
237 <td>The number of two-byte words following, containing the version string.</td>
238 </tr>
239
240 <tr>
241 <td><b>verStr</b></td>
242 <td align="center">2 * <b>verStrWords</b></td>
243 <td>String</td>
244 <td>NUL-terminated ISO Latin-1 string, padded at end if necessary with a zero byte to an even-byte boundary, containing a version string to display to the user containing version information for the document.</td>
245 </tr>
246
247 <tr>
248 <td><b>pqaTitleWords</b></td>
249 <td align="center">2</td>
250 <td>Numeric</td>
251 <td>The number of two-byte words in the following <b>pqaTitleStr</b>.</td>
252 </tr>
253
254 <tr>
255 <td><b>pqaTitleStr</b></td>
256 <td align="center">2 * <b>pqaTitleWords</b></td>
257 <td>String</td>
258 <td>NUL-terminated ISO Latin-1 string, padded at end if necessary with a zero byte to an even-byte boundary, containing a title string for iconic display of the document.</td>
259 </tr>
260
261 <tr>
262 <td><b>iconWords</b></td>
263 <td align="center">2</td>
264 <td>Numeric</td>
265 <td>Number of two-byte words in the following icon image.</td>
266 </tr>
267
268 <tr>
269 <td><b>icon</b></td>
270 <td align="center">2 * <b>iconWords</b></td>
271 <td>Image</td>
272 <td>Image (32x32) in Palm image format to be used as an icon to represent the document on a desktop-style display. The image may not use a custom color map.</td>
273 </tr>
274
275 <tr>
276 <td><b>smIconWords</b></td>
277 <td align="center">2</td>
278 <td>Numeric</td>
279 <td>Number of two-byte words in the following icon image.</td>
280 </tr>
281
282 <tr>
283 <td><b>smIcon</b></td>
284 <td align="center">2 * <b>smIconWords</b></td>
285 <td>Image</td>
286 <td>Small image (15x9) in Palm image format to be used as an icon to represent the document on a desktop-style display. The image may not use a custom color map.</td>
287 </tr>
288 </table>
289
290 <HR><H2><a name="index_record">The Index Record</a></H2>
291 <p>
292 This record includes info about the compression type used
293 for the Plucker document and also what IDs the reserved records use.
294 The viewer will use this record to know where to look for the
295 reserved records and whether it must have support for ZLib
296 compression. This record should always be the first record in
297 the Plucker document (i.e. at index 0).</p>
298
299 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
300 <tr BGCOLOR="#99CCCC">
301 <td><b><font color="#000000">Field</font></b></td>
302 <td align="center"><b><font color="#000000">Bytes</font></b></td>
303 <td><b><font color="#000000">Type</font></b></td>
304 <td><b><font color="#000000">Notes</font></b></td>
305 </tr>
306
307 <tr>
308 <td><b>uid</b></td>
309
310 <td align="center">2</td>
311
312 <td>Numeric</td>
313
314 <td>unique ID for record, always 0x0001</td>
315 </tr>
316
317 <tr BGCOLOR="#F0F0F0">
318 <td><b>version</b></td>
319
320 <td align="center">2</td>
321
322 <td>Numeric</td>
323
324 <td>0x0002 if data is ZLib compressed, 0x0001 if DOC compressed</td>
325 </tr>
326
327 <tr>
328 <td><b>records</b></td>
329
330 <td align="center">2</td>
331
332 <td>Numeric</td>
333
334 <td>number of reserved records</td>
335 </tr>
336
337 <tr BGCOLOR="#F0F0F0">
338 <td><b>reserved</b></td>
339
340 <td align="center">4*records</td>
341
342 <td>Numeric</td>
343
344 <td>reserved ID array</td>
345 </tr>
346 </table>
347
348 <p>
349 The reserved ID array consists of a series of name/ID pairs,
350 where the <strong>ID</strong> is the unique ID (2 bytes) for
351 the record and the <strong>name</strong> is a value (2 bytes)
352 from the following list.</p>
353
354 <ul>
355 <li>home.html = 0</li>
356 <li>external bookmarks = 1</li>
357 <li>URL handling = 2</li>
358 <li>default category = 3</li>
359 <li>additional metadata = 4</li>
360 <li>page list metadata = 5</li>
361 <li>sorted URL name data = 6</li>
362 <li>external anchor name data = 7</li>
363
364 </ul>
365
366 <HR><H2><a name="data_records">The Data Records</a></H2>
367 <p>
368 There are several different types of data records.</p>
369
370 <ul>
371 <li><A HREF="#text_dr">text data (compressed/uncompressed)</A></li>
372 <li><A HREF="#image_dr">image data (compressed/uncompressed)</A></li>
373 <li><A HREF="#mailto_dr">mailto data</A></li>
374 <li><A HREF="#url_handling_dr">URL handling data</A></li>
375 <li><A HREF="#url_dr">URL data (compressed/uncompressed)</A></li>
376 <li><A HREF="#external_bookmarks_dr">external bookmarks</A></li>
377 <li><A HREF="#default_category_dr">default category</A></li>
378 <li><a href="#index_extension_dr">metadata</a></li>
379 <li><a href="#style_sheet_dr">style sheets (not yet implemented)</a></li>
380 <li><a href="#font_page_dr">font pages (not yet implemented)</a></li>
381 <li><a href="#table_dr">table data (compressed/uncompressed)</a></li>
382 <li><a href="#pagelist_dr">page list metadata</a></li>
383 <li><a href="#sorted_url_handling_dr">sorted URL handling data</a></li>
384 <li><a href="#sorted_url_dr">sorted URL data (compressed/uncompressed)</a></li>
385 <li><a href="#extanchor_handling_dr">external anchor name handling data</a></li>
386 <li><a href="#extanchor_dr">external anchor name data (compressed/uncompressed)</a></li>
387
388 </ul>
389
390
391 <p>
392 Each data record starts with a header, having the following structure:</p>
393
394 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
395 <tr BGCOLOR="#99CCCC">
396 <td><b><font color="#000000">Field</font></b></td>
397 <td align="center"><b><font color="#000000">Bytes</font></b></td>
398 <td><b><font color="#000000">Type</font></b></td>
399 <td><b><font color="#000000">Notes</font></b></td>
400 </tr>
401
402 <tr>
403 <td><b>uid</b></td>
404 <td align="center">2</td>
405 <td>Numeric</td>
406 <td>Unique ID for record. IDs must be sorted in increasing order.
407 Currently the ID is not
408 allowed to be 0xFFFF. Moreover, some earlier versions of the viewer had a bug
409 that crashed on records numbered 0x8000-0xFFFE.</td>
410 </tr>
411
412 <tr>
413 <td><b>paragraphs</b></td>
414 <td align="center">2</td>
415 <td>Numeric</td>
416 <td>number of paragraphs</td>
417 </tr>
418
419 <tr>
420 <td><b>size</b></td>
421 <td align="center">2</td>
422 <td>Numeric</td>
423 <td>total length of data before compression</td>
424 </tr>
425
426 <tr>
427 <td><b>type</b></td>
428 <td align="center">1</td>
429 <td>Numeric</td>
430 <td>Data type. Must be one of the following:
431 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="100%" >
432 <tr BGCOLOR="#AADDDD">
433 <td><b><font color="#000000">Data type</font></b></td>
434 <td align="center"><b><font color="#000000">Value</font></b></td>
435 </tr>
436
437 <tr>
438 <td><b>DATATYPE_PHTML</b></td>
439
440 <td align="center">0</td>
441 </tr>
442
443 <tr BGCOLOR="#F0F0F0">
444 <td><b>DATATYPE_PHTML_COMPRESSED</b></td>
445
446 <td align="center">1</td>
447 </tr>
448
449 <tr>
450 <td><b>DATATYPE_TBMP</b></td>
451
452 <td align="center">2</td>
453 </tr>
454
455 <tr BGCOLOR="#F0F0F0">
456 <td><b>DATATYPE_TBMP_COMPRESSED</b></td>
457
458 <td align="center">3</td>
459 </tr>
460
461 <tr>
462 <td><b>DATATYPE_MAILTO</b></td>
463
464 <td align="center">4</td>
465 </tr>
466
467 <tr BGCOLOR="#F0F0F0">
468 <td><b>DATATYPE_LINK_INDEX</b></td>
469
470 <td align="center">5</td>
471 </tr>
472
473 <tr>
474 <td><b>DATATYPE_LINKS</b></td>
475
476 <td align="center">6</td>
477 </tr>
478
479 <tr BGCOLOR="#F0F0F0">
480 <td><b>DATATYPE_LINKS_COMPRESSED</b></td>
481
482 <td align="center">7</td>
483 </tr>
484
485 <tr>
486 <td><b>DATATYPE_BOOKMARKS</b></td>
487
488 <td align="center">8</td>
489 </tr>
490
491 <tr BGCOLOR="#F0F0F0">
492 <td><b>DATATYPE_CATEGORY</b></td>
493
494 <td align="center">9</td>
495 </tr>
496
497 <tr>
498 <td><b>DATATYPE_METADATA</b></td>
499
500 <td align="center">10</td>
501 </tr>
502
503 <tr BGCOLOR="#F0F0F0">
504 <td><b>DATATYPE_STYLE_SHEET</b></td>
505
506 <td align="center">11</td>
507 </tr>
508
509 <tr>
510 <td><b>DATATYPE_FONT_PAGE</b></td>
511
512 <td align="center">12</td>
513
514 <tr BGCOLOR="#F0F0F0">
515 <td><b>DATATYPE_TABLE</b></td>
516
517 <td align="center">13</td>
518 </tr>
519
520 <tr>
521 <td><b>DATATYPE_TABLE_COMPRESSED</b></td>
522
523 <td align="center">14</td>
524 </tr>
525
526 <tr BGCOLOR="#F0F0F0">
527 <td><b>DATATYPE_COMPOSITE_IMAGE</b></td>
528
529 <td align="center">15</td>
530 </tr>
531
532 <tr>
533 <td><b>DATATYPE_PAGELIST_METADATA</b></td>
534
535 <td align="center">16</td>
536 </tr>
537
538 <tr BGCOLOR="#F0F0F0">
539 <td><b>DATATYPE_SORTED_URL_INDEX</b></td>
540
541 <td align="center">17</td>
542 </tr>
543
544 <tr>
545 <td><b>DATATYPE_SORTED_URL</b></td>
546
547 <td align="center">18</td>
548 </tr>
549
550 <tr BGCOLOR="#F0F0F0">
551 <td><b>DATATYPE_SORTED_URL_COMPRESSED</b></td>
552
553 <td align="center">19</td>
554 </tr>
555
556 <tr>
557 <td><b>DATATYPE_EXT_ANCHOR_INDEX</b></td>
558
559 <td align="center">20</td>
560 </tr>
561
562 <tr BGCOLOR="#F0F0F0">
563 <td><b>DATATYPE_EXT_ANCHOR</b></td>
564
565 <td align="center">21</td>
566 </tr>
567
568 <tr>
569 <td><b>DATATYPE_EXT_ANCHOR_COMPRESSED</b></td>
570
571 <td align="center">22</td>
572 </tr>
573
574 </table>
575 </td>
576 </tr>
577
578 <tr>
579 <td><b>flags</b></td>
580 <td align="center">1</td>
581 <td>Bitfield</td>
582 <td>Bit-mapped record flags. Valid bits are as follows (all numeric values given are big-endian); unused bits should be set to zero.
583 <table border="1" cellpadding="2" cellspacing="0" width="811">
584 <tr bgcolor="#bbdddd">
585 <td width="147"><b><font color="#000000">Name</font></b></td>
586 <td width="39"><b><font color="#000000">Value</font></b></td>
587 <td width="605"><b><font color="#000000">Meaning</font></b></td>
588 </tr>
589
590 <tr>
591 <td bgcolor="#ffffff" width="147">Continued Record</td>
592 <td bgcolor="#ffffff" width="39">&nbsp;0x01</td>
593 <td bgcolor="#ffffff" width="605">A value of one indicates that the record is
594 continued by the fragment in the next sequential record of the same type.
595 This value is applicable to the following data types:
596 <ul>
597 <li>DATATYPE_PHTML</li>
598 <li>DATATYPE_PHTML_COMPRESSED</li>
599 </ul>
600 <p>A value of zero indicates that the record is not to be continued (i.e. there are no fragments beyond this one, or this is the last one).</p>
601 </td>
602 </tr>
603
604 <tr>
605 <td bgcolor="#ffffff" width="147">Navigation Metadata</td>
606 <td bgcolor="#ffffff" width="39">0x02</td>
607 <td bgcolor="#ffffff" width="605">A value of one indicates that the text or image data in this record is followed by additional navigation metadata.</td>
608 </tr>
609
610 </table>
611 </td>
612 </tr>
613 </table>
614
615 <H3><a name="compression">Compression and the Owner-ID</a></H3>
616 <p>This data format supports two forms of compression, DOC and ZLIB. That part of a data record that occurs after the header is compressed as a single chunk. All compressed records in a single document must use the same compression format. Compressed records may be mixed with uncompressed records. In a compressed record, the length of the compressed data <b>must</b> be less than its uncompressed length.</p>
617 <p>DOC compression is the <A HREF="http://www.pyrite.org/doc_format.php">the format invented for early Palm usage</a>.</P>
618 <p>ZLIB compression uses the ZLib format documented in Internet RFCs <a href="http://www.ietf.org/rfc/rfc1950.txt?number=1950">1950</a> and <a href="http://www.ietf.org/rfc/rfc1951.txt?number=1951">1951</a>. See also <a href="http://www.gzip.org/zlib/manual.html">http://www.gzip.org/zlib/manual.html</a> for a description of the library used to perform the compression and decompression.</p>
619 <p>Plucker documents may be keyed to a specific string of 40 or fewer ASCII characters, called the <i>owner-id</i>. When such a key is specified, zlib compression must be used in the document. When an owner-id is specified, the beginning of each zlib-compressed data segment is XOR'ed with a value derived from the key, after compression, and must be XOR'ed again with the derived value before being decompressed. If an owner-id is specified for a document, the metadata record must exist, and must contain an <TT>OwnerID</TT> subrecord giving the CRC-32 of the owner-id string.</p>
620 <p>The <i>derived value</i> mentioned above is a 40-byte value constructed by forming 10 strings by concatenating the owner-id string with itself 2, 3, 4, 5, 6, 7, 8, 9, 10, and 11 times, then taking the CRC-32 values of each of these concatenations, then packing those 32-bit values in big-endian order into a 40-byte buffer.
621 <p></p>
622
623 <p><HR width="60%" align=left><P>
624 <H3><A NAME="text_dr">Text data records</A></H3>
625 <p>
626 For text data the data record header is followed by a series of paragraph
627 headers, each representing a paragraph block in the text data. This series of paragraph headers is then followed by the compressed or uncompressed text data. Each paragraph header has the form:</p>
628
629 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
630 <tr BGCOLOR="#99CCCC">
631 <td><b><font color="#000000">Field</font></b></td>
632 <td align="center"><b><font color="#000000">Bytes</font></b></td>
633 <td><b><font color="#000000">Type</font></b></td>
634 <td><b><font color="#000000">Notes</font></b></td>
635 </tr>
636
637 <tr>
638 <td><b>size</b></td>
639
640 <td align="center">2</td>
641
642 <td>Numeric</td>
643
644 <td>Total length of paragraph before compression. <font color="#FF0000">NOTE: No text data should be larger than
645 32k. If the original document is larger than 32k, then the
646 parser must split it into several records.</font>
647 </td>
648 </tr>
649
650 <tr BGCOLOR="#F0F0F0">
651 <td><b>attributes</b></td>
652
653 <td align="center">2</td>
654
655 <td>Bitfield</td>
656
657 <td>Paragraph info. The high-order 13 bits are reserved for future use and should be set to zero; the 3 low-order bits contain a numeric value in the range [0..7] giving the
658 amount of extra paragraph spacing (2*value pixels).</td>
659 </tr>
660 </table>
661
662 <p>
663 The (uncompressed) text data contains a character stream of ISO Latin-1 characters, interspersed with 'functions'.</p>
664 <P>
665 A function is introduced in the text stream by a NULL character (0x00), followed by a one-byte function code
666 and up to 7 bytes of data. The 3 LSB of the function code represent the
667 remaining function data length; the 5 MSB denote the actual function
668 code. The following functions are valid:</p>
669
670 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
671 <tr BGCOLOR="#99CCCC">
672 <td><b><font color="#000000">Function Code</font></b></td>
673 <td><b><font color="#000000">Description</font></b></td>
674 <td align="center"><b><font color="#000000">Bytes</font></b></td>
675 <td><b><font color="#000000">Arguments</font></b></td>
676 </tr>
677
678 <tr>
679 <td><b>0x0A</b></td>
680 <td>Page link begins</td>
681 <td align="center">2</td>
682 <td>record ID</td>
683 </tr>
684
685 <tr BGCOLOR="#F0F0F0">
686 <td><b>0x0B</b></td>
687 <td>Targeted page link begins</td>
688 <td align="center">3</td>
689 <td>record ID, target</td>
690 </tr>
691
692 <tr>
693 <td><b>0x0C</b></td>
694 <td>Paragraph link begins</td>
695 <td align="center">4</td>
696 <td>record ID, paragraph number</td>
697 </tr>
698
699 <tr BGCOLOR="#F0F0F0">
700 <td><b>0x0D</b></td>
701 <td>Targeted paragraph link begins</td>
702 <td align="center">5</td>
703 <td>record ID, paragraph number, target</td>
704 </tr>
705
706 <tr>
707 <td><b>0x08</b></td>
708 <td>Link ends</td>
709 <td align="center">0</td>
710 <td>no data</td>
711 </tr>
712
713 <tr BGCOLOR="#F0F0F0">
714 <td><b>0x11</b></td>
715 <td>Set font</td>
716 <td align="center">1</td>
717 <td>font specifier</td>
718 </tr>
719
720 <tr>
721 <td><b>0x1A</b></td>
722 <td>Embedded image</td>
723 <td align="center">2</td>
724 <td>image record ID</td>
725 </tr>
726
727 <tr BGCOLOR="#F0F0F0">
728 <td><b>0x22</b></td>
729 <td>Set margin</td>
730 <td align="center">2</td>
731 <td>left margin, right margin</td>
732 </tr>
733
734 <tr>
735 <td><b>0x29</b></td>
736 <td>Alignment of text</td>
737 <td align="center">1</td>
738 <td>alignment</td>
739 </tr>
740
741 <tr BGCOLOR="#F0F0F0">
742 <td><b>0x33</b></td>
743 <td>Horizontal rule</td>
744 <td align="center">3</td>
745 <td>8-bit height, 8-bit width (pixels), 8-bit width (%, 1-100)</td>
746 </tr>
747
748 <tr>
749 <td><b>0x38</b></td>
750 <td>New line</td>
751 <td align="center">0</td>
752 <td>no data</td>
753 </tr>
754
755 <tr BGCOLOR="#F0F0F0">
756 <td><b>0x40</b></td>
757 <td>Italic text begins</td>
758 <td align="center">0</td>
759 <td>no data</td>
760 </tr>
761
762 <tr>
763 <td><b>0x48</b></td>
764 <td>Italic text ends</td>
765 <td align="center">0</td>
766 <td>no data</td>
767 </tr>
768
769 <tr BGCOLOR="#F0F0F0">
770 <td><b>0x53</b></td>
771 <td>Set text color</td>
772 <td align="center">3</td>
773 <td>8-bit red, 8-bit green, 8-bit blue</td>
774 </tr>
775
776 <tr>
777 <td><b>0x5C</b></td>
778 <td>Multiple embedded image</td>
779 <td align="center">4</td>
780 <td>alternate image record ID, image record ID</td>
781 </tr>
782
783 <tr BGCOLOR="#F0F0F0">
784 <td><b>0x60</b></td>
785 <td>Underline text begins</td>
786 <td align="center">0</td>
787 <td>no data</td>
788 </tr>
789
790 <tr>
791 <td><b>0x68</b></td>
792 <td>Underline text ends</td>
793 <td align="center">0</td>
794 <td>no data</td>
795 </tr>
796
797 <tr BGCOLOR="#F0F0F0">
798 <td><b>0x70</b></td>
799 <td>Strike-through text begins</td>
800 <td align="center">0</td>
801 <td>no data</td>
802 </tr>
803
804 <tr>
805 <td><b>0x78</b></td>
806 <td>Strike-through text ends</td>
807 <td align="center">0</td>
808 <td>no data</td>
809 </tr>
810
811 <tr BGCOLOR="#F0F0F0">
812 <td><b>0x83</b></td>
813 <td>16-bit Unicode character</td>
814 <td align="center">3</td>
815 <td>alternate text length, 16-bit unicode character</td>
816 </tr>
817
818 <tr>
819 <td><b>0x85</b></td>
820 <td>32-bit Unicode character</td>
821 <td align="center">5</td>
822 <td>alternate text length, 32-bit unicode character</td>
823 </tr>
824
825 <tr BGCOLOR="#F0F0F0">
826 <td><b>0x8E</b></td>
827 <td>Begin custom font span</td>
828 <td align="center">6</td>
829 <td>font page record ID, X page position, Y page position</td>
830 </tr>
831
832 <tr>
833 <td><b>0x8C</b></td>
834 <td>Adjust custom font glyph position</td>
835 <td align="center">4</td>
836 <td>X page position, Y page position</td>
837 </tr>
838
839 <tr BGCOLOR="#F0F0F0">
840 <td><b>0x8A</b></td>
841 <td>Change font page</td>
842 <td align="center">2</td>
843 <td>font record ID</td>
844 </tr>
845
846 <tr>
847 <td><b>0x88</b></td>
848 <td>End custom font span</td>
849 <td align="center">0</td>
850 <td>no data</td>
851 </tr>
852
853 <tr BGCOLOR="#F0F0F0">
854 <td><b>0x90</b></td>
855 <td>Begin new table row</td>
856 <td align="center">0</td>
857 <td>no data</td>
858 </tr>
859
860 <tr>
861 <td><b>0x92</b></td>
862 <td>Insert table (or table link)</td>
863 <td align="center">2</td>
864 <td>table record ID</td>
865 </tr>
866
867 <tr BGCOLOR="#F0F0F0">
868 <td><b>0x97</b></td>
869 <td>Table cell data</td>
870 <td align="center">7</td>
871 <td>8-bit alignment, 16-bit image record ID, 8-bit columns, 8-bit rows, 16-bit text length</td>
872 </tr>
873
874 <tr>
875 <td><b>0x9A</b></td>
876 <td>Exact link modifier</td>
877 <td align="center">2</td>
878 <td>Paragraph Offset (The Exact Link Modifier modifies a Paragraph Link or Targeted Paragraph Link function to specify an exact byte offset within the paragraph. This function must be followed immediately by the function it modifies).</td>
879 </tr>
880
881 </table>
882 <p>
883 The function arguments have the following definitions:</p>
884
885 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
886 <tr BGCOLOR="#99CCCC">
887 <td><b><font color="#000000">Argument</font></b></td>
888 <td align="center"><b><font color="#000000">Bytes</font></b></td>
889 <td><b><font color="#000000">Notes</font></b></td>
890 </tr>
891
892 <tr>
893 <td><b>record ID</b></td>
894
895 <td align="center">2</td>
896
897 <td>This is <em>either</em> a reference to a record in Plucker document (that is, a real record ID), or an index into the list of URLs, for URLs which have not been included in the document.</td>
898 </tr>
899
900 <tr BGCOLOR="#F0F0F0">
901 <td><b>image record ID</b></td>
902
903 <td align="center">2</td>
904
905 <td>reference to image in Plucker document</td>
906 </tr>
907
908 <tr>
909 <td><b>paragraph number</b></td>
910
911 <td align="center">2</td>
912
913 <td>paragraph number (starting from 0) to jump to or an index into the <a href="#extanchor_dr">external anchor name data</a> if the record ID is pseudo-Record ID for a URL which has not been included in the document.</td>
914 </tr>
915
916 <tr BGCOLOR="#F0F0F0">
917 <td><b>font specifier</b></td>
918
919 <td align="center">1</td>
920
921 <td>
922 The font concept used in Plucker is that of a 'standard' font, along with bold and italic versions of that font. There is no font notion corresponding to HTML's &lt;BIG&gt; or &lt;SMALL&gt;. In this markup, boldness and size are specified with a font specifier; italic is specified with a separate function code. There are currently 11 font specification values, with the following meanings (the actual PalmOS fonts used by the Palm viewer are also given):
923 <table BORDER=0 CELLSPACING=0 CELLPADDING=2 WIDTH="100%" >
924 <tr>
925 <td><b><font color="#000000">Value</font></b></td>
926 <td><b><font color="#000000">Description</font></b></td>
927 <td><b><font color="#000000">PalmOS 2.x</font></b></td>
928 <td><b><font color="#000000">PalmOS 3.x</font></b></td>
929 </tr>
930 <tr>
931 <td>0</td>
932 <td>Regular text.</td>
933 <td>stdFont</td>
934 <td>stdFont</td>
935 </tr>
936 <tr>
937 <td>1</td>
938 <td>Suitable for &lt;H1&gt HTML tags.</td>
939 <td>boldFont</td>
940 <td>largeBoldFont</td>
941 </tr>
942 <tr>
943 <td>2</td>
944 <td>Suitable for &lt;H2&gt HTML tags.</td>
945 <td>boldFont</td>
946 <td>largeBoldFont</td>
947 </tr>
948 <tr>
949 <td>3</td>
950 <td>Suitable for &lt;H3&gt HTML tags.</td>
951 <td>boldFont</td>
952 <td>largeFont</td>
953 </tr>
954 <tr>
955 <td>4</td>
956 <td>Suitable for &lt;H4&gt HTML tags.</td>
957 <td>boldFont</td>
958 <td>largeFont</td>
959 </tr>
960 <tr>
961 <td>5</td>
962 <td>Suitable for &lt;H5&gt HTML tags.</td>
963 <td>stdFont</td>
964 <td>boldFont</td>
965 </tr>
966 <tr>
967 <td>6</td>
968 <td>Suitable for &lt;H6&gt HTML tags.</td>
969 <td>stdFont</td>
970 <td>boldFont</td>
971 </tr>
972 <tr>
973 <td>7</td>
974 <td>Regular text, but bold.</td>
975 <td>stdFont</td>
976 <td>boldFont</td>
977 </tr>
978 <tr>
979 <td>8</td>
980 <td>Fixed-width text, suitable for &lt;TT&gt; HTML tags.</td>
981 <td>stdFont</td>
982 <td>fixedWidthFont</td>
983 </tr>
984 <tr>
985 <td>9</td>
986 <td>Small normal text, suitable for &lt;SMALL&gt; HTML tags.</td>
987 <td>stdFont</td>
988 <td>stdFont</td>
989 </tr>
990 <tr>
991 <td>10</td>
992 <td>Small subscript text, suitable for &lt;SUB&gt; HTML tags.</td>
993 <td>stdFont</td>
994 <td>stdFont</td>
995 </tr>
996 <tr>
997 <td>11</td>
998 <td>Small superscript text, suitable for &lt;SUP&gt; HTML tags.</td>
999 <td>stdFont</td>
1000 <td>stdFont</td>
1001 </tr>
1002 </table>
1003 </td>
1004 </tr>
1005
1006 <tr>
1007 <td><b>left margin</b></td>
1008
1009 <td align="center">1</td>
1010
1011 <td>left margin in pixels</td>
1012 </tr>
1013
1014 <tr BGCOLOR="#F0F0F0">
1015 <td><b>right margin</b></td>
1016
1017 <td align="center">1</td>
1018
1019 <td>right margin in pixels</td>
1020 </tr>
1021
1022 <tr>
1023 <td><b>alignment</b></td>
1024
1025 <td align="center">1</td>
1026
1027 <td>alignment code (left = 0, right = 1, center = 2, justify = 3)</td>
1028 </tr>
1029
1030 <tr BGCOLOR="#F0F0F0">
1031 <td><b>height</b></td>
1032
1033 <td align="center">1</td>
1034
1035 <td>height of horizontal rule in pixels, if not given a default value
1036 of 2 pixels will be used</td>
1037 </tr>
1038
1039 <tr>
1040 <td><b>width (pixels)</b></td>
1041
1042 <td align="center">1</td>
1043
1044 <td>width in pixels, should be 0 if percentage value should be used</td>
1045 </tr>
1046
1047 <tr BGCOLOR="#F0F0F0">
1048 <td><b>width (%)</b></td>
1049
1050 <td align="center">1</td>
1051
1052 <td>width as the percentage between the current left and right margins.
1053 The default is 100%</td>
1054 </tr>
1055
1056 <tr>
1057 <td><b>alternate text length</b></td>
1058
1059 <td align="center">1</td>
1060
1061 <td>When a Unicode character not representable in ISO-Latin-1 is encountered in an HTML document, a Unicode-character function code is inserted, with the 16-bit or 32-bit value of the character. This is followed by a "alternate representation" of the character in ISO-Latin-1 text. This parameter gives the length, in bytes, of the alternate text span. If the viewer can present the Unicode character directly, display of the alternate text should be suppressed.</td>
1062
1063 <tr BGCOLOR="#F0F0F0">
1064 <td><b>16 or 32 bit Unicode character</b></td>
1065
1066 <td align="center">2, 4</td>
1067
1068 <td>When a Unicode character not representable in ISO-Latin-1 is encountered in an HTML document, a Unicode-character function code is inserted, with the 16-bit or 32-bit Unicode character code for the character, which this parameter supplies. This is followed by a "alternate representation" of the character in ISO-Latin-1 text. If the viewer can present the Unicode character directly, display of the alternate text should be suppressed.</td>
1069 </tr>
1070
1071 <tr>
1072 <td><b>target</b></td>
1073
1074 <td align="center">1</td>
1075
1076 <td>The target parameter of a link function allows an alternate default target view for a link
1077 to be specified. By default, a link will always open in the same view as the current content
1078 location. Valid link targets are as follows:
1079 <table border="0" cellpadding="2" cellspacing="0" width="787">
1080 <tr>
1081 <td><b>Value</b></td>
1082 <td><b>Description</b></td>
1083 </tr>
1084 <tr>
1085 <td>0</td>
1086 <td>Default View. If specified, the link will be opened in the default view as
1087 determined by the reader. This value causes a Targeted Paragraph or Page
1088 Link to behave identical to a standard Paragraph or Page Link.</td>
1089 </tr>
1090 <tr>
1091 <td>1</td>
1092 <td>Primary View. Specifies that the link will be opened in the primary window
1093 regardless of current content location.</td>
1094 </tr>
1095 <tr>
1096 <td>2</td>
1097 <td>Secondary View/Popup View. Specifies that the link will be opened in the
1098 secondary or popup view regardless of current content location.</td>
1099 </tr>
1100 </table>
1101 </td>
1102 </tr>
1103
1104 <tr BGCOLOR="#F0F0F0">
1105 <td><b>Paragraph Offset</b></td>
1106
1107 <td align="center">2</td>
1108
1109 <td>specifies an exact byte offset within a paragraph relative to the beginning of the paragraph.</td>
1110 </tr>
1111
1112 </table>
1113
1114 <p><HR width="60%" align=left><P>
1115 <H3><A NAME="image_dr">Image data records</A></H3>
1116 <p>The image data consists of an image in Palm image format, compressed or uncompressed as specified in the document's index record. The image may in addition be internally compressed, via any of the compression techniques allowed in the Palm image format. The <i>fundamental size</i> of an image must be less than 480,000; this size is calculated by multiplying the width (in pixels) by the height (in pixels) by the depth (in bits).</p>
1117
1118 <p>If the <i>fundamental size</i> is greater than 480,000, most parsers can be told to create a Multi-image group. This is a group of image records consisting of parts of the image which the viewer displays as one image. The parts are standard Image data records and the Multi-image record tells how many columns and rows the image has, and the record numbers of the parts.
1119
1120 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
1121 <tr BGCOLOR="#99CCCC">
1122 <td><b><font color="#000000">Field</font></b></td>
1123 <td align="center"><b><font color="#000000">Bytes</font></b></td>
1124 <td><b><font color="#000000">Type</font></b></td>
1125 <td><b><font color="#000000">Notes</font></b></td>
1126 </tr>
1127
1128 <tr>
1129 <td><b>columns</b></td>
1130
1131 <td align="center">2</td>
1132
1133 <td>Numeric</td>
1134
1135 <td>number of columns in this image</td>
1136 </tr>
1137
1138 <tr BGCOLOR="#F0F0F0">
1139 <td><b>rows</b></td>
1140
1141 <td align="center">2</td>
1142
1143 <td>Numeric</td>
1144
1145 <td>number of rows in this image</td>
1146 </tr>
1147
1148 <tr>
1149 <td><b>image record IDs</b></td>
1150
1151 <td align="center">2 * columns * rows</td>
1152
1153 <td>Numeric</td>
1154
1155 <td>References to images in Plucker document. There are (columns * rows) images listed here</td>
1156 </tr>
1157
1158 </table>
1159
1160 <br>
1161 <p><HR width="60%" align=left><P>
1162
1163 <h3><a name="navigation_dr">Navigation metadata</a></h3>
1164 <p>This data is optionally appended to the end of a text or image data record based on the
1165 setting of the Navigation Metadata flag in the record header. If the Navigation Metadata flag
1166 is set to one, the image or text data is immediately followed by the following data structures.
1167 </p>
1168 <p>
1169 <font color="#FF0000">NOTE: If navigation data is appended to a record then the last two bytes
1170 in the record shall contain the byte offset from the beginning of the record to the start of the
1171 navigation data.</font>
1172 </p>
1173
1174 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
1175 <tr BGCOLOR="#99CCCC">
1176 <td><b><font color="#000000">Field</font></b></td>
1177 <td align="center"><b><font color="#000000">Bytes</font></b></td>
1178 <td><b><font color="#000000">Type</font></b></td>
1179 <td><b><font color="#000000">Notes</font></b></td>
1180 </tr>
1181
1182 <tr>
1183 <td><b>anchor name offset</b></td>
1184
1185 <td align="center">2</td>
1186
1187 <td>Numeric</td>
1188
1189 <td>Byte offset from the beginning of the metadata to the anchor name table for this record or 0xffff if there is no anchor name data.</td>
1190 </tr>
1191
1192 <tr bgcolor="#f0f0f0">
1193 <td><b>pagelist offset</b></td>
1194
1195 <td align="center">2</td>
1196
1197 <td>Numeric</td>
1198
1199 <td>Byte offset from the beginning of the metadata to the page list table for this record or 0xffff if there is no page list data.</td>
1200 </tr>
1201
1202 <tr>
1203 <td><b>hierarchy offset</b></td>
1204
1205 <td align="center">2</td>
1206
1207 <td>Numeric</td>
1208
1209 <td>Byte offset from the beginning of the metadata to the hierarchy table for this record or 0xffff if there is no hierarchy data.</td>
1210 </tr>
1211
1212 <tr bgcolor="#f0f0f0">
1213 <td><b>topic offset</b></td>
1214
1215 <td align="center">2</td>
1216
1217 <td>Numeric</span></font></td>
1218
1219 <td>Byte offset from the beginning of the metadata to the list of topics associates with this record or 0xffff if there is no topic data .</td>
1220 </tr>
1221
1222 <tr>
1223 <td><b>Title Strings</b></td>
1224
1225 <td align="center">2+</td>
1226
1227 <td>String sequence</td>
1228
1229 <td>A series of concatenated NUL-terminated strings in the following order:
1230 <ol>
1231 <li><b>Long Record Title - </b>The title of the record. This title should allow the record to be identified out of context.</li>
1232 <li><b>Short Record Title - </b>A title string which allows the record to be identified in context.</li>
1233 </ol>
1234 <p>If a given string in the list is not defined, an empty string (NUL) must still be entered
1235 in the appropriate location in the string sequence.</p></td>
1236 </tr>
1237
1238 </table>
1239
1240 <p>The offsets block and title strings are followed by a series of tables.</p>
1241
1242 <p>The <b>anchor name table</b> specifies the offset of the anchor names within the text record.</p>
1243
1244 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
1245 <tr BGCOLOR="#99CCCC">
1246 <td><b><font color="#000000">Field</font></b></td>
1247 <td align="center"><b><font color="#000000">Bytes</font></b></td>
1248 <td><b><font color="#000000">Type</font></b></td>
1249 <td><b><font color="#000000">Notes</font></b></td>
1250 </tr>
1251
1252 <tr bgcolor="#f0f0f0">
1253 <td><b>anchor names</b></td>
1254
1255 <td align="center">2</td>
1256
1257 <td>Numeric</td>
1258
1259 <td>number of anchor names</td>
1260 </tr>
1261
1262 <tr>
1263 <td><b>anchor name data</b></td>
1264
1265 <td align="center">2*anchor names</td>
1266
1267 <td>Numeric Array</td>
1268
1269 <td>This field is an array of 2 byte offsets, each representing the corresponding
1270 offset associated with an anchor name relative to the beginning of the text
1271 record. The order of each offset corresponds to the order of the string for that anchor name
1272 within the anchor name string sequence below.</td>
1273 </tr>
1274
1275 <tr bgcolor="#f0f0f0">
1276 <td><b>anchor name strings</b></td>
1277
1278 <td align="center">variable size</td>
1279
1280 <td>String sequence</td>
1281
1282 <td>A concatenated sequence of NUL-terminated strings, each an anchor name. The relative
1283 location of an anchor name string in the string sequence represents its index into the anchor
1284 name data.</td>
1285 </tr>
1286
1287 </table>
1288
1289 <p>
1290 The <b>page list table</b> contains
1291 the uid of the previous and next records relative to this record for one or more
1292 page lists. Each page list, combined with the page lists from other
1293 Incoming Navigation data records defines one of more unique a linear navigation
1294 schemes for the document. The default scheme is always associated with a
1295 list id of 0.</p>
1296
1297 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
1298 <tr BGCOLOR="#99CCCC">
1299 <td><b><font color="#000000">Field</font></b></td>
1300 <td align="center"><b><font color="#000000">Bytes</font></b></td>
1301 <td><b><font color="#000000">Type</font></b></td>
1302 <td><b><font color="#000000">Notes</font></b></td>
1303 </tr>
1304
1305 <tr bgcolor="#f0f0f0">
1306 <td><b>pagelists</b></td>
1307
1308 <td align="center">2</td>
1309
1310 <td>Numeric</td>
1311
1312 <td>number of page list entries for this record.</td>
1313 </tr>
1314
1315 <tr>
1316 <td><b>pagelist data</b></td>
1317
1318 <td align="center">6*pagelists</td>
1319
1320 <td>Page List Data</td>
1321
1322 <td>Block of data containing an array of Page List Data (described below).</td>
1323 </tr>
1324
1325 </table>
1326
1327 <p>
1328 The page list data consists of a series of structures containing a list id followed by the
1329 unique ID of the previous and next records associated with that list id.</p>
1330
1331 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
1332 <tr BGCOLOR="#99CCCC">
1333 <td><b><font color="#000000">Field</font></b></td>
1334 <td align="center"><b><font color="#000000">Bytes</font></b></td>
1335 <td><b><font color="#000000">Type</font></b></td>
1336 <td><b><font color="#000000">Notes</font></b></td>
1337 </tr>
1338
1339 <tr bgcolor="#f0f0f0">
1340 <td><b>list id</b></td>
1341
1342 <td align="center">2</td>
1343
1344 <td>Numeric</td>
1345
1346 <td>the list id for this list. A list id of 0 should be used for the default linear ordering.</td>
1347 </tr>
1348
1349 <tr>
1350 <td><b>prev uid</b></td>
1351
1352 <td align="center">2</td>
1353
1354 <td>Numeric</td>
1355
1356 <td>the uid of the previous record in the series for this list id or 0xffff if this is the
1357 first record in the series.</td>
1358 </tr>
1359
1360 <tr bgcolor="#f0f0f0">
1361 <td><b>next uid</b></td>
1362
1363 <td align="center">2</td>
1364
1365 <td>Numeric</td>
1366
1367 <td>the uid of the next record in the series for the list id or 0xffff if this is the
1368 last record in the series.</td>
1369 </tr>
1370
1371 </table>
1372
1373 <p>The <b>hierarchy table</b> specifies unique ID of each text record above this record in
1374 the document hierarchy that serves as an index leading to the current record.</p>
1375
1376 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
1377 <tr BGCOLOR="#99CCCC">
1378 <td><b><font color="#000000">Field</font></b></td>
1379 <td align="center"><b><font color="#000000">Bytes</font></b></td>
1380 <td><b><font color="#000000">Type</font></b></td>
1381 <td><b><font color="#000000">Notes</font></b></td>
1382 </tr>
1383
1384 <tr bgcolor="#f0f0f0">
1385 <td><b>levels</b></td>
1386
1387 <td align="center">2</td>
1388
1389 <td>Numeric</td>
1390
1391 <td>number of levels above the current record in the hierarchy.</td>
1392 </tr>
1393
1394 <tr>
1395 <td><b>hierarchy data</b></td>
1396
1397 <td align="center">2*levels</td>
1398
1399 <td>Numeric Array</td>
1400
1401 <td>This field is an array of 2 byte uids, each corresponding to the text record
1402 that serves as the index at a given level in the document hierarchy relative to
1403 the current record. The order of each uid in the array corresponds to the
1404 order of its corresponding string description in the string sequence below.</td>
1405 </tr>
1406
1407 <tr bgcolor="#f0f0f0">
1408 <td><b>hierarchy strings</b></td>
1409
1410 <td align="center">variable size</td>
1411
1412 <td>String sequence</td>
1413
1414 <td>An abbreviated string that identifies the level index. This string should be
1415 as short as possible, ideally only a few characters.</td>
1416 </tr>
1417
1418 </table>
1419
1420 <p>The <b>topic table</b> provides a list of topics associated with the record.</p>
1421
1422 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
1423 <tr BGCOLOR="#99CCCC">
1424 <td><b><font color="#000000">Field</font></b></td>
1425 <td align="center"><b><font color="#000000">Bytes</font></b></td>
1426 <td><b><font color="#000000">Type</font></b></td>
1427 <td><b><font color="#000000">Notes</font></b></td>
1428 </tr>
1429
1430 <tr bgcolor="#f0f0f0">
1431 <td><b>topics</b></td>
1432
1433 <td align="center">2</td>
1434
1435 <td>Numeric</td>
1436
1437 <td>number of topics in the topic string sequence.</td>
1438 </tr>
1439
1440 <tr>
1441 <td><b>topic strings</b></td>
1442
1443 <td align="center">0+</td>
1444
1445 <td>String sequence</td>
1446
1447 <td>A concatenated sequence of one or more NUL-terminated
1448 ISO Latin-1 strings. Each string represents a topic associated with this
1449 text record.</td>
1450 </tr>
1451
1452 </table>
1453
1454 <p><HR width="60%" align=left><P>
1455 <H3><A NAME="mailto_dr">Mailto data records</A></H3>
1456 The mailto data contains info about e-mail addresses that are
1457 referenced by the mailto anchors. All the offsets are counting
1458 from the end of the header.
1459
1460 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
1461 <tr BGCOLOR="#99CCCC">
1462 <td><b><font color="#000000">Field</font></b></td>
1463 <td align="center"><b><font color="#000000">Bytes</font></b></td>
1464 <td><b><font color="#000000">Type</font></b></td>
1465 <td><b><font color="#000000">Notes</font></b></td>
1466 </tr>
1467
1468 <tr>
1469 <td><b>to offset</b></td>
1470
1471 <td align="center">2</td>
1472
1473 <td>Numeric</td>
1474
1475 <td>offset to TO string</td>
1476 </tr>
1477
1478 <tr BGCOLOR="#F0F0F0">
1479 <td><b>cc offset</b></td>
1480
1481 <td align="center">2</td>
1482
1483 <td>Numeric</td>
1484
1485 <td>offset to CC string</td>
1486 </tr>
1487
1488 <tr>
1489 <td><b>subject offset</b></td>
1490
1491 <td align="center">2</td>
1492
1493 <td>Numeric</td>
1494
1495 <td>offset to SUBJECT string</td>
1496 </tr>
1497
1498 <tr BGCOLOR="#F0F0F0">
1499 <td><b>body offset</b></td>
1500
1501 <td align="center">2</td>
1502
1503 <td>Numeric</td>
1504
1505 <td>offset to BODY string</td>
1506 </tr>
1507
1508 <tr>
1509 <td><b>strings</b></td>
1510
1511 <td align="center">0+</td>
1512
1513 <td>String sequence</td>
1514
1515 <td>A concatenated sequence of one or more NUL-terminated US-ASCII strings. Each contains a header-value, which follows the constraints on header values laid down in IETF RFC 2822. Header folding is not allowed. Any of the four headers shown above may be absent; header values should be accessed via the above offsets.</td>
1516 </tr>
1517
1518 </table>
1519
1520 <p><HR width="60%" align=left><P>
1521 <H3><A NAME="url_handling_dr">URL handling data records</a></H3>
1522 Optionally, URL information for the records in the document may be stored. This information includes URL strings both for the pages actually included in the document, and for those pages excluded from the document. This information is conceptually stored as a sequence of strings, where the position of the URL in the sequence corresponds to the record ID of its page in the document. In the case of a page which is not actually included in the document, a pseudo-record-ID is assigned, greater than any actual record IDs in the document, and the URL of that page is associated with that pseudo-record-ID.
1523 <p>
1524 In practice, there are two kinds of records used to store the URL strings, the <i>URL handling data record</i>, which serves as an index into the sequence of strings, and the <i>URL data record</i>, one or more of which contain the actual strings.
1525 <p>
1526 <p>
1527 For cross-document linking support, the URL strings must be of the format "doc://[<i>external doc name</i>]:[<i>url</i>]" where <i>external doc name</i> is the name of the external document and <i>url</i> is the URL string associated with a given record.
1528 </p>
1529 The URL handling data is used to find the record ID of the record which contains the correct URL string. It
1530 contains a series of 2 byte number pairs.
1531
1532 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
1533 <tr BGCOLOR="#99CCCC">
1534 <td><b><font color="#000000">Field</font></b></td>
1535 <td align="center"><b><font color="#000000">Bytes</font></b></td>
1536 <td><b><font color="#000000">Type</font></b></td>
1537 <td><b><font color="#000000">Notes</font></b></td>
1538 </tr>
1539
1540 <tr>
1541 <td><b>last url</b></td>
1542
1543 <td align="center">2</td>
1544
1545 <td>Numeric</td>
1546
1547 <td>the ordinal number of the last URL in record</td>
1548 </tr>
1549
1550 <tr BGCOLOR="#F0F0F0">
1551 <td><b>id</b></td>
1552
1553 <td align="center">2</td>
1554
1555 <td>Numeric</td>
1556
1557 <td>record ID for record</td>
1558 </tr>
1559
1560 </table>
1561
1562 <p><HR width="60%" align=left><P>
1563 <H3><A NAME="url_dr">URL data records</A></h3>
1564 The URL data contains a list of the URLs. Additional records
1565 are created if needed and contain up to 200 URLs.
1566
1567 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
1568 <tr BGCOLOR="#99CCCC">
1569 <td><b><font color="#000000">Field</font></b></td>
1570 <td align="center"><b><font color="#000000">Bytes</font></b></td>
1571 <td><b><font color="#000000">Type</font></b></td>
1572 <td><b><font color="#000000">Notes</font></b></td>
1573 </tr>
1574
1575 <tr>
1576 <td><b>URLs</b></td>
1577
1578 <td align="center">1+</td>
1579
1580 <td>String sequence</td>
1581
1582 <td>a concatenated sequence of NUL-terminated URL strings following the constraints of IETF RFC 1738. The list may contain up to 200 URLs (only text and image records are included,
1583 other records are represented only by the presence of a NUL; that is, by an empty string)</td>
1584 </tr>
1585
1586 </table>
1587 <p>
1588 These records may or may not be compressed. This is indicated
1589 by the type in the header. These records are used by the Details
1590 form to display the URL of the current record and by the External
1591 Reference form to display the URL of not collected pages. From
1592 either form you can copy the URL to a Memo to remind you to pluck
1593 it at a later date. For inter-document links, a paragraph link
1594 function may be specified to contain a pseudo-Record ID in place
1595 of an actual-Record ID, and an index into the
1596 <a href="#extanchor_handling_dr">external anchor names</a> record
1597 in place of the paragraph number.
1598 </p>
1599
1600 <p><HR width="60%" align=left><P>
1601 <h3><A NAME="external_bookmarks_dr">External Bookmarks data records</A></h3>
1602 The external bookmarks data contains a list of bookmarks added by the
1603 parser. It will work similar to named anchors.
1604
1605 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
1606 <tr BGCOLOR="#99CCCC">
1607 <td><b><font color="#000000">Field</font></b></td>
1608 <td align="center"><b><font color="#000000">Bytes</font></b></td>
1609 <td><b><font color="#000000">Type</font></b></td>
1610 <td><b><font color="#000000">Notes</font></b></td>
1611 </tr>
1612
1613 <tr BGCOLOR="#F0F0F0">
1614 <td><b>bookmarks</b></td>
1615
1616 <td align="center">2</td>
1617
1618 <td>Numeric</td>
1619
1620 <td>number of bookmarks</td>
1621 </tr>
1622
1623 <tr>
1624 <td><b>offset</b></td>
1625
1626 <td align="center">2</td>
1627
1628 <td>Numeric</td>
1629
1630 <td>offset to the start of the bookmark data (counting from the beginning
1631 of the record)</td>
1632 </tr>
1633
1634 <tr BGCOLOR="#F0F0F0">
1635 <td><b>names</b></td>
1636
1637 <td align="center">variable size</td>
1638
1639 <td>String sequence</td>
1640
1641 <td>A concatenated sequence of NUL-terminated strings, each a bookmark name</td>
1642 </tr>
1643
1644 <tr>
1645 <td><b>bookmark data</b></td>
1646
1647 <td align="center">4*bookmarks</td>
1648
1649 <td>Bookmark Data</td>
1650
1651 <td>block of data for the location of the external bookmarks (see below)</td>
1652 </tr>
1653
1654 </table>
1655
1656 <p>
1657 The bookmark data is a series of uid/offset pairs.</p>
1658
1659 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
1660 <tr BGCOLOR="#99CCCC">
1661 <td><b><font color="#000000">Field</font></b></td>
1662 <td align="center"><b><font color="#000000">Bytes</font></b></td>
1663 <td><b><font color="#000000">Type</font></b></td>
1664 <td><b><font color="#000000">Notes</font></b></td>
1665 </tr>
1666
1667 <tr>
1668 <td><b>uid</b></td>
1669
1670 <td align="center">2</td>
1671
1672 <td>Numeric</td>
1673
1674 <td>unique ID for record</td>
1675 </tr>
1676
1677 <tr BGCOLOR="#F0F0F0">
1678 <td><b>offset</b></td>
1679
1680 <td align="center">2</td>
1681
1682 <td>Numeric</td>
1683
1684 <td>paragraph offset</td>
1685 </tr>
1686
1687 </table>
1688
1689 <p><HR width="60%" align=left><P>
1690 <H3><A NAME="default_category_dr">Default Category data records</A></h3>
1691 <p>Each Plucker document can be assigned to a number of named categories. This record stores the names of default categories for the document. The data consists of a concatenated series of NUL-terminated strings that
1692 should be used as the default category/categories for this document.</p>
1693
1694 <p><HR width="60%" align=left><P>
1695 <H3><A NAME="index_extension_dr">Metadata data records</A></h3>
1696 <p>There should only be one of these per document. This record begins with a two byte numeric value, giving the number of subrecords that follow, followed by that number of subrecords. The subrecords are a sequence of tagged variable length items. Each subrecord consists of three fields:
1697
1698 <P>
1699 <P><table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
1700 <tr BGCOLOR="#99CCCC">
1701 <td><b><font color="#000000">Field</font></b></td>
1702 <td align="center"><b><font color="#000000">Bytes</font></b></td>
1703 <td><b><font color="#000000">Type</font></b></td>
1704 <td><b><font color="#000000">Description</font></b></td>
1705 </tr>
1706
1707 <tr>
1708 <td><b>type code</b></td>
1709 <td align="center">2</td>
1710 <td>Numeric</td>
1711 <td>Specifies what piece of extra information is in this subrecord</td>
1712 </tr>
1713
1714 <tr>
1715 <td><b>length</b></td>
1716 <td align="center">2</td>
1717 <td>Numeric</td>
1718 <td>Number of 2-byte words in the <b>argument</b></td>
1719 </tr>
1720
1721 <tr>
1722 <td><b>argument</b></td>
1723 <td align="center">2 * <b>length</b></td>
1724 <td>(type code specific)</td>
1725 <td>Data</td>
1726 </tr>
1727
1728 </table>
1729
1730 <P>The following table describes the valid subrecord type codes, and describes the structure of the associated data for each subrecord type. Subrecords with unknown type codes should be ignored.
1731
1732 <P><table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
1733 <tr BGCOLOR="#99CCCC">
1734 <td><b><font color="#000000">Type code</font></b></td>
1735 <td><b><font color="#000000">Name</font></b></td>
1736 <td><b><font color="#000000">Description</font></b></td>
1737 <td><b><font color="#000000">Argument</font></b></td>
1738 </tr>
1739
1740 <tr>
1741 <td align="center">1</td>
1742 <td><b>CharSet</b></td>
1743 <td>This is the character set and encoding used by text records in this document, unless otherwise specified for particular records.</td>
1744 <td>a two-byte numeric value, specifying the IETF IANA MIBenum value for the character set. See <a href="http://www.iana.org/assignments/character-sets">the IANA registry of character sets</a> for valid values.</td>
1745 </tr>
1746
1747 <tr>
1748 <td align="center">2</td>
1749 <td><b>ExceptionalCharSets</b></td>
1750 <td>This is a list of text records which use a charset other than that specified by the default CharSet. Note that if no default CharSet is specified, the default charset should be thought of as "unknown".</td>
1751 <td>a sequence of (<b>length</b> / 2) record-ID, IANA-MIBenum pairs, where MIBenum values are as specified for <B>CharSet</B>. The invalid MIBenum value of 0 (zero) is used for records which have an unknown charset, if necessary.<br>
1752 <table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="100%" >
1753 <tr BGCOLOR="#BBDDDD">
1754 <td><b><font color="#000000">Field</font></b></td>
1755 <td align="center"><b><font color="#000000">Bytes</font></b></td>
1756 <td><b><font color="#000000">Type</font></b></td>
1757 <td><b><font color="#000000">Notes</font></b></td>
1758 </tr>
1759
1760 <tr>
1761 <td><b>record ID</b></td>
1762
1763 <td align="center">2</td>
1764
1765 <td>Numeric</td>
1766
1767 <td>unique ID for record</td>
1768 </tr>
1769
1770 <tr>
1771 <td><b>MIBenum</b></td>
1772
1773 <td align="center">2</td>
1774
1775 <td>Numeric</td>
1776
1777 <td>IANA MIBenum for the character set used in this record</td>
1778 </tr>
1779
1780 </table>
1781 </td>
1782 </tr>
1783
1784 <tr>
1785 <td align="center">3</td>
1786 <td><b>OwnerID</b></td>
1787 <td>This is the CRC-32 of the specified owner-id for the document, if any. Note that associating an owner-id with a document also affects the calculation of <a href="#compression">zlib compression</a>.</td>
1788 <td>a four-byte numeric value giving the CRC-32 of the owner-id string.</td>
1789 </tr>
1790
1791 <tr>
1792 <td align="center">4</td>
1793 <td><b>Author</b></td>
1794 <td>The name of the author of the document.</td>
1795 <td>A string value in the document's default character set, padded at the end with NUL characters to an even number of bytes.</td>
1796 </tr>
1797
1798 <tr>
1799 <td align="center">5</td>
1800 <td><b>Title</b></td>
1801 <td>The full title of the document.</td>
1802 <td>A string value in the document's default character set, padded at the end with NUL characters to an even number of bytes.</td>
1803 </tr>
1804
1805 <tr>
1806 <td align="center">6</td>
1807 <td><b>PublicationDate</b></td>
1808 <td>The date and time this document was created.</td>
1809 <td>A 4-byte unsigned integer giving the number of seconds from 12:00 AM on January 1, 1904, to the time when this document was created.</td>
1810 </tr>
1811
1812 <tr>
1813 <td align="center">7</td>
1814 <td><b>Linked Documents</b></td>
1815 <td>The list of external documents that this document links to.</td>
1816 <td>A concatenated sequence of NUL-terminated strings representing the document names for each external document linked to within this document. The string sequence should be padded at the end with NUL characters to an even number of bytes.</td>
1817 </tr>
1818
1819 </table>
1820
1821 <p><HR width="60%" align=left><P>
1822 <H3><A NAME="style_sheet_dr">Style Sheet data records</A></h3>
1823 <p>TBD</p>
1824
1825 <p><HR width="60%" align=left><P>
1826 <H3><A NAME="font_page_dr">Font Page data records</A></h3>
1827 <p>TBD</p>
1828
1829 <p><HR width="60%" align=left><P>
1830 <H3><A NAME="table_dr">Table data records</A></h3>
1831 <p>The Table Record describes an HTML table. It begins with a structure with the following format.</p>
1832
1833 <P><table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
1834 <tr BGCOLOR="#99CCCC">
1835 <td><b><font color="#000000">Field</font></b></td>
1836 <td align="center"><b><font color="#000000">Bytes</font></b></td>
1837 <td><b><font color="#000000">Type</font></b></td>
1838 <td><b><font color="#000000">Description</font></b></td>
1839 </tr>
1840
1841 <tr>
1842 <td><b>size</b></td>
1843 <td align="center">2</td>
1844 <td>Numeric</td>
1845 <td>Size of the following data</td>
1846 </tr>
1847
1848 <tr BGCOLOR="#F0F0F0">
1849 <td><b>columns</b></td>
1850 <td align="center">2</td>
1851 <td>Numeric</td>
1852 <td>Number of columns the table contains</td>
1853 </tr>
1854
1855 <tr>
1856 <td><b>rows</b></td>
1857 <td align="center">2</td>
1858 <td>Numeric</td>
1859 <td>Number of rows the table contains</td>
1860 </tr>
1861
1862 <tr BGCOLOR="#F0F0F0">
1863 <td><b>depth</b></td>
1864 <td align="center">1</td>
1865 <td>Numeric</td>
1866 <td>Bits per pixel (BPP) needed to render the table</td>
1867 </tr>
1868
1869 <tr>
1870 <td><b>border</b></td>
1871 <td align="center">1</td>
1872 <td>Numeric</td>
1873 <td>Draw table borders (0 = no, any other value = yes, 1 pixel wide)</td>
1874 </tr>
1875
1876 <tr BGCOLOR="#F0F0F0">
1877 <td><b>border color</b></td>
1878 <td align="center">4</td>
1879 <td>Numeric</td>
1880 <td>RGB value of border color</td>
1881 </tr>
1882
1883 <tr>
1884 <td><b>link color</b></td>
1885 <td align="center">4</td>
1886 <td>Numeric</td>
1887 <td>RGB value of link color</td>
1888 </tr>
1889
1890 </table>
1891
1892 <p>This is followed by table row and table cell functions (their ends are implied). Each table cell function is followed by 'text length' (from the function) text, containing text and/or formatting functions. (Such as links, style, underline, strike through, italic, etc.)</p>
1893
1894 <p><hr align="left" width="60%">
1895 <h3><a name="pagelist_dr">Page List Metadata data record</a></h3>
1896 <p>
1897 There should only be one of these per document. This record is used to assign the name and initial record associated with each page list in the document. Page lists are used to define the default ordering of pages within the document. More than one page list can be specified, which can be useful for defining tours through a document.
1898 </p>
1899
1900 <P><table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
1901 <tr BGCOLOR="#99CCCC">
1902 <td><b><font color="#000000">Field</font></b></td>
1903 <td align="center"><b><font color="#000000">Bytes</font></b></td>
1904 <td><b><font color="#000000">Type</font></b></td>
1905 <td><b><font color="#000000">Description</font></b></td>
1906 </tr>
1907
1908 <tr>
1909 <td><b>lists</b></td>
1910
1911 <td align="center">2</td>
1912
1913 <td>Numeric</td>
1914
1915 <td>The number of page lists or tours in the document.</td>
1916 </tr>
1917
1918 <tr>
1919 <td><b>first record</b></td>
1920
1921 <td align="center">2 * sequences</td>
1922
1923 <td>Numeric Array</td>
1924
1925 <td>An array of uids corresponding to the first record in each page sequence. The zero
1926 based index into this array represents the sequence id or tour id. The first entry should be
1927 considered the default page ordering for the document.</td>
1928 </tr>
1929
1930 <tr>
1931 <td><b>list name</b></td>
1932
1933 <td align="center">1+</td>
1934
1935 <td>String sequence</td>
1936
1937 <td>a concatenated sequence of NUL-terminated strings, each representing the name of a
1938 page list. The first entry in the list corresponds to the default page ordering. For
1939 unnamed page lists, a NUL character should still be specified.</td>
1940 </tr>
1941
1942 </table>
1943
1944 <p>Page lists can be thought of as linked lists of records. The first record field in the
1945 Page List Metadata record is equivalent to the head pointer of the list.
1946 Each text record contains a previous/next record pointer within it's navigation
1947 metadata.</p>
1948
1949 <p><hr align="left" width="60%">
1950 <h3><a name="sorted_url_handling_dr">Sorted URL Handling data record</a></h3>
1951 <p>
1952 The Sorted URL handling record is used to find the record ID of the Sorted URL data record
1953 containing data for a given URL string. It contains a series of 2 byte number pairs.
1954 </p>
1955
1956 <P><table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
1957 <tr BGCOLOR="#99CCCC">
1958 <td><b><font color="#000000">Field</font></b></td>
1959 <td align="center"><b><font color="#000000">Bytes</font></b></td>
1960 <td><b><font color="#000000">Type</font></b></td>
1961 <td><b><font color="#000000">Description</font></b></td>
1962 </tr>
1963
1964 <tr>
1965 <td><b>last URL</b></td>
1966
1967 <td align="center">2</td>
1968
1969 <td>Numeric</td>
1970
1971 <td>the ordinal number of the last URL in record</td>
1972 </tr>
1973
1974 <tr bgcolor="#f0f0f0">
1975 <td><b>id</b></td>
1976
1977 <td align="center">2</td>
1978
1979 <td>Numeric</td>
1980
1981 <td>record ID for record</td>
1982 </tr>
1983
1984 </table>
1985
1986 <p><hr align="left" width="60%">
1987
1988 <h3><a name="sorted_url_dr">Sorted URL data records</a></h3>
1989 <p>The sorted URL data record contains a list of URL/UID pointers sorted according to the
1990 lexicographical order of the URL strings pointed to by the url uid and
1991 url offset fields. This data is used in cross-document linking to
1992 facilitate a binary search of the URL strings in order to lookup the record ID
1993 for an incoming URL string. Only URLs for records actually contained in the document
1994 should be included in the Sorted URL data records. URLs for external
1995 records should be omitted.</p>
1996
1997 <P><table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
1998 <tr BGCOLOR="#99CCCC">
1999 <td><b><font color="#000000">Field</font></b></td>
2000 <td align="center"><b><font color="#000000">Bytes</font></b></td>
2001 <td><b><font color="#000000">Type</font></b></td>
2002 <td><b><font color="#000000">Description</font></b></td>
2003 </tr>
2004
2005 <tr>
2006 <td><b>url uid</b></td>
2007
2008 <td align="center">2</td>
2009
2010 <td>Numeric</td>
2011
2012 <td>unique ID for URL data record that contains the sorted URL string.</td>
2013 </tr>
2014
2015 <tr bgcolor="#f0f0f0">
2016 <td><b>url offset</b></td>
2017
2018 <td align="center">2</td>
2019
2020 <td>Numeric</td>
2021
2022 <td>byte offset of the first character of the sorted URL string in the URL data record.</td>
2023 </tr>
2024
2025 <tr>
2026 <td><b>record uid</b></td>
2027
2028 <td align="center">2</td>
2029
2030 <td>Numeric</td>
2031
2032 <td>unique ID of the text or image record that pertains to the sorted URL string.</td>
2033 </tr>
2034
2035 </table>
2036
2037 <p><hr align="left" width="60%">
2038
2039 <h3><a name="extanchor_handling_dr">External Anchor Name Handling data record</a></h3>
2040 <p>The External Anchor handling record is used to find the record ID of the External
2041 Anchor data record containing a given external anchor string. It contains a series of
2042 2 byte number pairs.
2043 </p>
2044
2045 <P><table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
2046 <tr BGCOLOR="#99CCCC">
2047 <td><b><font color="#000000">Field</font></b></td>
2048 <td align="center"><b><font color="#000000">Bytes</font></b></td>
2049 <td><b><font color="#000000">Type</font></b></td>
2050 <td><b><font color="#000000">Description</font></b></td>
2051 </tr>
2052
2053 <tr>
2054 <td><b>last anchor</b></td>
2055
2056 <td align="center">2</td>
2057
2058 <td>Numeric</td>
2059
2060 <td>the ordinal number of the last anchor in record</td>
2061 </tr>
2062
2063 <tr bgcolor="#f0f0f0">
2064 <td><b>id</b></td>
2065
2066 <td align="center">2</td>
2067
2068 <td>Numeric</td>
2069
2070 <td>record ID for record</td>
2071 </tr>
2072
2073 </table>
2074
2075 <p><hr align="left" width="60%">
2076
2077 <h3><a name="extanchor_dr">External Anchor Name data record</a></h3>
2078 <p>The External Anchor data record is a string table containing the unique names for all
2079 external anchor name strings referenced in this document. These strings
2080 are used to query the record specific anchor name tables in a target book to
2081 determine a paragraph offset for cross-document linking. This information is
2082 conceptually stored as a sequence of strings, where the position of the anchor
2083 name in the sequence corresponds to it's index.</p>
2084
2085 <P><table BORDER CELLSPACING=0 CELLPADDING=2 WIDTH="80%" >
2086 <tr BGCOLOR="#99CCCC">
2087 <td><b><font color="#000000">Field</font></b></td>
2088 <td align="center"><b><font color="#000000">Bytes</font></b></td>
2089 <td><b><font color="#000000">Type</font></b></td>
2090 <td><b><font color="#000000">Description</font></b></td>
2091 </tr>
2092
2093 <tr>
2094 <td><b>anchor name list</b></td>
2095
2096 <td align="center">1+</td>
2097
2098 <td>String sequence</td>
2099
2100 <td>a concatenated sequence of unique NUL-terminated strings, each representing an anchor
2101 name from an external link found within this document.</td>
2102 </tr>
2103
2104 </table>
2105
2106 <p>
2107 These records may or may not be compressed. This is indicated by the type in the header. These
2108 records are used in conjunction with the Sorted URL Data records and record specific anchor
2109 name tables to facilitate cross-document linking.</p>
2110
2111 <p><HR><P>
2112 <table BORDER=0 CELLSPACING=0 CELLPADDING=2 WIDTH="100%" BGCOLOR="#EEEEEE" >
2113 <tr>
2114 <td BGCOLOR="#EEEEEE"><font size=-2>&copy; Copyright 2000 Michael
2115 Nordstr&ouml;m
2116 &lt;<a href="mailto:[email protected]">[email protected]</a>&gt; &middot; Copyright 2001 Bill Janssen &lt;<a href="mailto:[email protected]">[email protected]</a></font></td>
2117
2118 <td ALIGN=RIGHT BGCOLOR="#EEEEEE"><font size=-2>$Id: DBFormat.html,v 1.27 2005/10/29 14:14:21 nordstrom Exp $</font></td>
2119 </tr>
2120 </table>
2121 </BODY>
2122 </HTML>