additional documentation on surrogate concerns for mementos

oduwsdl · Jul 8, 2019 · fd5137c2a3731323ac03b752d5c113f0a77d2cb9 · fd5137c
1 parent 67fbc7a
commit fd5137c2a3731323ac03b752d5c113f0a77d2cb9
Unified Split

Showing with 13 additions and 0 deletions.

+3 −0 .gitignore

BIN docs/source/images/mementoembed_annotated.png

+10 −0 docs/source/templates.rst
diff --git a/.gitignore b/.gitignore
@@ -114,3 +114,6 @@ _testtemplates/
 # for sphix documentation
 _build/
+  
+
+  
+# caching
+  
+*.sqlite
diff --git a/docs/source/images/mementoembed_annotated.png b/docs/source/images/mementoembed_annotated.png
diff --git a/docs/source/templates.rst b/docs/source/templates.rst
@@ -234,3 +234,13 @@ The above example would replace the value of the variable with the 3 :superscrip
 * ``element.surrogate.urim``
    - the URI-M of this memento
+  
+Considerations For Surrogates
+  
+-----------------------------
+  
+
+  
+As noted in our work with MementoEmbed, surrogates for mementos need special consideration to avoid misleading users. Here we provide a brief explanation of some of the decisions made with MementoEmbed to address problems created by other surrogate services. 
+  
+
+  
+.. image:: images/mementoembed_annotated.png
+  
+
+  
+Note that the surrogate below contains information from the memento content, such as the title and a text snippet. It also provides information from the archive. This duality may make mementos confusing for some users. It is important to provide both archive information as well as the information about the original resource. In the example below, CNN is the author of the underlying memento, Archive-It merely captured it. If you leave out the information on the original resource, visitors to your story may think that Archive-It is the author, which is incorrect. If you leave out information on the archive, visitors to your story may think that you have misled them because the link did not lead them to cnn.com. Such misleading behavior may cause you, the story author, to lose credibility. When developing templates, please keep these considerations in mind.
+  
+
+  
+