[Synopsis-changes] Synopsis/Synopsis/doc/Tutorial Tutorial.xml,NONE,1.1 Makefile,1.7,1.8 index.html,1.3,1.4

Wed Nov 26 06:11:54 UTC 2003

Update of /cvs/synopsis/Synopsis/doc/Tutorial
In directory frida:/tmp/cvs-serv11295/doc/Tutorial

Modified Files:
	Makefile index.html 
Added Files:
	Tutorial.xml 
Log Message:
more work on document generation

--- NEW FILE: Tutorial.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<book>
  <bookinfo>
    <title>Synopsis Tutorial</title>

    <releaseinfo>Version 0.1</releaseinfo>

    <author>
      <firstname>Stefan</firstname>

      <surname>Seefeld</surname>
    </author>
  </bookinfo>

  <chapter>
    <title>Introduction</title>

    <section>
      <title>Inspecting code</title>
      <!-- Talk about the problem domain:
         code documentation, software metrics, etc. -->
      <para></para>
    </section>

    <section>
      <title>The Abstract Syntax Tree</title>
      <!-- Talk about source code and its representation
         inside synopsis -->

      <para></para>
    </section>

    <section>
      <title>The synopsis processing pipeline</title>
      <!-- Talk about AST manipulation as done 
         in synopsis -->

      <para></para>
    </section>

    <section>
      <title>The synopsis executable</title>
      <!-- Talk about the simplest frontend, the
         synopsis executable: basic usage, options, etc. -->

      <para></para>
    </section>
  </chapter>

  <chapter>
    <title>Writing a processing pipeline</title>
      <!-- When the synopsis executable isn't
           powerful enough... -->

    <para></para>

    <section>
      <title>The Processor class</title>
      <!-- Talk about the Processor class design -->

      <para></para>
    </section>

    <section>
      <title>Parameters and the order of initialization</title>
      <!-- Talk about the Parameter setting for processors and
           other 'Parametrized' -->

      <para></para>
    </section>

    <section>
      <title></title>

      <para></para>
    </section>
  </chapter>
</book>
Index: Makefile
===================================================================
RCS file: /cvs/synopsis/Synopsis/doc/Tutorial/Makefile,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -p -d -r1.7 -r1.8
--- Makefile	24 Mar 2003 08:30:34 -0000	1.7
+++ Makefile	26 Nov 2003 06:11:51 -0000	1.8
@@ -1,37 +1,21 @@
-# Compile Synopsis manual using docbook-utils (Jade or OpenJade wrappers)
-
-SYNOPSIS	:= ../../bin/synopsis
+srcdir	:= .
 
-XMLFILES	:= synopsis.xml
+vpath Tutorial.xml $(srcdir)
 
-.PHONY:	all html pdf clean
+all: html pdf
 
-all:	html pdf
+html: Tutorial.xml
+	mkdir -p $@
+	cp $(srcdir)/synopsis.css $@
+	xsltproc --novalid -o $@/ $(srcdir)/html.xsl $^
 
-html:	html/index.html
+pdf: Tutorial.pdf
 
-pdf:	synopsis-user.pdf
+Tutorial.pdf: Tutorial.xml
+	docbook2pdf $^
 
 clean:
-	rm -rf html *.pdf
-
-config.xml:	../../Synopsis/Config.py
-	$(SYNOPSIS) -p Python -Wp,-b,../../Synopsis/ -Wl,-p,javatags -f DocBook -Wf,-d,-m -o config.xml ../../Synopsis/Config.py.in
-
-# The following rules use xsltproc (specifically the xmlto wrapper)
-
-html/index.html:	$(XMLFILES)
-	xmlto --skip-validation -o html -m synopsis-html.xsl html synopsis.xml && \
-	    cp synopsis-html.css bg.png html/
 
-#synopsis.pdf:	$(XMLFILES)
-#	xmlto pdf synopsis.xml
+distclean: clean
+	rm -rf html Tutorial.pdf
 
-## The following rules use Jade (specifically the docbook2 wrapper)
-#
-#html/index.html:	$(XMLFILES)
-#	docbook2html -o html synopsis.xml
-#
-synopsis-user.pdf:	$(XMLFILES)
-	docbook2pdf synopsis.xml && \
-	mv synopsis.pdf $@

