Home » Archimedes archive » Acorn User » AU 1994-10.adf » !Home_HomeWorks » TagFormat

TagFormat

This website contains an archive of files for the Acorn Electron, BBC Micro, Acorn Archimedes, Commodore 16 and Commodore 64 computers, which Dominic Ford has rescued from his private collection of floppy disks and cassettes.

Some of these files were originally commercial releases in the 1980s and 1990s, but they are now widely available online. I assume that copyright over them is no longer being asserted. If you own the copyright and would like files to be removed, please contact me.

Tape/disk: Home » Archimedes archive » Acorn User » AU 1994-10.adf » !Home_HomeWorks
Filename: TagFormat
Read OK:
File size: 055A bytes
Load address: 0000
Exec address: 0000
File contents
HomeWorks Document Designer Tag File Format
-------------------------------------------

Text which is imported and exported to and from HomeWorks can contain
style information, in the form of 'tags' in the file. This text file
describes the file format in version 1.00 of the Document Designer.

Tag files can contain any non-control characters (i.e. keyboard
characters), as well as special code sequences to change text styles. The
code sequence to turn a style on is:
   @StyleName:
where StyleName is the name of the style, such as Sub-Heading or Italic.

The default style is Normal, and styles take effect from the @ command
until a new style is implemented with another @ command. So, the
following at the start of a tag file:

   This is some text which @Italic:goes into italics and @Normal:then
   goes back to normal

would show all of the text in Normal style, except for the portion 'goes
into italics and ' which would be in Italic style.

There are two special characters which cannot be entered directly, namely
'@' and '<'. These can be entered into the tag file using <\@> and <\<>
so you would enter the line:

   Five is < Six

as follows in the tag file:

   Five is <\<> Six

An example tag file is included on this disc, called 'TagExample'. This
should be loaded into the default document to show the Heading and
Sub-Heading styles in operation.
00000000  48 6f 6d 65 57 6f 72 6b  73 20 44 6f 63 75 6d 65  |HomeWorks Docume|
00000010  6e 74 20 44 65 73 69 67  6e 65 72 20 54 61 67 20  |nt Designer Tag |
00000020  46 69 6c 65 20 46 6f 72  6d 61 74 0a 2d 2d 2d 2d  |File Format.----|
00000030  2d 2d 2d 2d 2d 2d 2d 2d  2d 2d 2d 2d 2d 2d 2d 2d  |----------------|
*
00000050  2d 2d 2d 2d 2d 2d 2d 0a  0a 54 65 78 74 20 77 68  |-------..Text wh|
00000060  69 63 68 20 69 73 20 69  6d 70 6f 72 74 65 64 20  |ich is imported |
00000070  61 6e 64 20 65 78 70 6f  72 74 65 64 20 74 6f 20  |and exported to |
00000080  61 6e 64 20 66 72 6f 6d  20 48 6f 6d 65 57 6f 72  |and from HomeWor|
00000090  6b 73 20 63 61 6e 20 63  6f 6e 74 61 69 6e 0a 73  |ks can contain.s|
000000a0  74 79 6c 65 20 69 6e 66  6f 72 6d 61 74 69 6f 6e  |tyle information|
000000b0  2c 20 69 6e 20 74 68 65  20 66 6f 72 6d 20 6f 66  |, in the form of|
000000c0  20 27 74 61 67 73 27 20  69 6e 20 74 68 65 20 66  | 'tags' in the f|
000000d0  69 6c 65 2e 20 54 68 69  73 20 74 65 78 74 20 66  |ile. This text f|
000000e0  69 6c 65 0a 64 65 73 63  72 69 62 65 73 20 74 68  |ile.describes th|
000000f0  65 20 66 69 6c 65 20 66  6f 72 6d 61 74 20 69 6e  |e file format in|
00000100  20 76 65 72 73 69 6f 6e  20 31 2e 30 30 20 6f 66  | version 1.00 of|
00000110  20 74 68 65 20 44 6f 63  75 6d 65 6e 74 20 44 65  | the Document De|
00000120  73 69 67 6e 65 72 2e 0a  0a 54 61 67 20 66 69 6c  |signer...Tag fil|
00000130  65 73 20 63 61 6e 20 63  6f 6e 74 61 69 6e 20 61  |es can contain a|
00000140  6e 79 20 6e 6f 6e 2d 63  6f 6e 74 72 6f 6c 20 63  |ny non-control c|
00000150  68 61 72 61 63 74 65 72  73 20 28 69 2e 65 2e 20  |haracters (i.e. |
00000160  6b 65 79 62 6f 61 72 64  0a 63 68 61 72 61 63 74  |keyboard.charact|
00000170  65 72 73 29 2c 20 61 73  20 77 65 6c 6c 20 61 73  |ers), as well as|
00000180  20 73 70 65 63 69 61 6c  20 63 6f 64 65 20 73 65  | special code se|
00000190  71 75 65 6e 63 65 73 20  74 6f 20 63 68 61 6e 67  |quences to chang|
000001a0  65 20 74 65 78 74 20 73  74 79 6c 65 73 2e 20 54  |e text styles. T|
000001b0  68 65 0a 63 6f 64 65 20  73 65 71 75 65 6e 63 65  |he.code sequence|
000001c0  20 74 6f 20 74 75 72 6e  20 61 20 73 74 79 6c 65  | to turn a style|
000001d0  20 6f 6e 20 69 73 3a 0a  20 20 20 40 53 74 79 6c  | on is:.   @Styl|
000001e0  65 4e 61 6d 65 3a 0a 77  68 65 72 65 20 53 74 79  |eName:.where Sty|
000001f0  6c 65 4e 61 6d 65 20 69  73 20 74 68 65 20 6e 61  |leName is the na|
00000200  6d 65 20 6f 66 20 74 68  65 20 73 74 79 6c 65 2c  |me of the style,|
00000210  20 73 75 63 68 20 61 73  20 53 75 62 2d 48 65 61  | such as Sub-Hea|
00000220  64 69 6e 67 20 6f 72 20  49 74 61 6c 69 63 2e 0a  |ding or Italic..|
00000230  0a 54 68 65 20 64 65 66  61 75 6c 74 20 73 74 79  |.The default sty|
00000240  6c 65 20 69 73 20 4e 6f  72 6d 61 6c 2c 20 61 6e  |le is Normal, an|
00000250  64 20 73 74 79 6c 65 73  20 74 61 6b 65 20 65 66  |d styles take ef|
00000260  66 65 63 74 20 66 72 6f  6d 20 74 68 65 20 40 20  |fect from the @ |
00000270  63 6f 6d 6d 61 6e 64 0a  75 6e 74 69 6c 20 61 20  |command.until a |
00000280  6e 65 77 20 73 74 79 6c  65 20 69 73 20 69 6d 70  |new style is imp|
00000290  6c 65 6d 65 6e 74 65 64  20 77 69 74 68 20 61 6e  |lemented with an|
000002a0  6f 74 68 65 72 20 40 20  63 6f 6d 6d 61 6e 64 2e  |other @ command.|
000002b0  20 53 6f 2c 20 74 68 65  0a 66 6f 6c 6c 6f 77 69  | So, the.followi|
000002c0  6e 67 20 61 74 20 74 68  65 20 73 74 61 72 74 20  |ng at the start |
000002d0  6f 66 20 61 20 74 61 67  20 66 69 6c 65 3a 0a 0a  |of a tag file:..|
000002e0  20 20 20 54 68 69 73 20  69 73 20 73 6f 6d 65 20  |   This is some |
000002f0  74 65 78 74 20 77 68 69  63 68 20 40 49 74 61 6c  |text which @Ital|
00000300  69 63 3a 67 6f 65 73 20  69 6e 74 6f 20 69 74 61  |ic:goes into ita|
00000310  6c 69 63 73 20 61 6e 64  20 40 4e 6f 72 6d 61 6c  |lics and @Normal|
00000320  3a 74 68 65 6e 0a 20 20  20 67 6f 65 73 20 62 61  |:then.   goes ba|
00000330  63 6b 20 74 6f 20 6e 6f  72 6d 61 6c 0a 0a 77 6f  |ck to normal..wo|
00000340  75 6c 64 20 73 68 6f 77  20 61 6c 6c 20 6f 66 20  |uld show all of |
00000350  74 68 65 20 74 65 78 74  20 69 6e 20 4e 6f 72 6d  |the text in Norm|
00000360  61 6c 20 73 74 79 6c 65  2c 20 65 78 63 65 70 74  |al style, except|
00000370  20 66 6f 72 20 74 68 65  20 70 6f 72 74 69 6f 6e  | for the portion|
00000380  20 27 67 6f 65 73 0a 69  6e 74 6f 20 69 74 61 6c  | 'goes.into ital|
00000390  69 63 73 20 61 6e 64 20  27 20 77 68 69 63 68 20  |ics and ' which |
000003a0  77 6f 75 6c 64 20 62 65  20 69 6e 20 49 74 61 6c  |would be in Ital|
000003b0  69 63 20 73 74 79 6c 65  2e 0a 0a 54 68 65 72 65  |ic style...There|
000003c0  20 61 72 65 20 74 77 6f  20 73 70 65 63 69 61 6c  | are two special|
000003d0  20 63 68 61 72 61 63 74  65 72 73 20 77 68 69 63  | characters whic|
000003e0  68 20 63 61 6e 6e 6f 74  20 62 65 20 65 6e 74 65  |h cannot be ente|
000003f0  72 65 64 20 64 69 72 65  63 74 6c 79 2c 20 6e 61  |red directly, na|
00000400  6d 65 6c 79 0a 27 40 27  20 61 6e 64 20 27 3c 27  |mely.'@' and '<'|
00000410  2e 20 54 68 65 73 65 20  63 61 6e 20 62 65 20 65  |. These can be e|
00000420  6e 74 65 72 65 64 20 69  6e 74 6f 20 74 68 65 20  |ntered into the |
00000430  74 61 67 20 66 69 6c 65  20 75 73 69 6e 67 20 3c  |tag file using <|
00000440  5c 40 3e 20 61 6e 64 20  3c 5c 3c 3e 0a 73 6f 20  |\@> and <\<>.so |
00000450  79 6f 75 20 77 6f 75 6c  64 20 65 6e 74 65 72 20  |you would enter |
00000460  74 68 65 20 6c 69 6e 65  3a 0a 0a 20 20 20 46 69  |the line:..   Fi|
00000470  76 65 20 69 73 20 3c 20  53 69 78 0a 0a 61 73 20  |ve is < Six..as |
00000480  66 6f 6c 6c 6f 77 73 20  69 6e 20 74 68 65 20 74  |follows in the t|
00000490  61 67 20 66 69 6c 65 3a  0a 0a 20 20 20 46 69 76  |ag file:..   Fiv|
000004a0  65 20 69 73 20 3c 5c 3c  3e 20 53 69 78 0a 0a 41  |e is <\<> Six..A|
000004b0  6e 20 65 78 61 6d 70 6c  65 20 74 61 67 20 66 69  |n example tag fi|
000004c0  6c 65 20 69 73 20 69 6e  63 6c 75 64 65 64 20 6f  |le is included o|
000004d0  6e 20 74 68 69 73 20 64  69 73 63 2c 20 63 61 6c  |n this disc, cal|
000004e0  6c 65 64 20 27 54 61 67  45 78 61 6d 70 6c 65 27  |led 'TagExample'|
000004f0  2e 20 54 68 69 73 0a 73  68 6f 75 6c 64 20 62 65  |. This.should be|
00000500  20 6c 6f 61 64 65 64 20  69 6e 74 6f 20 74 68 65  | loaded into the|
00000510  20 64 65 66 61 75 6c 74  20 64 6f 63 75 6d 65 6e  | default documen|
00000520  74 20 74 6f 20 73 68 6f  77 20 74 68 65 20 48 65  |t to show the He|
00000530  61 64 69 6e 67 20 61 6e  64 0a 53 75 62 2d 48 65  |ading and.Sub-He|
00000540  61 64 69 6e 67 20 73 74  79 6c 65 73 20 69 6e 20  |ading styles in |
00000550  6f 70 65 72 61 74 69 6f  6e 2e                    |operation.|
0000055a