ViewVC Help
View File | Revision Log | Show Annotations | Revision Graph | Root Listing
root/i-scream/projects/cms/documentation/specification/doc_spec.txt
(Generate patch)

Comparing projects/cms/documentation/specification/doc_spec.txt (file contents):
Revision 1.2 by ajm, Thu Mar 8 00:32:15 2001 UTC vs.
Revision 1.5 by tdb, Sun Aug 1 10:39:55 2004 UTC

# Line 18 | Line 18 | Standards to adhere to: -
18      This is to prevent problems when the file is included
19      as the contents on an SHTML page.
20  
21 +    NOTE: The previous point has been relaxed slightly,
22 +    as it made it a bit difficult to display XML tags.
23 +    All documents may now include HTML-style markup, but
24 +    please note that such markup will be displayed on the
25 +    i-scream.org website as written.
26  
27 +
28   Other issues
29  
30      If possible, please save the text files in 'Windows'
# Line 33 | Line 39 | found in CVS:
39  
40      CVSROOT:/documentation/i-scream-template.dot
41  
42 + To make use of this template you must set the following.
43 + Click Tools->Options->File Locations and modify the path
44 + of your "Workgroup Templates" to be CVSROOT:/documentation
45 +
46 + This should then mean to start a new document, simply click
47 + File->New... and choose the i-scream-template.
48 +
49   1)
50   The tags <SECTION NAME> and <DOCUMENT NAME> are Word fields
51   and should NOT be manually changed.  Instead they should be
# Line 44 | Line 57 | changed by click File->Properties, where:
57   The "Title" and "Subject" fields should be used in ALL areas
58   where the name of the section or document are needed.
59  
60 + (note, any changes to fields like this must be followed by
61 + an update of the fields in the document.  To do this, click
62 + Edit->Select All, then hit F9)
63 +
64   2)
65   All text should make use of "Styles".  There should be NO
66   hardcoded text formatting in the document.  If you wish to
# Line 69 | Line 86 | again, all changes should be made in the template file
86   Notes :-
87  
88   To ensure your document is using the latest template, update
89 < CVS and click Tools->Templates and Add-ins then Attach. This
90 < should ensure that all the latest template changes are
91 < applied to your document.
89 > CVS and check click Tools->Templates and Add-ins for
90 > information about the attached template.  This should ensure
91 > that all the latest template changes are applied to your
92 > document.  In theory it should just work, but its unclear.
93  
94   All the above has been tried with Word 2000 *only* some
95   testing will need to be done to ensure that it is compatible
96 < with Word 97.
96 > with Word 97.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines