PmWiki Markdown Recipe

Markdown.Markdown History

Hide minor edits - Show changes to markup

Changed lines 35-51 from:
  • I retained the inherent linking mechanism of PmWiki, because I have hundreds of pages that use it. However, I added the distinct markdown links that allow the author to link to offsite URLs.
  • Indented list blocks with nested indents creating nested list items. This required me to completely disabled the left-leading whitespace markups.
  • Introduced the '1.' markup for ordered lists. The PmWiki markup is '#'. Further, I added a refinement that allows the author to explicitly set the starting count of a list. This is one by starting the list with the target number.
  • Introduced the two heading markups following this bullet item. Internally, they are converted to PmWiki headings, which preserves compatibility with various recipes such as Page Table of Contents?.
to:
  • I retained the inherent linking mechanism of PmWiki, because I have hundreds of pages that use it. However, I added the distinct markdown links that allow the author to link to offsite URLs.
  • Indented list blocks with nested indents creating nested list items. This required me to completely disabled the left-leading whitespace markups.
  • Introduced the '1.' markup for ordered lists. The PmWiki markup is '#'. Further, I added a refinement that allows the author to explicitly set the starting count of a list. This is one by starting the list with the target number.
  • Introduced the two heading markups following this bullet item. Internally, they are converted to PmWiki headings, which preserves compatibility with various recipes such as Page Table of Contents?.
Changed lines 32-33 from:

About this Recipe. This recipe came about after a conversation with another fellow who wanted a wiki that allowed Markdown. Having dabbled a few times before, I threw myself in earnest to create this recipe.

to:

About this Recipe. This recipe came about after a conversation with another fellow who wanted a wiki that allowed Markdown. Having dabbled a few times before, I threw myself in earnest to create this recipe. I provide much more information on my website to detail the PmWiki Markdown extension.

Changed lines 35-51 from:
   * I retained the inherent linking mechanism of PmWiki,
   because I have hundreds of pages that use it. However, 
   I added the distinct markdown links that allow the 
   author to link to offsite URLs.
   * Indented list blocks with nested indents creating
   nested list items. This required me to completely 
   disabled the left-leading whitespace markups.
   * Introduced the '1.' markup for ordered lists. The
   PmWiki markup is '#'. Further, I added a refinement
   that allows the author to explicitly set the starting
   count of a list. This is one by starting the list with
   the target number.
   * Introduced the two heading markups following this 
   bullet item. Internally, they are converted to PmWiki
   headings, which preserves compatibility with various
   recipes such as PageToc?.
to:
  • I retained the inherent linking mechanism of PmWiki, because I have hundreds of pages that use it. However, I added the distinct markdown links that allow the author to link to offsite URLs.
  • Indented list blocks with nested indents creating nested list items. This required me to completely disabled the left-leading whitespace markups.
  • Introduced the '1.' markup for ordered lists. The PmWiki markup is '#'. Further, I added a refinement that allows the author to explicitly set the starting count of a list. This is one by starting the list with the target number.
  • Introduced the two heading markups following this bullet item. Internally, they are converted to PmWiki headings, which preserves compatibility with various recipes such as Page Table of Contents?.
Changed line 81 from:
  • 0.2 - Improved support, bug fixes BenWilson? May 17, 2006, at 12:38 PM
to:
  • 0.2 - Improved support, bug fixes BenWilson? May 17, 2006, at 11:40 AM
Changed line 3 from:

Version: 0.1

to:

Version: 0.2

Changed line 22 from:
  1. Download the compressed file to your web server. Markdown-0.1.tgz Δ
to:
  1. Download the compressed file to your web server. Markdown-0.2.tgz Δ
Changed lines 25-26 from:
  1. Set "$EnableMardown = 1;" in the appropriate config.php file. This allows per-Group or per-wiki implimentation.
