Macaulay2 » Documentation
Packages » Macaulay2Doc :: hypertext

Synopsis

• Usage:

  hypertext x

• Inputs:
  • x, a list, a list of strings and hypertext mark-up lists
• Outputs:
  • a markup list, a new list of mark-up lists obtained from the old by making the format more suitable for ultimate display

Description

Here is a list of some of the transformations that are performed.

• occurrences of null, such as those that might have been produced by the insertion of an extra comma, are removed
• sequences, such as those produced by extra sets of parentheses, are spliced into the lists containing them
• the contents of lists and sequences are merged into the mark-up lists containing them
• mark-up lists of type TO occurring a mark-up list of type UL are converted to lists of type TOH, so the headlines of the items will appear in the resulting menu
• the targets of the links in mark-up lists of type TO, TOH, and TO2, are converted into document tags
• mark-up types, such as PARA, are converted into lists of length 0 of that type
• strings spanning multiple lines are wrapped into one long line after appropriately trimming the spaces at the beginning and end of each line
• an error message is produced if something not recognizable as documentation is encountered

We may phase out this function in favor of performing the listed transformations automatically when hypertext elements are created.

See also

• Hypertext -- the class of markup lists used with hypertext