Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified assets/Figures/chooseCourse.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/Figures/customCourse.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/Figures/login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/Figures/register_choose_course.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/Figures/support_runestone.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 15 additions & 11 deletions pretext/CustomCourses/createCourse.ptx
Original file line number Diff line number Diff line change
@@ -1,49 +1,53 @@
<?xml version="1.0"?>
<section xml:id="custom-courses_how-to-create-a-custom-course">
<title>How to Create a course</title>
<video xml:id="create_course_vid" youtube="t78ktTWrGkc"/>

<p>
<ol marker="1">
<li>
<p>Log in to the runestone server at <url href="https://runestone.academy" visual="https://runestone.academy">https://runestone.academy</url> if you already have an account with Runestone Academy. If you don't have an account then you can create one at <url href="https://runestone.academy/runestone/default/user/register" visual="https://runestone.academy/runestone/default/user/register">https://runestone.academy/runestone/default/user/register</url>. When you register, it will ask to enter the name of an ebook. You can enter the name for any of the existing ebooks.
<p>Log in to Runestone by clicking on the Login button at <url href="https://runestone.academy" visual="https://runestone.academy">https://runestone.academy</url> if you already have an account with Runestone Academy. If you don't have an account then you can create one at <url href="https://runestone.academy/admin/auth/register">https://runestone.academy/admin/auth/register</url>. When you register, it will ask to enter the name of an ebook. You can enter the name for any of the existing ebooks.
<figure align="center" xml:id="login_screen_fig">
<caption xmlns:c="https://www.sphinx-doc.org/" xmlns:changeset="https://www.sphinx-doc.org/" xmlns:citation="https://www.sphinx-doc.org/" xmlns:cpp="https://www.sphinx-doc.org/" xmlns:index="https://www.sphinx-doc.org/" xmlns:js="https://www.sphinx-doc.org/" xmlns:math="https://www.sphinx-doc.org/" xmlns:py="https://www.sphinx-doc.org/" xmlns:rst="https://www.sphinx-doc.org/" xmlns:std="https://www.sphinx-doc.org/">Figure 1: The login screen for Runestone Academy</caption>
<caption>Figure 1: The login screen for Runestone Academy</caption>
<image source="Figures/login.png" width="100%" alt="shows the login screen" />
</figure>
</p>
</li>
<li>
<p>Go to the Build a course Page at <url href="https://runestone.academy/runestone/designer/index" visual="https://runestone.academy/runestone/designer/index">https://runestone.academy/runestone/designer/index</url>. Fill in a unique name for your course. You may want to include a semester and year as part of the unique name. Enter a description and the name of your institution. Scroll down and check the other options and then click <q>Submit</q>.
<p>Go to the Instructor Dashboard from the user menu or the links at the bottom of the Course Home Page and click on the Create a Course link or go directly to the Build a course Page at <url href="https://runestone.academy/admin/instructor/create_course">https://runestone.academy/admin/instructor/create_course</url>. Enter a description and the name of your institution. Choose a base course. A unique course name will be suggested for you. You can
change this name, but make sure that it is unique. You may want to include your institution and a semester and year as part of the unique name. Scroll down and check the other options and then click <q>Submit</q>.
<figure align="center" xml:id="custom_course_fig">
<caption xmlns:c="https://www.sphinx-doc.org/" xmlns:changeset="https://www.sphinx-doc.org/" xmlns:citation="https://www.sphinx-doc.org/" xmlns:cpp="https://www.sphinx-doc.org/" xmlns:index="https://www.sphinx-doc.org/" xmlns:js="https://www.sphinx-doc.org/" xmlns:math="https://www.sphinx-doc.org/" xmlns:py="https://www.sphinx-doc.org/" xmlns:rst="https://www.sphinx-doc.org/" xmlns:std="https://www.sphinx-doc.org/">Figure 2: The Build a course Page</caption>
<caption>Figure 2: The Create a Course Page</caption>
<image source="Figures/customCourse.png" width="100%" alt="Page to create a course" />
</figure>
</p>

