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

Instructions completed. #518

Open
wants to merge 2 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 src/docs/source/docs/media/timeline_1.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 src/docs/source/docs/media/timeline_10.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 src/docs/source/docs/media/timeline_11.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 src/docs/source/docs/media/timeline_12.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 src/docs/source/docs/media/timeline_13.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 src/docs/source/docs/media/timeline_14.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 src/docs/source/docs/media/timeline_15.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 src/docs/source/docs/media/timeline_16.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 src/docs/source/docs/media/timeline_2.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 src/docs/source/docs/media/timeline_3.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 src/docs/source/docs/media/timeline_4.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 src/docs/source/docs/media/timeline_5.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 src/docs/source/docs/media/timeline_7.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 src/docs/source/docs/media/timeline_8.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 src/docs/source/docs/media/timeline_9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
111 changes: 111 additions & 0 deletions src/docs/source/docs/timeline_essay.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
Timeline Essay
=====================


Steps to Create a Timeline Essay
---------------------------------------
1. The process of adding any variety of content to PECE begins by logging in with your screen name and password and clicking “Create Content” in the top right corner.


![](media/timeline_1.png)


2. You should now see the "Add content" page.


![](media/timeline_2.png)


As you scroll down the page, you can find thumbnails
for creating different forms of new content. Each is organised under a category. "Timeline Essay" can be found under the category "Curate". "Timeline Essay" is one of the types of content. A timeline essay is a collection of artifacts, ordered into a timeline, with text added for context.




3. To create a timeline essay, click on the "Timeline Essay" thumbnail.

![](media/timeline_3.png)


4. This takes you to the "Create Timeline Essay" page. You should now have access to all of the fields you need to fill out in order to create a new timeline essay. First, type the title of your timeline essay in the “Title” field.


5. Type a description of your timeline essay into the "Description" field.

![](media/timeline_4.png)


6. Next, is the "Media thumbnail". Select the "Add media" button, to add a form of media to your timeline essay.
In the pop-up window that appears, select a media file from your device.
After your media has been selected, add a short description of the image used by screen readers and displayed when the image is not loaded. This is important for accessibility.
Select "Save and insert" to save the image.

![](media/timeline_5.png)

7. The next section is the "Timeline Entries" section.
Here you can select artifacts to add to the timeline essay by typing in the first few letters of the artifact's title. Select the artifact from the drop-down menu.


Each timeline essay item has a title, description, date, and referenced artifact. The "Title" field indicates a title for the timeline essay item. It will appear as a heading at the top of the essay item. Enter a title for your timeline essay item.


Add a description of the artifact and a date or date range for the timeline essay item. It will determine where along the timeline the essay item displays.

![](media/timeline_7.png)

![](media/timeline_8.png)

Choose a background image from your local device as well as a background colour. This color will appear in the background of the timeline essay item. If you select a color, you should also set the background opacity to a value between 0 (transparent) and 1 (opaque). (e.g. 0.5 will set the background color to half opacity). Type this value into the "Opacity" box.
To add more timeline essay items, select the "Add PECE Timeline Essay Item".

![](media/timeline_9.png)


![](media/timeline_10.png)


8. Next are three tabs: "Permissions", "Contribution Metadata" and Custom Citation. The "Permissions, Authorship, and Groups" should be automatically opened.


In the "Edit Permissions and Authorship" section, you should be automatically added as a contributor as your username. Listed contributors have the ability to edit the content, and are also credited as content contributors when the content is published. If there are any other contributors, add them by typing the first few letters of their name into the field. Their screen name should pop up. Select their name. To add more than one contributor other than yourself, click the "Add another item" button and repeat the same process.


![](media/timeline_11.png)


9. Next, in the "View Permissions and Groups", you will come across the "Everyone can view this content" toggle. By default, the toggle will be set to on, meaning everyone on the Web can view the content. If you want to restrict access to the content, turn this off.


If you choose to leave the toggle on, you can still associate the content with a particular group. To do so, complete the "Group association and view access." You can select a group with which to associate the content by typing its name into the field.

![](media/timeline_12.png)

If you choose to restrict access to the content, you can designate specific people or groups that will have view access. Add the people who should have view access to this timeline essay by typing their screen name into the "People with view access" field. Add groups whose members should have view access to this timeline essay by typing the group name into the "Group association and view access" field. **Note that if you give a group view access, it will also associate the content with that group. This means the content will appear on the group's page.**

10. Next, click on the "Contribution Metadata" tab.

11. Complete the "License" field by selecting a license from the drop-down menu. This indicates how the content should be licensed. We encourage you to leave it as Attribution, Share Alike CC BY-SA, but you can choose any of the other Creative Commons licenses as you see fit. Please refer to the [*Licensing*](https://creativecommons.org/share-your-work/cclicenses/) section for more information.


![](media/timeline_13.png)


12. Next, add optional keyword tags to your timeline essay. Tag the content. As you type, suggested tags will be automatically generated if they exist already in the system. We recommend following these suggestions and using existing tags if they are not too different from what you intended, but feel free to make up new tags!

![](media/timeline_16.png)


13. In the "Custom Citation" tab, you have the option to cite your timeline essay as a part of a particular project.
When you save this content, a suggested citation will be auto-created by the platform. If this content is generated from or associated with a particular project on the platform, this field indicates which project the content should be cited as part of. You may leave this field blank if the content does not need to be cited as part of a particular project.

![](media/timeline_14.png)


There is also the option to enable ARK. ARKs (Archival Resource Keys) serve as persistent identifiers, or stable, trusted references for an information object. They are like DOIs but are open, decentralized, and non-paywalled; you can assign an ARK to almost any content you create, but they should be used thoughtfully for content whose long-term accessibility is vital. This is toggled off by default but you have the option to enable ARKs.


14. Finally, click “Save” at the top of the page to save your work. And remember: all of these settings can be revised at any time: private artifacts can be made public later, and vice versa, for example.


![](media/timeline_.png)

Loading