From ihatchondo at common-lisp.net Thu Jan 5 14:47:15 2006 From: ihatchondo at common-lisp.net (Iban Hatchondo) Date: Thu, 5 Jan 2006 15:47:15 +0100 (CET) Subject: [cldoc-cvs] CVS update: cldoc/src/cludg.lisp cldoc/src/html.lisp cldoc/src/package.lisp Message-ID: <20060105144715.6B85288592@common-lisp.net> Update of /project/cldoc/cvsroot/cldoc/src In directory common-lisp.net:/tmp/cvs-serv31239 Modified Files: cludg.lisp html.lisp package.lisp Log Message: Fix Cody Koeninger bug: NIL is an acceptable value for dest-dir arg in extract-documentation (html.lisp); and clean up. Date: Thu Jan 5 15:47:12 2006 Author: ihatchondo Index: cldoc/src/cludg.lisp diff -u cldoc/src/cludg.lisp:1.3 cldoc/src/cludg.lisp:1.4 --- cldoc/src/cludg.lisp:1.3 Thu Dec 15 01:55:27 2005 +++ cldoc/src/cludg.lisp Thu Jan 5 15:47:11 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: cludg.lisp,v 1.3 2005/12/15 00:55:27 ihatchondo Exp $ +;;; $Id: cludg.lisp,v 1.4 2006/01/05 14:47:11 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator ;;; Created: 2005 10 23 12:30 @@ -867,12 +867,16 @@ (defmethod extract-documentation ((text (eql 'text)) dest-dir (system asdf:system) &rest rest) (let ((files (get-asdf-system-files system))) + (unless (getf rest :path-prefix) + (setf (getf rest :path-prefix) + (namestring (asdf:component-relative-pathname system)))) (apply #'extract-documentation text dest-dir files rest))) (defmethod extract-documentation ((text (eql 'text)) dest-dir files &rest rest) (declare (ignorable text)) - (unless (char= (char dest-dir (1- (length dest-dir))) #\/) - (setf dest-dir (concatenate 'string dest-dir "/"))) + (cond ((not (stringp dest-dir)) (setf dest-dir "./")) + ((char/= (char dest-dir (1- (length dest-dir))) #\/) + (setf dest-dir (concatenate 'string dest-dir "/")))) (ensure-directories-exist dest-dir) (let ((path-prefix (or (getf rest :path-prefix) Index: cldoc/src/html.lisp diff -u cldoc/src/html.lisp:1.5 cldoc/src/html.lisp:1.6 --- cldoc/src/html.lisp:1.5 Fri Dec 16 19:21:58 2005 +++ cldoc/src/html.lisp Thu Jan 5 15:47:11 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: html.lisp,v 1.5 2005/12/16 18:21:58 ihatchondo Exp $ +;;; $Id: html.lisp,v 1.6 2006/01/05 14:47:11 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator: HTML driver ;;; Created: 2005 10 23 2:30 @@ -135,16 +135,11 @@ (defmethod extract-documentation ((driver (eql 'html)) dest-dir (system asdf:system) &rest initargs &key &allow-other-keys) - (declare (ignorable driver)) - (let ((pp (getf initargs :path-prefix))) - (remf initargs :path-prefix) - (let ((args (get-initargs initargs))) - (make-html-doc - (apply #'make-instance 'html :string-parser-initargs initargs args) - (get-asdf-system-files system) - :dest-dir dest-dir - :path-prefix (or pp (namestring - (asdf:component-relative-pathname system))))))) + (unless (getf initargs :path-prefix) + (setf (getf initargs :path-prefix) + (namestring (asdf:component-relative-pathname system)))) + (let ((files (get-asdf-system-files system))) + (apply #'extract-documentation driver dest-dir files initargs))) (defmethod extract-documentation ((driver (eql 'html)) dest-dir filenames &rest initargs &key &allow-other-keys) @@ -156,7 +151,7 @@ (apply #'make-instance 'html :string-parser-initargs initargs args) filenames :path-prefix (or pp (directory-namestring (or *load-truename* "."))) - :dest-dir dest-dir)))) + :dest-dir (or dest-dir "."))))) ;;; @@ -342,26 +337,25 @@ ((&key (divclass "defun") name arg-list type anchor) &body body) "Presents lisp forms according to our html documentation template." (with-gensym (hanchor args) - `(progn - (with-tag (:div ,(when divclass `(:class ,divclass))) - (with-tag (:div ,(when divclass `(:class "defunsignatures"))) - (let ((,hanchor ,anchor)) - (when ,hanchor (with-tag (:a (:id ,hanchor)) ""))) - (with-tag (:table (:cellpadding 0 :cellspacing 0 :width "100%")) - (with-tag (:colgroup (:span 3)) - (with-tag (:col (:width "0*"))) - (with-tag (:col (:width "1*"))) - (with-tag (:col (:width "0*")))) - (with-tag (:tbody ()) - (with-tag (:tr ()) - (with-tag (:td (:class "symbol-name")) - (html-write "~a  " ,name)) - (with-tag (:td (:class "lambda-list")) - (let ((,args ,arg-list)) - (when ,args (html-write "~a" ,args)))) - (with-tag (:td (:class "symbol-type")) - (html-write " [~@(~a~)]" ,type)))))) - , at body)))) + `(with-tag (:div ,(when divclass `(:class ,divclass))) + (with-tag (:div ,(when divclass `(:class "defunsignatures"))) + (let ((,hanchor ,anchor)) + (when ,hanchor (with-tag (:a (:id ,hanchor)) ""))) + (with-tag (:table (:cellpadding 0 :cellspacing 0 :width "100%")) + (with-tag (:colgroup (:span 3)) + (with-tag (:col (:width "0*"))) + (with-tag (:col (:width "1*"))) + (with-tag (:col (:width "0*")))) + (with-tag (:tbody ()) + (with-tag (:tr ()) + (with-tag (:td (:class "symbol-name")) + (html-write "~a  " ,name)) + (with-tag (:td (:class "lambda-list")) + (let ((,args ,arg-list)) + (when ,args (html-write "~a" ,args)))) + (with-tag (:td (:class "symbol-type")) + (html-write " [~@(~a~)]" ,type)))))) + , at body))) (defun make-footer () "Appends CLDOC link and generation date." @@ -411,26 +405,25 @@ (defmacro with-index-header ((index hdriver dest-dir title &key (head-title title)) &body body) - (with-gensym (ctype href f ttitle) + (with-gensym (href ttitle iindex ddir) `(with-slots (filter css-pathname charset) ,hdriver - (with-open-file (os ,index :direction :output :if-exists :supersede) - (let ((*print-case* :downcase) - (,ttitle ,title) - (,f (enough-namestring (truename ,index) (truename ,dest-dir))) - (,ctype (format nil "text/html; charset=~a" charset)) - (,href (namestring (make-pathname-relative - :from (truename ,dest-dir) - :to (truename css-pathname))))) + (let* ((*print-case* :downcase) + (,iindex ,index) + (,ddir ,dest-dir) + (,ttitle ,title) + (,href (make-pathname-relative + :from (truename ,ddir) :to (truename css-pathname)))) + (with-open-file (os ,iindex :direction :output :if-exists :supersede) (with-html-page - (os :csshref ,href - :content-type ,ctype + (os :csshref (namestring ,href) + :content-type (format nil "text/html; charset=~a" charset) :head-title ,head-title :nav-name ,ttitle - :index (toc-path-from (pathname os) ,dest-dir)) + :index (toc-path-from (pathname os) ,ddir)) (with-tag (:div (:class "cludg-index-body")) (when ,ttitle (with-tag (:h2 ()) (html-write "~a~%" ,ttitle))) - (with-tag (:div ()) , at body))) - (format nil "~a" ,f)))))) + (with-tag (:div ()) , at body)))) + (enough-namestring (truename ,iindex) (truename ,ddir)))))) (defun make-abc-index-entry (filename &key char-code non-alphabetic) (let* ((name (file-namestring filename)) @@ -672,49 +665,53 @@ This control string has no parameter.") (defun resolve-link (symdesc strings) - (let ((protocols '("http://" "ftp://")) + (let ((schemes '("http://" "ftp://")) (file (meta-descriptor-file (lookup-meta-descriptor symdesc)))) - (if (loop for p in protocols when (starts-with (car strings) p) - do (return T)) + (if (some #'(lambda (scheme) (starts-with (first strings) scheme)) schemes) (values T (format nil "~{~a~^ ~}" strings)) (multiple-value-bind (name package) (split-name (second strings)) (let ((href (lookup-meta-descriptor-href name (first strings) package file))) - (values T href name)))))) + (when (values T href name))))))) (defun format-doc (symdesc html-driver strings) "Default documentation string formater. The Do What I Mean capabilities are delegated to the create-doctree-from-string method of the doctree protocol in coordination with with-tree-loop iterator to produced the final output." - (labels ((map-over-tree (tree) - (with-tree-loop (element tree) - (if (stringp element) - (html-write "~a " element) - (case (tree-tag element) - (:keyword - (with-tag (:span (:class "keyword")) - (map-over-tree element))) - (:hyper-link - (let ((link '())) - (with-tree-loop (e element) (push e link)) - (multiple-value-bind (found-p href name) - (resolve-link symdesc (reverse link)) - (if (and found-p href) - (with-tag (:a (:href href)) - (html-write (or name href))) - ;; [FIXME] RETRIEVE THE LINK MARKERS !!! - ;; No link can be created from the given - ;; information. Maybe the author was not - ;; thinking to a an hyper link, for this - ;; reason the text will be outputed as - ;; as it was initially found. - (html-write "{~{~a~^ ~}}" (reverse link)))))) - (t (with-tag ((tree-tag element) ()) - (map-over-tree element)))))))) - (with-slots (string-parser-initargs) html-driver - (map-over-tree (apply #'create-doctree-from-string - 'doctree strings string-parser-initargs))))) + (with-slots ((spi string-parser-initargs)) html-driver + (let* ((link-delims (getf spi :link-delimiters +default-link-delimiters+)) + (left-link-delim (first link-delims)) + (right-link-delim (second link-delims))) + (labels ((map-over-tree (tree) + (with-tree-loop (element tree) + (if (stringp element) + (html-write "~a " element) + (case (tree-tag element) + (:keyword + (with-tag (:span (:class "keyword")) + (map-over-tree element))) + (:hyper-link + (let ((link '())) + (with-tree-loop (e element) (push e link)) + (multiple-value-bind (found-p href name) + (resolve-link symdesc (reverse link)) + (if (and found-p href) + (with-tag (:a (:href href)) + (html-write (or name href))) + ;; No link can be created from the given + ;; information. Maybe the author was not + ;; thinking to an hyper link, for this + ;; reason the text will be outputed as + ;; it was initially found. + (html-write "~a~{~a~^ ~}~a" + left-link-delim + (reverse link)1 + right-link-delim))))) + (t (with-tag ((tree-tag element) ()) + (map-over-tree element)))))))) + (map-over-tree + (apply #'create-doctree-from-string 'doctree strings spi)))))) (defun make-html-doc (hdriver filenames &key (dest-dir ".") path-prefix) "Reads all files specified in filenames and extract their documentation Index: cldoc/src/package.lisp diff -u cldoc/src/package.lisp:1.1.1.1 cldoc/src/package.lisp:1.2 --- cldoc/src/package.lisp:1.1.1.1 Fri Nov 18 15:52:18 2005 +++ cldoc/src/package.lisp Thu Jan 5 15:47:11 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: package.lisp,v 1.1.1.1 2005/11/18 14:52:18 ihatchondo Exp $ +;;; $Id: package.lisp,v 1.2 2006/01/05 14:47:11 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator package definition ;;; Created: 2005 10 23 12:30 @@ -82,9 +82,9 @@ should be added to the DWIM: - links. how ? - Unlike Albert (http://albert.sourceforge.net/) it does not allow programmers - to insert comments at the source code level which are incorporated into the - generated documentation. + Unlike Albert, {http://albert.sourceforge.net} , it does not allow + programmers to insert comments at the source code level which are + incorporated into the generated documentation. Its goal was not to produce a LispDoc ala JavaDoc but to create a simple and easy way to take advantage of the Lisp documentation string. So instead of copying and pasting it in some commentary section with extra special From ihatchondo at common-lisp.net Thu Jan 5 14:54:12 2006 From: ihatchondo at common-lisp.net (Iban Hatchondo) Date: Thu, 5 Jan 2006 15:54:12 +0100 (CET) Subject: [cldoc-cvs] CVS update: cldoc/src/html.lisp Message-ID: <20060105145412.673F188592@common-lisp.net> Update of /project/cldoc/cvsroot/cldoc/src In directory common-lisp.net:/tmp/cvs-serv31320 Modified Files: html.lisp Log Message: Typo fix Date: Thu Jan 5 15:54:11 2006 Author: ihatchondo Index: cldoc/src/html.lisp diff -u cldoc/src/html.lisp:1.6 cldoc/src/html.lisp:1.7 --- cldoc/src/html.lisp:1.6 Thu Jan 5 15:47:11 2006 +++ cldoc/src/html.lisp Thu Jan 5 15:54:11 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: html.lisp,v 1.6 2006/01/05 14:47:11 ihatchondo Exp $ +;;; $Id: html.lisp,v 1.7 2006/01/05 14:54:11 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator: HTML driver ;;; Created: 2005 10 23 2:30 @@ -706,7 +706,7 @@ ;; it was initially found. (html-write "~a~{~a~^ ~}~a" left-link-delim - (reverse link)1 + (reverse link) right-link-delim))))) (t (with-tag ((tree-tag element) ()) (map-over-tree element)))))))) From ihatchondo at common-lisp.net Thu Jan 5 15:08:07 2006 From: ihatchondo at common-lisp.net (Iban Hatchondo) Date: Thu, 5 Jan 2006 16:08:07 +0100 (CET) Subject: [cldoc-cvs] CVS update: cldoc/src/html.lisp Message-ID: <20060105150807.D66BC88592@common-lisp.net> Update of /project/cldoc/cvsroot/cldoc/src In directory common-lisp.net:/tmp/cvs-serv32466 Modified Files: html.lisp Log Message: Fix invalid (when) expression in resolve-link. Date: Thu Jan 5 16:08:06 2006 Author: ihatchondo Index: cldoc/src/html.lisp diff -u cldoc/src/html.lisp:1.7 cldoc/src/html.lisp:1.8 --- cldoc/src/html.lisp:1.7 Thu Jan 5 15:54:11 2006 +++ cldoc/src/html.lisp Thu Jan 5 16:08:06 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: html.lisp,v 1.7 2006/01/05 14:54:11 ihatchondo Exp $ +;;; $Id: html.lisp,v 1.8 2006/01/05 15:08:06 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator: HTML driver ;;; Created: 2005 10 23 2:30 @@ -672,7 +672,7 @@ (multiple-value-bind (name package) (split-name (second strings)) (let ((href (lookup-meta-descriptor-href name (first strings) package file))) - (when (values T href name))))))) + (values (if href T NIL) href name)))))) (defun format-doc (symdesc html-driver strings) "Default documentation string formater. The Do What I Mean capabilities From ihatchondo at common-lisp.net Sun Jan 8 16:12:21 2006 From: ihatchondo at common-lisp.net (Iban Hatchondo) Date: Sun, 8 Jan 2006 17:12:21 +0100 (CET) Subject: [cldoc-cvs] CVS update: cldoc/src/cludg.lisp cldoc/src/html.lisp Message-ID: <20060108161221.37C3D885A7@common-lisp.net> Update of /project/cldoc/cvsroot/cldoc/src In directory common-lisp.net:/tmp/cvs-serv19285 Modified Files: cludg.lisp html.lisp Log Message: title attribute added in the general symbol index href. The title attribute will show the fully qualified name of the symbol and its lambda list when this symbol is 'lambda-descriptor' symbol. Date: Sun Jan 8 17:12:18 2006 Author: ihatchondo Index: cldoc/src/cludg.lisp diff -u cldoc/src/cludg.lisp:1.4 cldoc/src/cludg.lisp:1.5 --- cldoc/src/cludg.lisp:1.4 Thu Jan 5 15:47:11 2006 +++ cldoc/src/cludg.lisp Sun Jan 8 17:12:17 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: cludg.lisp,v 1.4 2006/01/05 14:47:11 ihatchondo Exp $ +;;; $Id: cludg.lisp,v 1.5 2006/01/08 16:12:17 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator ;;; Created: 2005 10 23 12:30 @@ -347,6 +347,16 @@ :reader allocation-type)) (:documentation "This descripor is made for describe the slots of class, conditon and structure.")) + +(defgeneric fully-qualified-name (symbol-descriptor) + (:documentation "Returns the string that represent the fully qualified + name of the given symbol-descriptor.") + (:method ((symdesc symbol-descriptor)) + (with-slots ((pname package) name) symdesc + (multiple-value-bind (sym status) + (find-symbol (standard-io-name name) (find-package-caseless pname)) + (declare (ignore sym)) + (format nil "~(~a~):~:[~;:~]~a" pname (eq status :internal) name))))) ;;; ;;; Common Lisp common descripor classes. Index: cldoc/src/html.lisp diff -u cldoc/src/html.lisp:1.8 cldoc/src/html.lisp:1.9 --- cldoc/src/html.lisp:1.8 Thu Jan 5 16:08:06 2006 +++ cldoc/src/html.lisp Sun Jan 8 17:12:18 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: html.lisp,v 1.8 2006/01/05 15:08:06 ihatchondo Exp $ +;;; $Id: html.lisp,v 1.9 2006/01/08 16:12:18 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator: HTML driver ;;; Created: 2005 10 23 2:30 @@ -403,6 +403,15 @@ ;;; HTML index creation facilities ;;; +(defgeneric href-title (symbol-descriptor) + (:documentation "Returns a string for the title attribute of an href.") + (:method ((symdesc symbol-descriptor)) + (purge-string-for-html (fully-qualified-name symdesc))) + (:method ((symdesc lambda-descriptor)) + (let ((name (purge-string-for-html (fully-qualified-name symdesc))) + (ll (format nil "(~{~s~^ ~})" (lambda-list symdesc)))) + (concatenate 'string name " " (purge-string-for-html ll))))) + (defmacro with-index-header ((index hdriver dest-dir title &key (head-title title)) &body body) (with-gensym (href ttitle iindex ddir) @@ -448,7 +457,8 @@ if (or (and entry (first-char-p (name desc) entry)) non-alphabetic) do (unless (and filter (funcall filter desc)) (with-tag (:div (:class "index-entry")) - (with-tag (:a (:href (meta-descriptor-href mdesc))) + (with-tag (:a (:href (meta-descriptor-href mdesc) + :title (href-title desc))) (html-write "~a," (purge-string-for-html (name desc)))) (with-tag (:em ()) (html-write "~a" (html-printable-type desc))))) From ihatchondo at common-lisp.net Sun Jan 8 16:49:25 2006 From: ihatchondo at common-lisp.net (Iban Hatchondo) Date: Sun, 8 Jan 2006 17:49:25 +0100 (CET) Subject: [cldoc-cvs] CVS update: cldoc/src/html.lisp cldoc/src/package.lisp Message-ID: <20060108164925.C62BD885A7@common-lisp.net> Update of /project/cldoc/cvsroot/cldoc/src In directory common-lisp.net:/tmp/cvs-serv22814 Modified Files: html.lisp package.lisp Log Message: doc updated. Date: Sun Jan 8 17:49:17 2006 Author: ihatchondo Index: cldoc/src/html.lisp diff -u cldoc/src/html.lisp:1.9 cldoc/src/html.lisp:1.10 --- cldoc/src/html.lisp:1.9 Sun Jan 8 17:12:18 2006 +++ cldoc/src/html.lisp Sun Jan 8 17:49:16 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: html.lisp,v 1.9 2006/01/08 16:12:18 ihatchondo Exp $ +;;; $Id: html.lisp,v 1.10 2006/01/08 16:49:16 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator: HTML driver ;;; Created: 2005 10 23 2:30 @@ -681,7 +681,7 @@ (values T (format nil "~{~a~^ ~}" strings)) (multiple-value-bind (name package) (split-name (second strings)) (let ((href (lookup-meta-descriptor-href - name (first strings) package file))) + (or name "") (first strings) package file))) (values (if href T NIL) href name)))))) (defun format-doc (symdesc html-driver strings) Index: cldoc/src/package.lisp diff -u cldoc/src/package.lisp:1.2 cldoc/src/package.lisp:1.3 --- cldoc/src/package.lisp:1.2 Thu Jan 5 15:47:11 2006 +++ cldoc/src/package.lisp Sun Jan 8 17:49:16 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: package.lisp,v 1.2 2006/01/05 14:47:11 ihatchondo Exp $ +;;; $Id: package.lisp,v 1.3 2006/01/08 16:49:16 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator package definition ;;; Created: 2005 10 23 12:30 @@ -78,9 +78,21 @@ - Recognize both indent and empty-line paragraph breaks. - Recognizes bulleted lists (the list grammar can be specified). - Recognizes code segments: by default each lines are prefixed with ';;; '. - - should be added to the DWIM: - - links. how ? + - Recognizes links: two kinds of hyper link are possible both using the + same grammar: + [opening-char(defun|defclass|defgeneric|...) symbol-name closing-char]?| + [opening-char(http://|ftp://)address closing-char]. + opening-char and closing char can be customized, see the :link-delimiters + option of {defclass cldoc:doctree} . + + ;;; (defun foo () + ;;; \"-- URL's: {http://common-lisp.net/cldoc} + ;;; -- Common Lisp symbols: {defgeneric cldoc:extract-documentation}\" + ;;; (values)) + + will produce: + -- URL's: {http://common-lisp.net/cldoc} + -- Common Lisp symbols: {defgeneric cldoc:extract-documentation} Unlike Albert, {http://albert.sourceforge.net} , it does not allow programmers to insert comments at the source code level which are From ihatchondo at common-lisp.net Sun Jan 8 17:16:43 2006 From: ihatchondo at common-lisp.net (Iban Hatchondo) Date: Sun, 8 Jan 2006 18:16:43 +0100 (CET) Subject: [cldoc-cvs] CVS update: public_html/documentation.html Message-ID: <20060108171643.971F0885A2@common-lisp.net> Update of /project/cldoc/cvsroot/public_html In directory common-lisp.net:/tmp/cvs-serv24765 Modified Files: documentation.html Log Message: Link are supported. Date: Sun Jan 8 18:16:28 2006 Author: ihatchondo Index: public_html/documentation.html diff -u public_html/documentation.html:1.2 public_html/documentation.html:1.3 --- public_html/documentation.html:1.2 Sat Nov 19 20:04:11 2005 +++ public_html/documentation.html Sun Jan 8 18:16:26 2006 @@ -155,9 +155,11 @@ Recognizes code segments: by default each lines are prefixed with ';;; '. +
  • + Recognizes links: for standard URL's and symbol referencing. + (see the :link-delimiters option of the doctree class). +
    • -

    should be added to the DWIM:

    -

    Install From ihatchondo at common-lisp.net Sun Jan 8 17:19:32 2006 From: ihatchondo at common-lisp.net (Iban Hatchondo) Date: Sun, 8 Jan 2006 18:19:32 +0100 (CET) Subject: [cldoc-cvs] CVS update: cldoc/README Message-ID: <20060108171932.AA316885A2@common-lisp.net> Update of /project/cldoc/cvsroot/cldoc In directory common-lisp.net:/tmp/cvs-serv25219 Modified Files: README Log Message: Link support added. Date: Sun Jan 8 18:19:31 2006 Author: ihatchondo Index: cldoc/README diff -u cldoc/README:1.1.1.1 cldoc/README:1.2 --- cldoc/README:1.1.1.1 Fri Nov 18 15:52:17 2005 +++ cldoc/README Sun Jan 8 18:19:31 2006 @@ -14,9 +14,8 @@ - Recognizes bulleted lists (the list grammar can be specified). - Recognizes code segments: by default each lines are prefixed with ';;; '. - - should be added to the DWIM: - - links. how ? + - Recognizes links: for standard URL's and symbol referencing. + (see the :link-delimiters option of the doctree class). Unlike Albert (http://albert.sourceforge.net/) it does not allow programmers to insert comments at the source code level which are From ihatchondo at common-lisp.net Sun Jan 8 22:18:35 2006 From: ihatchondo at common-lisp.net (Iban Hatchondo) Date: Sun, 8 Jan 2006 23:18:35 +0100 (CET) Subject: [cldoc-cvs] CVS update: cldoc/src/html.lisp cldoc/src/package.lisp Message-ID: <20060108221835.D564E885A2@common-lisp.net> Update of /project/cldoc/cvsroot/cldoc/src In directory common-lisp.net:/tmp/cvs-serv16258/src Modified Files: html.lisp package.lisp Log Message: package def updated and cosmetic changes. Date: Sun Jan 8 23:18:33 2006 Author: ihatchondo Index: cldoc/src/html.lisp diff -u cldoc/src/html.lisp:1.10 cldoc/src/html.lisp:1.11 --- cldoc/src/html.lisp:1.10 Sun Jan 8 17:49:16 2006 +++ cldoc/src/html.lisp Sun Jan 8 23:18:26 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: html.lisp,v 1.10 2006/01/08 16:49:16 ihatchondo Exp $ +;;; $Id: html.lisp,v 1.11 2006/01/08 22:18:26 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator: HTML driver ;;; Created: 2005 10 23 2:30 @@ -514,8 +514,7 @@ (with-tag (:a (:href file)) (if (string/= name "the-index") (html-write "~d ~a~%" (incf i) name) - (html-write " Index")))))))))) - (truename toc))) + (html-write " Index")))))))))))) (defun get-defpackage-descriptor (meta-descriptors package-table) "Finds all the defpackage-descriptor and insert them in the package-table." @@ -635,7 +634,7 @@ defmacro descriptors if any." ;; Because neither the defstruct nor the defclass nor the define-condition ;; accessors are present in the list of descriptors they will be retrieved - ;; manually and added to defun or defmethod list before make-summary call. + ;; manually and added to defun or defmethod list before call make-summary. (flet ((mapconc (fun list) (apply #'concatenate 'list (mapcar fun list)))) (let* ((defmethods '(or defgeneric-descriptor defmethod-descriptor)) (defuns '(or defun-descriptor defsetf-descriptor)) Index: cldoc/src/package.lisp diff -u cldoc/src/package.lisp:1.3 cldoc/src/package.lisp:1.4 --- cldoc/src/package.lisp:1.3 Sun Jan 8 17:49:16 2006 +++ cldoc/src/package.lisp Sun Jan 8 23:18:27 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: package.lisp,v 1.3 2006/01/08 16:49:16 ihatchondo Exp $ +;;; $Id: package.lisp,v 1.4 2006/01/08 22:18:27 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator package definition ;;; Created: 2005 10 23 12:30 @@ -27,7 +27,8 @@ #:*class-inheritence* #:*condition-inheritence* #:*struct-inheritence* #:*slot-reader-control-string* #:*slot-writer-control-string* #:*slot-accessor-control-string* - #:+html-doctype+ #:+default-charset+ + #:+html-doctype+ #:+default-charset+ #:+default-link-delimiters+ + #:+default-section-prefix+ #:+default-code-prefix+ #:+default-section-names+ #:define-descriptor-handler #:find-descriptor-handler #:register-output-type @@ -40,7 +41,6 @@ #:html #:text #:extract-documentation - #:make-doc #:dformat #:dformat-documentation ;; cache system. @@ -48,7 +48,7 @@ #:meta-descriptor-href #:meta-descriptor-desc #:meta-descriptor-file #:clear-cache #:cache-descriptor #:initialise-cache #:lookup-meta-descriptor #:lookup-meta-descriptor-anchor - #:lookup-meta-descriptor-href + #:lookup-meta-descriptor-href #:cache-meta-descriptors ;; documentation string parsing utilities #:doctree #:doctree-tree From ihatchondo at common-lisp.net Mon Jan 9 22:23:45 2006 From: ihatchondo at common-lisp.net (Iban Hatchondo) Date: Mon, 9 Jan 2006 23:23:45 +0100 (CET) Subject: [cldoc-cvs] CVS update: cldoc/src/package.lisp Message-ID: <20060109222345.E2640880D9@common-lisp.net> Update of /project/cldoc/cvsroot/cldoc/src In directory common-lisp.net:/tmp/cvs-serv3411 Modified Files: package.lisp Log Message: removed non ascii space char. Date: Mon Jan 9 23:23:43 2006 Author: ihatchondo Index: cldoc/src/package.lisp diff -u cldoc/src/package.lisp:1.4 cldoc/src/package.lisp:1.5 --- cldoc/src/package.lisp:1.4 Sun Jan 8 23:18:27 2006 +++ cldoc/src/package.lisp Mon Jan 9 23:23:43 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: package.lisp,v 1.4 2006/01/08 22:18:27 ihatchondo Exp $ +;;; $Id: package.lisp,v 1.5 2006/01/09 22:23:43 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator package definition ;;; Created: 2005 10 23 12:30 @@ -80,7 +80,7 @@ - Recognizes code segments: by default each lines are prefixed with ';;; '. - Recognizes links: two kinds of hyper link are possible both using the same grammar: - [opening-char(defun|defclass|defgeneric|...) symbol-name closing-char]?| + [opening-char(defun|defclass|defgeneric|...) symbol-name closing-char] | [opening-char(http://|ftp://)address closing-char]. opening-char and closing char can be customized, see the :link-delimiters option of {defclass cldoc:doctree} . From ihatchondo at common-lisp.net Mon Jan 9 22:31:56 2006 From: ihatchondo at common-lisp.net (Iban Hatchondo) Date: Mon, 9 Jan 2006 23:31:56 +0100 (CET) Subject: [cldoc-cvs] CVS update: cldoc/COPYING cldoc/INSTALL cldoc/README Message-ID: <20060109223156.DC271880D9@common-lisp.net> Update of /project/cldoc/cvsroot/cldoc In directory common-lisp.net:/tmp/cvs-serv4572 Modified Files: COPYING INSTALL README Log Message: removed non ascii space char. Date: Mon Jan 9 23:31:50 2006 Author: ihatchondo From ihatchondo at common-lisp.net Mon Jan 9 22:32:15 2006 From: ihatchondo at common-lisp.net (Iban Hatchondo) Date: Mon, 9 Jan 2006 23:32:15 +0100 (CET) Subject: [cldoc-cvs] CVS update: cldoc/src/package.lisp Message-ID: <20060109223215.C2AB4880D9@common-lisp.net> Update of /project/cldoc/cvsroot/cldoc/src In directory common-lisp.net:/tmp/cvs-serv4604/src Modified Files: package.lisp Log Message: removed non ascii space char. Date: Mon Jan 9 23:32:13 2006 Author: ihatchondo Index: cldoc/src/package.lisp diff -u cldoc/src/package.lisp:1.5 cldoc/src/package.lisp:1.6 --- cldoc/src/package.lisp:1.5 Mon Jan 9 23:23:43 2006 +++ cldoc/src/package.lisp Mon Jan 9 23:32:12 2006 @@ -1,5 +1,5 @@ ;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: CLUDG; -*- -;;; $Id: package.lisp,v 1.5 2006/01/09 22:23:43 ihatchondo Exp $ +;;; $Id: package.lisp,v 1.6 2006/01/09 22:32:12 ihatchondo Exp $ ;;; --------------------------------------------------------------------------- ;;; Title: Common Lisp Universal Documentation Generator package definition ;;; Created: 2005 10 23 12:30