File: PRINT-DOC-START-COLUMN.html

package info (click to toggle)
acl2 3.1-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 36,712 kB
  • ctags: 38,396
  • sloc: lisp: 464,023; makefile: 5,470; sh: 86; csh: 47; cpp: 25; ansic: 22
file content (28 lines) | stat: -rw-r--r-- 1,419 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<html>
<head><title>PRINT-DOC-START-COLUMN.html  --  ACL2 Version 3.1</title></head>
<body text=#000000 bgcolor="#FFFFFF">
<h2>PRINT-DOC-START-COLUMN</h2>printing the one-liner
<pre>Major Section:  <a href="MISCELLANEOUS.html">MISCELLANEOUS</a>
</pre><p>


<pre>
Examples:
(assign print-doc-start-column nil)
(assign print-doc-start-column 17)
</pre>

<p>
This <a href="STATE.html">state</a> global variable controls the column in which the
``one-liner'' of a formatted <a href="DOCUMENTATION.html">documentation</a> string is printed.
Generally, when <code>:</code><code><a href="DOC.html">doc</a></code> is used to print a <a href="DOCUMENTATION.html">documentation</a> string, the
name of the documented concept is printed and then <code>:</code><code><a href="DOC.html">doc</a></code> tabs over to
<code>print-doc-start-column</code> and prints the one-liner.  If the name
extends past the desired column, <code>:</code><code><a href="DOC.html">doc</a></code> outputs a carriage return and
then tabs over to the column.  If <code>print-doc-start-column</code> is <code>nil</code>,
<code>:</code><code><a href="DOC.html">doc</a></code> just starts the one-liner two spaces from the end of the name,
on the same line.  The initial value of <code>print-doc-start-column</code> is
15.
<br><br><br><a href="acl2-doc.html"><img src="llogo.gif"></a> <a href="acl2-doc-index.html"><img src="index.gif"></a>
</body>
</html>