Index: index.html
===================================================================
RCS file: /cvs/synopsis/Synopsis/doc/Tutorial/index.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -p -d -r1.3 -r1.4
--- index.html	20 Nov 2003 04:48:17 -0000	1.3
+++ index.html	26 Nov 2003 06:11:51 -0000	1.4
@@ -1,54 +1 @@
-<?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 Home</title>
-    <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"/>
-    <link type="text/css" rel="stylesheet" href="../synopsis.css"/>
-  </head>
-  <body>
-    <h1>Synopsis - Tutorial</h1>
-    <table class="page">
-      <tr>
-        <td class="menu">
-          <table class="menu">
-            <tr><td class="normal1"><a href="/index.html">Home</a></td></tr>
-	    <tr><td class="normal1"><a href="/news.html">News</a></td></tr>
-	    <tr><td class="normal1"><a href="/docs.html">Docs</a></td></tr>
-            <tr><td class="normal2"><a href="/design.html">Design</a></td></tr>
-            <tr><td class="selected2"><a href="index.html">Tutorial</a></td></tr>
-            <tr><td class="normal2"><a href="../RefManual/index.html">RefManual</a></td></tr>
-            <tr><td class="normal2"><a href="../../demo/index.html">Demos</a></td></tr>
-            <tr><td class="normal1"><a href="http://synopsis.fresco.org/issues/">Issue Tracker</a></td></tr>
-            <tr><td class="normal1"><a href="http://synopsis.fresco.org/download/">Download</a></td></tr>
-            <tr><td class="normal1"><a href="http://synopsis.fresco.org/mailinglists.html">Mailing&nbsp;List</a></td></tr>
-            <tr><td class="normal1"><a href="http://synopsis.fresco.org/viewcvs/">CVS</a></td></tr>
-          </table>
-        </td>
-        <td class="content">
-          <p>
-            By running make in the docs/Tutorial directory you can generate a 
-            Tutorial in <a href="html/index.html">HTML</a> and 
-            <a href="synopsis-user.pdf">PDF</a> formats. The Tutorial is written in 
-            XML DocBook.
-          </p>
-        </td>
-      </tr>
-    </table>
-    <br/>
-    <br/>
-    <br/>
-    <br/>
-    <br/>
-    <br/>
-    <br/>
-    <br/>
-    <br/>
-    <br/>
-    <div class="modifiedby">
-      Last modified: 2003-09-22<br/>
-      by Stefan Seefeld
-    </div>
-  </body>
-</html><!-- vim: set et sts=2 sw=2 ts=8: -->
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Synopsis User Manual</title><link rel="stylesheet" href="synopsis-html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.62.4"><link rel="home" href="index.html" title="Synopsis User Manual"><link rel="next" href="ch01.html" title="Chapter 1. Introduction"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Synopsis User Manual</th></tr><tr><td width="20%" align="left"> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ch01.html">Next</a></td></tr></table><hr></div><div class="book" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="id2393214"></a>Synopsis User Manual</h1></div></div><div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="ch01.html">1. Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="ch01s01.html">What is Synopsis?</a></span></dt><dt><span class="section"><a href="ch01s02.html">How to use this manual</a></span></dt><dt><span class="section"><a href="ch01s03.html">How to use Synopsis</a></span></dt><dt><span class="section"><a href="ch01s04.html">How to format your comments</a></span></dt><dd><dl><dt><span class="section"><a href="ch01s04.html#id2448629">The parser</a></span></dt><dt><span class="section"><a href="ch01s04.html#id2448726">The linker</a></span></dt><dt><span class="section"><a href="ch01s04.html#id2448783">The formatter</a></span></dt></dl></dd><dt><span class="section"><a href="ch01s05.html">Where to get more help</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch02.html">2. Tutorial</a></span></dt><dd><dl><dt><span class="section"><a href="ch02s01.html">Running Synopsis</a></span></dt><dt><span class="section"><a href="ch02s02.html">The easy way: copy a demo config + modify</a></span></dt><dd><dl><dt><span class="section"><a href="ch02s02.html#id2448906">The Makefile</a></span></dt><dt><span class="section"><a href="ch02s02.html#id2449240">The config.py file</a></span></dt><dt><span class="section"><a href="ch02s02.html#id2449762">The output explained</a></span></dt></dl></dd><dt><span class="section"><a href="ch02s03.html">The hard way: create from scratch</a></span></dt><dt><span class="section"><a href="ch02s04.html">The powerful way: new project file format</a></span></dt><dd><dl><dt><span class="section"><a href="ch02s04.html#id2450117">Project class</a></span></dt><dt><span class="section"><a href="ch02s04.html#id2450166">Action object</a></span></dt><dt><span class="section"><a href="ch02s04.html#sourceaction-rules">SourceAction Rules</a></span></dt><dt><span class="section"><a href="ch02s04.html#id2450446">Command Line Usage</a></span></dt></dl></dd><dt><span class="section"><a href="ch02s05.html">The future way: use the GUI</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch03.html">3. The Parsers</a></span></dt><dd><dl><dt><span class="section"><a href="ch03s01.html">C++ Parser</a></span></dt><dd><dl><dt><span class="section"><a href="ch03s01.html#id2450593">SXR and XREF</a></span></dt><dt><span class="section"><a href="ch03s01.html#id2450685">Options</a></span></dt></dl></dd><dt><span class="section"><a href="ch03s02.html">Python Parser</a></span></dt><dd><dl><dt><span class="section"><a href="ch03s02.html#id2506929">Options</a></span></dt></dl></dd><dt><span class="section"><a href="ch03s03.html">CORBA IDL Parser</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch04.html">4. The Linker</a></span></dt><dd><dl><dt><span class="section"><a href="ch04s01.html">Unduplicator</a></span></dt><dt><span class="section"><a href="ch04s02.html">Stripper</a></span></dt><dt><span class="section"><a href="ch04s03.html">NameMapper</a></span></dt><dt><span class="section"><a href="ch04s04.html">Comments</a></span></dt><dd><dl><dt><span class="section"><a href="ch04s04.html#id2507289">ssd</a></span></dt><dt><span class="section"><a href="ch04s04.html#id2507307">ss</a></span></dt><dt><span class="section"><a href="ch04s04.html#id2507325">java</a></span></dt><dt><span class="section"><a href="ch04s04.html#id2507350">qt</a></span></dt><dt><span class="section"><a href="ch04s04.html#id2507370">group</a></span></dt><dt><span class="section"><a href="ch04s04.html#id2507407">dummy</a></span></dt><dt><span class="section"><a href="ch04s04.html#id2507423">prev</a></span></dt><dt><span class="section"><a href="ch04s04.html#id2507458">javatags</a></span></dt><dt><span class="section"><a href="ch04s04.html#id2507477">summary</a></span></dt></dl></dd><dt><span class="section"><a href="ch04s05.html">EmptyNS</a></span></dt><dt><span class="section"><a href="ch04s06.html">AccessRestrictor</a></span></dt><dt><span class="section"><a href="ch04s07.html">LanguageMapper</a></span></dt><dt><span class="section"><a href="ch04s08.html">XRefCompiler</a></span></dt><dd><dl><dt><span class="section"><a href="ch04s08.html#id2507592">XRefCompiler options</a></span></dt></dl></dd><dt><span class="section"><a href="ch04s09.html">Linker options</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch05.html">5. The HTML Formatter</a></span></dt><dd><dl><dt><span class="section"><a href="ch05s01.html">Basics</a></span></dt><dt><span class="section"><a href="ch05s02.html">Layouts</a></span></dt><dt><span class="section"><a href="ch05s03.html">Pages</a></span></dt><dd><dl><dt><span class="section"><a href="ch05s03.html#id2508079">FramesIndex</a></span></dt><dt><span class="section"><a href="ch05s03.html#id2508091">ScopePages</a></span></dt><dt><span class="section"><a href="ch05s03.html#id2508477">ModuleListing</a></span></dt><dt><span class="section"><a href="ch05s03.html#id2508576">ModuleIndexer</a></span></dt><dt><span class="section"><a href="ch05s03.html#id2508594">FileListing</a></span></dt><dt><span class="section"><a href="ch05s03.html#id2508611">FileIndexer</a></span></dt><dt><span class="section"><a href="ch05s03.html#id2508639">FileDetails</a></span></dt><dt><span class="section"><a href="ch05s03.html#id2508652">FileSource</a></span></dt><dt><span class="section"><a href="ch05s03.html#id2508773">RawFilePages</a></span></dt><dt><span class="section"><a href="ch05s03.html#id2508787">DirBrowse</a></span></dt><dt><span class="section"><a href="ch05s03.html#id2508862">XRefPages</a></span></dt><dt><span class="section"><a href="ch05s03.html#id2508952">InheritanceGraph</a></span></dt><dt><span class="section"><a href="ch05s03.html#id2509004">InheritanceTree</a></span></dt><dt><span class="section"><a href="ch05s03.html#id2509017">NameIndex</a></span></dt></dl></dd><dt><span class="section"><a href="ch05s04.html">Options</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch06.html">6. Other Formatters</a></span></dt><dd><dl><dt><span class="section"><a href="ch06s01.html">HTML_Simple</a></span></dt><dt><span class="section"><a href="ch06s02.html">DocBook</a></span></dt><dt><span class="section"><a href="ch06s03.html">BoostBook</a></span></dt><dt><span class="section"><a href="ch06s04.html">TexInfo</a></span></dt><dt><span class="section"><a href="ch06s05.html">Dot</a></span></dt><dt><span class="section"><a href="ch06s06.html">ASCII</a></span></dt><dt><span class="section"><a href="ch06s07.html">DUMP</a></span></dt><dt><span class="section"><a href="ch06s08.html">Dia</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch07.html">7. Customising Synopsis</a></span></dt><dd><dl><dt><span class="section"><a href="ch07s01.html">Importing Objects and Import Specifications</a></span></dt><dt><span class="section"><a href="ch07s02.html">New output format</a></span></dt><dt><span class="section"><a href="ch07s03.html">New parser (new language)</a></span></dt><dt><span class="section"><a href="ch07s04.html">New linker operation</a></span></dt><dt><span class="section"><a href="ch07s05.html">New HTML Page</a></span></dt></dl></dd></dl></div><div class="list-of-examples"><p><b>List of Examples</b></p><dl><dt>2.1. <a href="ch02s04.html#id2449946">How object instantiation works</a></dt></dl></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ch01.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"> </td><td width="40%" align="right" valign="top"> Chapter 1. Introduction</td></tr></table></div></body></html>



