Tutorial

From OWASP
Revision as of 17:43, 24 May 2006 by Jeff Williams (Talk | contribs)

Jump to: navigation, search

Contents

Editing OWASP

OWASP is built on the MediaWiki platform. Anyone can create an account and make OWASP better.

When you make edits, please use the "preview" feature to make sure your changes are final, and then don't forget to save. Use the "edit summary" to describe what you did and why.

In general, we follow the editing guidelines of Wikipedia.. You should ensure that your additions to OWASP reflect a "Neutral Point of View" and a positive collaboration in the interest of better application security.

Please use the "Discussion" pages to work out differences of opinion about a particular topic.

The MediaWiki help is a great place to start learning about all the features available.

Writing for Wikipedia articles is a bit different from writing on a standard word processor. Instead of a strict "what you see is what you get" approach, wiki uses simple text codes for formatting. The approach is similar to that used in writing HTML for web pages, but the codes are simpler.

Bold and italics

Bold and italics are created like this:

  • ''italics'' appears as italics. (2 apostrophes on both sides)
  • '''bold''' appears as bold. (3 apostrophes on both sides)

Headings and subheadings

Headings and subheadings are an easy way to improve the organization of an article. If you can see two or more distinct topics being discussed, you can break up the article by inserting a heading for each section.

Headings can be created like this:

  • ==Top level heading== (2 equals signs)
  • ===Subheading=== (3 equals signs)
  • ====Another level down==== (4 equals signs)

Internal links

One thing that makes Wikipedia useful (and highly habit-forming) is extensive cross-listing by internal links. These easily-created links allow users to access information related to the article they're reading.

The easiest way to learn when to link is to look at Wikipedia articles for examples. If you're trying to decide whether to make a link or not, ask yourself "If I were reading this article, would the link be useful to me?"

When you want to make a link to another Wikipedia page (called a wiki link) you have to put it in double square brackets, like this:

[[Threats]]

If you want to use words other than the article title as the text of the link, you can do so by adding the "|" divider followed by the alternative name. For example, if you wanted to make a link to the Main Page, but wanted it to say "OWASP home" you would write it as such:

To view the article, [[Main Page|OWASP home]]...

Categories

OWASP makes extensive use of categories. Categories are used to "tag" articles in OWASP so that people can find them. An article can be in lots of categories at the same time. For example, an article discussing a flaw in the Java sandbox might be in the Category:Java, Category:Vulnerability, and Category:Access Control categories at the same time.

To add a category to an article, just add [[Category:XXX]] to the end of the article, replacing the XXX with the name of the appropriate category.

To reference a Category page, simply put a colon (:) at the beginning of the "Category" tag, like this:

[[:Category:Principles]]

It is very important to put in the correct categories so that other people can easily find your work. The best way to find which categories to put in is to look at pages on similar subjects, and check which categories they use. For example if you write an article about a type of tree, you may look at an article on another type of tree to see which categories could be appropriate.