edit

Editing this Wiki

• Markdown and Tutorials
• General Editing Rules

If something is missing from this wiki, please add it! If something in this wiki is wrong, please fix it! Remember that this wiki is meant to help people exactly like you, so you are the best judge of what should or should not be here, and on whether it is useful.

You can edit everything by clicking on the various edit buttons. GitHub will immediately display an editor, including a summary of markdown rules on the very top of the page. This contains most of the markdown syntax you will ever need while editing this wiki.

If you are a member of the Northeastern community and would like to contribute to this wiki, please email Prof. Ioannidis to request access. Include your GitHub username, as well as a brief description of how you are affiliated with Northeastern.

Tip. To quickly see examples of how to create headers, lists, references, code blocks, block-quotes, etc., just click on edit on the top right of this wiki page, and inspect its markdown code.

Markdown and Tutorials

This wiki is written in markdown language, the same language use to generate most of the documentation in GitHub, including README.md files. You can use the following tutorials to familiarize yourself with markdown and wiki functionalities.

• Markdown-Cheatsheet
• Markdown Tutorial
• GitHub Wikis
• Writing on Github

General Editing Rules

• When in doubt, edit! This wiki is, in itself, a git repository, so any mistake you make can be instantly and easily corrected.
• Try to maintain a uniform look and feel across pages. For example:
  • Use headers for title pages, sections, subsections, etc.
  • Add a list of references to sections in the page at the beginning of each page.
  • Use lists when you wish to represent listed items.
  • Use code blocks when you want to write code like:

        for key in d:
            d[key] += 1 
            print 'Dictionary value after incrementing by one is:',d[key]

  • Use block-quotes to indicate interesting asides or tips such as:

    Tip: Block-quotes can highlight something that would appear better outside the normal flow of your text.

• If you edit the home page, particularly links in Main Topics, Special Topics, etc., make sure to reflect these changes also in the sidebar: this is does not happen automatically.
• If something deserves to be mentioned in multiple pages, give it a home, and then point to it from other pages via links. Avoid duplication.
• Finally, be concise, but write proper English sentences, with proper punctuation, syntax, etc.