Help:Hosting courses

From OpenWetWare

(Difference between revisions)
Jump to: navigation, search
Current revision (12:32, 10 March 2008) (view source)
 
(13 intermediate revisions not shown.)
Line 1: Line 1:
-
This is a placeholder page for instructions and suggestions for hosting a course on [[OpenWetWare]].
+
<font size=1>< [[Help:Contents|Help]]</font>
-
==FAQ==
+
This is a help page for hosting a course on [[OpenWetWare]].
-
===Why should I host a course on OpenWetWare?===
+
'''See also the [[FAQ/Courses|FAQ on hosting a course on OpenWetWare]].'''
-
 
+
-
There are several motivations for hosting a course on OpenWetWare ...
+
-
 
+
-
#'''Enhance student participation in the course.'''  Students have the ability to edit any page on OpenWetWare.  So by placing course materials here, you are giving them the ability to revise (and improve) course content.
+
-
#'''Promote reuse of course materials.'''  All content on OpenWetWare is [[OpenWetWare:Copyrights|dual-licensed under the Creative Commons Atrribution ShareAlike and GFDL copyright licenses]].  Thus, you are making your course materials freely available for others to reuse.  Moreover, the wiki format allows people to more easily copy and ''modify'' your materials (as compared to static websites and PDF files) so you are also making it easier for others to build upon your work.
+
-
#'''Facilitate collaborative course development.'''  Many courses are developed jointly among multiple faculty and teaching assistants.  Placing the materials on OpenWetWare makes it easy to work together on developing course materials (as compared to emailing word documents back and forth).
+
-
 
+
-
===Why shouldn't I host a course on OpenWetWare?===
+
-
 
+
-
A common concern among many OpenWetWare users is that someone may accidentally or intentionally modify a page.  However, all changes and updates are tracked and can be easily reverted.  Nevertheless, course instructors do need to monitor their course site closely to ensure that errors are not introduced and propagated around the class.
+
-
 
+
-
Note that the primary reason to put a course on OpenWetWare is to enable students to edit course materials and the course site.  If you're not interested in having students edit the course pages, then it might not be wise to post your materials to OpenWetWare.  We give anyone in biology and biological engineering an OpenWetWare account (who requests one).
+
-
 
+
-
===Am I surrendering copyright to my course materials?===
+
-
 
+
-
No, you retain copyright to all materials you upload or write on OpenWetWare.  You can later republish and relicense them in any way you like. However, you can never retract the Creative Commons Atrribution ShareAlike and GFDL licenses for the versions you placed here.
+
-
 
+
-
===What courses are hosted on OpenWetWare===
+
-
 
