[MKDoc-modules] Ideas for MKDoc::Text::Structured

[Jean-Michel Hiver]

Bruno Postle wrote:

1. Smart Quotes

>This list is lifted from here:
>
>     http://www.textism.com/tools/textile/help.html?item=what
>
>•  Replace single and double primes (' and ") used as quotation
>   marks with HTML entities for opening and closing quotation
>   marks (‘’ and “”) in readable text, while leaving untouched
>   the primes required within HTML tags.
>
Opening smart single quote: ‘
Closing smart single quote: ’
Opening smart double quote: “
Closing smart double quote: ”


2. Hyphens

>•  Replaced double hyphens (--) with an em-dash (—) entity.
>
  —

>•  Replace single hyphens surrounded by spaces with an en-dash
>   (–) entity.
>
–


3. Ellipsis

>•  Replace triplets of periods (...) with an ellipsis (…) entity.
>
…


4. Acronyms

>•  Wrap an <acronym> tag around runs of three or more capital
>   letters automatically.
>
Example:

    ACLU(American Civil Liberties Union)

Will become:

    <acronym title="American Civil Liberties Union">ACLU</acronym>

Example:

    ACLU (American Civil Liberties Union)

Will become:

    <acronym title="American Civil Liberties Union">ACLU</acronym>
    (American Civil Liberties Union)

5. Copyright / Trademarks / etc

>•  Convert (TM), (R), and (C) to ™, ®, and ©
>

(tm) : &#129;
(r): &reg;
(c): &copy;


6. Dimension

>•  Convert the letter x to a dimension sign: 2x4 to 2×4 and 8 x 10
>   to 8×10
>
&times;



Plus a couple of extras:

To make a numbered list, place each item in its own paragraph, preceded 
by “# ”.

Example

# A first item
# A second item
# A third item
# A fourth item


      Deleted Text

Use -hyphens- around text that has been deleted. This is useful in 
marking changes from one version of a document to the next.

The <del> HTML tag is applied:

-a phrase- → <del>a phrase</del> → a phrase


TEXTPATTERN HELP


      Inserted Text

Use +pluses+ around text that has been inserted. This is useful in 
marking changes from one version of a document to the next.

The <ins> HTML tag is applied:

+a phrase+ → <ins>a phrase</ins> → a phrase

NB: quick tags must open and close within a single paragraph to produce 
valid markup.


      Superscript

Use ^carets^ for text to be rendered ^superscript .

The <sup> HTML tag is applied:

^a phrase^ → <sup>a phrase</sup> → ^a phrase