<?xml version="1.0"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Synopsis Examples</title>
<link type="text/css" rel="stylesheet" href="../synopsis.css"/>
</head>
<body>
<div class="navigation">
<div class="menu">
<p class="normal1"><a href="http://synopsis.fresco.org/index.html">Home</a></p>
<p class="normal1"><a href="http://synopsis.fresco.org/news.html">News</a></p>
<p class="normal1"><a href="http://synopsis.fresco.org/download/">Download</a></p>
<p class="normal1"><a href="../index.html">Docs</a></p>
<p class="normal2"><a href="../Tutorial/index.html">Tutorial</a></p>
<p class="selected2"><a href="index.html">Examples</a></p>
<p class="normal2"><a href="../DevGuide/index.html">DevGuide</a></p>
<p class="normal2"><a href="http://synopsis.fresco.org/docs/Manual/index.html">Manual</a></p>
<p class="normal2"><a href="http://synopsis.fresco.org/reading.html">Further Reading</a></p>
<p class="normal1"><a href="http://synopsis.fresco.org/issues/bug">Bugs</a></p>
<p class="normal1"><a href="http://synopsis.fresco.org/contact.html">Contact</a></p>
<p class="normal1"><a href="http://synopsis.fresco.org/issues/task">Tasks</a></p>
<p class="normal1"><a href="http://synopsis.fresco.org/code.html">Code</a></p>
</div>
<div class="modifiedby">
Last modified: 2006-11-30<br/>
by Stefan Seefeld
</div>
</div>
<div class="content">
<h1>Synopsis - Examples</h1>
<h2><a id="Diagrams"></a>Diagrams</h2>
<p>
<a href="Paths/diagrams/index.html">Here</a> are some examples of class- and
other diagrams synopsis can generate, with explanation
</p>
<h2><a id="html"></a>HTML</h2>
<h3>Default Settings</h3>
<p>
<a href="Paths/html/index.html">This</a> is an API reference generated with
the default HTML formatter settings. The sources include documentation in
different markup, such as <a href="http://docutils.sourceforge.net/rst.html">RestructuredText</a>, or
<a href="http://java.sun.com/j2se/1.5.0/docs/tooldocs/solaris/javadoc.html">Javadoc</a>.
</p>
<h3>No Frames</h3>
<p>
<a href="Paths/html-noframes/index.html">This</a> is the same HTML formatter, but without
<i>frames</i>.
</p>
<h3>Source Cross Reference</h3>
<p>
<a href="Paths/html-rich/index.html">This</a> is again the HTML formatter,
but customized a bit to also include source cross-referencing.
</p>
<h2><a id="sxr"></a>SXR</h2>
<p>
The Synopsis Cross-Reference tool allows to search for (type, variable, function,
and file) names by means of a CGI script. Please see the build instructions for
the <i>Paths/sxr</i> example for the required steps to start the <i>sxr-server</i>
tool. The Synopsis website uses this to navigate its own source code <a href="http://synopsis.fresco.org/sxr/">here</a>.
</p>
<h2><a id="docbook"></a>DocBook</h2>
<h3>Default Settings</h3>
<p><a href="Paths/docbook/Paths.xml">Paths.xml</a></p>
<h4>HTML</h4>
<p>
<a href="Paths/docbook/index.html">This</a> is a C++ API reference generated with
the default DocBook formatter settings, using the XHTML stylesheets from the
<a href="http://wiki.docbook.org/topic/DocBookXslStylesheets">xsl-docbook</a> package.
The sources include documentation in
different markup, such as <a href="http://docutils.sourceforge.net/rst.html">RestructuredText</a>, or
<a href="http://java.sun.com/j2se/1.5.0/docs/tooldocs/solaris/javadoc.html">Javadoc</a>.
</p>
<h4>PDF</h4>
<p>
<a href="Paths/docbook/Paths.pdf">This</a> is the same, but formatted as pdf using the FO stylesheets.
</p>
<h3>Alternative Settings</h3>
<h4>HTML</h4>
<p>
<a href="math/index.html">This</a> is a C API reference generated with
the default DocBook formatter settings, using the XHTML stylesheets from the
<a href="http://wiki.docbook.org/topic/DocBookXslStylesheets">xsl-docbook</a> package.
</p>
<!-- <h4>PDF</h4>
<p>
<a href="math/math.pdf">This</a> is the same, but formatted as pdf using the FO stylesheets.
</p> -->
<h2><a id="hybrid"></a>Hybrid IDL / C++ code</h2>
<p>
Synopsis is able to cross-reference two distinct Reference manuals, using
TOCs. Moreover, it is possible to map symbols across lanugage-boundaries.
This example shows an <a href="hybrid/interface/index.html">IDL interface</a> cross-referenced
with a <a href="hybrid/implementation/index.html">C++ implementation</a>.
</p>
</div>
</body>
</html>