<p>Of special note is the checkbox just above the submit button. This says that you would like to support Runestone at the rate of $10 / student from your department or school. This is totally VOLUNTARY! If you check the box you will get an invoice from us about a week after the starting date you entered for your course. If you can't pay or do not wish to pay simply do not check the box. It is fine either way, but we would love your support if you are able.</p>
<figure align="center" xml:id="support_runestone_fig">
<caption xmlns:c="https://www.sphinx-doc.org/" xmlns:changeset="https://www.sphinx-doc.org/" xmlns:citation="https://www.sphinx-doc.org/" xmlns:cpp="https://www.sphinx-doc.org/" xmlns:index="https://www.sphinx-doc.org/" xmlns:js="https://www.sphinx-doc.org/" xmlns:math="https://www.sphinx-doc.org/" xmlns:py="https://www.sphinx-doc.org/" xmlns:rst="https://www.sphinx-doc.org/" xmlns:std="https://www.sphinx-doc.org/">Support Runestone</caption>
<caption>Support Runestone</caption>
<image source="Figures/support_runestone.png" width="100%" alt="Support Runestone" />
</figure>
</li>
<li>
<p>Success!
<figure align="center" xml:id="id5">
<caption xmlns:c="https://www.sphinx-doc.org/" xmlns:changeset="https://www.sphinx-doc.org/" xmlns:citation="https://www.sphinx-doc.org/" xmlns:cpp="https://www.sphinx-doc.org/" xmlns:index="https://www.sphinx-doc.org/" xmlns:js="https://www.sphinx-doc.org/" xmlns:math="https://www.sphinx-doc.org/" xmlns:py="https://www.sphinx-doc.org/" xmlns:rst="https://www.sphinx-doc.org/" xmlns:std="https://www.sphinx-doc.org/">Build Successful</caption>
<caption>Build Successful</caption>
<image source="Figures/build_done.png" width="100%" alt="Support Runestone" />
</figure>
</p>
<p>The successful build page reminds you of some resources that you can use to get help. Please do not use email. Please check for and file problems on Github. Many problems are duplicates and have already have workarounds or explanations.</p>
<p>The successful build page reminds you of some resources that you can use to get help. Please do not use email. Please check for and file problems on Github or with the new <url href="https://runestone.academy/admin/problem/report">Problem Reporting page</url> from the user icon menu. Many problems are duplicates and have already have workarounds or explanations.</p>
</li>
<li>
<p>Your students can register for your course by using the unique name that you used when you created your course when they register at <url href="https://runestone.academy/runestone/default/user/register" visual="https://runestone.academy/runestone/default/user/register">https://runestone.academy/runestone/default/user/register</url>.. If they already have a login on Runestone Academy, they can simply add another course using the new course name by going to <url href="https://runestone.academy/runestone/default/user/register" visual="https://runestone.academy/runestone/default/user/register">https://runestone.academy/runestone/default/courses</url>. and then clicking on <q>Add Another Course</q>.
<p>Your students can register for your course by using the unique name that you used when you created your course when they register at <url href="https://runestone.academy/admin/auth/register">https://runestone.academy/admin/auth/register</url>. If they already have an account on Runestone Academy, they can simply add another course using the new course name by selecting Change Course from the user icon menu or by going to <url href="https://runestone.academy/admin/auth/my_courses">My Courses page</url> and then clicking on <q>Enroll in Another Course</q>.
<figure align="center" xml:id="id6">
<caption xmlns:c="https://www.sphinx-doc.org/" xmlns:changeset="https://www.sphinx-doc.org/" xmlns:citation="https://www.sphinx-doc.org/" xmlns:cpp="https://www.sphinx-doc.org/" xmlns:index="https://www.sphinx-doc.org/" xmlns:js="https://www.sphinx-doc.org/" xmlns:math="https://www.sphinx-doc.org/" xmlns:py="https://www.sphinx-doc.org/" xmlns:rst="https://www.sphinx-doc.org/" xmlns:std="https://www.sphinx-doc.org/">Figure 4: The page that allows the user to add another course or switch courses</caption>
<image source="Figures/courseSel.png" width="100%" alt="The screen that allows a user to add another course or switch courses" />
<caption>My Courses Page to Change Course</caption>
<image source="Figures/chooseCourse.png" width="100%" alt="The page that allows a user to add another course or switch courses" />
</figure>
</p>
</li>
</ol>
</p>
<p>We will also cover how you can pre-register your students with a CSV file in another section.</p>

