Open Source Projects Europe

    </li>

    </li>

  {% endfor %}

  {% endfor %}

{% endmacro %}

{% endmacro %}

{% macro markdown_syntax(id='') %}

{% macro markdown_syntax(id='') %}

<h1>Markdown Syntax Guide</h1>

<h1>Markdown Syntax Guide</h1>

<p>The Allura code uses markdown syntax everywhere to allow you to create rich<br>text markup, and extends markdown in several ways to allow for quick linking<br>to other artifacts in your project. </p>

<p>The Allura code uses markdown syntax everywhere to allow you to create rich<br>text markup, and extends markdown in several ways to allow for quick linking<br>to other artifacts in your project. </p>

<p>Markdown was created to be easy to read, easy to write, and still readable in plain text format.</p>

<p>Markdown was created to be easy to read, easy to write, and still readable in plain text format.</p>

    <li><a href="#md_ex_links{{id}}">Links</a></li>

    <li><a href="#md_ex_links{{id}}">Links</a></li>

    <li><a href="#md_ex_reflinks{{id}}">Reference Links</a></li>

    <li><a href="#md_ex_reflinks{{id}}">Reference Links</a></li>

    <li><a href="#md_ex_artlinks{{id}}">Artifact Links</a></li>

    <li><a href="#md_ex_artlinks{{id}}">Artifact Links</a></li>

    <li><a href="#md_ex_text{{id}}">Text</a></li>

    <li><a href="#md_ex_text{{id}}">Text</a></li>

    <li><a href="#md_ex_bq{{id}}">Blockquotes</a></li>

    <li><a href="#md_ex_bq{{id}}">Blockquotes</a></li>

    <li><a href="#md_ex_neighborhood_notes{{id}}">Neighborhood Notifications</a></li>

    <li><a href="#md_ex_neighborhood_notes{{id}}">Neighborhood Notifications</a></li>

    <li><a href="#md_ex_download_button{{id}}">Download Button</a></li>

    <li><a href="#md_ex_download_button{{id}}">Download Button</a></li>

    <li><a href="#md_ex_project_screenshots{{id}}">Project Screenshots</a></li>

    <li><a href="#md_ex_project_screenshots{{id}}">Project Screenshots</a></li>

    <li><a href="#md_ex_thanks{{id}}">Thanks</a></li>

    <li><a href="#md_ex_thanks{{id}}">Thanks</a></li>

</ul>

</ul>

<h2 id="md_ex_links{{id}}">Links</h2>

<h2 id="md_ex_links{{id}}">Links</h2>

<p>Most URLs will automatically be turned into links.  To be explicit, just write it like this:</p>

<p>Most URLs will automatically be turned into links.  To be explicit, just write it like this:</p>

<div class="codehilite"><pre>

<div class="codehilite"><pre>

<p>You can add a *title* (which shows up under the cursor):</p>

<p>You can add a *title* (which shows up under the cursor):</p>

