Help talk:Notebook

From OpenWetWare

(Difference between revisions)
Jump to: navigation, search
(Is it simpler to have users use a substitution template instead of "edit"+"cut and paste?")
Line 26: Line 26:
[[User:Steven J. Koch|Steve Koch]] 23:51, 11 April 2008 (EDT):Jason and Ricardo -- the addition of the link to example notebook along with the screencast are a big help.  I was able to set up my notebook, and while doing so, everything "clicked" and made sense finally.  Thanks!
[[User:Steven J. Koch|Steve Koch]] 23:51, 11 April 2008 (EDT):Jason and Ricardo -- the addition of the link to example notebook along with the screencast are a big help.  I was able to set up my notebook, and while doing so, everything "clicked" and made sense finally.  Thanks!
*'''[[User:Jason R. Kelly|Jason R. Kelly]] 00:44, 12 April 2008 (EDT)''': Cool, thanks for the great comments above.
*'''[[User:Jason R. Kelly|Jason R. Kelly]] 00:44, 12 April 2008 (EDT)''': Cool, thanks for the great comments above.
 +
 +
 +
==Setting up your Lab Notebook (will replace with current version after new screencast ready)==
 +
*  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:Your UserName/Notebook]]</nowiki></code>. This page does not require a template. On your new lab notebook page, add a link to a new page by add 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="15"
 +
|-
 +
| 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="15"
 +
|-
 +
| 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 wikitext that you'll find in our templates, you will 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 wikitext || align="center"| [[image:arrow_right.png]] || align="center"| Create page || align="center"| [[image:arrow_right.png]] || align="center"| Paste wikitext & Save
 +
|}
 +
 +
:{| {{table}} width="400px"
 +
|-
 +
|style="background-color:#e5edc8;" align="center" | [[image:important-orange.png|left]]How to set up your OWW lab notebook<br />'''[[/Screencast|View screencast]]'''
 +
|}</center>

Revision as of 14:26, 14 April 2008

Contents

Possible tweaks to instructions

Steve Koch 00:05, 12 April 2008 (EDT):I am not sure whether this would be good to change the help page, but below are my suggested tweaks that would have helped my understanding (for lack of a better method, I'll color my changes red):

  • 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 [[User:Your UserName/Notebook]]. This page does not require a template. On your new lab notebook page, add a link to a new page by add the wiki code, [[/Test Project]])
    2. The Project page (This is the "Test Project" page you created a link to on your main notebook page. Cut and paste all of the wiki code from one of the following templates ((NOTE: Here is where I think it would be simpler to have them add a substitution template instead)Standard or iGEM template)
    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 all of the wiki code from one of the following templates Standard or iGEM template)

Is it simpler to have users use a substitution template instead of "edit"+"cut and paste?"

E.g., have them add code like this:
     {{subst:Project Base}}
or
             {{subst:Entry Base}}

--Steve Koch 23:59, 11 April 2008 (EDT)

  • Steve Koch 00:17, 12 April 2008 (EDT):I tried this using the Template:Project Base and Template:Entry Base pages I created and it seemed to work. My opinion is that it's easier to explain how to setup things. (Because you can just say, cut and paste the following:
    {{subst:Project Page}}
  • Ricardo Vidal 00:20, 14 April 2008 (EDT): This would make it much easier but there is the matter of keeping things open to editing of the templates and such. If we use "universal" templates, any changes a user makes would change all the notebooks. Also, individual templates per user beats the purpose.

    We are almost about to roll out our "one-click" autocreate notebook that will make this all so much simpler :)
    • Steve Koch 01:09, 14 April 2008 (EDT):Yeah, one-click will be great. Just a detail, though: when you use "subst:" in the template (as above), it loads the entire text of the template upon saving (as opposed to each time page is loaded)--and so the editing the template will not change all the notebooks previously created.
      • Ricardo Vidal 01:12, 14 April 2008 (EDT): Oh, I'm sorry. I didn't notice the "subst:" in there. My bad. That sounds like a great idea. I'll look into that tomorrow and maybe we can get some new easier tutorials ready :). Thanks for the great feedback!

Addition of example and screencast help a lot!

Steve Koch 23:51, 11 April 2008 (EDT):Jason and Ricardo -- the addition of the link to example notebook along with the screencast are a big help. I was able to set up my notebook, and while doing so, everything "clicked" and made sense finally. Thanks!

  • Jason R. Kelly 00:44, 12 April 2008 (EDT): Cool, thanks for the great comments above.


Setting up your Lab Notebook (will replace with current version after new screencast ready)

  • 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 [[User:Your UserName/Notebook]]. This page does not require a template. On your new lab notebook page, add a link to a new page by add the wiki code, [[/Test Project]])
  • 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:
Standard
IGEM
  • 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:
Standard
IGEM
  • By putting these pages in their proper places you will not only keep 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 wikitext that you'll find in our templates, you will have your lab notebook working in no time. It's as simple as 1, 2, 3!
1 2 3
Copy template wikitext image:arrow_right.png Create page image:arrow_right.png Paste wikitext & Save
How to set up your OWW lab notebook
View screencast
Personal tools