Changes between Version 2 and Version 3 of WikiHtml


Ignore:
Timestamp:
11/12/2017 01:15:51 PM (22 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiHtml

    v2 v3  
    1 = Using HTML in Wiki Text =
    2 
    3 Trac supports inserting HTML into any wiki context, accomplished using the `#!html` [wiki:WikiProcessors WikiProcessor].
    4 
    5 However a constraint is that this HTML has to be well-formed.
    6 In particular you can't insert a start tag in an `#!html` block,
    7 resume normal wiki text and insert the corresponding end tag in a
    8 second `#!html` block.
    9 
    10 Fortunately, for creating styled <div>s, <span>s  or even complex tables
    11 containing arbitrary Wiki text, there's a powerful alternative: use of
    12 dedicated `#!div`, `#!span` and `#!table`, `#!tr`, `#!td` and `#!th` blocks.
    13 
    14 Those Wiki processors are built-in, and does not require installing any additional packages.
    15 
    16 == How to use `#!html` == #HowtoUseHTML
    17 To inform the wiki engine that a block of text should be treated as HTML, use the ''html'' processor.
    18 
    19 ||= Wiki Markup =||= Display =||
    20 {{{#!td
    21   {{{
    22   {{{
    23   #!html
     1= Using HTML in Wiki Text
     2
     3Trac supports the display of HTML in any wiki context, by using the `#!html` [wiki:WikiProcessors WikiProcessor].
     4
     5However, this HTML has to be [http://en.wikipedia.org/wiki/Well-formed_element well-formed].
     6In particular, you can't insert a start tag in an `#!html` block, resume normal wiki text and insert the corresponding end tag in a second `#!html` block.
     7
     8For creating styled `<div>`s, `<span>`s  or even complex tables containing arbitrary Wiki text, there is a powerful alternative: `#!div`, `#!span` and `#!table`, `#!tr`, `#!td` and `#!th` blocks. Those Wiki processors are built-in and do not require additional packages to be installed.
     9
     10== How to use `#!html` #HowtoUseHTML
     11To inform the wiki engine that a block of text should be treated as HTML, use the ''html'' processor:
     12
     13||= Wiki Markup =||= Display =||
     14{{{#!td
     15  {{{
     16  {{{#!html
    2417  <h1 style="text-align: right; color: blue">HTML Test</h1>
    2518  }}}
     
    2720}}}
    2821{{{#!td style="padding-left: 2em"
    29   {{{
    30   #!html
     22  {{{#!html
    3123  <h1 style="text-align: right; color: blue">HTML Test</h1>
    3224  }}}
    3325}}}
    3426
    35 Note 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.
    36 
    37 Since 0.11, the filtering is done by Genshi, and as such, the produced output will be a well-formed fragment of HTML. As noted above in the introduction, 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.
    38 The new way to wrap any wiki content inside a <div> is to use the `#!div` Wiki  processor.
     27Note that Trac sanitizes your HTML code before displaying it. That means that potentially dangerous constructs, such as Javascript event handlers, will be removed from the output.
     28
     29The filtering is done by [http://genshi.edgewall.org/ Genshi] and the output will be a well-formed fragment of HTML. This means that you cannot use two HTML blocks, one for opening a <div> and another for closing it, in order to wrap arbitrary wiki text.
    3930
    4031== How to use `#!div` and `#!span` == #HowtoUseDivSpan
     
    4334{{{#!td
    4435  {{{
    45   {{{
    46   #!div class="important"
     36  {{{#!div class="important"
    4737  **important** is a predefined class.
    4838  }}}
    4939  }}}
    5040  {{{
    51   {{{
    52   #!div style="border: 1pt dotted; margin: 1em"
     41  {{{#!div style="border: 1pt dotted; margin: 1em"
    5342  **wikipage** is another predefined class that will
    5443  be used when no class is specified.
     
    5645  }}}
    5746  {{{
    58   {{{
    59   #!div class="compact" style="border: 1pt dotted; margin: 1em"
     47  {{{#!div class="compact" style="border: 1pt dotted; margin: 1em"
    6048  **compact** is another predefined class reducing
    6149  the padding within the `<div>` to a minimum.
     
    6351  }}}
    6452  {{{
    65   {{{
    66   #!div class="wikipage compact" style="border: 1pt dotted"
     53  {{{#!div class="wikipage compact" style="border: 1pt dotted"
    6754  Classes can be combined (here **wikipage** and **compact**)
    6855  which results in this case in reduced //vertical//
     
    7259  }}}
    7360  {{{
    74   {{{
    75   #!div class="" style="border: 1pt dotted; margin: 1em"
     61  {{{#!div class="" style="border: 1pt dotted; margin: 1em"
    7662  Explicitly specifying no classes is //not// the same
    7763  as specifying no class attribute, as this will remove
     
    8268{{{#!td style="padding-left: 2em"
    8369
    84   {{{
    85   #!div class="important"
     70  {{{#!div class="important"
    8671  **important** is a predefined class.
    8772  }}}
    8873
    89   {{{
    90   #!div style="border: 1pt dotted; margin: 1em"
     74  {{{#!div style="border: 1pt dotted; margin: 1em"
    9175  **wikipage** is another predefined class that will
    9276  be used when no class is specified.
    9377  }}}
    9478
    95   {{{
    96   #!div class="compact" style="border: 1pt dotted; margin: 1em"
     79  {{{#!div class="compact" style="border: 1pt dotted; margin: 1em"
    9780  **compact** is another predefined class reducing
    9881  the padding within the `<div>` to a minimum.
    9982  }}}
    10083
    101   {{{
    102   #!div class="wikipage compact" style="border: 1pt dotted"
     84  {{{#!div class="wikipage compact" style="border: 1pt dotted"
    10385  Classes can be combined (here **wikipage** and **compact**)
    10486  which results in this case in reduced //vertical//
     
    10789  }}}
    10890
    109   {{{
    110   #!div class="" style="border: 1pt dotted; margin: 1em"
     91  {{{#!div class="" style="border: 1pt dotted; margin: 1em"
    11192  Explicitly specifying no classes is //not// the same
    11293  as specifying no class attribute, as this will remove
     
    11697}}}
    11798
    118 Note that the contents of a `#!div` block are contained in one or more paragraphs, which have a non-zero top and bottom margin. This leads to the top and bottom padding in the example above. To remove the top and bottom margin of the contents, add the `compact` class to the `#!div`. Another predefined class besides `wikipage` and `compact` is `important`, which can be used to make a paragraph stand out. Extra CSS classes can be defined via the `site/style.css` file for example, see TracInterfaceCustomization#SiteAppearance.
    119 
    120 For spans, you should rather use the Macro call syntax:
     99Note that the contents of a `#!div` block are contained in one or more paragraphs, which have a non-zero top and bottom margin. This leads to the top and bottom padding in the example above. To remove the top and bottom margin of the content, add the `compact` class to the `#!div`. Another predefined class besides `wikipage` and `compact` is `important`, which can be used to make a paragraph stand out. Extra CSS classes can be defined via [TracInterfaceCustomization#SiteAppearance site/style.css].
     100
     101For spans, you should use the Macro call syntax:
    121102||= Wiki Markup =||
    122103{{{#!td
     
    133114}}}
    134115
    135 == How to use `#!td` and other table related processors == #Tables
    136 
    137 `#!td` or `#!th` processors are actually the main ones, for creating table data and header cells, respectively. The other processors `#!table` and `#!tr` are not required for introducing a table structure, as `#!td` and `#!th` will do this automatically. The `|-` row separator can be used to start a new row when needed, but some may prefer to use a `#!tr` block for that, as this introduces a more formal grouping and offers the possibility to use an extra level of indentation. The main purpose of the `#!table` and `#!tr` is to give the possibility to specify HTML attributes, like ''style'' or ''valign'' to these elements.
     116== How to use `#!td` and other table related processors #Tables
     117
     118The `#!td` or `#!th` processors should be used to create table data and table header cells, respectively. The other processors `#!table` and `#!tr` are not required for introducing a table structure, as `#!td` and `#!th` will do this automatically. The `|-` row separator can be used to start a new row when needed, but some may prefer to use a `#!tr` block for that, as this introduces a more formal grouping and offers the possibility to use an extra level of indentation. The main purpose of the `#!table` and `#!tr` is to give the possibility to specify HTML attributes, like ''style'' or ''valign'' to these elements.
    138119
    139120||= Wiki Markup =||= Display =||
     
    171152 attributes to the table itself...
    172153 
    173  {{{
    174  #!table style="border:none;text-align:center;margin:auto"
     154 {{{#!table style="border:none;text-align:center;margin:auto"
    175155   {{{#!tr ====================================
    176156     {{{#!th style="border: none"
     
    234214attributes to the table itself...
    235215
    236 {{{
    237 #!table style="border:none;text-align:center;margin:auto"
     216{{{#!table style="border:none;text-align:center;margin:auto"
    238217  {{{#!tr ====================================
    239218    {{{#!th style="border: none"
     
    263242}}}
    264243
    265 Note that by default tables are assigned the "wiki" CSS class, which gives a distinctive look to the header cells and a default border to the table and cells (as can be seen for the tables on this page). By removing this class (`#!table class=""`), one regains complete control on the table presentation. In particular, neither the table, the rows nor the cells will have a border, so this is a more effective way to get such an effect than having to specify a `style="border: no"` parameter everywhere.
     244Note that by default tables are assigned the "wiki" CSS class, which gives a distinctive look to the header cells and a default border to the table and cells, as can be seen for the tables on this page. By removing this class (`#!table class=""`), one regains complete control on the table presentation. In particular, neither the table nor the rows nor the cells will have a border, so this is a more effective way to get such an effect rather than having to specify a `style="border: no"` parameter everywhere.
    266245
    267246{{{#!table class=""
     
    309288}}}
    310289
    311 
    312 == HTML comments ==
    313 HTML 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:
     290== HTML comments
     291HTML 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 Trac 0.12:
    314292||= Wiki Markup =||
    315293{{{#!td
    316294  {{{
    317   {{{
    318   #!htmlcomment
     295  {{{#!htmlcomment
    319296  This block is translated to an HTML comment.
    320297  It can contain <tags> and &entities; that will not be escaped in the output.
     
    333310}}}
    334311
    335 Please note that the character sequence "`--`" is not allowed in HTML comments, and will generate a rendering error.
    336 
    337 
    338 == More Information ==
     312The character sequence `--` is not allowed in HTML comments, and will generate a rendering error.
     313
     314
     315== More Information
    339316
    340317 * http://www.w3.org/ -- World Wide Web Consortium
     
    342319
    343320----
    344 See also:  WikiProcessors, WikiFormatting, WikiRestructuredText
     321See also:  WikiFormatting, WikiProcessors, WikiRestructuredText