Help:Notebook

From OpenWetWare

(Difference between revisions)
Jump to: navigation, search
(Setting up your Lab Notebook (Manual setup))
Current revision (15:49, 4 November 2011) (view source)
(Entry Base template page)
 
(6 intermediate revisions not shown.)
Line 23: Line 23:
|}
|}
For any help with the form or setting up the required pages, feel free to [[Contact_Us|contact us]]</center>
For any help with the form or setting up the required pages, feel free to [[Contact_Us|contact us]]</center>
-
 
-
==Setting up your Lab Notebook (Manual setup)==
 
-
*  To set up your lab notebook you'll first need to create a few pages, cut and paste some starting wiki code and put them in the right places. As soon as they are set up, you'll be a click away from creating new lab notebook entries.
 
-
 
-
* The required pages are:
 
-
'''1. The Notebook page''' You should create the page as <code><nowiki>[[User:Melissa S. Dulcich/Notebook]]</nowiki></code>. This page does not require a template. On your new lab notebook page, add a link to a new page by adding the wiki code, <code><nowiki>[[/Test Project]]</nowiki></code>
 
-
 
-
'''2. The Project page''' This is the "Test Project" page you created a link to on your main notebook page. Cut and paste the short wiki code from one of the following boxes:
 
-
:{| width="500" cellspacing="10"
 
-
| Standard<br><html><form class="formbody"><textarea class="form_format" rows="2" cols="10" onClick="this.select();">{{subst:Project_Base}}</textarea></form></html> || IGEM<br><html><form class="formbody"><textarea class="form_format" rows="2" cols="10" onClick="this.select();">{{subst:IGEM_Project_Base}}</textarea></form></html>
 
-
|}
 
-
 
-
'''3. The Entry Base page''' Click on the "customize your entry pages" link to create the "entry base page". On this new page, cut and paste the short wiki code from one of the following boxes:
 
-
:{| width="500" cellspacing="10"
 
-
| Standard<br><html><form class="formbody"><textarea class="form_format" rows="2" cols="10" onClick="this.select();">{{subst:Entry_Base}}</textarea></form></html> || IGEM<br><html><form class="formbody"><textarea class="form_format" rows="2" cols="10" onClick="this.select();">{{subst:IGEM_Entry_Base}}</textarea></form></html>
 
-
|}
 
-
 
-
 
-
*By putting these pages in their proper places you will not only keep [[OpenWetWare:Tidy|OWW tidy]], but you'll also be able to take full advantage of the features we've built into the lab notebook.
 
-
 
-
* By simply copying and pasting the wiki code from the boxes, you'll have your lab notebook working in no time. It's as simple as 1, 2, 3!
 
-
<center>
 
-
:{| style="border: 0px;"
 
-
| align="center" style="background-color:#EEEEEE;"| 1 || align="center"|  || align="center" style="background-color:#EEEEEE;"| 2 || align="center"|  || align="center" style="background-color:#EEEEEE;"| 3
 
-
|-
 
-
| align="center"| Copy template wiki code || align="center"| [[image:arrow_right.png]] || align="center"| Create page || align="center"| [[image:arrow_right.png]] || align="center"| Paste wiki code & Save
 
-
|}
 
-
</center>
 
==Using your lab notebook==
==Using your lab notebook==
 +
===Notebook page===
* Once your notebook is set up, you can start making entries on a daily basis. By simply clicking on the calendar date you want to make an entry for, a page will automatically be created using your Entry_Base template and you can add your data by simply editing the page.
* Once your notebook is set up, you can start making entries on a daily basis. By simply clicking on the calendar date you want to make an entry for, a page will automatically be created using your Entry_Base template and you can add your data by simply editing the page.
 +
[[image:notebook-help.jpg|400px|thumb|center]]
 +
 +
