Remove blue text typesetting convention for UPC++ identifiers

Issue #152 resolved
Dan Bonachea created an issue

Overview section 1.6 currently states:

UPC++ terms are set in the color bright blue except when they appear in a synopsis framebox.

However this statement is false, as this convention is applied only very sporadically. There are currently hundreds of places where we refer to UPC++ identifiers with inline \code{} resulting in typeset using black courier font.

I'd like to argue the documented convention is a poor convention, for the following reasons:

  1. Unlike the C++ keyword coloring, we have no automated mechanism in the TeX sources for coloring UPC++ identifiers - the currently colored instances have been applied manually using one-off macros.
  2. The change required to apply this convention uniformly would be huge and labor-intensive
  3. Maintaining it uniformly would be tedious and error-prone
  4. UPC++ identifiers frequently appear as parts of larger \code{} expressions, which would be especially obtrusive to maintain
  5. Blue is the color used for PDF hyperref links, so even if it were somehow applied uniformly the result would be visually confusing.
  6. Printed versions of the spec are likely to be grayscale, where the color is lost anyhow.

I motion that we strike this convention entirely and change the rare instances of identifiers typeset as blue-colored to regular black courier font.

Comments (3)

  1. Dan Bonachea reporter

    fix issue #152: Remove blue color text convention

    • Alter existing macros to remove coloring, and mark them as deprecated.
    • Remove unused macros.
    • Update conventions section

    → <<cset b7190821ed39>>

  2. Log in to comment