Repository/Site Upload Instructions

advertisement
Repository/Site Upload Instructions
By Elizabeth Liang
ewl6@duke.edu
Duke University, May 2009
Alice Project under Prof. Susan Rodger
Follow these steps to upload a finished tutorial onto the alice09 repository webpage
(http://www.cs.duke.edu/csed/alice09/). To transfer from the alice09 repository to the teacher
website (http://www.cs.duke.edu/csed/alice/aliceInSchools/workshop09/tutorials.php) skip
directly to step 7
Step 1: Create a Folder
1. Create a folder: Name it “nameOfTutorial” (shorten the name as needed, try to
keep “tutorial” at the end though)
2. Create Documents: Each tutorial folder (* if applicable) should have
nameOfTutorial.ppt (powerpoint document)
nameOfTutorial.pdf (one slide per page)
nameOfTutorialHandout.pdf (handout, 4 slides to a page)
*nameOfTutorialStart.a2w (starting alice world)
*nameOfTutorialFinished.a2w (finished alice world)
*exercises.html (webpage to put exercises)
nameOfTutorialScreen.jpg (screenshot associated with tutorial)
tutorial.php (code for the repository)
publicTutorial.php (code for the teacher website)
Step 2: Tutorial PHP Code
1. For tutorial.php create a new document in a html/text editor
2. Insert the following code, replacing/deleting information as needed: (parent
folder means either gettingStartedTutorials or advancedTutorials depending on
the tutorial)
<p class="tutorial">
<img src="tutorials/parentFolder/nameOfTutorial/nameOfTutorialScreen.jpg" alt="">
<b>Name:</b> NameOfTutorial<br>
<b>Level:</b> Beginner/Intermediate/Expert<br>
<b>Time:</b> Approx. time it takes to do the tutorial<br><br>
<b>Description:</b> Description of tutorial and the concepts it covers (2-3 sentences).<br><br>
<b>Worlds:</b>
<a href=“tutorials/parentFolder/nameOfTutorial/nameOfTutorialStart.a2w”>Start</a>,
<a href=“tutorials/parentFolder/nameOfTutorial/nameOfTutorialFinished.a2w”>Finished</a><br>
<b>Links:</b>
<a href="tutorials/parentFolder/nameOfTutorial/nameOfTutorial.ppt">Powerpoint</a>,
<a href="tutorials/parentFolder/nameOfTutorial/nameOfTutorial.pdf">Slides (.pdf)</a>,
<a href="tutorials/parentFolder/nameOfTutorial/nameOfTutorialHandout.pdf">Handout</a>,
<a href="tutorials/parentFolder/nameOfTutorial/exercises.html" target="_blank">Exercises</a>
</p>
Step 3: Public PHP Code
1. For publicTutorial.php create a new document in a html/text editor
2. Insert the following code, replacing/deleting information as needed: (parent
folder means either gettingStartedTutorials or advancedTutorials depending on
the tutorial)
<p class="tutorial">
<img src=”workshop09/tutorials/parentFolder/nameOfTutorial/nameOfTutorialScreen.jpg" alt="">
<b>Name:</b> NameOfTutorial<br>
<b>Level:</b> Beginner/Intermediate/Expert<br>
<b>Time:</b> Approx. time it takes to do the tutorial<br><br>
<b>Description:</b> Description of tutorial and the concepts it covers (2-3 sentences).<br><br>
<b>Worlds:</b>
<a href=“workshop09/tutorials/parentFolder/nameOfTutorial/nameOfTutorialStart.a2w”>Start</a>,
<a href=“workshop09/tutorials/parentFolder/nameOfTutorial/nameOfTutorialFinished.a2w”>Finished</a><br>
<b>Links:</b>
<a href=”workshop09/tutorials/parentFolder/nameOfTutorial/nameOfTutorial.ppt">Powerpoint</a>,
<a href=”workshop09/tutorials/parentFolder/nameOfTutorial/nameOfTutorial.pdf">Slides (.pdf)</a>,
<a href=”workshop09/tutorials/parentFolder/nameOfTutorial/nameOfTutorialHandout.pdf">Handout</a>,
<a href=”workshop09/tutorials/parentFolder/nameOfTutorial/exercises.html" target="_blank">Exercises</a>
</p>
Step 4: Exercises Code
1. For exercises.html create a new document in a html/text editor
2. Insert the following code, replacing information as needed:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8”>
<title>NameOfTutorial Exercises</title>
</head>
<body>
<h2>NameOfTutorial Exercises</h2>
<p>
Text for the exercises go here, just a few suggestions that can be used as follow up/homework.
</p>
<p>
<a href="http://cs.duke.edu/~rodger">Susan Rodger</a> // Duke University Department of Computer Science //
Summer 2009
</p>
</body>
</html>
Step 5: Uploading
1. Connect to the CS server. (If you do not have a FTP/SSH program download one from
http://www.oit.duke.edu/comp-print/software/list.html, go down to “Security,
SSH/SFTP and firewalls.” I use fileZilla but any of those should work.) The server name
is login.cs.duke.edu, use your cs username and password, the port is 22.
2. Once you have successfully connected it will automatically go to your cs space. Go to
the root folder by clicking the folder with just a “/” after it.
3. Enter in the address “/usr/project/csed/web/alice09/tutorials/parentFolder”
4. Drag the nameOfTutorial folder from your computer into that space.
5. Open the tutorial.php document in the parentFolder and download it onto your
computer (drag it somewhere where you can find it).
6. Open it in a html/text editor and where you want to add the tutorial (for example at
the end or after a certain tutorial that is already there) on the page insert the
following code, replacing information as needed. Reupload when done.
<?php
include (”nameOfTutorial/tutorial.php");
?>
Step 6: Testing and Troubleshooting
1. Open a web browser and go to the repository page
(http://www.cs.duke.edu/csed/alice09/). Your tutorial should now be on the
page, if a warning shows go back and double check your php code, making sure
the syntax and spelling is correct.
2. If the picture and text do not line up correctly (the picture after it seems
indented into the page) go back to the php code and add <br><br> tags right
before the </p> tag. You will need to change both tutorial.php and
publicTutorial.php. Upload the modified documents into the appropriate folder.
You do not need to modify tutorial.php in the parent folder again.
3. If something still doesn’t work, let Liz know and we’ll try to figure it out.
4. If everything looks ok, then congratulations you’re done with another tutorial!
Cross it off the whiteboard and update your blog. 
5. If you also need to upload it onto the teacher website (check with Professor
Rodger first) then continue onto step 7.
Step 7: Directory Transfer
1. Transfer the nameOfTutorial folder from
“/usr/project/csed/web/alice09/tutorials/parentFolder” into
“/usr/project/csed/web/alice/aliceInSchools/workshop09/tutorials/parentFolder
”
2. Update (download, change, reupload) parentFolder’s publicTutorial.php with the
following code placed where you want the tutorial to display (for example at the
end or after a certain tutorial), replacing information as necessary:
<?php
include (”nameOfTutorial/publicTutorial.php");
?>
1. Open a web browser and go to
http://www.cs.duke.edu/csed/alice/aliceInSchools/workshop09/tutorials.php to
check that the tutorial displays properly, if it doesn’t check the spelling and
syntax in the php code that you inserted earlier.
Download