openproject/app/views/help/wiki_syntax.html.erb

<%#-- copyright
OpenProject is a project management system.

Copyright (C) 2012-2013 the OpenProject Team

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License version 3.

See doc/COPYRIGHT.rdoc for more details.

++#%>

<% content_for :styles do %>
    h1 { font-family: Verdana, sans-serif; font-size: 14px; text-align: center; color: #444; }
    body { font-family: Verdana, sans-serif; font-size: 12px; color: #444; }
    table th { padding-top: 1em; }
    table td { vertical-align: top; background-color: #f5f5f5; height: 2em; vertical-align: middle;}
    table td code { font-size: 1.2em; }
    table td h1 { font-size: 1.8em; text-align: left; }
    table td h2 { font-size: 1.4em; text-align: left; }
    table td h3 { font-size: 1.2em; text-align: left; }
<% end %>

<% html_title "Wiki Syntax Quick Reference" %>
<h1>Wiki Syntax Quick Reference</h1>

<table width="100%">
  <tr>
    <th colspan="3">Font Styles</th>
  </tr>
  <tr>
    <th><%= image_tag 'jstoolbar/bt_strong.png', :style => 'border: 1px solid #bbb', :alt => 'Strong' %></th>
    <td width="50%">*Strong*</td>
    <td width="50%"><strong>Strong</strong></td>
  </tr>
  <tr>
    <th><%= image_tag 'jstoolbar/bt_em.png', :style => 'border: 1px solid #bbb', :alt => 'Italic' %></th>
    <td>_Italic_</td>
    <td><em>Italic</em></td>
  </tr>
  <tr>
    <th><%= image_tag 'jstoolbar/bt_ins.png', :style => 'border: 1px solid #bbb', :alt => 'Underline' %></th>
    <td>+Underline+</td>
    <td><ins>Underline</ins></td>
  </tr>
  <tr>
    <th><%= image_tag 'jstoolbar/bt_del.png', :style => 'border: 1px solid #bbb', :alt => 'Deleted' %></th>
    <td>-Deleted-</td>
    <td><del>Deleted</del></td>
  </tr>
  <tr>
    <th></th>
    <td>??Quote??</td>
    <td><cite>Quote</cite></td>
  </tr>
  <tr>
    <th><%= image_tag 'jstoolbar/bt_code.png', :style => 'border: 1px solid #bbb', :alt => 'Inline Code' %></th>
    <td>@Inline Code@</td>
    <td><code>Inline Code</code></td>
  </tr>
  <tr>
    <th><%= image_tag 'jstoolbar/bt_pre.png', :style => 'border: 1px solid #bbb', :alt => 'Preformatted text' %></th>
    <td>&lt;pre><br />&nbsp;lines<br />&nbsp;of code<br />&lt;/pre></td>
    <td>
<pre>
 lines
 of code
</pre>
    </td>
  </tr>

  <tr>
    <th colspan="3">Lists</th>
  </tr>
  <tr>
    <th><%= image_tag 'jstoolbar/bt_ul.png', :style => 'border: 1px solid #bbb', :alt => 'Unordered list' %></th>
    <td>* Item 1<br />* Item 2</td>
    <td>
      <ul>
        <li>Item 1</li>
        <li>Item 2</li>
      </ul>
    </td>
  </tr>
  <tr>
    <th><%= image_tag 'jstoolbar/bt_ol.png', :style => 'border: 1px solid #bbb', :alt => 'Ordered list' %></th>
    <td># Item 1<br /># Item 2</td>
    <td>
      <ol>
        <li>Item 1</li>
        <li>Item 2</li>
      </ol>
    </td>
  </tr>

  <tr>
    <th colspan="3">Headings</th>
  </tr>
  <tr>
    <th><%= image_tag 'jstoolbar/bt_h1.png', :style => 'border: 1px solid #bbb', :alt => 'Heading 1' %></th>
    <td>h1. Title 1</td>
    <td><h1>Title 1</h1></td>
  </tr>
  <tr>
    <th><%= image_tag 'jstoolbar/bt_h2.png', :style => 'border: 1px solid #bbb', :alt => 'Heading 2' %></th>
    <td>h2. Title 2</td>
    <td><h2>Title 2</h2></td>
  </tr>
  <tr>
    <th><%= image_tag 'jstoolbar/bt_h3.png', :style => 'border: 1px solid #bbb', :alt => 'Heading 3' %></th>
    <td>h3. Title 3</td>
    <td><h3>Title 3</h3></td>
  </tr>

  <tr>
    <th colspan="3">Links</th>
  </tr>
  <tr>
    <th></th>
    <td>http://foo.bar</td>
    <td><a href="#">http://foo.bar</a></td>
  </tr>
  <tr>
    <th></th>
    <td>"Foo":http://foo.bar</td>
    <td><a href="#">Foo</a></td>
  </tr>

  <tr>
    <th colspan="3">OpenProject links</th>
  </tr>
  <tr>
    <th><%= image_tag 'jstoolbar/bt_link.png', :style => 'border: 1px solid #bbb', :alt => 'Link to a Wiki page' %></th>
    <td>[[Wiki page]]</td>
    <td><a href="#">Wiki page</a></td>
  </tr>
  <tr>
    <th><%= image_tag 'jstoolbar/bt_link.png', :style => 'border: 1px solid #bbb', :alt => 'Link to a Wiki page' %></th>
    <td>[[Sandbox:Wiki page]]</td>
    <td><a href="#">Wiki page</a> (On the Sandbox project)</td>
  </tr>
  <tr>
    <th></th>
    <td>Issue #12</td>
    <td>Issue <a href="#">#12</a></td>
  </tr>
  <tr>
    <th></th>
    <td>##12</td>
    <td>Issue ##12</td><td>Issue <a href="#">Bug #12 New: Issue Subject</a> 2012-06-06 – 2013-06-06 (John Doe)</td>
  </tr>
  <tr>
    <th></th>
    <td>###12</td>
    <td>Issue ###12</td><td>Issue <a href="#">Bug #12 New: Issue Subject</a> 2012-06-06 – 2013-06-06 (John Doe) <div style="padding-left: 10px;"><p>I am the description of this issue.</p></div></td>
  </tr>
  <tr>
    <th></th>
    <td>Revision r43</td>
    <td>Revision <a href="#">r43</a></td>
  </tr>
  <tr>
    <th></th>
    <td>commit:f30e13e43</td>
    <td><a href="#">f30e13e4</a></td>
  </tr>
  <tr>
    <th></th>
    <td>source:some/file</td>
    <td><a href="#">source:some/file</a></td>
  </tr>

  <tr>
    <th colspan="3">Inline images</th>
  </tr>
  <tr>
    <th><%= image_tag 'jstoolbar/bt_img.png', :style => 'border: 1px solid #bbb', :alt => 'Image' %></th>
    <td>!<em>image_url</em>!</td>
    <td></td>
  </tr>
  <tr>
    <th></th>
    <td>!<em>attached_image</em>!</td>
    <td></td>
  </tr>
</table>

<p>
  <%= link_to_function 'More Information', "window.open('wiki_syntax_detailed', '', '')" %>
</p>