howto

Instructions for Authors

This wiki is hosted on Github.com, but you can download the content to your own computer and run it as an interactive website using a software called gollum (not available for Windows).

The wiki is composed of pure text files, written in Markdown syntax, that you can edit individually on the GitHub web-interface or on your computer using any text editor.

Using markdown

The markdown syntax is a very simple style of writing text files that can be interpreted by the wiki software.

• write headings using hash signs #, ##, ###.
• write bold text using double asterisks **bold text**
• write italic text using asterisk *italic text*
• write external links using [link text](http://www.link.url)
• write internal links using [[ link text | pagename ]]
• embed figures using ![alternative text](path/to/figure.png) (an alternative text is displayed if the figure is unavailable. figures can only be uploaded by cloning the wiki to your computer)
• write unnumbered lists using dashes or asterisks before each list entry:

  leave a blank line before beginning the list. 
  
   - first entry
   - second entry
  

• write numbered lists

  leave a blank line before beginning the list. 
  
   1. first entry
      1. first sub-section
      2. second sub-section
   2. second entry
  

Wiki structure and navigation

If registered to Github, you can add and edit pages of the wiki. Please make sure you use valid Markdown by checking the page preview.

If you create a new page, use a short but descriptive and unique filename without spaces. Also make sure it is linked to in the _Sidebar.md file, which is used to create the wiki table of contents. This is simply a numbered list of internal links.

If you edit an existing page, please do not change the filename indicated in the first row of the editor view, since this will break internal links that are existing to this page, unless you take care for fixing all the links yourself.

One of the advantages of a wiki are cross references between the pages. Please create cross-references using the internal link syntax [[ link text | pagename ]]

Math equations

If you would like to add math equations to your model equations this is possible using LaTeX syntax. Inline variables or short equations can be set using single dollar signs $\alpha$, and block equations are marked by double dollar signs

$$ f(x) = \alpha x ^{2 \vareps } \frac{a}{1+K} $$

You can check your equations in LaTeX before copying it into the wiki, because the equations will not display properly on the GitHub.com website. In the future this wiki might be transferred into a pdf document or hosted on a webserver that is able to render those Math equations.

Download the files

It is more flexible to modify the wiki on your own computer, because you are able to

• organise pages in sub-directories
• add figures
• work offline

To download the wiki, you can use your git client. Just clone the wiki content to a directory on your computer.

git clone https://github.com/cascade-wp6/wp6_docs.wiki.git

Now you can modify the content of any markdown file, add pages and figures, etc. To upload your changes, you need to add and commit them to git:

git add .
git commit -m "your commit message"

Then, you push your changes back to the server using

git push origin master