<!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 User Guide: Example Paragraphs</TITLE>
<STYLE TYPE="text/css">
<!--
.changed {background-color: teal}
.changed {background-color: teal}
.changed {background-color: teal}
.changed {background-color: teal}
.changed {background-color: teal}
.changed {background-color: teal}
.changed {background-color: teal}
.changed {background-color: teal}
.changed {background-color: teal}
.changed {background-color: teal}
.changed {background-color: teal}
.changed {background-color: teal}
.changed {background-color: teal}
.changed {background-color: teal}
.changed {background-color: teal}
.changed {background-color: teal}
.changed {background-color: teal}
.changed {background-color: teal}
.changed {background-color: teal}
-->
</STYLE>
</HEAD>
<BODY BGCOLOR="ffffff">
<DIV CLASS="header">
<P><IMG SRC="../sdflogo.gif" ALIGN="Right"></P>
<DIV CLASS="navigate">
<P ALIGN="Center"><A HREF="ug_sdf.html">Contents</A> | <A HREF="in_parag.html">Parent Topic</A> | <A HREF="in_hdg.html">Previous Topic</A> | <A HREF="in_lists.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>3.2. Example Paragraphs</H1>
<HR>
<H2><A NAME="Simple Examples">3.2.1. Simple Examples</A></H2>
<P>Example paragraphs are displayed in a fixed-width font (e.g. Courier). Unlike most other paragraphs, spaces and tabs immediately after the paragraph tag are not ignored in example paragraphs. The tags used are:</P>
<UL>
<LI>E - fixed-width text
<LI>V - verbatim, fixed-width text (embedded symbols are ignored).</UL>
<P>For example:</P>
<PRE>
E:# {{Greeting}} outputs a friendly greeting.
E:sub Greeting {
E: print "Hello world\n";
E:}
</PRE>
<P>The result is:</P>
<PRE>
# <EM>Greeting</EM> outputs a friendly greeting.
sub Greeting {
print "Hello world\n";
}
</PRE>
<HR>
<H2><A NAME="Shorthand Notation">3.2.2. Shorthand Notation</A></H2>
<P>As verbatim, fixed-width text is very common in software documentation, ">" is provided as a shorthand for "V:". For example:</P>
<PRE>
># {{Greeting}} outputs a friendly greeting.
>sub Greeting {
> print "Hello world\n";
>}
</PRE>
<P>The result is:</P>
<PRE>
# {{Greeting}} outputs a friendly greeting.
sub Greeting {
print "Hello world\n";
}
</PRE>
<HR>
<H2><A NAME="Large Examples">3.2.3. Large Examples</A></H2>
<P>Large examples are usually defined using the <EM>example</EM> or <EM>verbatim</EM> filters like this:</P>
<PRE>
!block example
# {{Greeting}} outputs a friendly greeting.
sub Greeting {
print "Hello world\n";
}
!endblock
</PRE>
<HR>
<H2><A NAME="Wide Examples">3.2.4. Wide Examples</A></H2>
<P>If an example block has unwanted line breaks, the <EM>wide</EM> parameter should be specified. Wide examples use a wider text area (and a smaller font, if necessary) so that 80 characters can fit onto each line. For example:</P>
<PRE>
!block example; wide
sub SaveTheWorld { # This routine provides world peace
local($param1, param2) = @_; # Input parameters
# Do the work
# ...
}
!endblock
</PRE>
<P>The result is:</P>
<PRE>
sub SaveTheWorld { # This routine provides world peace
local($param1, param2) = @_; # Input parameters
# Do the work
# ...
}
</PRE>
<HR>
<H2><A NAME="Formatting Source Code">3.2.5. Formatting Source Code</A></H2>
<P>Blocks of source code can be nicely formatted via the <EM>lang</EM> parameter to the <A HREF="../ref/fexample.html">example</A> filter. For example:</P>
<PRE>
!block example; lang='Perl'
sub hello {
local($planet) = @_;
# Output a nice message
print "hello $planet!\n";
}
!endblock
</PRE>
<P>The result is:</P>
<PRE>
<B>sub</B> hello {
<B>local</B>($planet) = @_;
<I># Output a nice message</I>
<B>print</B> <TT>"hello $planet!\n"</TT>;
}
</PRE>
<P>For convenience, if a programming language is used as a filter (and a filter of that name doesn't exist), SDF implicitly calls the example filter for you with the relevant lang parameter.</P>
<P>There is built-in support for numerous languages including <A HREF="http://www.perl.com/perl/index.html">Perl</A>, C, C++, <A HREF="http://java.sun.com/">Java</A>, <A HREF="http://www.borland.com/Product/Lang/delphi2/">Delphi</A>, CORBA IDL and shell. New language definitions can be easily added (<CMD>vgrind</CMD> definitions are used).</P>
<HR>
<H2><A NAME="File Pretty Printing">3.2.6. File Pretty Printing</A></H2>
<P>Pretty printing of source code files is directly supported by <A HREF="../ref/sdf.html">sdf</A>'s -P option. For example:</P>
<PRE>
sdf -2ps -Psh myscript
sdf -2ps -P myapp.c
sdf -2ps -P -n5 mylib.pl
</PRE>
<P>The language to use can be specified as a parameter. The default language is derived from the extension of the file. The -n option adds line numbers at the frequency given. The default frequency is 1. i.e. every line.</P>
</DIV>
<DIV CLASS="footer">
<DIV CLASS="navigate">
<P ALIGN="Center"><A HREF="ug_sdf.html">Contents</A> | <A HREF="in_parag.html">Parent Topic</A> | <A HREF="in_hdg.html">Previous Topic</A> | <A HREF="in_lists.html">Next Topic</A> <BR><A HREF="../index.html">Home</A> | <A HREF="../catalog.html">Catalog</A></P>
</DIV>
</DIV>
</BODY>
</HTML>