		Search-engine friendly clone of the ACL2 documentation.

Primitive-constructors

Box

Construct an XDOC tree for an XDOC box <box>...</box>.

See the primitive constructors topic for information about the kind of arguments that must be passed to this constructor.

Macro: box

(defmacro box (&rest args)
  (mv-let (trees attributes)
          (partition-macro-args args 'box)
    (let ((attributes (keyword-macro-args-to-terms attributes)))
      (list 'box-fn
            (cons 'list attributes)
            (cons 'list trees)))))

Definitions and Theorems

Function: box-fn

(defun box-fn (attributes trees)
  (declare (xargs :guard (and (keyword-tree-alistp attributes)
                              (tree-listp trees))))
  (make-tree-tag :box attributes trees))

Theorem: stringp-of-box

(defthm stringp-of-box
  (equal (treep (box-fn attributes trees))
         (and (keyword-tree-alistp attributes)
              (tree-listp trees))))