7.2 Text markup: fonts and links
AllApplicationManualNameSummaryHelp

  • Documentation
    • Reference manual
    • Packages
      • SWI-Prolog Source Documentation Version 2
        • Wiki notation
          • Text markup: fonts and links
            • Emphasizing text
            • Inline code
            • Links

7.2.2 Inline code

Inline code can be realised using the = switch described in section 7.2.1 or the markdown backtick. In addition, it can use the mardown/Doxygen backtick (`) convention: a string that is delimited by backticks is considered code, provided:

  • An internal double backtick is translated into a single backtick.
  • Inline code is limited to the current structure (paragraph, table cell, list item, etc.
  • The content of the code block is valid Prolog syntax. Note that in Doxygen, the syntax is not validated and a single quote cancels the recognition as code. The latter is a problematic in Prolog because single quotes are often required.

Currently,‘Var` is typeset as a variable (italics) and other terms are typeset using a fixed-width code font.

In addition, compound terms in canonical notation (i.e., functor(,...args...) that can be parsed are first verified as a file-specification for absolute_file_name/3 and otherwise rendered as code.