Commit 00469f1e authored by Dave Cooper's avatar Dave Cooper

added to auto-generated reference docs in the manual

parent 1d258c85
......@@ -311,9 +311,8 @@ loaderImg: '/static/gwl/tasty-unpix/loader.gif',loaderText: 'Narrowing Down...'}
package-form :type 'package-form))
:functions
(("Void. Prints to *html-stream* a bulleted list for each of the three categories of docs in the package."
dom-section
nil
(("List in GDL dom authoring format. Suitable for filling in a section of output document." dom-section
()
(mapcar #'(lambda(child)
(the-object child dom-subsections))
(the children))
......
......@@ -298,8 +298,48 @@ If you specify :part-symbol-supplied, do not specify :instance-supplied."))
(
(dom-body
()
`(:p "Mixins: " ,@(mapcar #'(lambda (sym) (string sym)) (the mixins-list))))
`((:p (:textbf (:underline "Mixins:")) " "
,(format nil "~{~a~^, ~}" (mapcar #'(lambda (sym) (string sym)) (the mixins-list))))
(:p ((:list :style :description)
,@(mapcar #'(lambda(keyword)
`((:item :word (:underline ,(format nil "~@(~a~)" keyword)))
(:p ,@(net.html.parser:parse-html (getf (the :part-documentation-plist) keyword)))))
(remove-if-not #'(lambda(keyword)
(getf (the part-documentation-plist) keyword))
(remove :examples (safe-sort *allowed-part-documentation-keywords* #'string<))))))
(:p ,@(or
(remove
nil
(mapcar #'(lambda (section)
(let ((values (the-object section message-and-remarks)))
(when values
`(:p
(:textbf (:underline ,(format nil "~@(~a~):" (the-object section heading))))
((:list :style :description)
,@(mapcar #'(lambda(value)
`((:item :word ,(format nil "~@(~a~)"
(first value)
#+nil ;; reformat inheritance note
(if (sixth value)
(format nil "[~a]" (sixth value))
"")))
(:index ,(format nil "~@(~a~)~%[~(~a~)]"
(first value)
(the symbol)))
,(if (getf (fourth value) :type)
`(:emph ,(replace-substring
(getf (fourth value) :type)
"-dot-" ".")) "")
,(getf (fourth value) :intro)
))
values))))))
(list-elements (the sections))))
`("")))))
(write-documentation
nil
......
......@@ -76,7 +76,7 @@ The javascript loaded is jquery."
(:i "User Code Packages copyright &copy; their respective authors"))))))
:functions
((dom-body () "")
((dom-body () `((:p "")))
(compute-url
()
......@@ -266,7 +266,7 @@ The javascript loaded is jquery."
(if (the-object documentation :macro?)
" [Macro]" ""))
,(the-object documentation dom-body))))
,@(the-object documentation dom-body))))
documentations))))))
......
\BOOKMARK [0][-]{chapter.1}{Introduction}{}% 1
\BOOKMARK [1][-]{section.1.1}{Welcome}{chapter.1}% 2
\BOOKMARK [1][-]{section.1.2}{Knowledge Base Concepts According to Genworks}{chapter.1}% 3
\BOOKMARK [1][-]{section.1.3}{Classic Definition of Knowledge Based Engineering \(KBE\)}{chapter.1}% 4
\BOOKMARK [1][-]{section.1.4}{Classic Caching Feature}{chapter.1}% 5
\BOOKMARK [1][-]{section.1.5}{Demand-Driven Evaluation}{chapter.1}% 6
\BOOKMARK [1][-]{section.1.6}{The Object-Oriented Paradigm meets the Functional paradigm}{chapter.1}% 7
\BOOKMARK [1][-]{section.1.7}{Object-oriented Systems}{chapter.1}% 8
\BOOKMARK [1][-]{section.1.8}{Object-oriented Analysis}{chapter.1}% 9
\BOOKMARK [1][-]{section.1.9}{Object-oriented Design}{chapter.1}% 10
\BOOKMARK [1][-]{section.1.10}{Goals for this Manual}{chapter.1}% 11
\BOOKMARK [1][-]{section.1.11}{What is GDL?}{chapter.1}% 12
\BOOKMARK [1][-]{section.1.12}{Why GDL \(what is GDL good for?\)}{chapter.1}% 13
\BOOKMARK [1][-]{section.1.13}{What GDL is not}{chapter.1}% 14
\BOOKMARK [0][-]{chapter.2}{Installation}{}% 15
\BOOKMARK [1][-]{section.2.1}{Installation of pre-packaged GDL}{chapter.2}% 16
\BOOKMARK [2][-]{subsection.2.1.1}{Download the Software and retrieve a license key}{section.2.1}% 17
\BOOKMARK [2][-]{subsection.2.1.2}{Unpack the Distribution}{section.2.1}% 18
\BOOKMARK [1][-]{section.2.2}{Installation of open-source Gendl}{chapter.2}% 19
\BOOKMARK [2][-]{subsection.2.2.1}{Install and Configure your Common Lisp environment}{section.2.2}% 20
\BOOKMARK [2][-]{subsection.2.2.2}{Load and Configure Quicklisp}{section.2.2}% 21
\BOOKMARK [2][-]{subsection.2.2.3}{Load and Start Gendl}{section.2.2}% 22
\BOOKMARK [1][-]{section.2.3}{System Testing}{chapter.2}% 23
\BOOKMARK [2][-]{subsection.2.3.1}{Basic Sanity Test}{section.2.3}% 24
\BOOKMARK [2][-]{subsection.2.3.2}{Full Regression Test}{section.2.3}% 25
\BOOKMARK [1][-]{section.2.4}{Getting Help and Support}{chapter.2}% 26
\BOOKMARK [0][-]{chapter.3}{Basic Operation of the GDL Environment}{}% 27
\BOOKMARK [1][-]{section.3.1}{What is Different about GDL?}{chapter.3}% 28
\BOOKMARK [1][-]{section.3.2}{Startup, ``Hello, World!'' and Shutdown}{chapter.3}% 29
\BOOKMARK [2][-]{subsection.3.2.1}{Startup}{section.3.2}% 30
\BOOKMARK [2][-]{subsection.3.2.2}{Developing and Testing a ``Hello World'' application}{section.3.2}% 31
\BOOKMARK [2][-]{subsection.3.2.3}{Shutdown}{section.3.2}% 32
\BOOKMARK [1][-]{section.3.3}{Working with Projects}{chapter.3}% 33
\BOOKMARK [2][-]{subsection.3.3.1}{Directory Structure}{section.3.3}% 34
\BOOKMARK [2][-]{subsection.3.3.2}{Source Files within a source/ subdirectory}{section.3.3}% 35
\BOOKMARK [2][-]{subsection.3.3.3}{Generating an ASDF System}{section.3.3}% 36
\BOOKMARK [2][-]{subsection.3.3.4}{Compiling and Loading a System}{section.3.3}% 37
\BOOKMARK [1][-]{section.3.4}{Customizing your Environment}{chapter.3}% 38
\BOOKMARK [1][-]{section.3.5}{Saving the World}{chapter.3}% 39
\BOOKMARK [1][-]{section.3.6}{Starting up a Saved World}{chapter.3}% 40
\BOOKMARK [0][-]{chapter.4}{Understanding Common Lisp}{}% 41
\BOOKMARK [1][-]{section.4.1}{S-expression Fundamentals}{chapter.4}% 42
\BOOKMARK [1][-]{section.4.2}{Fundamental CL Data Types}{chapter.4}% 43
\BOOKMARK [2][-]{subsection.4.2.1}{Numbers}{section.4.2}% 44
\BOOKMARK [2][-]{subsection.4.2.2}{Strings}{section.4.2}% 45
\BOOKMARK [2][-]{subsection.4.2.3}{Symbols}{section.4.2}% 46
\BOOKMARK [2][-]{subsection.4.2.4}{List Basics}{section.4.2}% 47
\BOOKMARK [2][-]{subsection.4.2.5}{The List as a Data Structure}{section.4.2}% 48
\BOOKMARK [0][-]{chapter.5}{Understanding GDL \204 Core GDL Syntax}{}% 49
\BOOKMARK [1][-]{section.5.1}{Defining a Working Package}{chapter.5}% 50
\BOOKMARK [1][-]{section.5.2}{Define-Object}{chapter.5}% 51
\BOOKMARK [1][-]{section.5.3}{Making Instances and Sending Messages}{chapter.5}% 52
\BOOKMARK [1][-]{section.5.4}{Objects}{chapter.5}% 53
\BOOKMARK [1][-]{section.5.5}{Sequences of Objects and Input-slots with a Default Expression}{chapter.5}% 54
\BOOKMARK [1][-]{section.5.6}{Summary}{chapter.5}% 55
\BOOKMARK [0][-]{chapter.6}{The Tasty Development Environment}{}% 56
\BOOKMARK [1][-]{subsection.6.0.1}{The Toolbars}{chapter.6}% 57
\BOOKMARK [2][-]{subsection.6.0.2}{View Frames}{subsection.6.0.1}% 58
\BOOKMARK [0][-]{chapter.7}{Working with Geometry in GDL}{}% 59
\BOOKMARK [1][-]{section.7.1}{The Default Coordinate System in GDL}{chapter.7}% 60
\BOOKMARK [1][-]{section.7.2}{Building a Geometric GDL Model from LLPs}{chapter.7}% 61
\BOOKMARK [0][-]{chapter.8}{Custom User Interfaces in Gendl}{}% 62
\BOOKMARK [1][-]{section.8.1}{Package and Environment for Web Development}{chapter.8}% 63
\BOOKMARK [1][-]{section.8.2}{Traditional Web Pages and Applications}{chapter.8}% 64
\BOOKMARK [2][-]{subsection.8.2.1}{A Simple Static Page Example}{section.8.2}% 65
\BOOKMARK [2][-]{subsection.8.2.2}{A Simple Dynamic Page which Mixes HTML and Common Lisp/Gendl}{section.8.2}% 66
\BOOKMARK [2][-]{subsection.8.2.3}{Linking to Multiple Pages}{section.8.2}% 67
\BOOKMARK [2][-]{subsection.8.2.4}{Form Controls and Fillout-Forms}{section.8.2}% 68
\BOOKMARK [1][-]{section.8.3}{Partial Page Updates with gdlAjax}{chapter.8}% 69
\BOOKMARK [2][-]{subsection.8.3.1}{Steps to Create a gdlAjax Application}{section.8.3}% 70
\BOOKMARK [2][-]{subsection.8.3.2}{Including Graphics}{section.8.3}% 71
\BOOKMARK [0][-]{chapter.9}{More Common Lisp for Gendl}{}% 72
\BOOKMARK [0][-]{chapter.10}{Advanced Gendl}{}% 73
\BOOKMARK [0][-]{chapter.11}{Gendl Reference}{}% 74
\BOOKMARK [1][-]{section.11.1}{CL-LITE \(Compile-and-Load Lite Utility\)}{chapter.11}% 75
\BOOKMARK [2][-]{subsection.11.1.1}{Object Definitions}{section.11.1}% 76
\BOOKMARK [2][-]{subsection.11.1.2}{Function and Macro Definitions}{section.11.1}% 77
\BOOKMARK [1][-]{section.11.2}{COM.GENWORKS.DOM }{chapter.11}% 78
\BOOKMARK [1][-]{section.11.3}{COM.GENWORKS.DOM-HTML }{chapter.11}% 79
\BOOKMARK [1][-]{section.11.4}{COM.GENWORKS.DOM-LATEX }{chapter.11}% 80
\BOOKMARK [1][-]{section.11.5}{COM.GENWORKS.DOM-WRITERS }{chapter.11}% 81
\BOOKMARK [1][-]{section.11.6}{GENDL \(Base Core Kernel Engine\) Nicknames: Gdl, Genworks, Base}{chapter.11}% 82
\BOOKMARK [2][-]{subsection.11.6.1}{Object Definitions}{section.11.6}% 83
\BOOKMARK [2][-]{subsection.11.6.2}{Function and Macro Definitions}{section.11.6}% 84
\BOOKMARK [2][-]{subsection.11.6.3}{Variables and Constants}{section.11.6}% 85
\BOOKMARK [1][-]{section.11.7}{GDL-USER }{chapter.11}% 86
\BOOKMARK [1][-]{section.11.8}{GENDL-DOC }{chapter.11}% 87
\BOOKMARK [1][-]{section.11.9}{GEOM-BASE \(Wireframe Geometry\)}{chapter.11}% 88
\BOOKMARK [2][-]{subsection.11.9.1}{Object Definitions}{section.11.9}% 89
\BOOKMARK [2][-]{subsection.11.9.2}{Function and Macro Definitions}{section.11.9}% 90
\BOOKMARK [2][-]{subsection.11.9.3}{Variables and Constants}{section.11.9}% 91
\BOOKMARK [1][-]{section.11.10}{GWL \(Generative Web Language \(GWL\)\)}{chapter.11}% 92
\BOOKMARK [2][-]{subsection.11.10.1}{Object Definitions}{section.11.10}% 93
\BOOKMARK [2][-]{subsection.11.10.2}{Function and Macro Definitions}{section.11.10}% 94
\BOOKMARK [2][-]{subsection.11.10.3}{Variables and Constants}{section.11.10}% 95
\BOOKMARK [1][-]{section.11.11}{JQUERY }{chapter.11}% 96
\BOOKMARK [1][-]{section.11.12}{RAPHAEL }{chapter.11}% 97
\BOOKMARK [1][-]{section.11.13}{ROBOT \(Simplified Android Robot example \)}{chapter.11}% 98
\BOOKMARK [1][-]{section.11.14}{SURF \(NURBS Surface and Solids Geometry Primitives\)}{chapter.11}% 99
\BOOKMARK [1][-]{section.11.15}{TASTY \(Web-based Development Environment \(tasty\)\)}{chapter.11}% 100
\BOOKMARK [1][-]{section.11.16}{TREE \(Tree component used by Tasty and potentially as a UI component on its own\)}{chapter.11}% 101
\BOOKMARK [2][-]{subsection.11.16.1}{Object Definitions}{section.11.16}% 102
\BOOKMARK [1][-]{section.11.17}{YADD \(Yet Another Definition Documenter \(yadd\)\)}{chapter.11}% 103
\BOOKMARK [2][-]{subsection.11.17.1}{Object Definitions}{section.11.17}% 104
This diff is collapsed.
......@@ -318,7 +318,7 @@ to Figure "
(:p "GDL provides a set of primitives useful for generating the
standard HTML form-controls"
(:footnote "http://www.w3.org/TR/html401/interact/forms.html")}
(:footnote "http://www.w3.org/TR/html401/interact/forms.html")
" such as text, checkbox, radio, submit, menu, etc. These
should be instantiated as child objects in the page, then
included in the HTML for the page
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment