Changeset 3244 for trunk/thirdparty/documentation-template

Timestamp:

06/02/08 12:07:08 (7 months ago)

Author:

edi

Message:

Add hacks from flight

Now generates output compatible with Hans' clixdoc

Files:

• trunk/thirdparty/documentation-template (modified) (1 prop)
• trunk/thirdparty/documentation-template/doc (modified) (1 prop)
• trunk/thirdparty/documentation-template/doc/clixdoc.xsl (added)
• trunk/thirdparty/documentation-template/output.lisp (modified) (8 diffs)
• trunk/thirdparty/documentation-template/specials.lisp (modified) (3 diffs)

trunk/thirdparty/documentation-template/output.lisp

@@ -1 +1 @@
-;;; -*- Mode: LISP; Syntax: COMMON-LISP; Package: DOCUMENTATION-TEMPLATE; Base: 10 -*-
-4 2008/05/29 08:23:37
+6 2008/06/01 21:26:20
-
-;;; Copyright (c) 2006-2008, Dr. Edmund Weitz.  All rights reserved.
@@ -30 +30 @@
-(in-package :documentation-template)
-
-(defun write-entry-header (name type &key (write-name-p t))
-  "Writes the header for a documentation entry of name NAME and
-type TYPE.  The HTML anchor will only get a 'name' attribute if
-WRITE-NAME-P is true and NAME is not a SETF name."
-  (format t "~%~%<!-- Entry for ~A -->~%~%<p><br>[~A]<br><a class=none~@[ name='~A'~]>" 
-          name type (and write-name-p (atom name) (string-downcase name))))
-
-(defun write-entry-footer (name doc-string)
-  "Writes the footer for a documentation entry for the name NAME
-including the documentation string DOC-STRING."
-  (format t "~%<blockquote><br>~%~%~@[~A~]~%~%</blockquote>~%~%<!-- End of entry for ~A -->~%"
-          (and doc-string (escape-string-iso-8859 doc-string)) name))
-
-(defun write-constant-entry (symbol doc-string)
-  "Writes a full documentation entry for the constant SYMBOL."
-rite-entry-header symbol "Constant"
-(format t "<b>~A</b></a>" (string-downcase symbol)
-(write-entry-footer symbol doc-string
+ith-html-output (*doc-output* nil :indent 2
+  (:|clix:constant| :name (string-downcase symbol
+   (:|clix:description| (esc doc-string)))
-
-(defun write-special-var-entry (symbol doc-string)
-
-
-
-
-
+
+
+
+
-
-(defun write-class-entry (symbol doc-string)
-  "Writes a full documentation entry for the class SYMBOL."
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-(defun write-lambda-list* (lambda-list &optional specializers)
-  "The function which does all the work for WRITE-LAMBDA-LIST and
-
+ly
-  (let (body-seen after-required-args-p (firstp t))
-    (dolist (part lambda-list)
@@ -73 +63 @@
-                 (setq part (first part)))
-               (unless firstp
-
+ *doc-output*
-               (setq firstp nil)
-               (cond ((consp part)
-                      ;; a destructuring lambda list - recurse
-
+ *doc-output*
-                      (write-lambda-list* part)
-
+ *doc-output*
-                     ((member part '(&key &optional &rest &allow-other-keys &aux &environment &whole))
-                      ;; marks these between <tt> and </tt>
-                      (setq after-required-args-p t)
-
+
+
-                     ((eq part '&body)
-                      ;; we don't really write '&BODY', we write it
@@ -89 +80 @@
-                      (setq body-seen t
-                            after-required-args-p t)
-
+ *doc-output*
-                     (t
-                      (let ((specializer (pop specializers)))
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-  "Writes the lambda list LAMBDA-LIST, optionally with the
-specializers SPECIALIZERS.  Adds something like `=> result' at
-the end if RESULTP is true."
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-(defun write-macro-entry (symbol lambda-list doc-string)
-  "Writes a full documentation entry for the macro SYMBOL."
-rite-entry-header symbol "Macro"
-(format t "<b>~A</b> " (string-downcase symbol)
-
-(write-entry-footer symbol doc-string
+ith-html-output (*doc-output* nil :indent 2
+  (:|clix:function| :macro "true" :name (string-downcase symbol
+   
+   (:|clix:description| (esc doc-string)))
-
-(defun write-function-entry (name lambda-list doc-string other-entries
-ignature-only-p s
+
-  "Writes a full documentation entry for the function, generic
-function, or method with name NAME.  NAME is a generic function
-if GENERICP is true, SPECIALIZERS is a list of specializers,
-i.e. in this case NAME is a method.  Likewise, QUALIFIERS is a
-
-
+
-  (let* ((setfp (consp name))
-         (symbol (if setfp (second name) name))
@@ -140 +135 @@
-         (resultp (and (not setfp)
-                       (null (intersection '(:before :after)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  other-entries)
-
@@ -189 +168 @@
-  (destructuring-bind (name doc-type lambda-list doc-string &optional specializers qualifiers)
-      entry
-    (unless (or (consp name) specializers)
-      ;; add NAME to index list unless it's a SETF name or the name of
-      ;; a method
-      (push name *symbols*))
-    (ecase doc-type
-      (:constant (write-constant-entry name doc-string))
@@ -209 +184 @@
-  other-entries)
-
-(defun write-page-header (package-name subtitle symbols)
-  "Writes the header of the HTML page.  Assumes that the library
-has the same name as the package.  Adds a list of all exported
-symbols with links."
-  (format t "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\">
-<html> 
-
-<head>
-  <meta http-equiv=\"Content-Type\" content=\"text/html; charset=iso-8859-1\">
-  <title>~A - ~A</title>
-  <style type=\"text/css\">
-  pre { padding:5px; background-color:#e0e0e0 }
-  h3, h4 { text-decoration: underline; }
-  a { text-decoration: none; padding: 1px 2px 1px 2px; }
-  a:visited { text-decoration: none; padding: 1px 2px 1px 2px; }
-  a:hover { text-decoration: none; padding: 1px 1px 1px 1px; border: 1px solid #000000; } 
-  a:focus { text-decoration: none; padding: 1px 2px 1px 2px; border: none; }
-  a.none { text-decoration: none; padding: 0; }
-  a.none:visited { text-decoration: none; padding: 0; } 
-  a.none:hover { text-decoration: none; border: none; padding: 0; } 
-  a.none:focus { text-decoration: none; border: none; padding: 0; } 
-  a.noborder { text-decoration: none; padding: 0; } 
-  a.noborder:visited { text-decoration: none; padding: 0; } 
-  a.noborder:hover { text-decoration: none; border: none; padding: 0; } 
-  a.noborder:focus { text-decoration: none; border: none; padding: 0; }  
-  pre.none { padding:5px; background-color:#ffffff }
-  </style>
-</head>
-
-<body bgcolor=white>
-
-<h2> ~2:*~A - ~A</h2>
-
-<blockquote>
-<br>&nbsp;<br><h3><a name=abstract class=none>Abstract</a></h3>
-
-The code comes with
-a <a
-href=\"http://www.opensource.org/licenses/bsd-license.php\">BSD-style
-license</a> so you can basically do with it whatever you want.
-
-<p>
-<font color=red>Download shortcut:</font> <a href=\"http://weitz.de/files/~A.tar.gz\">http://weitz.de/files/~:*~A.tar.gz</a>.
-</blockquote>
-
-<br>&nbsp;<br><h3><a class=none name=\"contents\">Contents</a></h3>
-<ol>
-  <li><a href=\"#download\">Download</a>
-  <li><a href=\"#dictionary\">The ~A dictionary</a>
-    <ol>
-~{      <li><a href=\"#~A\"><code>~:*~A</code></a>
-~}    </ol>
-  <li><a href=\"#ack\">Acknowledgements</a>
-</ol>
-
-<br>&nbsp;<br><h3><a class=none name=\"download\">Download</a></h3>
-
-~2:*~A together with this documentation can be downloaded from <a
-href=\"http://weitz.de/files/~2:*~A.tar.gz\">http://weitz.de/files/~:*~A.tar.gz</a>. The
-current version is 0.1.0.
-
-<br>&nbsp;<br><h3><a class=none name=\"dictionary\">The ~A dictionary</a></h3>
-
-"
-          package-name subtitle (string-downcase package-name)
-          package-name symbols))
-
-(defun write-page-footer ()
-  "Writes the footer of the HTML page."
-  (write-string "
-
-<br>&nbsp;<br><h3><a class=none name=\"ack\">Acknowledgements</a></h3>
-
-<p>
-This documentation was prepared with <a href=\"http://weitz.de/documentation-template/\">DOCUMENTATION-TEMPLATE</a>.
-</p>
-<p>
-$Header: /usr/local/cvsrep/documentation-template/output.lisp,v 1.14 2008/05/29 08:23:37 edi Exp $
-<p><a href=\"http://weitz.de/index.html\">BACK TO MY HOMEPAGE</a>
-
-</body>
-</html>"))
-
-(defun create-template (package &key (target (or *target*
-                                                 #-:lispworks (error "*TARGET* not specified.")
@@ -297 +189 @@
-                                                 (capi:prompt-for-file "Select an output target:"
-                                                                       :operation :save
-
+
+
-                                                                                  "All Files" "*.*")
-HTML;*.HTM
-     
-     
-     
-     
-     
-HTML page with preliminary documentation entries and an
-
-
-
-has a 
+XML
+
+
+
+
+
+XML file with documentation entries for all exported
+
+
+
+
-  (when target
-    (setq *target* target))
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  (values))

trunk/thirdparty/documentation-template/specials.lisp

@@ -1 +1 @@
-;;; -*- Mode: LISP; Syntax: COMMON-LISP; Package: DOCUMENTATION-TEMPLATE; Base: 10 -*-
-7 2008/05/29 08:23:37
+9 2008/06/01 21:26:20
-
-;;; Copyright (c) 2006-2008, Dr. Edmund Weitz.  All rights reserved.
@@ -31 +31 @@
-
-(defvar *target* nil
-HTML page.  If this value is not NIL, it will
-
-set 
+XML page.  If this value is not NIL, it will be
+
+
-
-(defvar *maybe-skip-methods-p* nil
@@ -40 +40 @@
-used internally.")
-
-
-
+
+
+
+
+
+
+
+
-
-;; stuff for Nikodemus Siivola's HYPERDOC