eggdoc-texinfo produces Texinfo output for Chicken eggs. You feed it plain old eggdoc SXML source, which it transforms into an intermediate representation of Texinfo in SXML, and then transforms that into .texi output. From there, you can use makeinfo to produce an .info file, and texi2pdf to create a .pdf.
Transform the SXML document DOC into Texinfo SXML using the optional SXSLT stylesheet STYLESHEET, then transform the result into Texinfo output. If not specified, the built-in stylesheet will be used, which is also accessible with (eggdoc:make-texinfo-stylesheet).
If you currently use the optional stylesheet to convert eggdoc tags into other eggdoc expressions, via *macro*, it will continue to work in the same way.
Returns the default SXSLT stylesheet, which transforms eggdoc to Texinfo SXML. This is a procedure because the stylesheet is built dynamically using the contents of the SXML document DOC.
You can append to or modify this stylesheet and then pass it to eggdoc->texinfo or eggdoc->texinfo-sxml.
Generate the intermediate SXML representation of Texinfo used by this egg. You don't normally need to call this function except when debugging, or when you explicitly need to call texinfo-sxml->texinfo.
Texinfo SXML was designed especially for this egg, and is not compatible with the
Texinfo XML output of makeinfo --xml.
Convert a Texinfo SXML document into Texinfo output suitable for writing to a .texi file. The default stylesheet is universal-texi-conversion-rules and a modified version can be passed in if you feel the need to hack the .texi output.
An SXSLT stylesheet used to convert Texinfo SXML into raw .texi output.
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->texinfo doc `( ,@(eggdoc:make-stylesheet doc) (constant *macro* . ,eggdoc:make-defsig) (method *macro* . ,eggdoc:make-defsig) ))
will create new constant and method tags.
This extension is much more strict about well-formed eggdocs than the eggdoc extension itself, mostly because HTML parsers are so forgiving, and also because the stylesheet transformation is more complex. In the course of converting many pre-existing eggdocs, I have come up with several tips to help you write correct documents and track down problems.
smart quotes.To get smart quotes, use the (q ...) tag, which also works in HTML.
(section "License" "Public domain") ;; invalid (section "License" (p "Public domain")) ;; correct
Inside the egg under extras/ I included some simple scripts to help with conversion of one or more eggdoc sources to Texinfo.
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.