The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
<!doctype html public "-//W30//DTD W3 HTML 2.0//EN">

<HTML>

<!-- This file was generated using SDF 2.001 by
     Ian Clatworthy (ianc@mincom.com). SDF is freely
     available from http://www.mincom.com/mtr/sdf. -->

<HEAD>
<TITLE>SDF 2.001: SDF Reference: title Filter</TITLE>
</HEAD>
<BODY BGCOLOR="ffffff">

<DIV CLASS="header">
<P><IMG SRC="../sdflogo.gif" ALIGN="Right"></P>
<DIV CLASS="navigate">
<P ALIGN="Center"><A HREF="re_sdf.html">Contents</A> | <A HREF="in_filt.html">Parent Topic</A> | <A HREF="ftable.html">Previous Topic</A> | <A HREF="ftopics.html">Next Topic</A> <BR><A HREF="../index.html">Home</A> | <A HREF="../catalog.html">Catalog</A></P>
</DIV>
<BR CLEAR="Right">
</DIV>
<DIV CLASS="main">
<H1>5.32. title Filter</H1>
<HR>
<H2><A NAME="Interface">Interface</A></H2>
<P>The general syntax is:</P>
<PRE>
  !block <STRONG>title</STRONG>[; parameters]
  ...
  !endblock
</PRE>
<P>The parameters are:</P>
<TABLE CLASS="columns" BORDER>
<TR CLASS="heading">
<TD>
<STRONG>Name</STRONG>
</TD>
<TD>
<STRONG>Type</STRONG>
</TD>
<TD>
<STRONG>Rule</STRONG>
</TD>
</TR>
<TR>
<TD>
type
</TD>
<TD>
string
</TD>
<TD>
&nbsp;
</TD>
</TR>
<TR>
<TD>
toc
</TD>
<TD>
integer
</TD>
<TD>
&nbsp;
</TD>
</TR>
<TR>
<TD>
format
</TD>
<TD>
string
</TD>
<TD>
&nbsp;
</TD>
</TR>
</TABLE>

<P>See <A HREF="in_filif.html">Understanding Filter Interfaces</A>, if necessary.</P>
<HR>
<H2><A NAME="Description">Description</A></H2>
<P>The <EM>title</EM> filter is used to build the title block for memos, faxes, etc.</P>
<P>The <EM>type</EM> parameter can be used to override the document type. For PostScript output, the value is displayed in a box above the rest of the title.</P>
<P>The <EM>toc</EM> parameter is used to request a table of contents. The value is the level of headings to include in the contents.</P>
<P>The <EM>format</EM> attribute is used to fine tune the layout of the columns within the table for format where a table is used (e.g. plain text).</P>
<HR>
<H2><A NAME="Examples">Examples</A></H2>
<PRE>
<B>!block</B> title
Name        Value
Date:       [[DATE:DOC_MODIFIED]]
To:         Joe Bloggs, Sue Brown, Maree Jones
Copy:       David Smith
From:       Neil Armstrong
Subject:    Solar System Information
Ref. No:    XY.002/GUI/96
<B>!endblock</B>
</PRE>
</DIV>
<DIV CLASS="footer">
<DIV CLASS="navigate">
<P ALIGN="Center"><A HREF="re_sdf.html">Contents</A> | <A HREF="in_filt.html">Parent Topic</A> | <A HREF="ftable.html">Previous Topic</A> | <A HREF="ftopics.html">Next Topic</A> <BR><A HREF="../index.html">Home</A> | <A HREF="../catalog.html">Catalog</A></P>
</DIV>
</DIV>

</BODY>
</HTML>