===Entry page===
* If you are viewing an entry page, you can navigate to other entry pages (for example, using the links to the previous and next day's entries if they exist). These navigation links let you browse your notebook without having to jump back to the project page.
* If you are viewing an entry page, you can navigate to other entry pages (for example, using the links to the previous and next day's entries if they exist). These navigation links let you browse your notebook without having to jump back to the project page.
 +
[[image:entry-help.jpg|400px|thumb|center]]
==Naming recommendations==
==Naming recommendations==
Line 99: Line 76:
* The Entry Base template page is what your entry pages will look like when they are created. By making changes to the Entry Base template page, all subsequent entry pages you create will reflect these changes.
* The Entry Base template page is what your entry pages will look like when they are created. By making changes to the Entry Base template page, all subsequent entry pages you create will reflect these changes.
-
:[[image:norm-entpage-screen.png|left|thumb|300px|Go to and copy the [[Help:Notebook/Project_Base|Standard lab notebook entry template]]]]
+
:[[image:norm-entpage-screen.png|left|thumb|300px|Go to and copy the [[Help:Notebook/Project_Base/Entry_Base|Standard lab notebook entry template]]]]
-
[[image:igem-entpage-screen.png|none|thumb|300px|Go to and copy the [[IGEM:HelpU/2008/Notebook/Project_name1|iGEM lab notebook entry template]]]]
+
[[image:igem-entpage-screen.png|none|thumb|300px|Go to and copy the [[IGEM:HelpU/2008/Notebook/Project_name1/Entry_Base|iGEM lab notebook entry template]]]]
__NOTOC__
__NOTOC__

Current revision

Image:Owwnotebook icon.pngTo see an example of the new OpenWetWare Lab Notebook in action, take a look here.


Lab Notebook Tutorial

By the end of this tutorial, you should have an online lab notebook up and running. If you have feedback regarding any step in this tutorial or any of the lab notebook features (or just need help setting it up!), feel free to contact us.

Setting up your Lab Notebook (One-click setup)

  • The easiest way to setup your lab notebook is by using the One-click setup tool. You simply fill in the fields of the form and click. If everything is filled in correctly, you should have your lab notebook up and running instantaneously.
  • However, there are some requirements that need to be met before you can create notebooks anywhere:
    • You must obviously be a registered and logged in user of OWW.
    • The notebook will only be created for IGEM teams if the IGEM team page already exists for the current year.
    • The notebook will only be created for your Lab if the Lab page already exists.
Go One-click Lab Notebook Setup
Screencasts View the screencasts
For any help with the form or setting up the required pages, feel free to contact us

Using your lab notebook

Notebook page

  • Once your notebook is set up, you can start making entries on a daily basis. By simply clicking on the calendar date you want to make an entry for, a page will automatically be created using your Entry_Base template and you can add your data by simply editing the page.

Entry page

  • If you are viewing an entry page, you can navigate to other entry pages (for example, using the links to the previous and next day's entries if they exist). These navigation links let you browse your notebook without having to jump back to the project page.

Naming recommendations

  • If you plan to work on more than one project, we recommend that you set up a separate project page for each project and compile them in your notebook page. You can do this quite easily by keeping your online lab notebook organized as shown below:

For Users

  • http://openwetware.org/wiki/User:John_Q._Smith/Notebook/Project_name_1
    • http://openwetware.org/wiki/User:John_Q._Smith/Notebook/Project_name_1/Entry_Base
  • http://openwetware.org/wiki/User:John_Q._Smith/Notebook/Project_name_2
    • http://openwetware.org/wiki/User:John_Q._Smith/Notebook/Project_name_2/Entry_Base

For Labs

  • http://openwetware.org/wiki/LabName:Notebook/Project_name_1
    • http://openwetware.org/wiki/LabName:Notebook/Project_name_1/Entry_Base
  • http://openwetware.org/wiki/LabName:Notebook/Project_name_2
    • http://openwetware.org/wiki/LabName:Notebook/Project_name_2/Entry_Base

For iGEM Teams

(Visit the Help University example for more information regarding iGEM lab notebooks)

  • http://openwetware.org/wiki/IGEM:UnivName/2008/Notebook/Project_name_1
    • http://openwetware.org/wiki/IGEM:UnivName/2008/Notebook/Project_name_1/Entry_Base
  • http://openwetware.org/wiki/IGEM:UnivName/2008/Notebook/Project_name_2
    • http://openwetware.org/wiki/IGEM:UnivName/2008/Notebook/Project_name_2/Entry_Base


Notebook page

  • This page is where you should list all your projects. Even if you have only one!
    • Create the Notebook page in the proper hierarchy as displayed in the naming recommendation section above.
NOTE: This page may not seem to have much of a purpose at the moment but we are actively working on new features for the lab notebooks that will take advantage of a central notebook page for your project(s). Stay tuned! :)

Project page

  • The notebook page is where you will find some of the tools/features that allow you to maneuver around your lab notebook. The two most important tools at the moment are:
    • the dynamic calendar
    • the local search box
Go to and copy the Standard project template
Go to and copy the Standard project template
Go to and copy the iGEM project template
Go to and copy the iGEM project template

Entry Base template page

  • The Entry Base template page is what your entry pages will look like when they are created. By making changes to the Entry Base template page, all subsequent entry pages you create will reflect these changes.


Personal tools