This is eggdoc.egg.info, produced by makeinfo version 4.7 from
eggdoc-output.texi.

INFO-DIR-SECTION The Algorithmic Language Scheme
START-INFO-DIR-ENTRY
* eggdoc.egg: (eggdoc.egg).		An egg documentation tool
END-INFO-DIR-ENTRY


File: eggdoc.egg.info,  Node: Top,  Next: About this egg,  Up: (dir)

eggdoc egg
**********

An egg documentation tool

Written by Zbigniew (http://3e8.org/zb)

   This manual corresponds to version 1.2 of the eggdoc extension
library for Chicken Scheme.

* Menu:

* About this egg::
* Documentation::
* Examples::
* License::
* Index::


File: eggdoc.egg.info,  Node: About this egg,  Next: Documentation,  Prev: Top,  Up: Top

1 About this egg
****************

* Menu:

* Version history::
* Requirements::
* Usage::


File: eggdoc.egg.info,  Node: Version history,  Next: Requirements,  Up: About this egg

1.1 Version history
===================

`1.2'
     `eggdoc:make-defsig'; subsub[sub]section tags; with-default-param
     tag

`1.1'
     setup scripts adds documentation and version info [Thanks to Jim
     Miller]

`1.0'
     Initial release


File: eggdoc.egg.info,  Node: Requirements,  Next: Usage,  Prev: Version history,  Up: About this egg

1.2 Requirements
================

This egg requires the following extensions:

   `sxml-transforms', `doctype'


File: eggdoc.egg.info,  Node: Usage,  Prev: Requirements,  Up: About this egg

1.3 Usage
=========

Load this egg like so:

   `(require-extension eggdoc)'


File: eggdoc.egg.info,  Node: Documentation,  Next: Examples,  Prev: About this egg,  Up: Top

2 Documentation
***************

eggdoc is an SXML documentation tool which produces HTML pages for
Chicken eggs.  It uses the sxml-transforms extension to transform your
SXML via a comprehensive XML stylesheet, simplifying the creation of
egg documentation.  It's also quite customizable.

 -- procedure: eggdoc->html
          (eggdoc->html DOC [STYLESHEET])

     Transform the SXML document `DOC' using the optional SXSLT
     stylesheet `STYLESHEET'.  If not specified, the built-in
     stylesheet will be used, which is also accessible with
     `(eggdoc:make-stylesheet)'.

 -- procedure: eggdoc:make-stylesheet
          (eggdoc:make-stylesheet DOC)

     Returns the default SXSLT stylesheet.  This is a procedure because
     the stylesheet is built dynamically using the contents of the SXML
     document `DOC'.  For example, the value of the (name) tag is
     retrieved at build time and inserted in the header and the usage
     information.

     You can append to or modify this stylesheet and then pass it to
     `eggdoc->html'.  This is done in doctype's eggdoc to provide a new
     tag, (strings), which makes the SXML much cleaner.

 -- parameter: eggdoc:doctype
     The DOCTYPE for this document, typically as defined in the doctype
     extension.  This defaults to doctype:xhtml-1.0-strict.

 -- parameter: eggdoc:css
     CSS text inserted verbatim between the document's <style> tags.
     This must be <!- wrapped in HTML comments ->.  The default is
     quite reasonable.

     If you wish to source a CSS file instead of inserting the text
     directly, you can override the eggdoc-style tag in the default
     stylesheet to do so.

 -- procedure: eggdoc:make-defsig
          (eggdoc:make-defsig TAG SIG . [BODY])

     Use this procedure inside a stylesheet to generate a new signature
     tag, just like `procedure' or `macro'.  It expands to a
     `(definition (signatures (signature ...)))' expression.  For
     example,


     (eggdoc->html doc `( ,@(eggdoc:make-stylesheet doc)
                          (constant *macro* . ,eggdoc:make-defsig)
                          (method   *macro* . ,eggdoc:make-defsig) ))

     will create new `constant' and `method' tags.

* Menu:

* Subsections::


File: eggdoc.egg.info,  Node: Subsections,  Up: Documentation

2.1 Subsections
===============

Document section tags must be nested in the order `section ->
subsection -> subsubsection -> subsubsubsection'.  You may not nest
section tags of the same level, as in `(section "name" (section ...))',
and you may not skip a level. `eggdoc' won't complain if you violate
these rules--the HTML driver is pretty lax--but the appearance will be
off and `eggdoc-texinfo' will fail on such a document.
`eggdoc-texinfo' is more sensitive to malformed documents, so it is
recommended to generate `.info' and `.pdf' output as well to ensure
your document is correct.

   `documentation', `examples', and `license' are `section' tags in
disguise.  In particular, `(documentation (section ...))' is invalid;
use `(documentation (subsection ...)).'


File: eggdoc.egg.info,  Node: Examples,  Next: License,  Prev: Documentation,  Up: Top

3 Examples
**********

Complete examples for the Chicken extensions `args, doctype, eggdoc,
hostinfo, sxml-tools, sxml-transforms,' and `vector-lib' are provided
in the egg under src/.  These all validate as XHTML Strict 1.0.

   Also, `eggdoc' has become the standard documentation tool for
Chicken eggs, and an eggdoc source file is included in many eggs.
Unpack (untar) the egg by hand, or browse the SVN egg repository, to
access the source.


File: eggdoc.egg.info,  Node: License,  Next: Index,  Prev: Examples,  Up: Top

4 License
*********


Copyright (c) 2005, 2006 Jim "Zb" Ursetto.  All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

  Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer. Redistributions in
  binary form must reproduce the above copyright notice, this list of
  conditions and the following disclaimer in the documentation and/or
  other materials provided with the distribution. Neither the name of the
  author nor the names of its contributors may be used to endorse or
  promote products derived from this software without specific prior
  written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


File: eggdoc.egg.info,  Node: Index,  Prev: License,  Up: Top

Index
*****

 [index ]
* Menu:

* eggdoc->html:                          Documentation.        (line 12)
* eggdoc:css:                            Documentation.        (line 37)
* eggdoc:doctype:                        Documentation.        (line 33)
* eggdoc:make-defsig:                    Documentation.        (line 46)
* eggdoc:make-stylesheet:                Documentation.        (line 20)



Tag Table:
Node: Top229
Node: About this egg569
Node: Version history753
Node: Requirements1090
Node: Usage1308
Node: Documentation1467
Node: Subsections3804
Node: Examples4641
Node: License5178
Node: Index6773

End Tag Table
