• View
• Edit
• History
• Attach
• Print
• Backlinks

MarkupExtensions

Goal

Replicate and enhance some local customisations from PmWiki 1 in PmWiki 2, as a single MarkupExtensions package. For details, see the list of extensions.

It provides the following types of capability:

1. improve the look and readability of pages by displaying em or en dashes, smart quotes, arrows, fractions, ™ and the like
2. improve the structure of pages using footnotes, teaser paragraphs, sticky notes, run-in headings and the like
3. enhanced markup support, such as <dfn>, <cite>, <kbd>, small caps, drop caps

Solution

Please note. The PublishPDF library includes the current version of the MarkupExtensions recipe.

Version 2.1.1 works with PmWiki 2.2.56 or above. It requires php 5.3 or above and is compatible with php 5.5 (no more /e in calls to Markup).

For PmWiki 2.2.55 and below:

Use extendmarkup_pre44.phpΔ with versions of PmWiki before the introduction of $SiteGroup in beta 44.

Put extendmarkup.php and break_page.php in the PmWiki cookbook/ directory (you may have to create it).

To use the markup.css file, put markup.css in the pub/css/ directory and add the following line to local/config.php :

followed by:

Aside

Why is the script called “extendmarkup” and the css is just called “markup”?

See the change log (edit) for a history of this recipe. The latest entry in the change log is:

• 27 April 2006 — fix (I mean really fix) problem with title markup in pmwiki 2.1 (marcon title extension)
• 28 and 30 March 2006 — revise for compatibility with pmwiki 2.1
• 21 September 2005 — revert to standard AsSpaced, plus smartening; thanks to Hans

Note. Some extensions present in an early version are now part of PageTableOfContents. The aim is to allow different recipes to operate independently of one another.

Discussion

See Discussion at MarkupExtensions-Talk.
This adds a range of markup extensions to PmWiki 2. It combines into a single script a whole lot of separate items from PmWiki 1, adds some more, and fixes one or two minor bugs.

All extensions are now optional, controlled through the $MarkupExtensionsFmt array. This is set to:

SDV($MarkupExtensionsFmt,
    array("inote abbr `A `. `- `s `: `f -d ... aquo mac '/ '@ '; [^",
    "q&a A; {|} =| {= revisions ^!! fig :: para lazyweb spaced squo links"));

To enable a selected subset of these markups, copy the above 3 lines into local/config.php before the include statement and remove the markups you don’t want. For example, the following enables just 4 extensions:

Under php8.1, this approach generates warning messages for undefined array keys. Instead, use the following code (based on the example above):

$MarkupExtensionsDefaultState = false;
foreach array("para", "[^", "::", "{|}") as $mkup
   $MarkupExtensions[$mkup] = true;

To disable one or two markups, add one or more lines like the following before including extendmarkup.php:

For example, $MarkupExtensions['q&a'] = false; will disable the variant of Q: and A: markup, restoring PmWiki’s default behaviour.

• what about markup for ↑ and ↓?
• and what about markup for ↔?

Usage notes

It adjusts the line height so superscripts and subscripts no longer produce uneven line spacing.

Smart quotes now deal correctly with html tags that split across a line break.

Many things from PmWiki 1 are not yet complete, but we release early and often. Treat this release as a demonstrator.

Contributor

jr

Questions

See Discussion at MarkupExtensions-Talk.