{% macro gravatar(user, size, className) -%} {% set display_name = h.really_unicode(user.display_name) %} {% if user.icon_url() %} {{display_name}} {% else %} {% endif %} {%- endmacro %} {% macro email_gravatar(email, title=None, size=None) -%} {% set title=h.really_unicode(title) %} {% if email %} {{title or email}} {% else %} {% endif %} {%- endmacro %} {% macro file_field(name, label) %} {% if label %} {% endif %}
{% endmacro %} {% macro text_area(name, label, value=None) %} {% if label %}
{% endif %}
{% endmacro %} {% macro text_field(name, label, value='') %} {% if label %}
{% endif %}
{% endmacro %} {% macro radio_button(name, label, option, value=None) %} {% if label %}
{% endif %}
{% endmacro %} {% macro submit_button(value, name=None) %}
{% endmacro %} {% macro abbr_date(start_time) %} {{h.ago(start_time)}} {% endmacro %} {% macro path_links(parts) %} {% set i=0 %} {% for part in parts %} {{part}} / {% set i=i+1 %} {% endfor %} {% endmacro %} {% macro post_summary(post) %} {% if post %} by {{post.author().display_name}} {{abbr_date(post.timestamp)}} {% endif %} {% endmacro %} {% macro crumbs(trail) %} {% for (label, url) in trail %}
  • {% if url %} {{label}} {% else %} {{label}} {% endif %}
  • {% endfor %} {% endmacro %} {% macro markdown_syntax() %}

    Markdown Syntax Guide

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

    Markdown was created with one goal in mind:

    Markdown is intended to be as easy-to-read and easy-to-write as is feasible.

    But the most important goal was to make it readable in its raw plain text
    format.

    Links

    For a URL or email, just write it like this:
    
    <http://someurl>
    
    <somebbob@example.com>
    
    To use text for the link, write it [like this](http://someurl).
    
    You can add a *title* (which shows up under the cursor),
    [like this](http://someurl "this title shows up when you hover").
    

    Reference Links

    You can also put the [link URL][1] below the current paragraph
    like [this][2].
    
       [1]: http://url
       [2]: http://another.url "A funky title"
    
    Here the text "link URL" gets linked to "http://url", and the lines
    showing "[1]: http://url" won't show anything.
    
    Or you can use a [shortcut][] reference, which links the text
    "shortcut" to the link named "[shortcut]" on the next paragraph.
    
       [shortcut]: http://goes/with/the/link/name/text
    

    Artifact Links

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

    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. You can also link to tickets with `[tickets:#123]` assuming there's a 123 ticket in a Tracker instance mounted at `tickets`. The same is true for forums, or any of the other tools you have installed. You can even link to tickets in a subproject with `[subproject.tickets:#123]`.

    Text

    Use * or _ to emphasize things:
    
    *this is in italic*  and _so is this_
    
    **this is in bold**  and __so is this__
    
    ***this is bold and italic***  and ___so is this___
    
    Just write paragraphs like in a text file and they will display how
    you would expect.  A blank line separates paragraphs.
    
    So this is a new paragraph. But any text on adjacent lines
    will all end up
    in the same paragraph.
    

    Blockquotes

    > Use the > character in front of a line, *just like in email*.
    > Use it if you're quoting a person, a song or whatever.
    
    > You can use *italic* or lists inside them also.
    And just like with other paragraphs,
    all of these lines are still
    part of the blockquote, even without the > character in front.
    
    To end the blockquote, just put a blank line before the following
    paragraph.
    

    Preformatted Text

    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
    spaces (or 1 tab).
    
        This line won't *have any markdown* formatting applied.
        I can even write <b>HTML</b> and it will show up as text.
        This is great for showing program source code, or HTML or even
        Markdown. <b>this won't show up as HTML</b> but
        exactly <i>as you see it in this text file</i>.
    
    As a shortcut you can use backquotes to do the same thing while
    inside a normal pargraph.  `This won't be *italic* or **bold**
    at all.`
    
    

    Lists

    * an asterisk starts an unordered list
    * and this is another item in the list
    + or you can also use the + character
    - or the - character
    
    To start an ordered list, write this:
    
    1. this starts a list *with* numbers
    +  this will show as number "2"
    *  this will show as number "3."
    9. any number, +, -, or * will keep the list going.
        * just indent by 4 spaces (or tab) to make a sub-list
            1. keep indenting for more sub lists
        * here i'm back to the second level
    

    Headers

    This is a huge header
    ==================
    
    this is a smaller header
    ------------------
    
    Just put 1 or more dashes or equals signs (--- or ===) below the
    title.
    

    Horizontal Rule

    just put three or more *'s or -'s on a line:
    
    ----------------
    
    or you can use single spaces between then, like this:
    
    * * *
    
    or
    
    - - - - - - -
    
    Make sure you have a blank line above the dashes, though, or else:
    
    you will get a header
    ---
    

    Images

    To include an image, just put a "!" in front of a text link:
    
    ![alternate text](http://someurl/image.gif)
    
    The "alternate text" will show up if the browser can't load the
    image.
    
    You can also use a title if you want, like this:
    
    ![tiny arrow](http://greg.vario.us/img/extlink.png "tiny arrow")
    
    To reference an attached image, just use the img macro.  You can add more attributes:
    
    [[img src=attached-image.jpg alt=foobar width=20%]]
    
    

    Escapes

    What if you want to just show asterisks, not italics?

    * this shows up in italics: *a happy day*
    * this shows the asterisks: \*a happy day\*
    

    The backslashes will disappear and leave the asterisks.

    You can do the same with any of the characters that have a special meaning
    for Markdown.

    More Headers

    More ways of doing headers:
    
    # this is a huge header #
    ## this is a smaller header ##
    ### this is even smaller ###
    #### more small ####
    ##### even smaller #####
    ###### smallest still: `<h6>` header
    

    You can use up to 6 # characters at the beginning of the line.

    Code Highlighting

    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.

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

    #!/usr/bin/python
    # Code goes here ...
    

    If the first line contains a shebang, but the shebang line does not contain a path (a single / or even a space) or If the first line begins with three or more colons, the text following the colons identifies the language. In both cases, the first line is removed from the code block before processing.

    :::python
    # Code goes here ...
    

    You can also designate a code block by surrounding it with lines of tildes. The type of code highlighting to apply will be inferred based on the code within.

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

    Includes

    You can embed another wiki page directly:

    [[include ref=SamplePage]]
    

    HTML

    Don't worry about special characters which need to be escaped in html.

    You can write an ampersand & a less-than sign, and they show up expected: 3 < 4.

    Thanks

    Thanks to John Gruber and Aaron Swartz for creating Markdown.

    This page is based on some examples from Greg Schueler, greg@vario.us

    {% endmacro %}