Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added page with info on embedding Quadbase content #218

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
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 added app/assets/images/embed_list.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 app/assets/images/embed_question.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: 18 additions & 8 deletions app/views/help/index.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
<li><%= link_to "Legal FAQ", legal_path %></li>
<li><%= link_to "Logging In", "#logging_in" %></li>
<li><%= link_to "Exercise Formatting", "#exercise_formatting" %></li>
<li><%= link_to "Lists", "#lists" %></li>
<li><%= link_to "Roles and Request", "#roles" %></li>
<li><%= link_to "Authoring", "help/authoring"%></li>
</ol>
Expand Down Expand Up @@ -118,24 +119,33 @@ Fill out the registration form, agree to the site license, and click "Sign up".<

<p>For more help with LaTeX consult the <a href="http://en.wikibooks.org/wiki/LaTeX/Mathematics">tutorial</a>.</p>

<div class="sectionHeading" id="loggin_in">Lists</div>
<div class="sectionHeading" id="lists">Lists</div>

<p>Quadbase supports collaborative efforts by allowing you to create lists where many users can work together. A list is like a shared folder where you can store exercises and allow your collaborators to view and edit them.</p>
<p>Quadbase supports collaborative efforts by allowing you to create lists where many users can work together.
A list is like a shared folder where you can store exercises and allow your collaborators to view and edit them.</p>

<p>Creating a new list is simple.</p>
<p>To create a new list:</p>
<ol>
<li>Login to Quadbase and click the lists tab.</li>
<li>Click "New List", and then provide a name for your list.</li>
<li>Click "Create List" button</li>
<li>Login to Quadbase and click the lists tab.</li>
<li>Click "New List", and then provide a name for your list.</li>
<li>Click "Create List" button</li>
</ol>

<p>You can now add any person with a Quadbase account to your workgroup.</p>
</p>To populate a list with questions:</p>
<ol>
<li>Move a question from one of your existing lists to a new list;</li>
<li>Write a new question and save it to your list; or</li>
<li>Edit a new version of an existing question and save it to your list.</li>

</ol>

<p>To add any person with a Quadbase account as a member of your list:</p>

<ol>
<li>Click on the "Lists" tab.</li>
<li>Click on the name of the list you would like to add a user to.</li>
<li>Add a member by searching for the user in the search field at the bottom of the page.</li>
<li>Click "Add"</li>
<li>Click "Add."</li>
</ol>

<div class="sectionHeading" id="roles">Roles and Role Requests</div>
Expand Down
20 changes: 20 additions & 0 deletions app/views/help/topics/_embed_help.html.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<%# Copyright 2011-2012 Rice University. Licensed under the Affero General Public
License version 3 or later. See the COPYRIGHT file for details. %>

<div class="sectionHeading" id="Embed">Embed questions on any web page</div>
<p>Want to embed a workable Quadbase question on your webpage or blog? Simply copy and paste
the associated embed code to your own site.</p>

<div class="sectionHeadingNoUnder">To embed an individual question:</div>

<ol>
<li> <a href="http://www.quadbase.org/questions/new">Write</a> a new question, or
<a href="http://www.quadbase.org/questions">find</a> an existing question;</li>
<li>Open the question and click <b>Embed</b>, located on the lefthand navigatiom menu;</li>
<p><%=image_tag("embed_question.png", {:border => 1, :width => "75%",
:title => "Embed a question"})%></p>
<li>Copy and paste the provided HTML code directly to your own site.</li>
</ol>
<p>When you embed the HTML code, the workable question will also include proper
author attribution. Try it out!</p>
<iframe src="http://quadbase.org/practice?embed=true&ids=q5346v1" width="525px" height="500px" frameborder="0"></iframe>
7 changes: 7 additions & 0 deletions app/views/help/topics/_embed_in_LMS.html.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<%# Copyright 2011-2012 Rice University. Licensed under the Affero General Public
License version 3 or later. See the COPYRIGHT file for details. %>

<div class="sectionHeading" id="LMS">Embed questions in online learning platform</div>
<p>Quadbase integrates seamlessly with our online learning platform. Educators can use this
free, easy-to-use platform to deliver study resources, homework and tests to
students. <a href="http://openstaxtutor.org/about">Learn more</a>.</p>
21 changes: 21 additions & 0 deletions app/views/help/topics/_practice_widget_help.html.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<%# Copyright 2011-2012 Rice University. Licensed under the Affero General Public
License version 3 or later. See the COPYRIGHT file for details. %>

<div class="sectionHeading" id="widget">Embed the Practice Widget on any webpage</div>
<p>Use our Practice Widget to embed multiple Quadbase questions into any web page. To use
the Practice Widget, you must first populate a list with questions. For more information about
creating lists, <a href="http://quadbase.org/help#lists">go here</a>.

<div class="sectionHeadingNoUnder">To embed the Quadbase Practice Widget on your website:</div>

<ol>
<li>Open the <a href="http://quadbase.org/lists">list</a> of questions you want to embed
using the Widget;</li>
<li>Click <b>Embed</b>, located on the lefthand navigation menu;</li>
<p> <%=image_tag("embed_list.png", {:border => 1, :width => "75%",
:title => "Embed a question"})%></center><p/>
<li>Copy and paste the provided HTML code directly to your own site.</li>

<p>The Practice Widget will include all questions from the list. Try it out!</p>

<iframe src="http://quadbase.org/practice?embed=true&ids=L234" width="525px" height="500px" frameborder="0"></iframe>
2 changes: 1 addition & 1 deletion app/views/home/index.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
Easily use questions in tests and homeworks, or embed
in your online learning platform.
<div style="font-size:20px; padding-top: 10px">
<%= link_to ">> See examples!", nil, :onclick => "alert('Coming soon!');" %>
<%= link_to ">> See examples!", use_path %>
</div>
</div>
<div class="infoBox">
Expand Down
34 changes: 34 additions & 0 deletions app/views/questions/use.html.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<%# Copyright 2011-2012 Rice University. Licensed under the Affero General Public
License version 3 or later. See the COPYRIGHT file for details. %>

<%= pageHeading("Use Quadbase questions") %>

<p>All content in the Quadbase repository is licensed under the
<a href="http://creativecommons.org/licenses/by/3.0/us/">Creative Commons Attribution
license (CC-BY)</a>. This license makes it easy to use, share, and reuse questions legally,
as long as the original authors are given credit. For general legal questions about
use of Quadbase content, please <a href="http://quadbase.org/help/legal">go here</a>.
</p>

<p>Quadbase supports several options for embedding questions in your learning resources.
These features make it easy to give students practice problems, while also automatically
crediting the original authors. Choose from the following options:</p>

<%= link_to "Embed questions in an online learning platform", "#LMS" %><br/>
<%= link_to "Embed questions on any web page", "#embed" %><br/>
<%= link_to "Embed the Practice Widget on any web page", "#widget" %><br/>

<div id="simple">


<div id="LMS">
<%= render :partial => 'help/topics/embed_in_LMS' %>
</div>
<div id="embed">
<%= render :partial => 'help/topics/embed_help' %>
</div>
<div id="widget">
<%= render :partial => 'help/topics/practice_widget_help' %>
</div>
<div id="LMS">

1 change: 1 addition & 0 deletions config/routes.rb
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ def votable
get 'help/messages', :to => 'help#message_help', :as => "messages"
get 'help/roles', :to => 'help#roles_help', :as => 'roles'
get 'help/topic/:topic_name', :to => 'help#topic', :as => 'topic_help'
get 'questions/use', :to => 'questions#use', :as => 'use'

resources :lists do
resources :list_members, :only => [:create, :new] do
Expand Down