Skip to content

Commit

Permalink
Merge pull request #17 from smvgarcia/cedar-get-started
Browse files Browse the repository at this point in the history
change sizes of figs
  • Loading branch information
smvgarcia authored Oct 13, 2023
2 parents 528d3df + 73f1a51 commit 871a3ff
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions docs/cedar-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

* Remember to Save!
* You can collaborate to complete the form by sharing it
* Make sure you know which fields do and don't apply to your study --> Read the "Sections: Overview & Context" page (coming soon) before starting the form
* Detailed coverage for each field and response options are available in the "CEDAR Fields - Details" section (coming soon)
* Check out the FAQs document (coming soon) for questions and answers you may also be interested in!
* Make sure you know which fields do and don't apply to your study --> Read the "Sections: Overview & Context" page *(coming soon)* before starting the form
* Detailed coverage for each field and response options are available in the "CEDAR Fields - Details" section *(coming soon)*
* Check out the FAQs document *(coming soon)* for questions and answers you may also be interested in!

Read below for tech tips on finding, using, and sharing the CEDAR form.

Expand All @@ -16,7 +16,7 @@ Read below for tech tips on finding, using, and sharing the CEDAR form.

Log in to [cedar.metadatacenter.org][CEDAR site].
Click "Shared with me" in the left panel (#1).
Hover over the tiles to see the full study names and find the right form (#2).
Hover over the tiles to see the full study names and find the right form (#2).
*Note: The file will not be in any of the folders (red X).*

![Screenshot of Shared with Me showing how to find your CEDAR form.][img Find CEDAR form]
Expand All @@ -33,9 +33,9 @@ Step 1: Are you the person who registered the study?
Step 2: On the Shared with Me page (#1), turn off any filters by clicking Reset All (#2) if you see it there.
Your study form may appear after resetting filters to the default.

![Screenshot of Shared with Me showing Reset All link.][img CEDAR reset all]
![Screenshot of Shared with Me showing Reset All link.][img CEDAR reset all]{: style="height:250px"}

If neither of these steps resolves your access to the CEDAR form, please reach out to [email protected] for assistance.
If neither of these steps resolves your access to the CEDAR form, please reach out to **[[email protected]](mailto:[email protected])** for assistance.

### Collapse and expand sections

Expand All @@ -44,15 +44,15 @@ Section headings are in green text, and metadata fields are in black.

You can collapse or expand a section by clicking on the green section heading.

![Animation of clicking section headings to collapse and expand sections.][img CEDAR collapse sections]
![Animation of clicking section headings to collapse and expand sections.][img CEDAR collapse sections]{: style="height:350px"}

Consider "collapsing" all sections when you open the form, and expanding them individually as you move through the form.

### Save

The form does NOT autosave. Please be sure to save your entries by scrolling to the bottom of your form and clicking the green “Save” button at bottom right of the form. Saving will not close the page or redirect you.

![Screenshot of collapsed CEDAR form with arrow pointing to Save button.][img CEDAR save]
![Screenshot of collapsed CEDAR form with arrow pointing to Save button.][img CEDAR save]{: style="height:350px"}

Save often while completing the form so you do not lose any entered metadata. Consider saving each time you complete a form section (or more often).

Expand All @@ -73,49 +73,49 @@ To provide team members access to a CEDAR form:
* Find the CEDAR form by logging in to [cedar.metadatacenter.org/][CEDAR site], then clicking "Shared with me" (#1). Hover over the tiles to see the full study names and find the right form.
* Click on the vertical three dots in the right corner of the tile for the CEDAR form (#2), then click on "Share" (#3).

![Screenshot of first steps to share CEDAR form.][img CEDAR share1]
![Screenshot of first steps to share CEDAR form.][img CEDAR share1]{: style="height:250px"}

* In the pop-up window, under "With People," start typing the collaborator's name (#4). Select their name from the list below (#5)

![Screenshot of second steps to share CEDAR form.][img CEDAR share2]
![Screenshot of second steps to share CEDAR form.][img CEDAR share2]{: style="height:250px"}

* Use the dropdown on the right (#6) to select "can write" (#7) if you want the collaborator to make edits, or "can read" for collaborators who will only review, not edit. Then click the OK button (#8).

![Screenshot of third steps to share CEDAR form.][img CEDAR share3]
![Screenshot of third steps to share CEDAR form.][img CEDAR share3]{: style="height:200px"}

* You will see the collaborator's name appear on the right side of the window (red circle). Click Done (#9) to close the window and save changes.

![Screenshot of last steps to share CEDAR form.][img CEDAR share4]
![Screenshot of last steps to share CEDAR form.][img CEDAR share4]{: style="height:350px"}

* You can remove access from collaborators who have left the team by clicking on the X on the right side of the window.

### Help text & tooltips

Help text for each field is available while interacting with the field. Once you click into a field, a "?" icon is available in the upper right of the field area. Mouse over the "?" icon to view help text for that field.

![Screenshot showing the tooltip icon, indicated with a red arrow.][img CEDAR tooltips]
![Screenshot showing the tooltip icon, indicated with a red arrow.][img CEDAR tooltips]{: style="height:300px"}

### How to select or remove a response for a field

Most fields on the CEDAR form have a drop-down panel of options.

Click in the field to interact with the response options. You may then click to open the drop-down list of responses. Click on a response to select it for the CEDAR field.

![Screenshot showing the tooltip icon, indicated with a red arrow.][img CEDAR tooltips]
![Screenshot showing san example of a CEDAR form dropdown menu.][img CEDAR dropdown]{: style="height:250px"}

If the response field says "Select options" instead of "Select option," you may choose multiple responses for a field; simply click all options in the drop-down that apply.

![Screenshot showing the tooltip icon, indicated with a red arrow.][img CEDAR tooltips]
![Screenshot showing what the response field looks like if you can choose multiple selections.][img CEDAR multiple selection]{: style="height:250px"}

To remove a response that has been selected, click in the dropdown to select a new response. Or, for fields that allow multiple responses, click the X to the right of the

![Screenshot showing the tooltip icon, indicated with a red arrow.][img CEDAR tooltips]
![Screenshot showing highlighting the X to remove a selection with a red arrow.][img CEDAR remove selection]{: style="height:200px"}

Jump to Sections: Overview & Context page (coming soon)
*Jump to Sections: Overview & Context page (coming soon)*

Jump to CEDAR Fields - Details page (coming soon)
*Jump to CEDAR Fields - Details page (coming soon)*

Jump to FAQs (coming soon)
*Jump to FAQs (coming soon)*

<!-- Links and Images -->
[CEDAR site]: https://cedar.metadatacenter.org
Expand All @@ -127,7 +127,7 @@ Jump to FAQs (coming soon)
[img CEDAR share2]: ./img/cedar-share-2.png
[img CEDAR share3]: ./img/cedar-share-3.png
[img CEDAR share4]: ./img/cedar-share-4.png
[img CEDAR tooltips]: ./img/edar-tooltips.png
[img CEDAR tooltips]: ./img/cedar-tooltips.png
[img CEDAR dropdown]: ./img/cedar-dropdown.png
[img CEDAR multiple selection]: ./img/cedar-multiple-sel.png
[img CEDAR remove selection]: ./img/cedar-remove-sel.png
Expand Down

0 comments on commit 871a3ff

Please sign in to comment.