|
Please send all questions, problem reports, suggestions, appreciations
to DocSys.Support@cern.ch.
|
The SDLT are a set of generic format templates for the production
of software project documents, to be used in conjunction with separately
maintained content-only templates.
advantages
- Visual consistency across the various documents for a project can
be achieved in a manageable way, and requires the maintenance of only
one set of layout templates.
- Simplification of the production and maintenance of content-only
templates -- adding a template for a particular document type requires
only the creation of a content-only template, consisting only of content-specific
sample material.
- If a content-only template for a particular document type does not
yet exist, 3rd parties have the liberty and the means to add it, as
required by their project.
features
- FrameMaker book structure.
- Pre-defined formats for cover pages, front matter, table of contents,
automatically updated lists, chapters, appendices, and index.
- Comprehensive pre-defined formats for all typical software specification
documentation material.
- Customizable automatic generation of structured Webs.
- Single file version of template, convenient for the production of
short documents.
- Comprehensive user documentation.
Complete user documentation comes in the form of a user's guide that
is available in the following formats:
- HTML, for online use.
- PDF,
for printing (included in the distribution).
- Hard copy from outside 1-R-003.
Content templates specify such things as a detailed table of contents,
sample material and guidelines for a type of document. Additional instructions
how to use a content template with the SDLT are provided in a short
guide for the content template.
To add a content template, follow the instructions in the SDLT
User's Guide.
Currently, the following content templates are available:
- URD
- Distribution file:
urd-ctV1.0.tar
Guide:
urd-guide.pdf
under consideration
- Provide a simple mapping script that will map paragraph
and character tag names in the User Guide Templates to the SDLT.
15.01.1999 - Doris Burckhart
- Change figure, table, listing & equation numbering
from being accumulative across the document to be chapter dependent.
15.01.1999 - Arash Khodabandeh
- Provide a more refined CSS master file, to improve
generated HTML.
15.01.1999 - Mario Ruggier
- Add possibility to have chapter local table of contents,
as in the User Guide Templates.
01.02.1999 - Pere Mato
(Requires addition of one paragraph and one cross-reference format.)
- Provide recommendations for naming of chapter files.
18.02.1999 - Stefano Paoli
implemented in version 2.0
- Provide external format files to be able to switch between
long and medium short versions of book document. E.g. in
a medium short document, chapters may not necessarily start at top
of right page.
15.01.1999 - Mario Ruggier
- Provide a single-file version of layout templates
for very short documents (few pages, no TOC & index).
15.01.1999 - Mario Ruggier
- Change style of main chapter headings to something
with more weight and importance.
01.02.1999 - Pere Mato
- By default, generate a new HTML file only for H1's, instead of H2's,
06.02.1999 - Pere Mato
- Lock the delivered TOC file for hypertext.
17.02.1999 - Renaud Barillere
- Make the inside cover sentence consistent between printed
and HTML versions
18.02.1999 - Mario Ruggier
- Allow also H1 headings to be included in the automatically generated
list of items.
18.02.1999 - Stefano Paoli
- Consider making para and char tags that are intended for code type
content to have language set to "None", so that the spellchecker does
not check them. (A char tag "NoSpellCheck" exists already.)
06.05.1999 - Mario Ruggier
Distribution (Version 2.0, 5 July 1999)
The full distribution package includes template files for a FrameMaker
book templates, a single file template, a complete guide in PDF, plus
other supporting files. Please read the user's guide.
The complete distribution UNIX tar file:
The following 2 UNIX component tar files are included as convenient
starting points for book documents and single file documents, respectively:
Once you download you can unpack this archive file with WinZip (Windows),
Expander (Macintosh) or, for UNIX systems, with the command:
tar xvf SDLT-V2.0-FM5.tar
Distribution (Version 2.1 - 16 July 2001)
The full distribution package includes template files for a FrameMaker
book templates, a single file template, a complete guide in PDF, plus
other supporting files. Please read the user's guide.
The complete distribution UNIX tar file:
The following 2 UNIX component tar files are included as convenient
starting points for book documents and single file documents, respectively:
Once you download you can unpack this archive file with WinZip (Windows),
Expander (Macintosh) or, for UNIX systems, with the command:
tar xvf SDLT-V2.1.tar
Procedure to start working with the book template
Download the template
Download the SDLT book requested tar file and save it as sdltbook.tar
(or sdltbook.tar).
Untar the template (UNIX)
> tar xvf sdltbook.tar (or sdltbook.tar)
This creates a subdirectory called sdltbook/ directory with all the
template files in it.
Get the needed files (UNIX)
> mv sdltbook/*.fm ./
> mv sdltbook/*.bk ./
> mv sdltbook/*.css ./
Rename the template files to match the new document name (in
FrameMaker)
Open sdlt.bk (or sdlt.book) with FrameMaker.
Accept any conversion to newer FrameMaker version
Open shift + File > Open All Files in Book
Accept any conversion to newer FrameMaker version
Open shift + File > Save All Files in Book
Open shift + File > Close All Files in Book
Open File > Save Book As...
Save the template with your own filename
Click Save
Rename the template generated files to match the new document name
(UNIX)
> mv sdltTOC.fm <your_filename>TOC.fm
> mv sdltLOF.fm <your_filename>LOF.fm
> mv sdltLOT.fm <your_filename>LOT.fm
> mv sdltLOL.fm <your_filename>LOL.fm
> mv sdltLOI.fm <your_filename>LOI.fm
> mv sdltIX.fm <your_filename>IX.fm
Update the book file and save (in FrameMaker)
Open Edit > Update Book...
Click Update
Click Continue for any View-Only File In Book alert message.
|
