Merge pull request #1495 from cgay/doc-linkification

Doc linkification and :macrocall: improvements

Author: cgay

documentation/library-reference/source/c-ffi/index.rst

@@ -13,7 +13,7 @@ The bit-set Module
    :keyword all-members-from: If this is a non-negative integer then the set
       created will be infinite. All integers greater than
       or equal to the one supplied will be members of the
-      set. The default is ``#f``.
+      set. The default is :drm:`#f`.
    :keyword member-vector:
    :keyword members: If supplied, this gives the initial elements of the
       set as a sequence of integers.
@@ -67,7 +67,7 @@ The bit-set Module
 
    :description:
 
-      Returns ``#t`` if the set is infinite, otherwise ``#f``.
+      Returns :drm:`#t` if the set is infinite, otherwise :drm:`#f`.
 
 .. generic-function:: member?
    :sealed:
@@ -80,7 +80,7 @@ The bit-set Module
 
    :description:
 
-     Returns ``#t`` if ``element`` is a member of the set, otherwise ``#f``.
+     Returns :drm:`#t` if ``element`` is a member of the set, otherwise :drm:`#f`.
      ``element`` must be a non-negative integer.
 
 .. generic-function:: set-add
@@ -260,11 +260,11 @@ The bit-set Module
    :signature: size *set* => *false-or-integer*
 
    :parameter set: An instance of :class:`<bit-set>`.
-   :value size: Either ``#f`` or an instance of :drm:`<integer>`.
+   :value size: Either :drm:`#f` or an instance of :drm:`<integer>`.
 
    :description:
 
-     Returns the cardinality of the set or ``#f`` if the set is
+     Returns the cardinality of the set or :drm:`#f` if the set is
      infinite. This operation may be relatively slow.
 
 .. function:: universal-bit-set!

documentation/library-reference/source/collections/bit-set.rst

@@ -79,9 +79,8 @@ Reference
    Modify the *plist*, adding *indicator* with the given *value*.
 
    :macrocall:
-     .. code-block:: dylan
-
-       put-property!(*plist*, *indicator*, *value*)
+      .. parsed-literal:: 
+         put-property!(`plist`, `indicator`, `value`)
 
    :parameter plist: An instance of :drm:`<sequence>`.
    :parameter indicator: An instance of :drm:`<object>`.
@@ -120,9 +119,8 @@ Reference
    if any.
 
    :macrocall:
-     .. code-block:: dylan
-
-       remove-property!(*plist*, *indicator*)
+      .. parsed-literal:: 
+         remove-property!(`plist`, `indicator`)
 
    :parameter plist: An instance of :drm:`<sequence>`.
    :parameter indicator: An instance of :drm:`<object>`.
@@ -157,16 +155,13 @@ Reference
    :statement:
 
    :macrocall:
-     .. code-block:: dylan
-
-       with-keywords-removed(*var* = *plist*, *keywords*)
-         *body*
-       end
+      .. parsed-literal:: 
+         with-keywords-removed(`var` = `plist`, `keywords`) `body` end
 
-   :parameter var: A Dylan name *bnf*.
+   :parameter var: A Dylan name *BNF*.
    :parameter plist: An instance of :drm:`<sequence>`.
    :parameter keywords: An instance of :drm:`<sequence>`.
-   :parameter body: A Dylan body *bnf*.
+   :parameter body: A Dylan body *BNF*.
 
    :description:
 

documentation/library-reference/source/collections/plists.rst

@@ -73,7 +73,7 @@ init-keyword. The legal values for this keyword are:
 - ``#"value"`` Creates a table with weak values. When there are no longer
   any strong references to a value, the table entry of which it is a
   part becomes eligible for garbage collection.
-- ``#f`` Creates a table with strong keys and values. This is the default
+- :drm:`#f` Creates a table with strong keys and values. This is the default
   value.
 
 The table-extensions Module
@@ -104,13 +104,13 @@ from the module *table-extensions*.
 
 .. class:: <case-insensitive-string-table>
    :sealed:
-   
+
    A table class that uses case-insensitive strings for keys.
-   
+
    :superclasses: :drm:`<table>`
-   
+
    :description:
-   
+
      The ``<string-table>`` class is the class of tables that use
      instances of :drm:`<string>` for their keys. It is an error to use a
      key that is not an instance of :drm:`<string>`.
@@ -147,7 +147,7 @@ from the module *table-extensions*.
    :parameter elt-hash-function: An instance of :drm:`<function>`.
    :parameter collection: An instance of :drm:`<collection>`.
    :parameter initial-state: An instance of ``<hash-state>``.
-   :parameter #key ordered: An instance of :drm:`<boolean>`. Default value: ``#f``.
+   :parameter #key ordered: An instance of :drm:`<boolean>`. Default value: :drm:`#f`.
    :value hash-id: An instance of :drm:`<integer>`.
    :value result-state: An instance of ``<hash-state>``.
 
@@ -172,7 +172,7 @@ from the module *table-extensions*.
    :parameter elt-hash-function: An instance of :drm:`<function>`.
    :parameter sequence: An instance of :drm:`<sequence>`.
    :parameter initial-state: An instance of ``<hash-state>``.
-   :parameter #key ordered: An instance of :drm:`<boolean>`. Default value: ``#f``.
+   :parameter #key ordered: An instance of :drm:`<boolean>`. Default value: :drm:`#f`.
    :value hash-id: An instance of :drm:`<integer>`.
    :value result-state: An instance of ``<hash-state>``.
 
@@ -346,26 +346,26 @@ from the module *table-extensions*.
 
 .. macro:: tabling
    :macro-type: Function
-   
+
    Creates a table and populates it with keys and values.
-   
+
    :macrocall:
