Zend_Markup_Parser_Markdown This page has been created from a template that uses "zones." To proceed: Edit the page Replace sample content within each zone-data tag with your own content Remove this notice Save the page When you are ready for community review, move this page to the Ready for Review section on the edit page. No placeholders allowed! Please do not create placeholders. Wait until you have sufficient content to replace all sample data in the proposal template before creating your proposal document.

<ac:macro ac:name="unmigrated-inline-wiki-markup"><ac:plain-text-body><![CDATA[

Zend Framework: Zend_Markup_Parser_Markdown Component Proposal

Table of Contents

1. Overview

Zend_Markup_Parser_Markdown is a parser for the wiki markup Markdown.

2. References

• Official Markdown website
• Python Implentation of Markdown
• Wikipedia
• Some article on the writting of a Markdown parser
• PHP implentation of Markdown

3. Component Requirements, Constraints, and Acceptance Criteria

Most requirements take the form of "foo will do ...." or "foo will not support ...", although different words and sentence structure might be used. Adding functionality to your proposal is requirements creep (bad), unless listed below. Discuss major changes with your team first, and then open a "feature improvement" issue against this component.

• This component will parse Markdown accordingly to the official Markdown syntax
• This component will fill a Zend_Markup_TokenList
• This component would supports Markdown Extra (Extra markup for uncommon elements)
• This component will not be aware of the renderer
• This component will implement Zend_Markup_Parser_ParserInterface

4. Dependencies on Other Framework Components

• Zend_Markup_Parser_ParserInterface
• Zend_Markup_Token
• Zend_Markup_TokenList

5. Theory of Operation

The component is mainly provided to be used through Zend_Markup factory method to be rendered with any Zend_Markup_Renderer_*.
However, it could be used as is to return a Zend_Markup_Tokenlist tree instance.

6. Milestones / Tasks

• Milestone 1: design notes will be published here
• Milestone 2: Working prototype checked into the incubator supporting use cases #1, #2, ...
• Milestone 3: Working prototype checked into the incubator supporting use cases #3 and #4.
• Milestone 4: Unit tests exist, work, and are checked into SVN.
• Milestone 5: Initial documentation exists.

7. Class Index

• Zend_Magic_Parser_Markdown

8. Use Cases

$markdown = <<<EOF

1. Zend_Markup_Parser_Markdown

1. 1. Requirements

• This component *will* parse Markdown accordingly to the [official Markdown syntax](http://daringfireball.net/projects/markdown/syntax)
• This component *will* fill a Zend_Markup_TokenList
• This component *would* supports Markdown Extra (Extra markup for uncommon elements)
• This component *will* not be aware of the renderer
• This component *will* implement Zend_Markup_Parser_ParserInterface
  EOF;

$m = Zend_Markup::factory('Markdown');
echo $m->render($markdown);

// result:

/*
<h1>Zend_Markup_Parser_Markdown</h1>

<h2>Requirements</h2>

<ul>
<li>This component <strong>will</strong> parse Markdown accordingly to the <a href="http://daringfireball.net/projects/markdown/syntax">official Markdown syntax</a></li>
<li>This component <strong>will</strong> fill a Zend_Markup_TokenList</li>
<li>This component <strong>would</strong> supports Markdown Extra (Extra markup for uncommon elements)</li>
<li>This component <strong>will</strong> not be aware of the renderer</li>
<li>This component <strong>will</strong> implement Zend_Markup_Parser_ParserInterface</li>
</ul>

*/

9. Class Skeletons