Edgewall Software

Changes between Initial Version and Version 1 of 0.12/WikiHtml


Ignore:
Timestamp:
Oct 28, 2008, 12:20:41 PM (16 years ago)
Author:
Christian Boos
Comment:

copied from WikiHtml@10

Legend:

Unmodified
Added
Removed
Modified
  • 0.12/WikiHtml

    v1 v1  
     1= Using HTML in Wiki Text =
     2
     3Trac supports inserting HTML into any wiki context, accomplished using the HTML [wiki:WikiProcessors WikiProcessor].
     4
     5HTML support is built-in, and does not require installing any additional packages.
     6
     7== How to Use HTML ==
     8To inform the wiki engine that a block of text should be treated as HTML, use the ''html'' processor.
     9
     10This example should explain:
     11{{{
     12#!html
     13<pre class="wiki">{{{
     14#!html
     15&lt;h1 style="text-align: right; color: blue"&gt;HTML Test&lt;/h1&gt;
     16}}}</pre>
     17}}}
     18
     19Results in:
     20{{{
     21#!html
     22<h1 style="text-align: right; color: blue">HTML Test</h1>
     23}}}
     24
     25Note that Trac sanitizes your HTML code before displaying it. That means that if you try to use potentially dangerous constructs such as Javascript event handlers, those will be removed from the output.
     26
     27Since 0.11, the filtering is done by Genshi, and as such, the produced out will be a well-formed fragment of HTML. In other words, this mean that you can no longer use two HTML blocks, one for opening a <div>, the second for closing it, in order to wrap arbitrary wiki text.
     28To achieve this, you need now to use the ''div'' Wiki processor:
     29
     30{{{
     31{{{
     32#!div class=important style="border: 2pt solid; text-align: center"
     33This is the ''only'' way to go in Trac 0.11
     34}}}
     35}}}
     36
     37Results in:
     38{{{
     39#!div class=important style="border: 2pt solid; text-align: center"
     40This is the ''only'' way to go in Trac 0.11
     41}}}
     42
     43For spans, you should rather use the Macro call syntax:
     44{{{
     45 Hello [[span(''WORLD'' (click [#world-anchor here]), style=color: green; font-size: 120%, id=world-anchor)]]!
     46}}}
     47
     48Results in:
     49 Hello [[span(''WORLD'' (click [#world-anchor here]), style=color: green; font-size: 120%, id=world-anchor)]]!
     50
     51
     52== HTML comments ==
     53HTML comments are stripped from the output of the `html` processor. To add an HTML comment to a wiki page, use the `htmlcomment` processor (available since 0.12). For example, the following code block:
     54{{{
     55{{{
     56#!htmlcomment
     57This block is translated to an HTML comment.
     58It can contain <tags> and &entities; that will not be escaped in the output.
     59}}}
     60}}}
     61results in the following block in the HTML output:
     62{{{
     63<!--
     64This block is translated to an HTML comment.
     65It can contain <tags> and &entities; that will not be escaped in the output.
     66-->
     67}}}
     68Please note that the character sequence "--" is not allowed in HTML comments, and will generate a rendering error.
     69
     70
     71== More Information ==
     72
     73 * http://www.w3.org/ -- World Wide Web Consortium
     74 * http://www.w3.org/MarkUp/ -- HTML Markup Home Page
     75
     76----
     77See also:  WikiProcessors, WikiFormatting, WikiRestructuredText