--- projects/cms/documentation/specification/doc_spec.txt 2000/10/25 18:16:30 1.1 +++ projects/cms/documentation/specification/doc_spec.txt 2004/08/01 10:39:55 1.5 @@ -1,8 +1,11 @@ Document Specification ====================== +ajm4, 08/03/2001 pjm2, 19/10/2000 +Electronic Standard +------------------- Standards to adhere to: - @@ -15,9 +18,79 @@ Standards to adhere to: - This is to prevent problems when the file is included as the contents on an SHTML page. + NOTE: The previous point has been relaxed slightly, + as it made it a bit difficult to display XML tags. + All documents may now include HTML-style markup, but + please note that such markup will be displayed on the + i-scream.org website as written. + 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. \ No newline at end of file + 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
and are Word fields +and should NOT be manually changed. Instead they should be +changed by click File->Properties, where: + + "Title" ->
+ "Subject" -> + +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.