<div class="codehilite"><pre>[like this](http://someurl "this title shows up when you hover")</pre></div>

<div class="codehilite"><pre>[like this](http://someurl "this title shows up when you hover")</pre></div>

<p>Output:</p>

<p>Output:</p>

{{g.markdown.convert('''[like this](http://someurl "this title shows up when you hover")''')}}

{{g.markdown.convert('''[like this](http://someurl "this title shows up when you hover")''')}}

<h2 id="md_ex_reflinks{{id}}">Reference Links</h2>

<h2 id="md_ex_reflinks{{id}}">Reference Links</h2>

<div class="codehilite"><pre>You can also put the [link URL][1] below the current paragraph

<div class="codehilite"><pre>You can also put the [link URL][1] below the current paragraph

like [this][2].

like [this][2].

   [1]: http://url

   [1]: http://url

<p>Output:</p>

<p>Output:</p>

{{g.markdown.convert('''Or you can use a [shortcut][] reference, which links the text

{{g.markdown.convert('''Or you can use a [shortcut][] reference, which links the text

"shortcut" to the link named "[shortcut]" on the next paragraph.

"shortcut" to the link named "[shortcut]" on the next paragraph.

[shortcut]: http://goes/with/the/link/name/text''')}}

[shortcut]: http://goes/with/the/link/name/text''')}}

<h2 id="md_ex_artlinks{{id}}">Artifact Links</h2>

<h2 id="md_ex_artlinks{{id}}">Artifact Links</h2>

<p>Any existing forge resource can be linked with surrounding square brackets ie [MyPage] or [#123].</p>

<p>Any existing forge resource can be linked with surrounding square brackets ie [MyPage] or [#123].</p>

<p>Links to resources in other tools can be explicitly referenced by adding a tool identifier prefix to the link.

<p>Links to resources in other tools can be explicitly referenced by adding a tool identifier prefix to the link.

So for instance `[developerwiki:MyPage]` can refer to a wiki page in a `developerwiki` instance.

So for instance `[developerwiki:MyPage]` can refer to a wiki page in a `developerwiki` instance.

[#123]

[#123]

[tickets:#123]

[tickets:#123]

</pre></div>

</pre></div>

<p>No example output is available for this one because it only works on real artifacts. Try it in your project!</p>

<p>No example output is available for this one because it only works on real artifacts. Try it in your project!</p>

<h2 id="md_ex_text{{id}}">Text</h2>

<h2 id="md_ex_text{{id}}">Text</h2>

<p>Use * or _ to emphasize things:</p>

<p>Use * or _ to emphasize things:</p>

<div class="codehilite"><pre>*this is in italic*  and _so is this_

<div class="codehilite"><pre>*this is in italic*  and _so is this_

**this is in bold**  and __so is this__

**this is in bold**  and __so is this__

you would expect.  A blank line separates paragraphs.

you would expect.  A blank line separates paragraphs.

So this is a new paragraph. But any text on adjacent lines

So this is a new paragraph. But any text on adjacent lines

will all end up

will all end up

in the same paragraph.""")}}

in the same paragraph.""")}}

<h2 id="md_ex_bq{{id}}">Blockquotes</h2>

<h2 id="md_ex_bq{{id}}">Blockquotes</h2>

<p>Use the &gt; character in front of a line, <i>just like in email</i></p>

<p>Use the &gt; character in front of a line, <i>just like in email</i></p>

<div class="codehilite"><pre>&gt; Use it if you're quoting a person, a song or whatever.

<div class="codehilite"><pre>&gt; Use it if you're quoting a person, a song or whatever.

> You can use *italic* or lists inside them also.

> You can use *italic* or lists inside them also.

all of these lines are still

all of these lines are still

part of the blockquote, even without the > character in front.

part of the blockquote, even without the > character in front.

To end the blockquote, just put a blank line before the following

To end the blockquote, just put a blank line before the following

paragraph.""")}}

paragraph.""")}}

<h2 id="md_ex_pre{{id}}">Preformatted Text</h2>

<h2 id="md_ex_pre{{id}}">Preformatted Text</h2>

<p>If you want some text to show up exactly as you write it, without

<p>If you want some text to show up exactly as you write it, without

Markdown doing anything to it, just indent every line by at least 4

Markdown doing anything to it, just indent every line by at least 4

spaces (or 1 tab).</p>

spaces (or 1 tab).</p>

<div class="codehilite"><pre>

<div class="codehilite"><pre>

    exactly <i>as you see it in this text file</i>.

    exactly <i>as you see it in this text file</i>.

As a shortcut you can use backquotes to do the same thing while

As a shortcut you can use backquotes to do the same thing while

inside a normal pargraph.  `This won't be *italic* or **bold**

inside a normal pargraph.  `This won't be *italic* or **bold**

at all.`""")}}

at all.`""")}}

<h2 id="md_ex_lists{{id}}">Lists</h2>

<h2 id="md_ex_lists{{id}}">Lists</h2>

<div class="codehilite"><pre>* an asterisk starts an unordered list

<div class="codehilite"><pre>* an asterisk starts an unordered list

* and this is another item in the list

* and this is another item in the list

+ or you can also use the + character

+ or you can also use the + character

- or the - character

- or the - character

*  this will show as number "3."

*  this will show as number "3."

9. any number, +, -, or * will keep the list going.

9. any number, +, -, or * will keep the list going.

    * just indent by 4 spaces (or tab) to make a sub-list

    * just indent by 4 spaces (or tab) to make a sub-list

        1. keep indenting for more sub lists

        1. keep indenting for more sub lists

    * here i\'m back to the second level''')}}

    * here i\'m back to the second level''')}}

<h2 id="md_ex_tables{{id}}">Tables</h2>

<h2 id="md_ex_tables{{id}}">Tables</h2>

<p>You can create tables using pipes and dashes like this:</p>

<p>You can create tables using pipes and dashes like this:</p>

<div class="codehilite"><pre>

<div class="codehilite"><pre>

  First Header  | Second Header

  First Header  | Second Header

  ------------- | -------------

  ------------- | -------------

-------------  | -------------

-------------  | -------------

*Content Cell* | Content Cell

*Content Cell* | Content Cell

Content Cell   | Content Cell''')}}

Content Cell   | Content Cell''')}}

<p>You can also create tables using HTML code.</p>

<p>You can also create tables using HTML code.</p>

<h2 id="md_ex_headers{{id}}">Headers</h2>

<h2 id="md_ex_headers{{id}}">Headers</h2>

<p>Just put 1 or more dashes or equals signs (--- or ===) below the

<p>Just put 1 or more dashes or equals signs (--- or ===) below the

title.</p>

title.</p>

<div class="codehilite"><pre>This is a huge header

<div class="codehilite"><pre>This is a huge header

==================

==================

{{g.markdown.convert('''This is a huge header

{{g.markdown.convert('''This is a huge header

==================

==================

this is a smaller header

this is a smaller header

------------------''')}}

------------------''')}}

<h2 id="md_ex_hr{{id}}">Horizontal Rule</h2>

<h2 id="md_ex_hr{{id}}">Horizontal Rule</h2>

<p>Just put three or more *'s or -'s on a line:</p>

<p>Just put three or more *'s or -'s on a line:</p>

<div class="codehilite"><pre>

<div class="codehilite"><pre>

----------------

----------------

</pre></div>

</pre></div>

</pre></div>

</pre></div>

<p>Output:</p>

<p>Output:</p>

{{g.markdown.convert('''you will get a header

{{g.markdown.convert('''you will get a header

---''')}}

---''')}}

<h2 id="md_ex_img{{id}}">Images</h2>

<h2 id="md_ex_img{{id}}">Images</h2>

<p>To include an image, just put a "!" in front of a text link:</p>

<p>To include an image, just put a "!" in front of a text link:</p>

<div class="codehilite"><pre>

<div class="codehilite"><pre>

![alternate text](https://sourceforge.net/images/icon_linux.gif)

![alternate text](https://sourceforge.net/images/icon_linux.gif)

</pre></div>

</pre></div>

[[img src=attached-image.jpg alt=foobar]]

[[img src=attached-image.jpg alt=foobar]]

</pre></div>

</pre></div>

<p>Output:</p>

<p>Output:</p>

{{g.markdown.convert('''[[img src=attached-image.jpg alt=foobar]]''')}}

{{g.markdown.convert('''[[img src=attached-image.jpg alt=foobar]]''')}}

<h2 id="md_ex_escapes{{id}}">Escapes</h2>

<h2 id="md_ex_escapes{{id}}">Escapes</h2>

<p>What if you want to just show asterisks, not italics?</p>

<p>What if you want to just show asterisks, not italics?</p>

<div class="codehilite"><pre>* this shows up in italics: *a happy day*

<div class="codehilite"><pre>* this shows up in italics: *a happy day*

* this shows the asterisks: \*a happy day\*

* this shows the asterisks: \*a happy day\*

</pre></div>

</pre></div>

{{g.markdown.convert('''<b>this will be bold</b>

{{g.markdown.convert('''<b>this will be bold</b>

you should escape <unknown> tags

you should escape <unknown> tags

< special entities work

< special entities work

< if you want to escape it''')}}

< if you want to escape it''')}}

<p>Individual ampersands (&amp;) and less-than signs (&lt;) are fine, they will be shown as expected.</p>

<p>Individual ampersands (&amp;) and less-than signs (&lt;) are fine, they will be shown as expected.</p>

<h2 id="md_ex_moreheaders{{id}}">More Headers</h2>

<h2 id="md_ex_moreheaders{{id}}">More Headers</h2>

<p>More ways of doing headers:</p>

<p>More ways of doing headers:</p>

<div class="codehilite"><pre># this is a huge header #

<div class="codehilite"><pre># this is a huge header #

## this is a smaller header ##

## this is a smaller header ##

### this is even smaller ###

### this is even smaller ###

### this is even smaller ###

### this is even smaller ###

#### more small ####

#### more small ####

##### even smaller #####

##### even smaller #####

###### smallest still: `<h6>` header''')}}

###### smallest still: `<h6>` header''')}}

<p>You can use up to 6 <code>#</code> characters at the beginning of the line.</p>

<p>You can use up to 6 <code>#</code> characters at the beginning of the line.</p>

<h2 id="md_ex_code{{id}}">Code Highlighting</h2>

<h2 id="md_ex_code{{id}}">Code Highlighting</h2>

<p>The Code highlighting used in the newforge is based on (http://www.freewisdom.org/projects/python-markdown/CodeHilite). It  follows the same syntax as regular Markdown code blocks, except that there are two ways to tell the highlighter what language to use for the code block.</p>

<p>The Code highlighting used in the newforge is based on (http://www.freewisdom.org/projects/python-markdown/CodeHilite). It  follows the same syntax as regular Markdown code blocks, except that there are two ways to tell the highlighter what language to use for the code block.</p>

<p>If the first line of the codeblock contains a shebang, the language is derived from that and line numbers are used.</p>

<p>If the first line of the codeblock contains a shebang, the language is derived from that and line numbers are used.</p>

<p>Output:</p>

<p>Output:</p>

{{g.markdown.convert('''

{{g.markdown.convert('''

~~~~~~

~~~~~~

<a href="#">My code</a>

<a href="#">My code</a>

~~~~~~''')}}

~~~~~~''')}}

<h2 id="md_ex_includes{{id}}">Includes</h2>

<h2 id="md_ex_includes{{id}}">Includes</h2>

<p>You can embed another wiki page directly:</p>

<p>You can embed another wiki page directly:</p>

<div class="codehilite"><pre>

<div class="codehilite"><pre>

[[include ref=SamplePage]]

[[include ref=SamplePage]]

</pre></div>

</pre></div>

<p>No example output is available for this one because it only works on real wiki pages. Try it in your wiki!</p>

<p>No example output is available for this one because it only works on real wiki pages. Try it in your wiki!</p>

<h2 id="md_ex_neighborhood_notes{{id}}">Neighborhood Notifications</h2>

<h2 id="md_ex_neighborhood_notes{{id}}">Neighborhood Notifications</h2>

<p>You can list updates from all projects in a neighborhood by tool type. Max_number (default is 5) and sort (default is pubdate) are optional:</p>

<p>You can list updates from all projects in a neighborhood by tool type. Max_number (default is 5) and sort (default is pubdate) are optional:</p>

<div class="codehilite"><pre>

<div class="codehilite"><pre>

[[neighborhood_feeds tool_name=Wiki max_number=10 sort=pubdate]]

[[neighborhood_feeds tool_name=Wiki max_number=10 sort=pubdate]]

</pre></div>

</pre></div>

<h2 id="md_ex_neighborhood_blog_posts{{id}}">Neighborhood Blog Posts</h2>

<h2 id="md_ex_neighborhood_blog_posts{{id}}">Neighborhood Blog Posts</h2>

<p>You can view blog posts from all projects in a neighborhood. Max_number (default is 5) and sort (default is timestamp) are optional:</p>

<p>You can view blog posts from all projects in a neighborhood. Max_number (default is 5) and sort (default is timestamp) are optional:</p>

<div class="codehilite"><pre>

<div class="codehilite"><pre>

[[neighborhood_blog_posts max_number=10 sort=timestamp]]

[[neighborhood_blog_posts max_number=10 sort=timestamp]]

</pre></div>

</pre></div>

<h2 id="md_ex_project_blog_posts{{id}}">Project Blog Posts</h2>

<h2 id="md_ex_project_blog_posts{{id}}">Project Blog Posts</h2>

<p>You can view blog posts from all blogs in a project. Max_number (default is 5), mount point (leave empty to view posts from all blog tools in a project), and sort (default is timestamp) are optional:</p>

<p>You can view blog posts from all blogs in a project. Max_number (default is 5), mount point (leave empty to view posts from all blog tools in a project), and sort (default is timestamp) are optional:</p>

<div class="codehilite"><pre>

<div class="codehilite"><pre>

[[project_blog_posts max_number=10 sort=timestamp mount_point=news]]

[[project_blog_posts max_number=10 sort=timestamp mount_point=news]]

</pre></div>

</pre></div>

<h2 id="md_ex_download_button{{id}}">Download Button</h2>

<h2 id="md_ex_download_button{{id}}">Download Button</h2>

<p>You can display a download button that links to the best download available for the active project. Please note that if you use this macro and there is no download associated with your project, the button will not appear.</p>

<p>You can display a download button that links to the best download available for the active project. Please note that if you use this macro and there is no download associated with your project, the button will not appear.</p>

<div class="codehilite"><pre>

<div class="codehilite"><pre>

[[download_button]]

[[download_button]]

</pre></div>

</pre></div>

<h2 id="md_ex_project_screenshots{{id}}">Project Screenshots</h2>

<h2 id="md_ex_project_screenshots{{id}}">Project Screenshots</h2>

<p>You can show all the screenshots for the current project as thumbnails that are linked to the full-size image.</p>

<p>You can show all the screenshots for the current project as thumbnails that are linked to the full-size image.</p>

<div class="codehilite"><pre>

<div class="codehilite"><pre>

[[project_screenshots]]

[[project_screenshots]]

</pre></div>

</pre></div>

<h2 id="md_ex_thanks{{id}}">Thanks</h2>

<h2 id="md_ex_thanks{{id}}">Thanks</h2>

<p>Thanks to John Gruber and Aaron Swartz for creating Markdown.</p>

<p>Thanks to John Gruber and Aaron Swartz for creating Markdown.</p>

<p>

<p>

This page is based on some examples from Greg Schueler, <a href="mailto:greg@vario.us">greg@vario.us</a>

This page is based on some examples from Greg Schueler, <a href="mailto:greg@vario.us">greg@vario.us</a>

</p>

</p>

{% endmacro %}

{% endmacro %}