Difference between revisions of "Tips for writing wiki pages"

From Cohen Courses
Jump to navigationJump to search
(Created page with '== Before you start == Look at some example pages to get an idea for what's expected. Search in the wiki to see if it's already t…')
 
Line 9: Line 9:
 
== Semantic links ==
 
== Semantic links ==
  
If the page summarizes a paper, include a link of the form <nowiki>[[Category::paper]]</nowiki>, like this: "This seminal <nowiki>[[Category::paper]]</nowiki> by Cohen is one of the finest..."
+
If the page describes a paper, include a link of the form <nowiki>[[Category::paper]]</nowiki>, like this: "This seminal <nowiki>[[Category::paper]]</nowiki> by Cohen is one of the finest...".  The other valid category links are <nowiki>[[Category::method]]</nowiki> and <nowiki>[[Category::dataset]]</nowiki>.
 +
 
 +
If the paper makes use of some learning method or analysis method that should be described on a separate wiki page, then add a link like this one <nowiki>[[UsesMethod::pointwise mutual information]]</nowiki>

Revision as of 15:52, 1 February 2011

Before you start

Look at some example pages to get an idea for what's expected. Search in the wiki to see if it's already there - or if something very related is already there.

Naming your page

Name your page something that would be reasonable citation entry, including at least the first author and the year, as in the examples. Squeeze in a conference name or an abbreviation of a journal if it's someplace easily recognizable to the audience - that will help them remember. You can move you page later if you need to, so this isn't critical.

Semantic links

If the page describes a paper, include a link of the form [[Category::paper]], like this: "This seminal [[Category::paper]] by Cohen is one of the finest...". The other valid category links are [[Category::method]] and [[Category::dataset]].

If the paper makes use of some learning method or analysis method that should be described on a separate wiki page, then add a link like this one [[UsesMethod::pointwise mutual information]]