+
-
See the [[Courses|list of past and present courses]] hosted on OpenWetWare.
+
==How do I start?==
==How do I start?==
Line 41: Line 21:
#First, go to [[Template:OWW.101|the OWW.101 template page]] (open this in a new browser window if you want to keep reading this text).
#First, go to [[Template:OWW.101|the OWW.101 template page]] (open this in a new browser window if you want to keep reading this text).
#Click [[Image:EditButton.jpg]] and copy all the wiki markup on that page.
#Click [[Image:EditButton.jpg]] and copy all the wiki markup on that page.
-
#In the search box on the lefthand side navigation bar, type <code>Template:<Your course number></code> (be sure and replace <code><Your course number></code> with your course's number like <code>20.109</code> or <code>MCB100</code>.  [[Image:Searchbox.png|right]]
+
#In the search box on the lefthand side navigation bar, type <code>Template:<Your course number/Course year></code> (be sure and replace <code><Your course number/Course year></code> with your course's number like <code>20.109/2006</code> or <code>MCB100/2007</code>.  [[Image:Searchbox.png|right]]
-
#You should see a page come up with a message saying '''"There is no page titled "Template:<Your course number>".''' You can create this page." If you don't see this message then that means a page with that name already exists.  You'll need to choose a different course name.  [[Image:NoPage.png|450px|left]] <br style="clear:both" />
+
#You should see a page come up with a message saying "You searched for Template:<Your course number/Course year>"  where "Template:<Your course number/Course year>" is in red. If you don't see this message then that means a page with that name already exists.  You'll need to choose a different course name.  [[Image:NoPage.png|450px|left]] <br style="clear:both" />
-
#Click on the create this page link.
+
#Click on the red link "Template:<Your course number/Course year>".
#Paste the code from the OWW.101 template onto this page.
#Paste the code from the OWW.101 template onto this page.
#Replace every instance of <code>OWW.101</code> with your course number.
#Replace every instance of <code>OWW.101</code> with your course number.
Line 56: Line 36:
#After the picture has been uploaded, you will be taken to the Image page for your course image.   
#After the picture has been uploaded, you will be taken to the Image page for your course image.   
#Copy the page title (i.e. '''Image:<What you named your picture>.png''').
#Copy the page title (i.e. '''Image:<What you named your picture>.png''').
-
#Return to your course template.  You can do this quickly by typing <code>Template:<Your course number></code> in the search box on the left.
+
#Return to your course template.  You can do this quickly by typing <code>Template:<Your course number/Course year></code> in the search box on the left.
#Click [[Image:EditButton.jpg]] and replace <code>Image:OWW101logo.png</code> with <code>Image:<What you named your picture>.png</code>
#Click [[Image:EditButton.jpg]] and replace <code>Image:OWW101logo.png</code> with <code>Image:<What you named your picture>.png</code>
#Check your work by clicking the [[Image:ShowPreviewButton.jpg]] button.
#Check your work by clicking the [[Image:ShowPreviewButton.jpg]] button.
Line 65: Line 45:
#First, go to [[OWW.101|the OWW.101 course homepage]] (again, open this in a new browser window if you want to keep reading this text).
#First, go to [[OWW.101|the OWW.101 course homepage]] (again, open this in a new browser window if you want to keep reading this text).
#Click [[Image:EditButton.jpg]] and copy all the wiki markup on that page.
#Click [[Image:EditButton.jpg]] and copy all the wiki markup on that page.
-
#[[Image:Searchbox.png|right]] In the search box on the lefthand side navigation bar, type <code><Your course number></code> (be sure and replace <code><Your course number></code> with your course's number like <code>20.109</code> or <code>MCB100</code>.   
+
#[[Image:Searchbox.png|right]] In the search box on the lefthand side navigation bar, type <code><Your course number></code> (be sure and replace <code><Your course number></code> with your course's number like <code>20.109/2006</code> or <code>MCB100/2007</code>.   
-
#You should see a page come up with a message saying '''"There is no page titled "<Your course number>".''' You can create this page." If you don't see this message then that means a page with that name already exists.  You'll need to choose a different course name (and [[Help:Renaming pages|rename your course template]]).
+
#You should see a page come up with a message saying "You searched for <Your course number/Course year>"  where "<Your course number/Course year>" is in red. If you don't see this message then that means a page with that name already exists.  You'll need to choose a different course name (and [[Help:Renaming pages|rename your course template]]).
-
#Click on the create this page link.
+
#Click on the red link "<Your course number/Course year>".
#Paste the code from the OWW.101 course homepage onto this page.
#Paste the code from the OWW.101 course homepage onto this page.
-
#Replace every instance of <code><nowiki>{{Template:OWW.101}}</nowiki></code> with <code><nowiki>{{Template:<Your course number>}}</nowiki></code>.  This line is responsible for including the course banner on the page.
+
#Replace every instance of <code><nowiki>{{Template:OWW.101}}</nowiki></code> with <code><nowiki>{{Template:<Your course number/Course year>}}</nowiki></code>.  This line is responsible for including the course banner on the page.
#Check your work by clicking the [[Image:ShowPreviewButton.jpg]] button.
#Check your work by clicking the [[Image:ShowPreviewButton.jpg]] button.
#Save the changes by clicking [[Image:SavePageButton.jpg]].  
#Save the changes by clicking [[Image:SavePageButton.jpg]].  
Line 82: Line 62:
Every new wiki page that you create for your course should be named <code><Your course number>:Name of the page</code>.
Every new wiki page that you create for your course should be named <code><Your course number>:Name of the page</code>.
-
So much in the same way you created your course homepage, you can copy the OWW.101 sample course's people page ([[OWW.101:People]]) to a new page titled <code><Your course number>:People</code> to list all the folks involved in the course.
+
So much in the same way you created your course homepage, you can copy the OWW.101 sample course's people page ([[OWW.101:People]]) to a new page titled <code><Your course number/Course year>:People</code> to list all the folks involved in the course.
===Set up your course schedule===
===Set up your course schedule===
-
Again, create a page as before titled <code><Your course number>:Schedule</code> and copy the OWW.101 sample schedule page ([[OWW.101:Schedule]]) to this new page.
+
Again, create a page as before titled <code><Your course number/Course year>:Schedule</code> and copy the OWW.101 sample schedule page ([[OWW.101:Schedule]]) to this new page.
Within the page's code, you'll see comments of the form <code><nowiki><!--This is a comment which is only seen when editing the wiki page and not while viewing it.--></nowiki></code>.  These are comments which do not show up on the actual wiki page but only on the edit version.  These comments explain how to edit the schedule table (like adding and deleting rows and columns).
Within the page's code, you'll see comments of the form <code><nowiki><!--This is a comment which is only seen when editing the wiki page and not while viewing it.--></nowiki></code>.  These are comments which do not show up on the actual wiki page but only on the edit version.  These comments explain how to edit the schedule table (like adding and deleting rows and columns).
Line 92: Line 72:
===Make wiki help pages for your students===
===Make wiki help pages for your students===
-
To help familiarize students with OpenWetWare, we've created a set of generic help pages for students.  Feel free to use these for your own course.  You can of course cutomize them for your own course's needs.  See [[OWW.101:Help]] for various generic help pages for students.  Again, be sure and create your own course's help page and copy material from OWW.101.
+
To help familiarize students with OpenWetWare, we've created a set of generic help pages for students.  Feel free to use these for your own course.  You can of course customize them for your own course's needs.  See [[OWW.101:Help]] for various generic help pages for students.  Again, be sure and create your own course's help page and copy material from OWW.101.
==Other common tasks==
==Other common tasks==
Line 103: Line 83:
#Click on upload file link on the left side of the screen (under toolbox).
#Click on upload file link on the left side of the screen (under toolbox).
#Follow the directions from there to upload the file.
#Follow the directions from there to upload the file.
-
#OpenWetWare doesn't explicitly support PDF, powerpoint or keynote filetypes.  Therefore these files are treated as images and an image page is generated upon upload.  To include a link directly to the PDF from your course page, you'll have to click on the filename from the image page and copy the corresponding URL from your browser.   
+
#OpenWetWare doesn't explicitly support PDF, powerpoint or keynote filetypes.  Therefore these files are treated as images and an image page is generated upon upload.  To include a link directly to the PDF from your course page, you'll have to use the <code>Media:</code> prefix in your link.   
For instance, here is a link to the image page of a PDF that has been uploaded to OpenWetWare: [[Image:Msb4100025.pdf]]
For instance, here is a link to the image page of a PDF that has been uploaded to OpenWetWare: [[Image:Msb4100025.pdf]]
Line 114: Line 94:
===How do I upload papers?===
===How do I upload papers?===
-
If you both own the copyright to the paper and are willing to license it under the terms listed at [[OpenWetWare:Copyrights]], then follow the directions listed above under '''How do I upload my lecture slides?'''.
+
If you both own the copyright to the paper and are willing to license it under the terms listed at [[OpenWetWare:Copyrights]], then follow the directions listed above under '''How do I upload my lecture slides?'''.  Also, any paper published in an open access journal (like one of the PLoS journals) can be freely uploaded to OpenWetWare.  Consult the particular journal's copyright policies for details.
-
<font color=red>Remember, all materials posted or uploaded to OpenWetWare are automatically licensed under the terms at [[OpenWetWare:Copyrights]].  Do not post or upload materials to which you do not hold the copyright (like some papers) or don't want to license under these terms.</font>  If you do need to make papers to which you don't own the copyright available to your students, you can do one of the following...
+
<font color=red>Remember, all materials posted or uploaded to OpenWetWare are automatically licensed under the terms at [[OpenWetWare:Copyrights]].  Do not post or upload materials to which you do not hold the copyright (like some papers) or don't want licensed under these terms.</font>  If you do need to make papers to which you don't own the copyright (or don't have a license) available to your students, you can do one of the following...
#Link to the publisher's version (for instance, if your institution has a site license then your students will still be able to access the paper).
#Link to the publisher's version (for instance, if your institution has a site license then your students will still be able to access the paper).
#Link to the author's version.  (Some journals allow authors to post preprints on their own website, so you can link to that version.)
#Link to the author's version.  (Some journals allow authors to post preprints on their own website, so you can link to that version.)
Line 127: Line 107:
===How can I check for the changes to my course wiki?===
===How can I check for the changes to my course wiki?===
-
If you've named all your pages as explained above (i.e. in the form <code><Your course number>:Page name</code> like <code>OWW.101:People</code> and <code>OWW.101:Schedule</code>, then it is quite easy to check the recent changes to your course website.  Just go to [[Special:Recentchanges/OWW.101]] (except replace the <code>OWW.101</code> with your course's number).
+
If you've named all your pages as explained above (i.e. in the form <code><Your course number/Course year>:Page name</code>, then it is quite easy to check the recent changes to your course website.  Just go to [[Special:Recentchanges/OWW.101]] (except replace the <code>OWW.101</code> with your course's number/course year like [[Special:Recentchanges/Harvard:Biophysics 101/2007]]).
===Oh no ... someone made an incorrect edit on one of my course pages.  How do I undo it?===
===Oh no ... someone made an incorrect edit on one of my course pages.  How do I undo it?===

