/[cldoc]/public_html/documentation.html
ViewVC logotype

Contents of /public_html/documentation.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.3 - (show annotations)
Sun Jan 8 17:16:26 2006 UTC (8 years, 3 months ago) by ihatchondo
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +4 -2 lines
File MIME type: text/html
Link are supported.
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en-GB">
5
6 <!--
7 _________________________________________________________
8 | |
9 | DESIGN + http://fullahead.org |
10 | DATE + 2005.05.12 |
11 | COPYRIGHT + free use if this notice is kept in place |
12 |_________________________________________________________|
13
14 -->
15
16 <head>
17
18 <meta http-equiv="content-type"
19 content="application/xhtml+xml; charset=UTF-8" />
20 <meta name="author" content="Iban Hatchondo" />
21 <meta name="keywords"
22 content="CLDOC, Common Lisp, automatic, documentation," />
23 <meta name="description"
24 content="Automatically documents Common Lisp source code." />
25
26 <link rel="stylesheet"
27 type="text/css"
28 href="css/screen_yellow.css"
29 media="screen, tv, projection" />
30
31 <title>CLDOC</title>
32
33 </head>
34
35 <body>
36
37 <!-- Main site container -->
38 <div id="siteBox">
39
40 <!-- Main site header : holds the img, title and top tabbed menu -->
41 <div id="header">
42
43 <!-- top rounded corner -->
44 <img src="images/corner_tl.gif" alt="corner" style="float:left;" />
45
46
47 <!-- Site title and subTitle -->
48 <span class="title">
49 <span class="white">CL</span>DOC
50 <span class="subTitle">
51 Documentation Tool
52 </span>
53 </span>
54
55 <!--
56 | Menu is displayed in reverse order from how you define it
57 | (caused by float: right)
58 -->
59 <a href="resources.html" title="resources" class="lastMenuItem">
60 resources<span class="desc">mailing list</span>
61 </a>
62 <a href="downloads.html" title="downloads">
63 downloads<span class="desc">free quotes</span>
64 </a>
65 <a href="documentation.html" title="documentation" class="active">
66 CLDoc<span class="desc">Documentation</span>
67 </a>
68 <a href="index.html" title="home">
69 home<span class="desc">welcome</span>
70 </a>
71
72 </div>
73
74 <!-- Content begins -->
75 <div id="content">
76
77 <!-- Left side menu : side bar links/news/search/etc. -->
78 <div id="contentLeft">
79
80 <p>
81 <span class="header">Quick links</span>
82 </p>
83
84 <p>
85 <a href="/cgi-bin/viewcvs.cgi/cldoc/?cvsroot=cldoc"
86 title="CVSWeb"
87 class="menuItem">CVSWeb</a>
88 <a href="HTMLdoc"
89 title="documentation"
90 class="menuItem">HTML documentation</a>
91 <a href="http://opensource.franz.com/preamble.html"
92 title="LLGPL"
93 class="menuItem">Lisp Lesser GPL</a>
94 </p>
95
96
97 <!-- Creates the rounded corner on the bottom of the left menu -->
98 <div class="bottomCorner">
99 <img src="images/corner_sub_br.gif"
100 alt="bottom corner" class="vBottom"/>
101 </div>
102
103 </div>
104
105
106
107 <!-- Right side main content -->
108 <div id="contentRight">
109
110 <p>
111 <span class="header">Getting started</span>
112 CLDOC reads lisp source files and generates documentation
113 using the selected output driver. Because it is performing
114 some symbol package resolution it needs packages definition
115 to be, at least loaded. A simple way to satisfy this
116 condition is to load, such as require would, the systems to
117 be documented before starting documentation extraction.
118 </p>
119 <p>
120 To get started with documentation extraction see the
121 extract-documentation generic function:
122 </p>
123 <pre>
124 (cldoc:extract-documentation 'cludg:html &quot;docu&quot;
125 (asdf:find-system :cldoc)
126 :table-of-contents-title
127 &quot;Common Lisp Universal Documentation Generator&quot;)</pre>
128 <p>
129 If you want your particular macro top-level form to be parsed,
130 then use the define-descriptor-handler macro. A basic use case
131 of this macro would be:
132 </p>
133 <pre>
134 ;; Extracted from doc-cludg.lisp
135 (cldoc::define-descriptor-handler DEFINE-STRING-PURGER (form)
136 "string purger"
137 (setf (car form) 'cldoc::define-string-purger)
138 (values nil :restart (list (let ((*print-case* :upcase))
139 (macroexpand-1 form)))))</pre>
140
141 <p>
142 It currently has an HTML driver that generates XHTML 1.0 Strict.
143 This HTML driver has some simple DWIM (Do What I Mean) capabilities
144 using the doctree string parser facilities:
145 </p>
146 <ul>
147 <li>
148 Recognize both indent and empty-line paragraph breaks.
149 </li>
150 <li>
151 Recognizes bulleted lists (the list grammar can be
152 specified).
153 </li>
154 <li>
155 Recognizes code segments: by default each lines are prefixed
156 with ';;; '.
157 </li>
158 <li>
159 Recognizes links: for standard URL's and symbol referencing.
160 (see the :link-delimiters option of the <a href="HTMLdoc/string-parser.html">doctree class</a>).
161 </li>
162 </ul>
163
164 <p>
165 <span class="header">Install</span>
166 We will assume that if you have gotten this far, it means that
167 you have either extracted a tar file with everything in it, or
168 checked out the files from some
169 <a href="/cgi-bin/viewcvs.cgi/cldoc/cldoc.tar.gz?tarball=1&cvsroot=cldoc">
170 CVS</a>
171 repository.
172 </p>
173 <ol>
174 <li> Start Lisp either from the shell or from Emacs</li>
175 <li> (load &quot;cldoc.asd&quot;)<br/>
176 This command will load the system definition file containing
177 system definitions for ASDF.
178 </li>
179 <li> (asdf:operate 'asdf:load-op :cldoc)
180 This command will compile and load the source files in the
181 right order.
182 </li>
183 <li> See cldoc:extract-documentation generic function
184 documentation in the doc/html directory.
185 </li>
186 </ol>
187 <!-- Creates bottom left rounded corner -->
188 <img src="images/corner_sub_bl.gif" alt="bottom corner" class="vBottom"/>
189
190 </div>
191
192 </div>
193
194
195
196 <!-- Footer begins -->
197 <div id="footer">
198
199 <div id="footerLeft">
200 &nbsp;&nbsp;design
201 <a href="http://oswd.org/userinfo.phtml?user=snop"
202 title="OSWD design work">snop</a>
203 <span class="grey">=</span> valid
204 <a href="http://validator.w3.org/check?uri=referer"
205 title="validate XHTML">XHTML</a> &amp;
206 <a href="http://jigsaw.w3.org/css-validator" title="validate CSS">CSS</a>
207 </div>
208
209 <div id="footerRight">&nbsp;</div>
210
211 </div>
212
213 </div>
214
215 </body>
216
217 </html>

  ViewVC Help
Powered by ViewVC 1.1.5