documentation/specification/doc_spec.txt

Document Specification
======================

ajm4, 08/03/2001
pjm2, 19/10/2000

Electronic Standard
-------------------

Standards to adhere to: -

    All documents must be saved as plain text with no more
    than 60 characters per line.

    Documents must be saved with a '.txt' file extension.

    The text file must not contain any HTML tags.
    This is to prevent problems when the file is included
    as the contents on an SHTML page.


Other issues

    If possible, please save the text files in 'Windows'
    format, such that each line is separated by a return
    and also a linefeed character.
    
Publication Standard
--------------------

All documents must use the Word template file that can be
found in CVS:

    CVSROOT:/documentation/i-scream-template.dot

To make use of this template you must set the following.
Click Tools->Options->File Locations and modify the path
of your "Workgroup Templates" to be CVSROOT:/documentation

This should then mean to start a new document, simply click
File->New... and choose the i-scream-template.

1)
The tags <SECTION NAME> and <DOCUMENT NAME> are Word fields
and should NOT be manually changed.  Instead they should be
changed by click File->Properties, where:

    "Title" -> <SECTION NAME>
    "Subject" -> <DOCUMENT NAME>
    
The "Title" and "Subject" fields should be used in ALL areas
where the name of the section or document are needed.

(note, any changes to fields like this must be followed by
 an update of the fields in the document.  To do this, click
 Edit->Select All, then hit F9)

2)
All text should make use of "Styles".  There should be NO
hardcoded text formatting in the document.  If you wish to
change the appearance of a specific style you should change
the document template only.

3)
No changes should be made to the layout of the opening page,
the header or the footer.  Again, all changes should be made
to the template only.

4)
All major changes to a document must have a full revision
entry on the opening page.  This change must also be
verified by a nominated member of the team.

5)
The table of contents must be the first page after the
opening page (including any revsion history).  This should
also NOT be manually edited for a specific document and
again, all changes should be made in the template file ONLY.

Notes :-

To ensure your document is using the latest template, update
CVS and check click Tools->Templates and Add-ins for
information about the attached template.  This should ensure
that all the latest template changes are applied to your
document.  In theory it should just work, but its unclear.

All the above has been tried with Word 2000 *only* some
testing will need to be done to ensure that it is compatible
with Word 97.
Revision:	1.3
Committed:	Thu Mar 8 01:26:43 2001 UTC (23 years, 8 months ago) by ajm
Content type:	text/plain
Branch:	MAIN
Changes since 1.2:	+15 -3 lines
Log Message:	Updates on how to use the template.
#	Content
1	Document Specification
2	======================
3
4	ajm4, 08/03/2001
5	pjm2, 19/10/2000
6
7	Electronic Standard
8	-------------------
9
10	Standards to adhere to: -
11
12	All documents must be saved as plain text with no more
13	than 60 characters per line.
14
15	Documents must be saved with a '.txt' file extension.
16
17	The text file must not contain any HTML tags.
18	This is to prevent problems when the file is included
19	as the contents on an SHTML page.
20
21
22	Other issues
23
24	If possible, please save the text files in 'Windows'
25	format, such that each line is separated by a return
26	and also a linefeed character.
27
28	Publication Standard
29	--------------------
30
31	All documents must use the Word template file that can be
32	found in CVS:
33
34	CVSROOT:/documentation/i-scream-template.dot
35
36	To make use of this template you must set the following.
37	Click Tools->Options->File Locations and modify the path
38	of your "Workgroup Templates" to be CVSROOT:/documentation
39
40	This should then mean to start a new document, simply click
41	File->New... and choose the i-scream-template.
42
43	1)
44	The tags <SECTION NAME> and <DOCUMENT NAME> are Word fields
45	and should NOT be manually changed. Instead they should be
46	changed by click File->Properties, where:
47
48	"Title" -> <SECTION NAME>
49	"Subject" -> <DOCUMENT NAME>
50
51	The "Title" and "Subject" fields should be used in ALL areas
52	where the name of the section or document are needed.
53
54	(note, any changes to fields like this must be followed by
55	an update of the fields in the document. To do this, click
56	Edit->Select All, then hit F9)
57
58	2)
59	All text should make use of "Styles". There should be NO
60	hardcoded text formatting in the document. If you wish to
61	change the appearance of a specific style you should change
62	the document template only.
63
64	3)
65	No changes should be made to the layout of the opening page,
66	the header or the footer. Again, all changes should be made
67	to the template only.
68
69	4)
70	All major changes to a document must have a full revision
71	entry on the opening page. This change must also be
72	verified by a nominated member of the team.
73
74	5)
75	The table of contents must be the first page after the
76	opening page (including any revsion history). This should
77	also NOT be manually edited for a specific document and
78	again, all changes should be made in the template file ONLY.
79
80	Notes :-
81
82	To ensure your document is using the latest template, update
83	CVS and check click Tools->Templates and Add-ins for
84	information about the attached template. This should ensure
85	that all the latest template changes are applied to your
86	document. In theory it should just work, but its unclear.
87
88	All the above has been tried with Word 2000 only some
89	testing will need to be done to ensure that it is compatible
90	with Word 97.