Silk Veil

Silk Veil is a Ruby extension or subclass of RedCloth, a library that implements the Textile document markups, which adds a few markups and short hand notations for some HTML entities.

Document reference markups

To make it easier to refer to other documents and file attachments in Pandora books, Silk Veil adds the following markups:

• To create a link to a page at the specified locator:

[[locator | title]]

• To create a link to a file attachment of the current page:

file:"attachment name [/attachment title [/icon]]"

• To render an image which has been attached to the current page:

image:"attachment name"

For “file” attachments, the attachment title, when specified, will be used to render the link in place of the raw file name. When the “icon” directive is specified, the link will be decorated with an icon.

HTML entity notations

Some commonly used HTML entities can be specified in the following notations:

      => to produce ⇒
      <= to produce &lArr;
      -> to produce &rarr;
      <- to produce &larr;
      >> to produce &raquo;
      << to produce &laquo;
      \\ to produce <br />

Textile markups

Reference to Textile markups can be found in the following pages:

• Textile Reference
  http://hobix.com/textile/

• Textile Quick Reference
  http://hobix.com/textile/quick.html