Skip to content

Commit 6bec8fb

Browse files
committed
Additional revisions
1 parent 165855b commit 6bec8fb

11 files changed

+34
-15
lines changed

_authors/collaborating.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ highlighter: no
77
---
88
# Sharing Widgets with Others
99

10-
Sharing widgets will allow you to collaborate with others to build your widget, distribute to students, and collect score results.
10+
Use the collaboration feature to grant authorship access to other Materia users at your institution. Depending on the access level you set, collaborators become co-owners of the widget, or can simply distribute the widget and collect scores without having the ability to make changes to it.
1111

1212
## The Collaboration Dialog
1313

@@ -23,7 +23,7 @@ To share a widget, select it on the *My Widgets* page and click *Collaborate*.
2323

2424
To find a user, type their name or email address into the *Add people* input box at the top of the Collaboration dialog. Materia will search for that user as you type, providing matched results from which you can select.
2525

26-
> Note that you can only share with users that are current instructors in Materia.
26+
> Note that you can only share your widget with users who are current instructors in Materia. The other users will have had to log in to Materia at least once. Additionally, while students may be able to author widgets themselves, you cannot share a widget with a student unless it is in **guest mode**.
2727
2828
{% include figure.html
2929
no_thumb="true"
@@ -45,4 +45,8 @@ Allows the user to distribute the widget among students and receive scores. Howe
4545

4646
You may set an expiration for each person's permissions. After this date, the collaboration will be revoked and the user will no longer have access to the widget.
4747

48-
> Keep in mind that users with the *Full* permission level may edit their own expiration date.
48+
> Note that users with the **Full** permission may grant access to additional collaborators, but cannot modify their own access expiration date, if set.
49+
50+
### Copying Widgets
51+
52+
A collaborator can always make a derivative copy of a widget they have access to, regardless of access level. The copy dialog allows you to choose whether to share access to the derivative with the original owner.

_authors/getting-started.md

+27-12
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,13 @@ class: instructors
66
category: first
77
highlighter: no
88
---
9+
10+
# What is a Widget?
11+
12+
A Materia _Widget_ is a catch-all term to describe the customizable games, study tools, and interactive content within the Materia catalog. However, the widget itself does not provide content specific to any topic or course - that's where you come in! Using the widget's creator interface, you create custom _instances_ of a particular widget. For example, a user can select the Crossword _widget_ and customize it to create an _instance_ of Crossword that's filled out with content they authored.
13+
914
# Customizing a New Widget
10-
The first step in using Materia in your course is to create a new widget with your own custom content. Each widget has a creation interface which allows you to easily customize it to your needs. Once created, the widget can be distributed and shared with students and other instructors.
15+
The first step in using Materia in your course is to create a new widget _instance_ with your own custom content. Each widget has a creation interface which allows you to easily customize it to your needs. Once created, the widget instance can be distributed and shared with students and other instructors.
1116

1217
## Selecting a Widget to Create
1318
Begin by logging in to Materia using the appropriate credentials, and selecting the *Widget Catalog* link at the top of the page.
@@ -18,14 +23,14 @@ Begin by logging in to Materia using the appropriate credentials, and selecting
1823
alt="Select the <strong>Widget Catalog</strong> link to view the widgets available for use."
1924
%}
2025

21-
The catalog page provides a list of available widgets, with filtration options on the left. Mousing over a widget provides an overview of their features and supported data.
26+
The catalog page provides a list of available widgets, with filtration options at the top. Mousing over a widget provides an overview of their features and supported data.
2227

2328
{% include figure.html
2429
url="widget_catalog.png"
2530
alt="Select a widget to create from the Materia widget catalog."
2631
%}
2732

28-
Selecting a widget brings you to the widget detail screen with screen shots of the widget in action, and links to play a demo or to build your own.
33+
Selecting a widget brings you to the widget detail screen with a short description, a playable demo, screenshots, and a link to create your own.
2934

