documentation/manual/en/module_specs/Zend_Markup-Getting-Started.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="zend.markup.getting-started">
   4     <title>Getting Started With Zend_Markup</title>
   5
   6     <para>
   7         This guide to get you started with <classname>Zend_Markup</classname> uses the BBCode parser
   8         and <acronym>HTML</acronym> renderer. The priciples discussed can be adapted to other
   9         parsers and renderers.
  10     </para>
  11
  12     <example id="zend.markup.getting-started.basic-usage">
  13         <title>Basic Zend_Markup Usage</title>
  14
  15         <para>
  16             We will first instantiate a <classname>Zend_Markup_Renderer_Html</classname> object
  17             using the <methodname>Zend_Markup::factory()</methodname> method. This will also create
  18             a <classname>Zend_Markup_Parser_Bbcode</classname> object which will be added to the
  19             renderer object.
  20         </para>
  21
  22         <para>
  23             Afther that, we will use the <methodname>render()</methodname> method to convert a piece
  24             of BBCode to <acronym>HTML</acronym>.
  25         </para>
  26
  27         <programlisting language="php"><![CDATA[
  28 // Creates instance of Zend_Markup_Renderer_Html,
  29 // with Zend_Markup_Parser_BbCode as its parser
  30 $bbcode = Zend_Markup::factory('Bbcode');
  31
  32 echo $bbcode->render('[b]bold text[/b] and [i]cursive text[/i]');
  33 // Outputs: '<strong>bold text</strong> and <em>cursive text</em>'
  34 ]]></programlisting>
  35     </example>
  36
  37     <example id="zend.markup.getting-started.complicated-example">
  38         <title>A more complicated example of Zend_Markup</title>
  39
  40         <para>
  41             This time, we will do exactly the same as above, but with more complicated BBCode
  42             markup.
  43         </para>
  44
  45         <programlisting language="php"><![CDATA[
  46 $bbcode = Zend_Markup::factory('Bbcode');
  47
  48 $input = <<<EOT
  49 [list]
  50 [*]Zend Framework
  51 [*]Foobar
  52 [/list]
  53 EOT;
  54
  55 echo $bbcode->render($input);
  56 /*
  57 Should output something like:
  58 <ul>
  59 <li>Zend Framework</li>
  60 <li>Foobar</li>
  61 </ul>
  62 */
  63 ]]></programlisting>
  64     </example>
  65
  66     <example id="zend.markup.getting-started.incorrect-input">
  67         <title>Processing incorrect input</title>
  68
  69         <para>
  70             Besides simply parsing and rendering markup such as BBCode,
  71             <classname>Zend_Markup</classname> is also able to handle incorrect input. Most BBCode
  72             processors are not able to render all input to <acronym>XHTML</acronym> valid output.
  73             <classname>Zend_Markup</classname> corrects input that is nested incorrectly, and also
  74             closes tags that were not closed:
  75         </para>
  76
  77         <programlisting language="php"><![CDATA[
  78 $bbcode = Zend_Markup::factory('Bbcode');
  79
  80 echo $bbcode->render('some [i]wrong [b]sample [/i] text');
  81 // Note that the '[b]' tag is never closed, and is also incorrectly
  82 // nested; regardless, Zend_Markup renders it correctly as:
  83 // some <em>wrong <strong>sample </strong></em><strong> text</strong>
  84 ]]></programlisting>
  85     </example>
  86 </sect1>