to:
  1. Add a call to the controling markdown file include_once('/path/to/cookbook/markdown.php');
  2. Set "$EnableMardown = 1;" in the appropriate config.php file (before the call to the recipe. This allows per-Group or per-wiki implimentation.
Changed lines 61-62 from:
   * I plan to revise the code to retain PmWiki markups and selectively disable those that get in the way, rather than the 0.1 mechanism of explicitly turning of PmWiki standard markup.
to:

0.2

  • Fixed problem with freezing page loads when combining bullet lists and asterisk-based emphasis
  • Added (limited) Atx heading support. You must trail the heading with at least one pound symbol.
  • Created syntax page.
  • Updated documentation.
Deleted line 74:
Added line 81:
  • 0.2 - Improved support, bug fixes BenWilson? May 17, 2006, at 12:38 PM
Changed lines 76-77 from:
  • 0.1 - Initally published. BenWilson? May 06, 2006, at 11:56 PM
to:
  • 0.1 - Initally published. BenWilson? May 06, 2006, at 11:56 PM

(:title PmWiki Markdown Recipe:)

Changed lines 34-50 from:
  • I retained the inherent linking mechanism of PmWiki, because I have hundreds of pages that use it. However, I added the distinct markdown links that allow the author to link to offsite URLs.
  • Indented list blocks with nested indents creating nested list items. This required me to completely disabled the left-leading whitespace markups.
  • Introduced the '1.' markup for ordered lists. The PmWiki markup is '#'. Further, I added a refinement that allows the author to explicitly set the starting count of a list. This is one by starting the list with the target number.
  • Introduced the two heading markups following this bullet item. Internally, they are converted to PmWiki headings, which preserves compatibility with various recipes such as PageToc?.
to:
   * I retained the inherent linking mechanism of PmWiki,
   because I have hundreds of pages that use it. However, 
   I added the distinct markdown links that allow the 
   author to link to offsite URLs.
   * Indented list blocks with nested indents creating
   nested list items. This required me to completely 
   disabled the left-leading whitespace markups.
   * Introduced the '1.' markup for ordered lists. The
   PmWiki markup is '#'. Further, I added a refinement
   that allows the author to explicitly set the starting
   count of a list. This is one by starting the list with
   the target number.
   * Introduced the two heading markups following this 
   bullet item. Internally, they are converted to PmWiki
   headings, which preserves compatibility with various
   recipes such as PageToc?.
Changed lines 60-61 from:
  • I plan to revise the code to retain PmWiki markups and selectively disable those that get in the way, rather than the 0.1 mechanism of explicitly turning of PmWiki standard markup.
to:
   * I plan to revise the code to retain PmWiki markups and selectively disable those that get in the way, rather than the 0.1 mechanism of explicitly turning of PmWiki standard markup.
Added lines 20-26:

Installation

  1. Download the compressed file to your web server. Markdown-0.1.tgz Δ
  2. Decompress, but not in your installation directory.
  3. Selectively copy over the files in the comprable folder (i.e. cookbook/ to cookbook/).
  4. Set "$EnableMardown = 1;" in the appropriate config.php file. This allows per-Group or per-wiki implimentation.
Changed lines 46-47 from:
  • Introduced the two heading markups following this bullet item.
to:
  • Introduced the two heading markups following this bullet item. Internally, they are converted to PmWiki headings, which preserves compatibility with various recipes such as PageToc?.
Changed lines 60-61 from:

If the recipe has multiple releases, then release notes can be placed here. Note that it's often easier for people to work with "release dates" instead of "version numbers".

to:
  • I plan to revise the code to retain PmWiki markups and selectively disable those that get in the way, rather than the 0.1 mechanism of explicitly turning of PmWiki standard markup.
Changed lines 72-73 from:
to:
Changed line 76 from:
to:
  • 0.1 - Initally published. BenWilson? May 06, 2006, at 11:56 PM
Added lines 1-66:

Summary: A replacement for some of PmWiki's typographical wiki markup Version: 0.1 Prerequisites: none Status: Beta Maintainer: BenWilson? Categories: Markup

Questions answered by this recipe

I (that is you, the reader) have been looking for a PHP-based wiki that allows me to use Markdown syntax to edit my pages. How do I selectively disable PmWiki's markup to allow this?

Description

"Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).

This recipe strives to honor the fundamental rules of Markdown without disturbing PmWiki's powerful directive language and other amenities that make PmWiki a potent wiki engine.

Notes

Introduction. Having been invovled with PmWiki for a couple of years now, I have found it to be the most effective wiki for my uses, which is pretty broad. In Winter 2006, I discovered Markdown. As a law student, I take notes using a python-based pmwe editor, which allows me to use vim. I also write quite a few emails, some of which I would like to archive on my private wiki. Markdown provided me with an effective tool to visually control both emails and notes, but had no wiki-based counterpart I was pleased with. BenWilson? May 06, 2006, at 11:49 PM

About this Recipe. This recipe came about after a conversation with another fellow who wanted a wiki that allowed Markdown. Having dabbled a few times before, I threw myself in earnest to create this recipe.

Disabling PmWiki. It just so happens that PmWiki provides a variable that allows site administrators to disable the standard markup. Pm? is very accomodating in that respect. So, what this recipe does is disable the standard markup, and then selectively re-add markups that are Markdown friendly. Specifically:

  • I retained the inherent linking mechanism of PmWiki, because I have hundreds of pages that use it. However, I added the distinct markdown links that allow the author to link to offsite URLs.
  • Indented list blocks with nested indents creating nested list items. This required me to completely disabled the left-leading whitespace markups.
  • Introduced the '1.' markup for ordered lists. The PmWiki markup is '#'. Further, I added a refinement that allows the author to explicitly set the starting count of a list. This is one by starting the list with the target number.
  • Introduced the two heading markups following this bullet item.
 Section Heading <h2>
 ====================

 Sub-Section Heading <h3>
 ------------------------

Release Notes

If the recipe has multiple releases, then release notes can be placed here. Note that it's often easier for people to work with "release dates" instead of "version numbers".

Comments

(:if false:) This space is for User-contributed commentary and notes. Please include your name and a date along with your comment. (:if:)

See Also

Contributors

Joanne West Peterson / Oshkosh, Wisconsin / www.oshkoshpiano.com