3035
{% include figure.html
3136
url="widget_detail.png"
@@ -34,24 +39,23 @@ Selecting a widget brings you to the widget detail screen with screen shots of t
3439

3540
## Widget Creator Basics
3641

37-
Each widget has a unique creator designed specifically to help you customize the content needed for that type of widget. While the details will change from widget to widget, all creators have several universal features in common. For details on creators for specific widgets, you may find them under the *Creating Widgets* menu at the top of this page.
42+
Each widget has a unique creator designed specifically to help you customize the content needed for that type of widget. While the details will change from widget to widget, all creators have several universal features in common. Use the Creator's Guide link on the widget's detail page to learn more about the creator interface for a specific widget.
3843

3944
## The Creator Page
40-
Below is an example of the *Hangman* widget creator.
45+
Below is an example of the *Crossword* widget creator.
4146

4247
{% include figure.html
43-
no_thumb="true"
48+
no_thumb="false"
4449
url="creator_example.png"
45-
alt="Screenshot showing the hangman creator."
50+
alt="Screenshot showing the Crossword creator."
4651
%}
4752

48-
0. Question importing, Publish, Preview, and Save Draft features. *Note: these buttons are standard across all creators.*
49-
0. Adding questions and content. *This will be different for each individual creator.*
50-
0. Widget title. *This is standard across all creators.*
51-
0. Widget options. *These will be different for each individual creator.*
53+
0. Built-In Creator Controls. *Note: these buttons are standard across all creators.*
54+
0. Widget Title. *This is standard across all creators, with modest variations.*
55+
0. Widget Creator Interface. *This will be different for each individual creator.*
5256

5357
## Developing Questions for your Widget
54-
In most cases, content for widgets is comprised of a *question* or *hint*, and an *answer* or *series of answers* for a given question. In this example, our Hangman widget has a question that is initially posed to the student and an answer that is considered the correct response. Some widgets, such as *Enigma* or *Choose your Own Adventure*, can have multiple responses to each question.
58+
In most cases, content for widgets is comprised of a *question* or *hint*, and an *answer* or *series of answers* for a given question. In this example, our Crossword widget has a *clue* that acts as a question, a *puzzle word* that acts as answer text, and an optional *hint* associated with each puzzle word. Some widgets, such as *Enigma* or *Choose your Own Adventure*, can have multiple responses to each question. The specific nature of each question in your widget instance is largely unique to each widget in the Materia catalog.
5559

5660
Note that each creator typically has a text box in which to enter a new question, as well as a text box (or boxes) in which to enter an answer or multiple answers. Each creator also has options to add new questions or to remove existing ones. Some widgets allow media such as images or audio to be used to supplement or replace questions.
5761

@@ -80,6 +84,17 @@ All creators share the same options once your widget is ready to go.
8084
alt="The Publish, Preview, and Save Draft buttons help you build and edit your widgets."
8185
%}
8286

87+
## Save History
88+
Are you making revisions to a widget you created previously and regret your changes, or want to revisit what the widget looked like after an earlier save? Use Save History to browse previous versions of your widget, and if desired, restore your work to the earlier save.
89+
90+
{% include figure.html
91+
no_thumb="false"
92+
url="creator_save_history.png"
93+
alt="Save history UI."
94+
%}
95+
96+
Select one of the saves listed to load it into the creator for review. Note that in this preview state, your old work is *not affected*. If you wish to commit to using the old version, select **Keep** on the header bar. Otherwise, selecting **Cancel** will revert the creator to the version you were working on.
97+
8398
## Guest Widget Instances
8499

85100
Guest widgets serve 2 main functions:
75.1 KB
Loading

assets/img/collab_window.png

-11 KB
Loading
22.9 KB
Loading

assets/img/creator_example.png

27.6 KB
Loading
-33.1 KB
Binary file not shown.
9.14 KB
Loading

assets/img/creator_save_history.png

19.9 KB
Loading
-67.9 KB
Loading

assets/img/widget_catalog.png

117 KB
Loading

0 commit comments

Comments
 (0)