Difference between revisions of "Tips for writing wiki pages"
| Line 11: | Line 11: | ||
== Semantic links == | == Semantic links == | ||
| − | 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 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>, <nowiki>[[Category::problem]]</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> or <nowiki>[[UsesMethod::logistic regression]]</nowiki>. Generally, it's best to put a learning method on a new page if it is going to be used by more than one author; otherwise, just describe it in the body of the paper page. | + | 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> or <nowiki>[[UsesMethod::logistic regression]]</nowiki>. Generally, it's best to put a learning method on a new page if it is going to be used by more than one author; otherwise, just describe it in the body of the paper page. If you create a link called <nowiki>[[UsesMethod::pointwise mutual information]]</nowiki> and the page for "pointwise mutual information" as well, make sure you mark the "pointwise mutual information" page as a dataset page, using a <nowiki>[[Category::dataset]]</nowiki> link. |
| + | |||
| + | There is also a semantic link for UsesDataset - which should link a paper page and a page marked as <nowiki>[[Category::Dataset]]</nowiki> - AddressesProblem - which should link a paper and a <nowiki>[[Category::problem]]</nowiki> page - and RelatedPaper - which should link two paper pages. | ||
Revision as of 17:27, 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
For a paper 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.
For a method page, name it according to a reasonably long name of the method - eg, use Logistic Regression, not just "LogReg" or "LR".
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]], [[Category::problem]] 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]] or [[UsesMethod::logistic regression]]. Generally, it's best to put a learning method on a new page if it is going to be used by more than one author; otherwise, just describe it in the body of the paper page. If you create a link called [[UsesMethod::pointwise mutual information]] and the page for "pointwise mutual information" as well, make sure you mark the "pointwise mutual information" page as a dataset page, using a [[Category::dataset]] link.
There is also a semantic link for UsesDataset - which should link a paper page and a page marked as [[Category::Dataset]] - AddressesProblem - which should link a paper and a [[Category::problem]] page - and RelatedPaper - which should link two paper pages.
