repo_zf1/documentation/manual/en/module_specs/Zend_Markup-Renderers.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<sect1 id="zend.markup.renderers">
    <title>Zend_Markup Renderers</title>

    <para>
        <classname>Zend_Markup</classname> is currently shipped with one renderer, the
        <acronym>HTML</acronym> renderer.
    </para>

    <sect2 id="zend.markup.renderers.add">
        <title>Adding your own tags</title>

        <para>
            By adding your own tags, you can add your own functionality to the
            <classname>Zend_Markup</classname> renderers. With the tag structure, you can add about
            any functionality you want. From simple tags, to complicated tag structures. A simple
            example for a 'foo' tag:
        </para>

        <programlisting language="php"><![CDATA[
// Creates instance of Zend_Markup_Renderer_Html,
// with Zend_Markup_Parser_BbCode as its parser
$bbcode = Zend_Markup::factory('Bbcode');

// this will create a simple 'foo' tag
// The first parameter defines the tag's name.
// The second parameter takes an integer that defines the tags type.
// The third parameter is an array that defines other things about a
// tag, like the tag's group, and (in this case) a start and end tag.
$bbcode->addTag(
    'foo',
    Zend_Markup_Renderer_RendererAbstract::TYPE_REPLACE
        | Zend_Markup_Renderer_RendererAbstract::TAG_NORMAL,
    array(
        'start' => '-bar-',
        'end'   => '-baz-',
        'group' => 'inline',
    )
);

// now, this will output: 'my -bar-tag-baz-'
echo $bbcode->render('my [foo]tag[/foo]');
]]></programlisting>

        <para>
            Please note that creating your own tags only makes sense when your parser also supports
            it with a tag structure. Currently, only BBCode supports this. Textile doesn't have
            support for custom tags.
        </para>
    </sect2>
    
    <sect2 id="zend.markup.renderers.list">
        <title>List of tags</title>

        <table id="zend.markup.renderers.list.tags">
            <title>List of tags</title>

            <tgroup cols="2" align="left" colsep="1" rowsep="1">
                <thead>
                    <row>
                        <entry>Sample input (bbcode)</entry>

                        <entry>Sample output</entry>
                    </row>
                </thead>

                <tbody>
                    <row>
                        <entry>[b]foo[/b]</entry>

                        <entry><![CDATA[<strong>foo</strong>]]></entry>
                    </row>

                    <row>
                        <entry>[i]foo[/i]</entry>

                        <entry><![CDATA[<em>foo</em>]]></entry>
                    </row>

                    <row>
                        <entry>[cite]foo[/cite]</entry>

                        <entry><![CDATA[<cite>foo</cite>]]></entry>
                    </row>

                    <row>
                        <entry>[del]foo[/del]</entry>

                        <entry><![CDATA[<del>foo</del>]]></entry>
                    </row>

                    <row>
                        <entry>[ins]foo[/ins]</entry>

                        <entry><![CDATA[<ins>foo</ins>]]></entry>
                    </row>

                    <row>
                        <entry>[sup]foo[/sup]</entry>

                        <entry><![CDATA[<sup>foo</sup>]]></entry>
                    </row>

                    <row>
                        <entry>[sub]foo[/sub]</entry>

                        <entry><![CDATA[<sub>foo</sub>]]></entry>
                    </row>

                    <row>
                        <entry>[span]foo[/span]</entry>

                        <entry><![CDATA[<span>foo</span>]]></entry>
                    </row>

                    <row>
                        <entry>[acronym title="PHP Hypertext Preprocessor]PHP[/acronym]</entry>

                        <entry><![CDATA[<acronym title="PHP Hypertext Preprocessor">PHP</acronym>]]></entry>
                    </row>

                    <row>
                        <entry>[url=http://framework.zend.com/]Zend Framework[/url]</entry>

                        <entry><![CDATA[<a href="http://framework.zend.com/">Zend Framework</a>]]></entry>
                    </row>

                    <row>
                        <entry>[h1]foobar[/h1]</entry>

                        <entry><![CDATA[<h1>foobar</h1>]]></entry>
                    </row>

                    <row>
                        <entry>[img]http://framework.zend.com/images/logo.gif[/img]</entry>

                        <entry><![CDATA[<img src="http://framework.zend.com/images/logo.gif" />]]></entry>
                    </row>
                </tbody>
            </tgroup>
        </table>
    </sect2>
</sect1>