SDLT Single File Template | |
---|---|
European Laboratory for Particle Physics
Laboratoire Européen pour la Physique des Particules
CH-1211 Genève 23 - Suisse
This is an Adobe FrameMaker 5.5 template file to be used for fairly short technical documents, i.e. up to 10 pages. This template is the single file version of the the SDLT multi-file book template package, i.e. it contains the same book-independent format definitions.
For short technical documents, that do not require a table of contents or an index, a single file template is more convenient to use than a multi-file book template package. And, with the set of predefined formats being mostly the same in both templates, you as an author have less to learn to be able to use both templates. Sharing the same predefined formats also facilitates the exchange of content between documents prepared in either of the two templates.
To...
|
Do..
|
More info...
|
---|---|---|
|
||
|
|
|
|
||
The title block consists of a special sequence of paragraphs, each containing a similarly-named user variable (or a piece of document metadata ). To edit you should only modify the value of these metadata variables. You can do this in either of the 2 ways:
The title block paragraphs used in this template sample are only a few of the ones defined here. Feel free to include others, e.g. DocID and DocIssue , or to exclude any that you feel are not appropriate. For a complete list and description of all title block paragraphs, please see the "Cover page" section of the chapter "Editing the front matter", in the SDLT manual.
Warning
!
Do not replace the metadata user variables with text!
The simple general way to create a figure, a table or a listing is to:
The Paranum cross-reference format is used for cross-references to a caption of a figure, table or listing.
For complete documentation on formatting figures, tables and listings, please see the corresponding sections in the chapter "Laying out the content", of the Guide for using the Software Documentation Layout Templates .
Warning
!
Due to limitations (and bugs!) in the
Save as... HTML
feature of FrameMaker 5.5.6,
please
follow
exactly
the following steps to convert your document to HTML.
html
.
SDLT-master.css
over the
.css
file generated by FrameMaker for your HTML document. To customize the generated HTML...
This template has includes the mostly the same formats of the front matter, chapter, and appendix templates of the SDLT book template package. The only difference is that all formats are rolled into the same file, and that things relevant only to long documents are removed.
All the predefined format tag names are the same in both templates. Thus it is very easy to exchange content back and forth between this single file template and the SDLT multi-file book template, as follows:
Re-applying formats is necessary because, although all the tag names of the predefined formats are the same in both templates, some of the format themselves are different.
This document has been prepared using the SDLT Single File Template that have been prepared by the IPT Group (Information, Process and Technology), IT Division, CERN (The European Laboratory for Particle Physics). For more information, go to http://framemaker.cern.ch/.
5 July 1999 - WebMaster | Copyright © CERN |