Docs memo edit session1

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"
   }
 }

src/docs/source/docs/memo.md

@@ -0,0 +1,202 @@
+Memo
+=====================
+
+Steps to Create an 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 type 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.
+
+5. Type your memo into the "Body" field.
+    To provide a summary of your memo, click the "Edit summary" link next to "Body".
+
+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. 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.
+
+7. Next, in the "View Permissions and Groups", toggle the "Everyone can view this content" on or off to determine who can view the content.
+
+    If you choose on, complete the "Group association and view access" by adding groups by typing in its name into the field. 
+
+    If you choose off, add the people who have access to this memo by adding typing in their screen name and clicking it. Continue to completing the "Group association and view access" field just as instructed above.
+
+8. Next, click on the "Contribution Metadata" tab.
+
+9. Complete the "License" field by selecting a license from the drop down menu. This indicates how the content should be licensed.
+
+10. Next, add optional keyword tags to your memo. Type in a keyword into the search bar to tag to your memo. Select it from the list that pops up. You can add several keyword tags by clicking the "Add another item" button and repeating the above instructions.
+
+5. Add yourself as a contributor by typing the first few letters of your name into the
+“contributor” field. Your screen name should pop up. Select your name. Repeat this process with the names of any other project members who you would
+like to grant access to editing the artifact.
+
+6. Next, write out your “Critical Commentary” section, making sure to follow any project-
+specific instructions.
+
+    ![](media/artifacts5.png)
+
+7. Next, upload your artifact by clicking the “Browse” link.
+
+    ![](media/artifacts6.png)
+
+    The browser window should pop up. Click “Browse” and select the name of the file you would like to upload.
+
+    ![](media/artifacts7.png)
+
+    * Click “Open” and then “Next” 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 and Title Text as desired.
+    * Click Save.
+
+8. Next, cite the source of the artifact in the Source pane, using your platform's preferred citation format.
+
+9. In the “creators” pane, credit all the contributors who helped produce the image.
+
+    ![](media/artifacts8.png)
+
+10. You may also include the format, language, or fieldsite 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.
+
+11. 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. Please refer
+to the [*Licensing*](../licensing) section for more information.
+
+12.  If the image is not ready to be made public, you can alter the permissions of the image. Selecting “Private” limits visibility to you and you alone. Selecting “Restricted” limits visibility to users of PECE designated as “Researchers” (this mostly matters to instances of PECE subject to IRB
+protections). Selecting “Open” make the artifact visible to all internet users. For more information, see [*Content Permissions*](../permissions#content-permissions) section.
+
+13. To designate the content as part of a group, select the group's name in the Group Audience field. Select “Public” to make it accessible to all viewers; this is the setting we generally recommend. Select “Private” to limit visibility to Group Members.
+
+14. 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/artifacts9.png)
+
+15. Only add an expiration date if it is important for the artifact to be deleted from the platform at some point.
+
+16. 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 time: private artifacts can be made public later, and vice versa, for example.
+
+    ![](media/artifacts10.png)
+
+Frequently Asked Questions
+---------------------------------------
+
+### 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 select a file that has already been added to the system?
+
+When creating a piece of content, under the Image Upload field, click
+the ‘Browse’ button to select a file from the existing PECE library.
+Select the ‘Library’ tab. Choose a file and hit the ‘Submit’ button.
+
+### 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 [*Where can I access older versions of content?*](#where-can-i-access-older-versions-of-content) 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.
+
+![](media/revisions.png)
+
+### I’ve identified my content as having multiple contributors, but those contributors don’t have access to edit the content. What’s going on?
+
+Identifying contributors only credits those site users involved in
+contributing the content. It does not grant those users access to edit
+the content. Only the content creator can edit the content.
+
+### Where can I find my fieldnotes?
+
+Navigate to your ‘Dashboard’. This link will be in the main menu. On
+your dashboard, there will be a tab labeled ‘Field Diary’. Click on this
+tab to access your fieldnotes. They will be ordered chronologically.
+
+### Why do my published images appear blurry?
+
+Currently, when images are uploaded to PECE, the files are compressed,
+and the image quality downgrades. If this is a problem for your content,
+you should reach out to your site administrator and ask to have the
+quality upgraded.
+
+### Can I download files from the platform?
+
+You cannot download files that are listed as All Rights Reserved. Please
+see the [*Licensing*](../licensing) 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.
+
+### ![](media/download.png)
+
+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.
+
+![](media/pdfdownload.png)
+
+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.