Docs

package.json

@@ -47,6 +47,7 @@
   "homepage": "https://github.com/PECE-project/drupal-pece#readme",
   "dependencies": {
     "node-gyp": "^10.0.1",
+    "pece": "file:",
     "sass": "^1.69.5"
   }
 }

photo-essay-new

@@ -0,0 +1 @@
+

src/docs/source/docs/artifact-new.md

@@ -0,0 +1,106 @@
+Steps to Create an Artifact
+
+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/PECE-new-artifact-create-content-screenshot.png)
+
+You should now see the "Add content" page.
+
+![](media/PECE-new-artifact-add-content-screenshot.png)
+
+On this page you will find a grid of options for creating different forms of new content followed by their brief descriptions. “Artifacts” are one type of content. An artifact is the basic working unit of PECE; once, created, artifacts are then used in photo essays (for image artifacts only), timelines, or PECE Essays (both of which accept images, video, documents, and any other type of artifact)
+
+You can add many types of artifacts, including audio files, video, images, pdf, text, and websites. Within the "Archive" section of content types, you will see all the artifact options.
+
+Next, click the type of artifact you want to create.
+
+![](media/PECE-new-artifact-screenshot-image.png)
+
+
+You should now have access to all of the fields you need to fill out in order to create a new image artifact. First, type the title of your image in the “Title” pane.
+
+Next, upload your artifact by clicking the "Choose file" button and selecting the name of the file you would like to upload. 
+
+![](media/PECE-new-artifact-title-screenshot.png)
+
+
+Click “Open” to upload the file into PECE. Depending on the size of the file it may take a few seconds or minutes to upload; a small icon for the file will appear once uploading is complete.
+Add Alt Text as desired.
+
+Next, scroll down to the metadata fields. The menu bar on the left side will automatically be open to the "Permission, Authorship, and Groups" section. Your screen name should already appear in the first contributor field. Listed contributors have the ability to edit the content, and are also credited as content contributors when the content is published. To add the names of any other project members who you would like to grant access to editing the artifact, type the first few letters of their name into the other “contributor” field. To add more than one additional contributor, click the "add another item" button and enter their name in the new field.
+
+
+Next, scroll down to the "View Permission and Groups" section. The button switch will automatically set viewing permissions to "Everyone can view this content," making the artifact visible to all internet users. If you want to restrict access to the content, click the button switch to 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.
+If you choose to restrict access to the content, you can designate specific people or groups that will have view access. To allow specific people viewing access, in the field, "People with view access" type the first few letters of their name and select their username. Add groups whose members should have view access to this memo 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.**
+
+
+![](media/PECE-new-artifact-permissions.png)
+
+
+Next, click on the “Source Metadata" section on the left side menu bar. Fill out the section, making sure to follow any project- specific instructions. You may also include the format, language, or location associated with the image if you feel as though they are important or interesting to the meaning or usefulness of the image. Otherwise you may choose to leave them blank.
+
+![](media/PECE-new-artifact-source-metadata.png)
+
+
+Click Save.
+Next, fill out the "Contribution Metadada" section, making sure to select the correct license and add any critical commentary. For the license, we encourage you to leave it as Attribution, Share Alike CC BY-SA, but you can choose any of the other Creative Commons license as you see fit. Descriptions of available creative commons licenses can be found <a href=”https://creativecommons.org/share-your-work/cclicenses/”>here</a>.
+
+If you wish to associate this artifact with a fieldsite that you have already created in the platform, you can do so by typing the Title for that fieldsite into the "Fieldsite" field. 
+
+Tag the content. As you type, suggested tags will be automatically generated if they exist already in the system. We recommend following theses suggestions and using existing tags if they are not too different from what you were intending, but feel free to make up new tags!
+
+![](media/PECE-new-artifact-contribution-metadata.png)
+
+
+
+Next, fill out the "Custom Citation" section, using your platform's preferred citation format.
+
+Next, you can fill out the "File format" section to indicate the file format of the artifact.
+
+Finally, scroll back up to the top of the page and click “Save” to save your work. And remember: all of these settings can be revised at a later time: private artifacts can be made public later, and vice versa, for example.
+
+![](media/PECE-new-artifact-custom-citation.png)
+
+**FAQs**
+
+
+What is the difference between a text artifact and a field note?
+
+A text artifact and a fieldnote are technically very similar. However, unlike a text artifact, a fieldnote will not have a title; the date the fieldnote was created will become the title. Also a fieldnote will appear in the field diary on user’s dashboard. If associated with a group, a fieldnote will also appear under the Field Diary tab of the group’s page, ordered by the date created.
+
+What is an artifact bundle, and why would I use it?
+
+An artifact bundle is an artifact that links to several other existing artifacts. You can create an artifact bundle so that you may annotate a group of artifacts together.
+
+What is “critical commentary”?
+
+In this field, you should provide commentary on the artifact that documents its significance as an ethnographic objects and why it is relevant to the platform.
+
+How do I list the creator (author, photographer, composer) of a piece of content when they are not part of the system?
+
+When creating an artifact, the Creator field can be used to designate the author of a piece of content when that creator is not a user of the system. Technically, this field is a tag. This means that if content in the system has already been tagged with the creator, you should be given the option to select this creator’s name when you begin typing in this field. Otherwise, upon saving the artifact, the creator’s name will become a new “Creator tag” in the system.
+
+When I edit content, what should I include in the revision log message?
+
+If a researcher cites a piece of content on the platform on a particular date, and then the content creator revises the content on a later date, it is important to be able to track which version of the PECE content the researcher was citing. PECE enables users to track changes made to content over time. In the revision log message section, users should summarize changes they make the content, so that it is easier to track the changes. See <i><a href=”https://pece-project.github.io/drupal-pece/artifacts/#where-can-i-access-older-versions-of-content”>Where can I access older versions of content?</a></i> for where to track these changes.
+
+Where can I access older versions of content?
+
+When logged in, navigate to the content. Click on the ‘Revisions’ tab. If there is no ‘Revisions’ tab, it means that no changes have been made to the content. Under the ‘Revisions’ tab, you can click on a date - time under the Revisions column to access older versions of the content. You can also compare a newer version of content to an older version by selecting two versions under the Compare column and clicking the ‘Compare’ button.
+
+Can I download files from the platform?
+
+You cannot download files that are listed as All Rights Reserved. Please see the <i><a href=”https://creativecommons.org/licenses/>Licensing</a></i> section for more information about this. Audio files and video files that have been added as a part of Open artifacts can be downloaded from the platform. Navigate to the artifact page where the file is displayed. In the bottom right hand corner of the rendered file, there will be an upside down arrow. Click this button to download the file.
+
+PDF files that have been added as part of Open artifacts can also be downloaded from the platform. Navigate to the artifact page where the file is displayed. When you hover over the PDF viewer, a bar will display at the top. In the upper right hand corner of this bar, there will be an upside down arrow. Click this button to download the file.
+
+Right now, there is not a simple way to download image files. You can right click on the image and Save the file to your computer however.
+
+Can I add a Youtube or Vimeo video to the platform?
+
+Currently, you cannot embed a YouTube for Vimeo video in the platform.
+
+Can I add a map to the platform?
+
+Currently the only way to share a map on the platform is by capturing an image of it and uploading it to the site as an image artifact, or alternatively by uploading a link to the map as a Website artifact.