Current revision

< Help

This is a help page for hosting a course on OpenWetWare.

See also the FAQ on hosting a course on OpenWetWare.

Contents

How do I start?

Get an account

You'll need a user account on OWW to edit pages. Register for an account here.

Learn the basics of wiki editing

If you've never used a wiki before, it is helpful to learn some basics of wiki editing via the OpenWetWare introductory tutorial.

In particular, it is helpful if you put at least a couple lines about yourself on your user page.

Once you're comfortable with the basics of wiki's, continue with these directions.

Set up your course template

Once you've registered for an OWW account, start by making your course banner. Your course banner will be used on every course page to help identify it as belonging to your course and to enable students to navigate through the course wiki pages.

  1. First, go to the OWW.101 template page (open this in a new browser window if you want to keep reading this text).
  2. Click Image:EditButton.jpg and copy all the wiki markup on that page.
  3. In the search box on the lefthand side navigation bar, type Template:<Your course number/Course year> (be sure and replace <Your course number/Course year> with your course's number like 20.109/2006 or MCB100/2007.
  4. You should see a page come up with a message saying "You searched for Template:<Your course number/Course year>" where "Template:<Your course number/Course year>" is in red. If you don't see this message then that means a page with that name already exists. You'll need to choose a different course name.

  5. Click on the red link "Template:<Your course number/Course year>".
  6. Paste the code from the OWW.101 template onto this page.
  7. Replace every instance of OWW.101 with your course number.
  8. Finally, check your work by clicking the Image:ShowPreviewButton.jpg button.
  9. Save the changes by clicking Image:SavePageButton.jpg ... and you're off.

Next you'll probably want to replace the default course image with your own.

  1. Click on upload file link on the left side of the screen (under toolbox).
  2. Follow the directions from there to upload the file. In general it is best if your course image is wider than it is tall and if it is in PNG format.
  3. After the picture has been uploaded, you will be taken to the Image page for your course image.
  4. Copy the page title (i.e. Image:<What you named your picture>.png).
  5. Return to your course template. You can do this quickly by typing Template:<Your course number/Course year> in the search box on the left.
  6. Click Image:EditButton.jpg and replace Image:OWW101logo.png with Image:<What you named your picture>.png
  7. Check your work by clicking the Image:ShowPreviewButton.jpg button.
  8. Save the changes by clicking Image:SavePageButton.jpg.

Set up your course homepage

  1. First, go to the OWW.101 course homepage (again, open this in a new browser window if you want to keep reading this text).
  2. Click Image:EditButton.jpg and copy all the wiki markup on that page.
  3. In the search box on the lefthand side navigation bar, type <Your course number> (be sure and replace <Your course number> with your course's number like 20.109/2006 or MCB100/2007.
  4. You should see a page come up with a message saying "You searched for <Your course number/Course year>" where "<Your course number/Course year>" is in red. If you don't see this message then that means a page with that name already exists. You'll need to choose a different course name (and rename your course template).
  5. Click on the red link "<Your course number/Course year>".
  6. Paste the code from the OWW.101 course homepage onto this page.
  7. Replace every instance of {{Template:OWW.101}} with {{Template:<Your course number/Course year>}}. This line is responsible for including the course banner on the page.
  8. Check your work by clicking the Image:ShowPreviewButton.jpg button.
  9. Save the changes by clicking Image:SavePageButton.jpg.

Next you can customize the rest of the content on your course's homepage.

  1. Click Image:EditButton.jpg on your course's homepage.
  2. Between the line that starts <div ...> and the line </div>, feel free to put any information you want ... like a course description, an announcements section or anything else that might be helpful there.

Set up your people page

Every new wiki page that you create for your course should be named <Your course number>:Name of the page.

So much in the same way you created your course homepage, you can copy the OWW.101 sample course's people page (OWW.101:People) to a new page titled <Your course number/Course year>:People to list all the folks involved in the course.

Set up your course schedule

Again, create a page as before titled <Your course number/Course year>:Schedule and copy the OWW.101 sample schedule page (OWW.101:Schedule) to this new page.

Within the page's code, you'll see comments of the form <!--This is a comment which is only seen when editing the wiki page and not while viewing it.-->. These are comments which do not show up on the actual wiki page but only on the edit version. These comments explain how to edit the schedule table (like adding and deleting rows and columns).

Make wiki help pages for your students

To help familiarize students with OpenWetWare, we've created a set of generic help pages for students. Feel free to use these for your own course. You can of course customize them for your own course's needs. See OWW.101:Help for various generic help pages for students. Again, be sure and create your own course's help page and copy material from OWW.101.

Other common tasks

How do I upload my lecture slides?

PDFs, word docs, powerpoint files or keynote files can all be uploaded to OpenWetWare.

  1. Click on upload file link on the left side of the screen (under toolbox).
  2. Follow the directions from there to upload the file.
  3. OpenWetWare doesn't explicitly support PDF, powerpoint or keynote filetypes. Therefore these files are treated as images and an image page is generated upon upload. To include a link directly to the PDF from your course page, you'll have to use the Media: prefix in your link.

For instance, here is a link to the image page of a PDF that has been uploaded to OpenWetWare: Image:Msb4100025.pdf

Here is a link to the corresponding PDF file itself: Media:Msb4100025.pdf

Note that if your files are in latex, you can actually post the latex source itself and autogenerate the corresponding PDF file via the wiki. Thus, you can collaboratively work via the wiki on latex docs! See OpenWetWare:Feature test/LatexDoc for a sample latex document.

How do I upload papers?

If you both own the copyright to the paper and are willing to license it under the terms listed at OpenWetWare:Copyrights, then follow the directions listed above under How do I upload my lecture slides?. Also, any paper published in an open access journal (like one of the PLoS journals) can be freely uploaded to OpenWetWare. Consult the particular journal's copyright policies for details.

Remember, all materials posted or uploaded to OpenWetWare are automatically licensed under the terms at OpenWetWare:Copyrights. Do not post or upload materials to which you do not hold the copyright (like some papers) or don't want licensed under these terms. If you do need to make papers to which you don't own the copyright (or don't have a license) available to your students, you can do one of the following...

  1. Link to the publisher's version (for instance, if your institution has a site license then your students will still be able to access the paper).
  2. Link to the author's version. (Some journals allow authors to post preprints on their own website, so you can link to that version.)
  3. Post them in a password protected directory elsewhere and link to them from OpenWetWare.

How do I include references to published materials?

Referencing published books and papers is easy in OpenWetWare. See OpenWetWare:Biblio for instructions on how to automatically generate formatted citations from just the ISBN for books and the PMID for papers.

How can I check for the changes to my course wiki?

If you've named all your pages as explained above (i.e. in the form <Your course number/Course year>:Page name, then it is quite easy to check the recent changes to your course website. Just go to Special:Recentchanges/OWW.101 (except replace the OWW.101 with your course's number/course year like Special:Recentchanges/Harvard:Biophysics 101/2007).

Oh no ... someone made an incorrect edit on one of my course pages. How do I undo it?

Occasionally, edits to pages in OpenWetWare are made which are incorrect or should not have been done. Fortunately, undoing edits is simple in a wiki. Here are some simple instructions on how to undo edits (also called reverting to a previous version of the page).

  1. Go to the page whose edit you would like to undo.
  2. Click on the Image:Historytab.png tab at the top of the page.
  3. You'll now be viewing the revision history of the page.
  4. Click the circle next to the version of the page that you wish to revert back to.
  5. Click the Image:Compareselectedversionsbutton.png button.
  6. You will see the difference between the current version and the selected older version.
  7. Click the Image:Rollbacklink.png link on the current version column to rollback to the older version.

How do I format a picture?

Wikipedia has various examples for formatting pictures.

How do I edit a table?

Again, Wikipedia has a pretty thorough page on editing tables.

How do my students get OpenWetWare accounts?

Students can go through the same process that you did to get an account. Fill out the form at OpenWetWare:How to join.

Help! My question isn't answered here.

Check out the help pages or else post your question at wiki questions forum.

Personal tools