<p>This video demonstrates the process of creating a new course in the older interface:</p>
<video xml:id="create_course_vid" youtube="t78ktTWrGkc"/>
</section>
17 changes: 10 additions & 7 deletions pretext/Registration/inviteStudents.ptx
Original file line number Diff line number Diff line change
@@ -1,22 +1,26 @@
<?xml version="1.0"?>
<section xml:id="registration_adding-students-to-your-course">
<title>Managing Students in your Course</title>
<video xml:id="register_vid" youtube="RJ-bYYjKbTU" width="100%" />

<subsection>
<title>Student Self Registration</title>
<p>When you created the course, you chose a unique course name. Give your course name to students.
They will register on the site and enter that string as their course name. If you've forgotten
what your course name is, you can see it displayed on the Course selection page <url
href="https://runestone.academy/runestone/default/courses"
visual="https://runestone.academy/runestone/default/courses">
https://runestone.academy/runestone/default/courses</url>. You can access that page by
href="https://runestone.academy/admin/auth/my_courses"
visual="https://runestone.academy/admin/auth/my_courses">
https://runestone.academy/admin/auth/my_courses</url>. You can access that page by
clicking on the person icon at the top right of the window and then selecting <em>Change
Course</em>.</p>
<note>
<p>Students will register for a course following the same procedures that were described <xref
ref="registration_register-for-this-course" />. You just need to provide them with the
text string for the course name. </p>
</note>

<p>This video demonstrates registering students in the old interface:</p>
<video xml:id="register_vid" youtube="RJ-bYYjKbTU" width="100%" />

</subsection>
<subsection>
<title>Pre-register your students</title>
Expand All @@ -28,8 +32,7 @@
</figure>
<p> You will see a page like this:</p>
<figure align="center" xml:id="reg_your_students_fig">
<caption>Register
your Students</caption>
<caption>Register your Students</caption>
<image source="Figures/manage_students.png" width="100%" alt="Support Runestone" />
</figure>
<p>You can create a csv file in your favorite spreadsheet program and then export it to a csv or
Expand Down Expand Up @@ -85,7 +88,7 @@ user1,user@school.com,Jane,Smith,xxxx,foocourse</pre>
are legitimate. Yes many high schoolers think it is funny to try to trick me into resetting
the password on one of their friends.</p>

<p>Instructors cannot change their own passwords through this mechanism. who among us hasn't
<p>Instructors cannot change their own passwords through this mechanism. Who among us hasn't
walked away from the computer and left ourselves logged into Runestone? As an instructor, you
will still have to use the normal email password reset mechanism. If your school blocks emails
then I suggest you just get a free gmail address to use for this purpose.</p>
Expand Down
45 changes: 21 additions & 24 deletions pretext/Registration/registerYourself.ptx
Original file line number Diff line number Diff line change
Expand Up @@ -6,47 +6,44 @@
<p>There are two kinds of courses on Runestone Academy:
<ul>
<li>Courses that are open to anyone to view without logging in or for anyone to enroll in if they choose to create an account. We call these books <term>base courses.</term> These courses are very large and have no instructor to guide the students, eveyone just proceeds at their own pace.</li>
<li>Smaller courses at a a high school, college, or university, that are guided by an instructor like yourself also use these books. We often refer to these as <term>custom courses</term>
<li>Smaller courses at a a high school, college, or university, that are guided by an instructor like yourself also use these books. We often refer to these as <term>custom courses</term>.
</li>
</ul>
You can think of the base courses as a template for custom courses, something like classes and instances in object oriented programming.
</p>
<p>Although the base course books are open to the public, to save your work, you will need to register for an account on Runestone Academy. When you first regigister you will have the privileges of a <term>student.</term> You do not become an <term>instructor</term> until your create your own course. Lets walk through the registration process now.</p>
<p>Although the base course books are open to the public, to save your work, you will need to register for an account on Runestone Academy. When you first register you will have the privileges of a <term>student.</term> You do not become an <term>instructor</term> until your create your own course. Lets walk through the registration process now.</p>
</section>
<section xml:id="registration_first-time-registration">
<title>First-time Registration</title>
<p>
When you register you must select a course. The right side of the page contains a list of names of the base courses (registration codes) for the most common courses. If you do not see the one you want on this list you can look in the library. We are working on a way to harmonize the various places to discover books and their names.</p>