src/docs/source/docs/bio.md

@@ -0,0 +1,11 @@
+User Accounts and Profiles
+=====================
+
+Steps to Updating Your Bio
+---------------------------------------
+
+1. Navigate to "My account" by clicking the link.
+2. Click the "Profile" link.
+3. This will take you to your profile where you can update your biography in the "Biography" text field.
+    Here you can update other aspects of your profile like your name, institution, and email address.
+4. Scroll to the end of the page and click the "Save" to save your changes.

src/docs/source/docs/groups-new.md

@@ -0,0 +1,111 @@
+Groups
+==========
+
+### Overview
+
+Steps to Create Group
+--------------------------
+
+1. Navigate to ‘Create Group’. This link is listed in the main menu.
+
+    ![](media/group-1.png)
+
+2. Select to add a group. You will be directed to a web form to create your group.
+
+3. Enter a title in the "Name" textbox for your new group.
+
+4. In the "Image" field, you can upload an image related to your group by first removing the placeholder image and clicking "Add media".
+
+    ![](media/group-2.png)
+
+    ![](media/group-3.png)
+
+5. Add a description related to your group, in the "Description" textbox.
+
+6. The "Group visibility" field, determines whether the group can be viewed by all site visitors or only by its own members. 
+It does not determine the visibility of group content. Select whether you would like your group to be publicly or privately visible.
+
+    ![](media/group-4.png)
+
+7. The "Substantive logic" provides the opportunity to describe the rational behind the creation of the group. 
+You may select a substantive logic by typing in the first few letters and making a selection from the drop-down menu.
+
+8. If there are any other group members or managers, 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, click the "Add another item" button and repeat the same process.
+
+9. Next, add optional keyword tags to your timeline essay. Tag the content. As you type, suggested tags will be automatically generated if they already exist 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!
+
+10. The "Relations" field allows you to select group(s) that are related to the current sub-group being made. 
+Type in the first few letters and a drop-down menu of groups to choose from will appear.
+
+    ![](media/group-5.png)
+
+11. 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. You are now the group administrator.
+
+
+Steps to Join a Group
+--------------------------
+
+1. Navigate to ‘Collaborate’. This tab is listed on the main menu bar.
+Here, you will find all of the open groups.
+
+    ![](media/group-6)
+
+2. Navigate by clicking through the arrows on the bottom of the pages, or by searching if you know the
+name of the group.
+
+    ![](media/group-7)
+
+3. Once you locate the group, click on the link to navigate to the group page.
+
+4. [To be revised, no current way to join a group from the website] 
+Contact the group manager to join the group.
+
+Steps to Manage Group Memberships 
+--------------------------
+
+1. If you created a group or have been appointed as an administrator of a
+group, navigate to the group’s page from your dashboard or from the “Collaborate” link.
+
+    To do this from your dashboard, click the edit button next to your group's name or click "See and sort all my managed groups".
+
+    ![](media/group-8)
+
+    To do this from the "Collaborate" link, select your group to navigate to the group page. Click the "Edit" link where you can manage group memberships. Save your changes.
+
+    ![](media/group-9)
+
+
+### Approving a Group Member [The below is to be revised, no current way to approve]
+
+1. To approve a group membership for a Pending user, click edit at the end of the row with their username.
+
+2. Change their membership Status to "Active".
+
+3. Select group user roles for the user.
+
+4. Click "Update Membership".
+
+### Changing a Group Member's roles 
+
+1. To change a group member's role, navigate to the group's page and select "Edit".
+
+2. Select "Remove" next to the group member's username under the category of their current role.
+
+3. Add the group member by their username under the category of the new role.
+
+### Deleting a Group Member
+
+1. To delete a group member, navigate to the group's page and select "Edit".
+
+2. Scroll down to "Group members" and click "Remove" next to their name.
+
+
+Adding Artifacts to Groups [Link to be changed for the artifacts]
+-----------------------------------------
+
+1. Follow instructions to [add an artifact](../artifacts), and designate the group you would like to assocaite it with in the "View Permissions and Groups".
+
+

