October 2007 - defdoc-cvs@common-lisp.net

[defdoc-cvs] CVS DefDoc/website
by rjain 11 Oct '07

11 Oct '07

Update of /project/defdoc/cvsroot/DefDoc/website In directory clnet:/tmp/cvs-serv20572 Modified Files: website.lisp Log Message: Use project-website document class from contribs --- /project/defdoc/cvsroot/DefDoc/website/website.lisp 2004/02/15 08:48:19 1.3 +++ /project/defdoc/cvsroot/DefDoc/website/website.lisp 2007/10/11 16:24:19 1.4 @@ -1,7 +1,8 @@ -(asdf:operate 'asdf:load-op :defdoc) +(asdf:operate 'asdf:load-op :defdoc.contrib.project-website) (defpackage :defdoc.website - (:use :defdoc :defdoc.elements :defdoc.layout :common-lisp :defdoc.frontends.basic)) + (:use :defdoc :defdoc.elements :defdoc.layout :common-lisp :defdoc.frontends.basic + :defdoc.contrib.project-website)) (in-package :defdoc.website) @@ -16,37 +17,40 @@ (defun gen-mailing-list-link (target) (concatenate 'string "/mailman/listinfo/defdoc-" target)) -(defdoc index (document title (doc DefDoc) - subtitle "An extensible, dynamic document creation system" - author "Rahul Jain") - (section (title "Documentation") - (paragraph () - "I have written up a document that is an overview of the goals and rationale behind "(DefDoc)". " - "It is available as " - (link (url "overview.tex") (LaTeX))", " - (link (url "overview.pdf") "PDF")", and " - (link (url "overview.ps") "Postscript")".")) - (section (title "Code") - (paragraph () - "The code is very incomplete, but what there is is " - (link (url (gen-src-link "/")) "publically available")". " - "There are definitions for various types of " - (link (url (gen-src-link "/elements/")) "document elements")". " - "There are also definitions for the abstract types of " - (link (url (gen-src-link "/layout/")) "layout engines") - " as well as the " - (link (url (gen-src-link "/layout/html-engine.lisp")) " HTML layout engine")". " - "Finally, there is a " - (link (url (gen-src-link "/frontends/basic/")) "basic frontend")", " - "essentially a few simple macros for creating "(DefDoc)" documents. " - "A more fully-featured frontend is planned, which will be sensitive to the " - "current context and allow texual content to be entered unquoted.") - (paragraph () - "This site is actually a "(DefDoc)" " - (link (url (gen-src-link "/../website/website.lisp")) "document")".")) - (section (title "Communication") - (paragraph () - "There are 3 mailing lists for "(DefDoc)", " - (link (url (gen-mailing-list-link "announce")) "defdoc-announce")", " - (link (url (gen-mailing-list-link "devel")) "defdoc-devel")", and " - (link (url (gen-mailing-list-link "cvs")) "defdoc-cvs")"."))) +(defdoc index (project-website name (doc DefDoc) + short-description "An extensible, dynamic document creation system" + author "Rahul Jain") + (documentation () + (paragraph () + "I have written up a document that is an overview of the goals and rationale behind "(DefDoc)". " + "It is available as " + (link (url "overview.tex") (LaTeX))", " + (link (url "overview.pdf") "PDF")", and " + (link (url "overview.ps") "Postscript")".")) + (code () + (paragraph () + "The code is very incomplete, but what there is is " + (link (url (gen-src-link "/")) "publically available")". " + "There are definitions for various types of " + (link (url (gen-src-link "/elements/")) "document elements")". " + "There are also definitions for the abstract types of " + (link (url (gen-src-link "/layout/")) "layout engines") + " as well as the " + (link (url (gen-src-link "/layout/html-engine.lisp")) " HTML layout engine")". " + "Finally, there is a " + (link (url (gen-src-link "/frontends/basic/")) "basic frontend")", " + "essentially a few simple macros for creating "(DefDoc)" documents. " + "A more fully-featured frontend is planned, which will be sensitive to the " + "current context and allow texual content to be entered unquoted.") + (paragraph () + "This site is actually a "(DefDoc)" " + (link (url (gen-src-link "/../website/website.lisp")) "document")".")) + (dependencies () + (link (url "http://www.common-lisp.net/projects/rjain-utils/specified-types.html") + "Specified types")) + (communication () + (paragraph () + "There are 3 mailing lists for "(DefDoc)", " + (link (url (gen-mailing-list-link "announce")) "defdoc-announce")", " + (link (url (gen-mailing-list-link "devel")) "defdoc-devel")", and " + (link (url (gen-mailing-list-link "cvs")) "defdoc-cvs")".")))

1 0

[defdoc-cvs] CVS DefDoc/contrib/project-website
by rjain 11 Oct '07

11 Oct '07

Update of /project/defdoc/cvsroot/DefDoc/contrib/project-website In directory clnet:/tmp/cvs-serv20352/contrib/project-website Modified Files: project-website.lisp Log Message: add "Dependencies" section --- /project/defdoc/cvsroot/DefDoc/contrib/project-website/project-website.lisp 2004/02/16 05:45:35 1.1 +++ /project/defdoc/cvsroot/DefDoc/contrib/project-website/project-website.lisp 2007/10/11 16:22:10 1.2 @@ -7,7 +7,8 @@ #:short-description #:documentation #:code - #:communication)) + #:communication + #:dependencies)) (in-package :defdoc.contrib.project-website) @@ -24,12 +25,18 @@ (defclass communication (section) ((title :allocation :class :initform "Communication"))) +(defclass dependencies (section) + ((title :allocation :class :initform "Dependencies"))) + +(defmethod convert ((input dependencies) (output t)) + (break) + (convert (make-instance 'itemized-list (contents input)) output)) (defgeneric section-before-p (o1 o2)) #.`(progn ,@ - (let ((order '(documentation code communication))) + (let ((order '(documentation code dependencies communication))) (loop for (prior . following-list) on order nconc (loop for following in following-list collect `(defmethod section-before-p ((o1 ,prior) (o2 ,following))

1 0

[defdoc-cvs] CVS DefDoc/src/layout
by rjain 11 Oct '07

11 Oct '07

Update of /project/defdoc/cvsroot/DefDoc/src/layout In directory clnet:/tmp/cvs-serv18720/src/layout Modified Files: html-engine.lisp Log Message: Add conversion for itemized lists --- /project/defdoc/cvsroot/DefDoc/src/layout/html-engine.lisp 2004/02/15 05:35:04 1.5 +++ /project/defdoc/cvsroot/DefDoc/src/layout/html-engine.lisp 2007/10/11 16:20:10 1.6 @@ -273,6 +273,12 @@ (with-html-block (:BLOCKQUOTE) (convert))) +(define-html-conversion itemized-list (input) + (with-html-block (:UL) + (dolist (element (contents input)) + (with-html-block (:LI) + (convert element))))) + (define-html-conversion preformatted-paragraph (input) (with-html-block+ (0 nil :PRE) (let ((*suppress-html-wrapping* t))

1 0

[defdoc-cvs] CVS DefDoc/src/elements
by rjain 11 Oct '07

11 Oct '07

Update of /project/defdoc/cvsroot/DefDoc/src/elements In directory clnet:/tmp/cvs-serv18177/src/elements Modified Files: structural.lisp Log Message: flesh out more of the definition-list class --- /project/defdoc/cvsroot/DefDoc/src/elements/structural.lisp 2003/12/07 23:27:11 1.1.1.1 +++ /project/defdoc/cvsroot/DefDoc/src/elements/structural.lisp 2007/10/11 16:18:09 1.2 @@ -37,12 +37,24 @@ (:documentation "A list of items labelled with a special character (bullet) to set each one off.")) +(defclass list-item (logical-structure-element) + () + (:documentation "An item in a listed-information element")) + (defclass definition-list (listed-information) () - (:documentation "A list ot terms and one or more definitions for each. The contents are + (:documentation "A list of terms and one or more definitions for each. The contents are an alist. Each CAR is the term being defined, each CDR is the definition or list of definitions.")) +(defclass defined-term (list-item) + () + (:documentation "An item in a definition-list: the term which will be defined")) + +(defclass term-definition (logical-structure-element) + () + (:documentation "An item in a definition-list: the definition of the term just introduced")) + (defclass preformatted-paragraph (logical-structure-element) () (:documentation "A paragraph whose elements are already laid out according to a

1 0

[defdoc-cvs] CVS DefDoc/src
by rjain 11 Oct '07

11 Oct '07

Update of /project/defdoc/cvsroot/DefDoc/src In directory clnet:/tmp/cvs-serv18117/src Modified Files: defdoc.asd Log Message: add documentation and other meta information to the defpackage form --- /project/defdoc/cvsroot/DefDoc/src/defdoc.asd 2004/02/16 05:44:08 1.5 +++ /project/defdoc/cvsroot/DefDoc/src/defdoc.asd 2007/10/11 16:17:31 1.6 @@ -1,4 +1,14 @@ (asdf:defsystem :DefDoc + :description "An extensible, object-oriented, dynamic document creation system." + :long-description "DefDoc lets you create structured documents using +a hierarchial format where each of the elements is an object. The +document can be modified interactively and dynamically and can be output +to any format for which an output engine is defined." + :properties ((:debian-package-name . "defdoc")) + :maintainer "Rahul Jain <rjain(a)common-lisp.net>" + :licence "MIT" + :version "0.0.1" + :components ((:module :core :pathname ""

1 0

[defdoc-cvs] CVS DefDoc/src/elements
by rjain 11 Oct '07

11 Oct '07

Update of /project/defdoc/cvsroot/DefDoc/src/elements In directory clnet:/tmp/cvs-serv18019 Modified Files: basic-elements.lisp Log Message: remove superclass that's not necessary --- /project/defdoc/cvsroot/DefDoc/src/elements/basic-elements.lisp 2004/03/01 18:14:54 1.2 +++ /project/defdoc/cvsroot/DefDoc/src/elements/basic-elements.lisp 2007/10/11 16:16:18 1.3 @@ -175,7 +175,7 @@ (defvar *default-line-rule-thickness* '(4/10 px)) -(defclass rule-mixin (dimension-mixin) +(defclass rule-mixin () () (:documentation "An element that is filled with ink within the dimension boundaries."))

1 0