• Top
    • Documentation
      • Xdoc
        • Undocumented
        • Save
        • Defsection
        • Markup
        • Preprocessor
        • Terminal
        • Emacs-links
        • Defxdoc
        • Katex-integration
        • Constructors
          • Primitive-constructors
          • Composite-constructors
            • Xdoc::apt-constructors
            • Generic-composite-constructors
              • Desc
              • Codeblock
              • Subsection
              • Section
              • Seetopic
                • Ahref
                • Topstring
                • Subsubsection
                • Subsubsubsection
                • Topstring-@def
                • Topstring-p
              • Event-macro-xdoc-constructors
            • Constructor-preliminaries
            • Trees
          • Entities
          • Defxdoc+
          • Save-rendered
          • Add-resource-directory
          • Testing
          • Order-subtopics
          • Save-rendered-event
          • Archive-matching-topics
          • Archive-xdoc
          • Xdoc-extend
          • Set-default-parents
          • Missing-parents
          • Defpointer
          • Defxdoc-raw
          • Xdoc-tests
          • Xdoc-prepend
          • Defsection-progn
          • Gen-xdoc-for-file
        • ACL2-doc
        • Recursion-and-induction
        • Loop$-primer
        • Operational-semantics
        • Pointers
        • Doc
        • Documentation-copyright
        • Course-materials
        • Args
        • ACL2-doc-summary
        • Finding-documentation
        • Broken-link
        • Doc-terminal-test-2
        • Doc-terminal-test-1
      • Books
      • Boolean-reasoning
      • Projects
      • Debugging
      • Std
      • Proof-automation
      • Macro-libraries
      • ACL2
      • Interfacing-tools
      • Hardware-verification
      • Software-verification
      • Math
      • Testing-utilities
    • Generic-composite-constructors

    Seetopic

    Construct an XDOC tree for a string of the form <see topic="@(url ...)">...</see>.

    This is a fairly common pattern, with several opportunities for mistyping it. This XDOC constructor takes two strings as arguments, one for the topic and one for the hyperlinked text.

    Macro: seetopic

    (defmacro seetopic (topic text)
      (cons 'see_
            (cons ':topic
                  (cons (cons '@url (cons topic 'nil))
                        (cons text 'nil)))))