src/docs/source/docs/memo.md

@@ -0,0 +1,74 @@
+Memo
+=====================
+
+Steps to Create a Memo
+---------------------------------------
+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/memo_1.png)
+
+2. You should now see the "Add content" page.
+
+    ![](media/memo_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. "Memo" can be found under the category "Analyze". "Memo" is one of the types of content. A memo is a first draft of a piece of writing, meant to synthesize ideas generated throughout data analysis. Upon publishing a memo, that memo is opened for comments from the platform's community.
+
+    ![](media/memo_3.png)
+
+3. To create a memo, click on the "Memo" thumbnail. 
+
+    ![](media/memo_4.png)
+
+4. This takes you to the "Create Memo" page. You should now have access to all of the fields you need to fill out in order to create a new memo. First, type the title of your memo in the “Title” field.
+
+    ![](media/memo_5.png)
+
+5. Type your memo into the "Body" field.
+    To provide a summary of your memo, click the "Edit summary" link next to "Body".
+
+    ![](media/memo_6.png)
+
+6. Next are two tabs: "Permissions, Authorship, and Groups" and "Contribution Metadata". 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/memo_7.png)
+
+7. 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/memo_8.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 memo by typing their screen name into the "People with view access" field. Add groups whose members should have view access to this memo 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.**
+
+    ![](media/memo_9.png)
+
+8. Next, click on the "Contribution Metadata" tab.
+
+    ![](media/memo_10.png)
+
+9. 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/memo_11.png)
+
+10. Next, add optional keyword tags to your memo. Tag the content. As you type, suggested tags will be automatically generated if they exist already in the system. We recommend following theses suggestions and using existing tags if they are not too different from what you were intending, but feel free to make up new tags!
+
+    ![](media/memo_12.png)
+
+11. 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/memo_13.png)
+
+Frequently Asked Questions
+---------------------------------------
+
+### What is the difference between a text artifact and a memo?
+
+A text artifact and a memo are similar but conceptually and architecturally different. A text artifact is writing that acts as a piece of data that will be analysed while a memo is a first draft of writing that is used to meditate on findings and data analysis. Architecturally, a memo can be commented on while a text artficat can be annotated.
+
+
+
+
+