Modified Markdown Syntax

The syntax of our wiki pages is based on the markdown syntax (see this guide). If you need more background, read the Wiki Guide for Beginners and the Quick Guide. That makes it more "standard" and portable than other formats, while allowing experts to type it directly.

Another good resource are github's guides.

The simplifications to the markdown syntax are:

  • simpler links:
    • [http://site text] this is common wiki syntax and translates into [text](http://site) and looks like text
    • [http://site] this is common wiki syntax and translates into [http://site](http://site) and looks like http://site
  • Newlines: simple text lines separated by only one CRLF are treated as two separate sentences, with a <br> inserted between
  • Simpler lists - it's really annoying having to indent at 4 spaces. We modified that rule so that you can only indent at 1 space for the first 3 levels.

The restrictions are:

  • restricted set of html/xml tags allowed

The additions are:

The wiki extensions

  • [[Topic]] - to add a link to a page in this same wiki, for instance [[Modified Markdown Syntax]] which looks like Modified Markdown Syntax
    • [[Category:Topic]] to link to a page in a known category
    • [[alias:Category:Topic]] means that the current page is only an alias to the other topic. Note that IF a topic's only content is an alias tag, it will result in a redirect to the other topic - this is great if you want to rename things and try to redirect the old URL.
    • [[search:How to edit wikis]] or [[q:How to edit wikis]] link to a google search on the subject, like How to edit wikis
    • [[include:Category:Topic]] include the body of the other topic
  • [[[Topic]]] - to add a link to a page in wikipedia, for instance [[[Terms of service]]] looks like Terms of service
  • {{special code}} - special code for properties
    • {{when:2012-05-28}} - tag a page with a date/time. Dates are always in Razie's universal date format: YYYY-MM-DD like here.
      • Note that you can use date or on instead of when
      • for instance {{when:2012-05-28}} looks like {{Date 2012-05-28}}
    • {{where:RJ}} - specify the Venue where an event takes place. The venues are topics in the category Venue
      • for instance {{at Burnt River}} looks like {{at Burnt River++}}
      • Note that you can use at or venue instead of where

Location

See Help with locations for details.

  • {{loc:ll:a,b}} - a location. Entering locations enables showing the respective topics on a map.
    • for instance: {{loc:ll:44.652994,-78.688738}} to use lat/long - looks like {{Location}}
    • or {{loc:s:502 Ledge Hill Road, Burnt River, ON, K0M 1C0}} to use a searcheable address - looks like {{Location}}
    • we use Google maps to resolve these addresses

Category / domain definition

When defining a category, which is a restricted operation, certain syntax can be used to add more information about the relationship between categories.

{{roles:Category2:Role1,Role2}} means that a topic in the current category can be linked from one in Category2 as one of the roles in the list. There are special roles:

  • {{roles:Category2:Child}} denotes a parent/child relationship
  • {{roles:User:Owner,Admin,Member,Coach,Fan}} users can link to this as one of the roles.
    • Owner and Admin are restricted roles that allow one to administer the given category.

Other properties

{{.nocomments:true}} will turn off comments on the respective topic - they are by default on.

{{.noSocial:true}} will turn off displaying the social sharing buttons (twitter, facebook etc) on the respective topic - they are by default on for most categories.

{{.title:Some text}} will use the text title for the web page tile, instead of the default title created using the page name. Don't use misleading titles - you risk a reprimand from the admins.

{{xpl...}} see WikiPath

{{xmap...}} see WikiPath

Photos and images

{{img[.icon|.small|.medium] URL ARGS}}

{{photo URL ARGS}}

ARGS are optional attributes of the img http tag.

{{video URL}} is good for videos shared from youtube.

Forms and fields

Insert form fields using the {{f: properties. These are some example:

A simple string field: {{f:simpleField}}

SimpleField:

Select/choices: {{f:province:type=select,choices=ON|QC}}

Province

A checkbox: {{f:check1:type=checkbox}}

Check:

A memo: {{f:memo1:type=textarea,rows=3}}

Memo:


Was this useful?    

By: Razie | 2012-09-04 .. 2018-10-28 | Tags: wiki , help


Viewed 1307 times ( | Print ) this page.

You need to log in to post a comment!
© Copyright DieselApps, 2012-2018, all rights reserved.