-     .. parsed-literal::
-        tabling( { `class`, } `key` => `value`, ...)
-           
+     .. parsed-literal:: 
+        tabling( [ `class`, ] `key` => `value`, ...)
+
    :parameter class:  An instance of :drm:`<class>`. Optional.
    :parameter key:    An expression.
    :parameter value:  An expression.
    :value table:      A new instance of *class*.
-   
+
    :description:
-   
+
      Creates a table of type *class* and populates it with *key*/*value*
      pairs. If *class* is omitted, creates a table of type :drm:`<table>`.
 
    :example:
-   
+
      .. code-block:: dylan
 
-       let my-table = tabling("red"=>"stop", "green"=>"go");
-       let my-table = tabling(<string-table>, "red"=>"stop", "green"=>"go");
+       let my-table = tabling(#"red" => "stop", #"green" => "go");
+       let my-table = tabling(<string-table>, "red" => "stop", "green" => "go");

documentation/library-reference/source/collections/table-extensions.rst

@@ -98,7 +98,7 @@ The coloring-stream Module
      to determine whether or not the underlying stream supports
      color output.
 
-     When *force-ansi?* is ``#t``, then the usual checks are skipped
+     When *force-ansi?* is :drm:`#t`, then the usual checks are skipped
      and a coloring stream that generates ANSI output is created.
      This is useful when outputting to a string prior to writing the
      text to :var:`*standard-output*` or when writing a network server
@@ -163,7 +163,7 @@ The coloring-stream Module
      ANSI color output, assuming that the underlying stream
      supports color output at all.
 
-     On Unix, this will always return ``#t``.
+     On Unix, this will always return :drm:`#t`.
 
      On Windows, this attempts to detect situations where ANSI
      output would be permissible, such as running within an

documentation/library-reference/source/coloring-stream/index.rst

@@ -349,7 +349,7 @@ The command-line-parser Module
 
    :signature: print-synopsis (parser subcommand #key stream) => ()
    :parameter parser: An instance of :class:`<command-line-parser>`.
-   :parameter subcommand: An instance of :class:`<subcommand>` or ``#f``.
+   :parameter subcommand: An instance of :class:`<subcommand>` or :drm:`#f`.
    :parameter #key stream: An instance of :class:`<stream>`.
 
    :description:
@@ -359,15 +359,15 @@ The command-line-parser Module
 
 .. function:: option-present?
 
-   Returns ``#t`` if this option was supplied on the command line.
+   Returns :drm:`#t` if this option was supplied on the command line.
 
    :signature: option-present? (option) => (present?)
    :parameter option: An instance of :class:`<option>`.
    :value present?: An instance of :drm:`<boolean>`.
    :description:
 
-     Returns ``#t`` if this option was supplied on the command line. Returns
-     ``#f`` if called before :func:`parse-command-line` has been called on the
+     Returns :drm:`#t` if this option was supplied on the command line. Returns
+     :drm:`#f` if called before :func:`parse-command-line` has been called on the
      associated parser, or if the option wasn't supplied on the command line.
 
 .. function:: option-value
@@ -382,7 +382,7 @@ The command-line-parser Module
      Returns the parsed value of the option supplied on the command line.  If
      no value was supplied on the command line it returns the value specified
      with ``default:`` when the option was created, which in turn defaults to
-     ``#f``.
+     :drm:`#f`.
 
      Note that the type of the return value is specified by the ``type:``
      keyword argument when the option was created and the string supplied on
@@ -517,7 +517,7 @@ Option Classes
 
      A default value for the option that will be used if the option isn't
      specified by the user. The default value should be a member of the type
-     specified with the ``type:`` keyword. ``#f`` is the default default value.
+     specified with the ``type:`` keyword. :drm:`#f` is the default default value.
 
 .. class:: <flag-option>
    :sealed:
@@ -532,7 +532,7 @@ Option Classes
 
    :description:
 
-     They default to ``#f`` and may exist in both positive and negative forms:
+     They default to :drm:`#f` and may exist in both positive and negative forms:
      ``--foo`` and ``--no-foo``.  In the case of conflicting options, the
      rightmost takes precedence to allow for abuse of the shell's "alias"
      command.
@@ -554,7 +554,7 @@ Option Classes
 
      If the option appears more than once, the rightmost value takes
      precedence. If the option never appears, these will default to
-     ``#f``.
+     :drm:`#f`.
 
      Examples::
 
@@ -572,8 +572,8 @@ Option Classes
    :description:
 
      The parameter must directly follow the option with no intervening
-     whitespace, or follow an "=" token. The value is ``#f`` if the option
-     never appears, ``#t`` if the option appears but the parameter does
+     whitespace, or follow an "=" token. The value is :drm:`#f` if the option
+     never appears, :drm:`#t` if the option appears but the parameter does
      not, and the value of the parameter otherwise.
 
      Examples::
@@ -617,12 +617,12 @@ Option Classes
      :class:`<usage-error>` is signaled.  If you supply a sequence of
      non-string choices you will also need to supply the ``test:``
      init keyword since all command-line arguments are strings and
-     won't compare equal with the default test, ``=``.
+     won't compare equal with the default test, :drm:`=`.
 
    :keyword test:
 
      A function to test whether the value supplied on the command line
-     is the same as one of the choices.  The default is ``=``.  Another
+     is the same as one of the choices.  The default is :drm:`=`.  Another
      commonly used value is ``string-equal-ic?``, to ignore case in the
      comparison.
 
@@ -651,7 +651,7 @@ Option Classes
      The final value is a :class:`<string-table>` containing each specified
      key, with one of the following values:
 
-     * ``#t``: The user specified "-Dkey"
+     * :drm:`#t`: The user specified "-Dkey"
      * a string: The user specified "-Dkey=value"
 
      You can read this with ``element(table, key, default: #f)`` to get a