<figure align="center" xml:id="reg_yourself">
<caption>Register yourself</caption>
<image source="Figures/new_register.png" width="100%" alt="Registration Page" />
<p>If you are a new Runestone user, you will need to register for a free account. Click on the Login button at
<url href="https://runestone.academy">https://runestone.academy</url> and then click on the
Register link at the bottom of the login form or go directly to the registration page at
<url href="https://runestone.academy/admin/auth/register">https://runestone.academy/admin/auth/register</url>. Make sure you fill in the Institution Name because this will be used to suggest courses for you to join at your institution. Click the Create Account button to go to the second page to choose your first course. </p>

<p>If you check "I am an instructor and want to create a course for my students" at the bottom of the registration form,
you will be taken to the create a new course page. </p>

<p>On the second page, you will see suggested courses from your institution. Or you can type in the name of a course you want to join. Or choose one from the list of base courses which are also listed on the <url href="https://runestone.academy/ns/books/index">library page</url>. After joining your first course, you will be able to add more courses.</p>

<figure align="center" xml:id="reg_yourself">
<caption>Register and Choose Course</caption>
<image source="Figures/register_choose_course.png" width="100%" alt="Registration Choose Course Page" />
</figure>

<p>
<ol marker="1">
<li>
<p>Open the following url in another tab: <url href="https://runestone.academy/runestone/default/user/register" visual="https://runestone.academy/runestone/default/user/register">https://runestone.academy/runestone/default/user/register</url>. The form is pretty self-explanatory, except for the <em>Course Name</em> field. There is information about that on the right side. You can specify one of the strings that identify one of the public courses that the server knows about: thinkcspy, pythonds, etc. Or you can enter the string for a course that someone else has created and provided you with.</p>
</li>
<li>
<p>Click <em>Register</em></p>
</li>
<li>
<p>If you are on the login page instead at <url href="https://runestone.academy/runestone/default/user/login" visual="https://runestone.academy/runestone/default/user/login">https://runestone.academy/runestone/default/user/login</url> then click the <em>Register</em> button which is near the bottom of the page to get to the registration page.</p>
</li>
</ol>
</p>
</section>

<section xml:id="registration_add-an-additional-course">
<title>Add an Additional Course</title>
<p>When you are logged in and looking at an eBook, click on the person icon in the upper right and select <em>Change Course</em>.
That will take you to the course selection page.</p>
That will take you to the <url href="https://runestone.academy/admin/auth/my_courses">My Courses page</url> where you can switch to another course or enroll in a new course using the "Enroll in Another Course" button at the bottom of the page. The courses that you have recently used are at the top and marked by a clock icon. </p>

<figure align="center" xml:id="choose_course_page">
<caption>Change Courses</caption>
<image source="Figures/chooseCourse.JPG" description="choose a course" />
<image source="Figures/chooseCourse.png" description="choose a course" />
</figure>
<p>Click on the <em>Enroll in a Course</em> button, which takes you to a page that looks a lot like the registration page. Don't change any of the fields except <em>Course Name</em>. There, you can enter any string that identifies another course.</p>
<p>As an instructor you may find that the list of courses can get quite long. You can use the <q>Remove Course</q> button to unenroll yourself from that course. Please note it does NOT delete the course it only takes you out of it. You can always re-enroll at a later time.</p>
<p>Click on the <em>Enroll in a Course</em> button, which takes you to a page that looks a lot like the registration choose a course page. You can enter a course name or choose another base course. </p>

<p>As an instructor you may find that the list of courses can get quite long. You can use the <q>Drop</q> button next to any course to unenroll yourself from that course, but make sure that you are first in an another active course. Please note it does NOT delete the course it only takes you out of it. You can always re-enroll at a later time. You cannot drop the course that you are currently active in without first switching to another active course.</p>
</section>
</chapter>
Loading