Difference between revisions of "WikiFAQ"

m
 
(30 intermediate revisions by 7 users not shown)
Line 1: Line 1:
= What are these pages? =
+
<!--
 
 
These pages serve as a knowledge base for the Computation Biology Group at the Department of Medical Genetics, University of Lausanne, Lausanne Switzerland. See the (non-Wiki) [http://serverdgm.unil.ch/bergmann homepage of the group here].
 
 
 
Some of these pages may be publicly readable, if the author of the page thinks that it is useful for people outside our group.
 
 
 
 
= Who can ... ? =
 
= Who can ... ? =
  
 
== Who can read these pages? ==
 
== Who can read these pages? ==
  
By default everyone can read the pages in this Wiki. If you want to create private pages, readable only by CBG members, then the name of your page should start with "<tt>Internal:</tt>", e.g. [[Internal:Test]] is a private page. Alternatively, the prefix of the page name can be "<tt>I:</tt>", if you prefer shorter names, e.g. [[I:Test]] is another (a different) private page. The third possibility is that you [mailto:wwwcbg@unil.ch tell the admin] to make your page private, then the name of the page can be anything you like.
+
Everyone can read the pages in this Wiki. There is currently no possibility to create private pages as this feature was not used at all in the past and it makes the life of the Wiki admin very difficult.
  
 
== Who can edit these pages? ==
 
== Who can edit these pages? ==
Line 17: Line 12:
 
== Who can create new pages? ==
 
== Who can create new pages? ==
  
Members of the CBG, more precisely anyone who has an account to the CBGWiki.
+
Members of the CBG, more precisely anyone who has an account to the CBGWiki.  
 +
-->
  
 
= How can I ...? =
 
= How can I ...? =
Line 23: Line 19:
 
== How can I create a new page? ==
 
== How can I create a new page? ==
  
Type in the name of the page into the search box on the left, to see whether it already exists. If not, then click on "create this link" towards the top of the page.
+
Type in the name of the page into the search box on the right, to see whether it already exists. If not, then click on "create this link" towards the top of the page.
  
 
== How can I edit an existing page? ==
 
== How can I edit an existing page? ==
Line 29: Line 25:
 
Navigate to the page you want to edit and then click on the "edit" tab on the top.
 
Navigate to the page you want to edit and then click on the "edit" tab on the top.
  
 +
== Can I undo the changes I did? ==
 +
 +
Yes, you can, all earlier versions of the pages are stored in the Wiki database. Click on the "history" tab of the page, and then on "undo" at the version you would like to go back to.
 +
 +
== How can I rename a page ? ==
 +
Once you are logged in, go to index.php?title=Special:MovePage/XXX, where XXX is the name of the page you want to move
 
== How do I write WikiText? ==
 
== How do I write WikiText? ==
  
Line 41: Line 43:
 
== Is there a way to cite [http://www.ncbi.nlm.nih.gov/pubmed/ PubMed] papers easily? ==
 
== Is there a way to cite [http://www.ncbi.nlm.nih.gov/pubmed/ PubMed] papers easily? ==
  
The [http://openwetware.org/wiki/Wikiomics:Biblio Biblio] extension is installed in this Wiki. you can create references to papers by simply giving their PubMed ID. For example
+
For the publication list we use the [http://www.mediawiki.org/wiki/Extension:Pubmed Pubmed] extension. To put references, just create a block as follows:
 +
<pre>
 +
<pubmed>
 +
12689096
 +
</pubmed>
 +
</pre>
 +
 
 +
Here, the number is the respective PubMed ID and it generates the following reference:
 +
<pubmed>
 +
12689096
 +
</pubmed>
 +
 
 +
This extension only generates reference lists but does not allow in-line citations. For this purpose the [http://openwetware.org/wiki/Wikiomics:Biblio Biblio] extension is installed in this Wiki. You can create references to papers by simply giving their PubMed ID. For example
  
 
<pre>
 
<pre>
Line 61: Line 75:
 
== How do I upload files? ==
 
== How do I upload files? ==
  
Click on the [[Special:Upload|"Upload file"]] link on the left.
+
Click on the [[Special:Upload|"Upload file"]] link on the bottom
 +
 
 +
== How do I include an image ? ==
 +
You can write something like <nowiki> [[File:filename.jpg|thumb|500px]]</nowiki>, where filename.jpg is a picture that has been uploaded (see above) to the wiki. More details are given [http://en.wikipedia.org/wiki/Wikipedia:Picture_tutorial here].
 +
 
 +
== What are minor and major edits? ==
 +
 
 +
A major edit is when you do substantial changes to a page, e.g. add a new paragraph to it, or change the time or place of the group meeting in the [[Group Meeting]] page. A minor edit is something small, e.g. correcting a typo, changing a word from boldface to italics.
 +
 
 +
When you edit a page, you can classify your contribution as minor or major. Please consider using this option because people who "watch" a page (see next question below), may expect to be notified about substantial changes, but not about minor ones.
 +
 
 +
== Can I get email notifications about page changes? ==
 +
 
 +
Yes, you can, it is easy. First, you have to click on the "watch" tab on the top of the page, this adds it to your "watchlist". Second, you click on "my preferences" on the very top of any wiki page, scroll down to the "E-mail" section and turn on the appropriate checkbox. You can set up whether you want get notifications about the minor edits (see previous question).
  
 
== How can I find a page that I have already created? ==
 
== How can I find a page that I have already created? ==
  
Type in its name into the search box on the left. Alternatively (if you cannot remember the name exactly), [[Special:AllPages|list all pages]] in the Wiki.
+
Type in its name into the search box on the right. Alternatively (if you cannot remember the name exactly), [[Special:AllPages|list all pages]] in the Wiki.
  
 
== How can I undelete a page? ==
 
== How can I undelete a page? ==
Line 83: Line 110:
 
Sure, we use Google Analytics for that. All you need is a Google account, [mailto:wwwcbg@unil.ch write a mail to the admin] including your Google user name and then go to [http://www.google.com/analytics/ Google Analytics]. Alternatively, you can log in to Analytics with the common user name, <tt>cbg.unil@gmail.com</tt>, to view the reports.
 
Sure, we use Google Analytics for that. All you need is a Google account, [mailto:wwwcbg@unil.ch write a mail to the admin] including your Google user name and then go to [http://www.google.com/analytics/ Google Analytics]. Alternatively, you can log in to Analytics with the common user name, <tt>cbg.unil@gmail.com</tt>, to view the reports.
  
== Can I change the menu on the left? ==
+
== Can I change the menu on the top? ==
  
 
Unfortunately you can't. But you can [mailto:wwwcbg@unil.ch ask the admin] to do that for you.
 
Unfortunately you can't. But you can [mailto:wwwcbg@unil.ch ask the admin] to do that for you.
 +
 +
== How can I add an entry to the News section on the front page? ==
 +
 +
It is pretty simple, takes two easy steps:
 +
# Create a new page, or choose the page you want to link from the title of the news entry.
 +
# Edit this page, and add the following to it (wherever you like, but maybe better at the top):
 +
  <pre>
 +
    [[Category:Bulletins]]
 +
    <teaser>
 +
    The message that you would like to see in the news entry comes here. It is WikiText, so it can contain links: [[ISA]]
 +
    But external links are better coded in html like this: <a href="http://www.unil.ch"> unil </a>
 +
    <date>15 Jul 2010 — 19:40</date>
 +
    </teaser>
 +
  </pre>
 +
 +
The <code><date>...</date></code> part is not required, and if it is not given, then the date and time of the creation of the page will be shown.
 +
 +
If you don't want to play with the main page, then here is what you can do. Instead of the <code>Bulletins</code> category, first use the <code>BulletinsTest</code> category, and then check the top of the [[Sandbox]] page. This page shows the news entries created with the <code>BulletinsTest</code> category. If everything looks fine, then edit your page again and replace <code><nowiki>[[Category:BulletinsTest]]</nowiki></code> with <code><nowiki>[[Category:Bulletins]]</nowiki></code>.
 +
 +
= Other issues =
 +
 +
== Is this secure? ==
 +
 +
No, not really. Since all transport goes over <tt>http</tt> without encryption, anyone on the same local network can steal your password. E.g. if you use your laptop to log int to the Wiki and you are connected through an open wireless network, then anyone within the range of the wireless signal can potentially steal your password. Please use a different password for the Wiki than the one(s) you normally use for other accounts.
 +
 +
== Could we make this secure? ==
 +
 +
No, not really. UNIL cannot (does not want to?) serve our Wiki through <tt>https</tt>.
 +
If you are outside the university, then you can use the UNIL VPN to make it somewhat more secure. Then the passwords travel unencrypted only between the UNIL VPN gateway and the UNIL web server. [http://www.unil.ch/ci/page62990.html See more info here.]

Latest revision as of 17:08, 4 April 2017


How can I ...?

How can I create a new page?

Type in the name of the page into the search box on the right, to see whether it already exists. If not, then click on "create this link" towards the top of the page.

How can I edit an existing page?

Navigate to the page you want to edit and then click on the "edit" tab on the top.

Can I undo the changes I did?

Yes, you can, all earlier versions of the pages are stored in the Wiki database. Click on the "history" tab of the page, and then on "undo" at the version you would like to go back to.

How can I rename a page ?

Once you are logged in, go to index.php?title=Special:MovePage/XXX, where XXX is the name of the page you want to move

How do I write WikiText?

Writing Wiki pages is quite simple, see the help page of Wikipedia. Most of the things described here should work in the CBGWiki, too.

How do I write formulas?

You can use <math>\LaTeX</math> markup between <math> ... </math>. E.g. <math>\sqrt{a^2+b^2}</math> will be displayed as <math>\sqrt{a^2+b^2}</math>.

We currently (and temporarily) use the web service of John Forkosh Associates, Inc. to render the formulas, so many thanks to them.

Is there a way to cite PubMed papers easily?

For the publication list we use the Pubmed extension. To put references, just create a block as follows:

<pubmed>
12689096
</pubmed>

Here, the number is the respective PubMed ID and it generates the following reference:


This extension only generates reference lists but does not allow in-line citations. For this purpose the Biblio extension is installed in this Wiki. You can create references to papers by simply giving their PubMed ID. For example

The Iterative Signature Algorithm <cite>ISA</cite>...
<biblio>
# ISA pmid=12689096
</biblio>

will be shown as:

The Iterative Signature Algorithm ISA... <biblio>

  1. ISA pmid=12689096

</biblio>

See the Biblio homepage for more help.

How do I upload files?

Click on the "Upload file" link on the bottom

How do I include an image ?

You can write something like [[File:filename.jpg|thumb|500px]], where filename.jpg is a picture that has been uploaded (see above) to the wiki. More details are given here.

What are minor and major edits?

A major edit is when you do substantial changes to a page, e.g. add a new paragraph to it, or change the time or place of the group meeting in the Group Meeting page. A minor edit is something small, e.g. correcting a typo, changing a word from boldface to italics.

When you edit a page, you can classify your contribution as minor or major. Please consider using this option because people who "watch" a page (see next question below), may expect to be notified about substantial changes, but not about minor ones.

Can I get email notifications about page changes?

Yes, you can, it is easy. First, you have to click on the "watch" tab on the top of the page, this adds it to your "watchlist". Second, you click on "my preferences" on the very top of any wiki page, scroll down to the "E-mail" section and turn on the appropriate checkbox. You can set up whether you want get notifications about the minor edits (see previous question).

How can I find a page that I have already created?

Type in its name into the search box on the right. Alternatively (if you cannot remember the name exactly), list all pages in the Wiki.

How can I undelete a page?

You can't, but the admin can. Write a mail to the admin.

How do I request a new feature?

Add it to the Feature Requests page, the admin will get emails about changes to this page automatically.

Where can I play around?

In the Sandbox, of course. This is a page that was created specifically for trying out things. Feel free to edit it any way you like.

Can I check how many visitors my page got?

Sure, we use Google Analytics for that. All you need is a Google account, write a mail to the admin including your Google user name and then go to Google Analytics. Alternatively, you can log in to Analytics with the common user name, cbg.unil@gmail.com, to view the reports.

Can I change the menu on the top?

Unfortunately you can't. But you can ask the admin to do that for you.

How can I add an entry to the News section on the front page?

It is pretty simple, takes two easy steps:

  1. Create a new page, or choose the page you want to link from the title of the news entry.
  2. Edit this page, and add the following to it (wherever you like, but maybe better at the top):
    [[Category:Bulletins]]
    <teaser>
    The message that you would like to see in the news entry comes here. It is WikiText, so it can contain links: [[ISA]] 
    But external links are better coded in html like this: <a href="http://www.unil.ch"> unil </a>
    <date>15 Jul 2010 — 19:40</date>
    </teaser>
  

The <date>...</date> part is not required, and if it is not given, then the date and time of the creation of the page will be shown.

If you don't want to play with the main page, then here is what you can do. Instead of the Bulletins category, first use the BulletinsTest category, and then check the top of the Sandbox page. This page shows the news entries created with the BulletinsTest category. If everything looks fine, then edit your page again and replace [[Category:BulletinsTest]] with [[Category:Bulletins]].

Other issues

Is this secure?

No, not really. Since all transport goes over http without encryption, anyone on the same local network can steal your password. E.g. if you use your laptop to log int to the Wiki and you are connected through an open wireless network, then anyone within the range of the wireless signal can potentially steal your password. Please use a different password for the Wiki than the one(s) you normally use for other accounts.

Could we make this secure?

No, not really. UNIL cannot (does not want to?) serve our Wiki through https. If you are outside the university, then you can use the UNIL VPN to make it somewhat more secure. Then the passwords travel unencrypted only between the UNIL VPN gateway and the UNIL web server. See more info here.