diff --git a/docs/collections.rst b/docs/collections.rst index aad64d19..3345715a 100644 --- a/docs/collections.rst +++ b/docs/collections.rst @@ -32,7 +32,7 @@ Twitter user timeline Twitter user timeline collections collect the 3,200 most recent tweets from each of a list of Twitter accounts using `Twitter's user_timeline API -`_. +`_. **Seeds** for Twitter user timelines are individual Twitter accounts. @@ -66,13 +66,14 @@ Twitter search Twitter searches collect tweets from the last 7-9 days that match search queries, similar to a regular search done on Twitter, using -the `Twitter Search API `_. +the `Twitter Search API `_. This is **not** a complete search of all tweets; results are limited both by time and arbitrary relevance (determined by Twitter). Search queries must follow standard search term formulation; permitted queries are listed in the documentation for the `Twitter Search API -`_, or you can construct a query +`_, +or you can construct a query using the `Twitter Advanced Search query builder `_. @@ -99,7 +100,7 @@ Twitter sample Twitter samples are a random collection of approximately 0.5--1% of public tweets, using the `Twitter sample stream -`_, useful for +`_, useful for capturing a sample of what people are talking about on Twitter. The Twitter sample stream returns approximately 0.5-1% of public tweets, which is approximately 3GB a day (compressed). @@ -125,7 +126,7 @@ Twitter filter Twitter Filter collections harvest a live selection of public tweets from criteria matching keywords, locations, or users, based on the `Twitter filter streaming API -`_. Because +`_. Because tweets are collected live, tweets from the past are not included. (Use a :ref:`Twitter search` collection to find tweets from the recent past.) @@ -135,14 +136,14 @@ location. **Track** collects tweets based on a keyword search. A space between words is treated as 'AND' and a comma is treated as 'OR'. Note that exact phrase matching is not supported. See the `track parameter documentation -`_ for more +`_ for more information. **Follow** collects tweets that are posted by or about a user (not including mentions) from a comma separated list of user IDs (the numeric identifier for a user account). Tweets collected will include those made by the user, retweeting the user, or replying to the user. See the `follow parameter documentation -`_ for +`_ for more information. - Note: The Twitter website does not provide a way to look up the user ID for a user account. You can use `https://tweeterid.com `_ for this purpose. @@ -151,7 +152,7 @@ more information. **Location** collects tweets that were geolocated within specific parameters, based on a bounding box made using the southwest and northeast corner coordinates. See the `location parameter documentation -`_ for +`_ for more information. Twitter will return a limited number of tweets, so filters that return many diff --git a/docs/data_dictionary.rst b/docs/data_dictionary.rst index 3a6a52e2..4c005dbf 100644 --- a/docs/data_dictionary.rst +++ b/docs/data_dictionary.rst @@ -22,9 +22,8 @@ Twitter Dictionary ------------------ For more info about source tweet data, see the `Twitter API documentation -`_, including `Tweets -`_ and `Entities -`_. +`_, including `Tweet data dictionaries +`_. Documentation about older archived tweets is archived by the Wayback Machine for the `Twitter API diff --git a/docs/messaging_spec.rst b/docs/messaging_spec.rst index 42d9e497..4f7afc7d 100644 --- a/docs/messaging_spec.rst +++ b/docs/messaging_spec.rst @@ -41,7 +41,7 @@ Background information requester may also want to monitor the status of a harvest. In the current architecture, the SFM UI serves the role of requester. * A stream harvest is a harvest that is intended to continue indefinitely until - terminated. A harvest of a `Twitter public stream `_ + terminated. A harvest of a Twitter sample stream is an example of a stream harvest. A stream harvest is different from a non-stream harvest in that a requester must both start and optionally stop a stream harvest. Following the naming conventions from Twitter, a harvest of a REST, non-streaming API diff --git a/docs/userguide.rst b/docs/userguide.rst index cadc693d..85824a04 100644 --- a/docs/userguide.rst +++ b/docs/userguide.rst @@ -121,7 +121,7 @@ platforms' terms (`Twitter `_, `Tumblr `_), as you agreed to them when you created your social media account. Social Feed Manager respects those platforms' terms as an application -(`Twitter `_, +(`Twitter `_, `Flickr `_, `Sina Weibo `_, `Tumblr `_). diff --git a/sfm/ui/forms.py b/sfm/ui/forms.py index 87d8d4e6..c4c737fe 100644 --- a/sfm/ui/forms.py +++ b/sfm/ui/forms.py @@ -574,7 +574,7 @@ def clean_token(self): class SeedTwitterSearchForm(BaseSeedForm): query = forms.CharField(required=False, widget=forms.Textarea(attrs={'rows': 4}), - help_text='See ' \ + help_text='See ' \ 'these instructions for writing a query. ' \ 'Example: firefly OR "lightning bug"') geocode = forms.CharField(required=False, @@ -647,18 +647,19 @@ def __init__(self, *args, **kwargs): class SeedTwitterFilterForm(BaseSeedForm): track = forms.CharField(required=False, widget=forms.Textarea(attrs={'rows': 4}), help_text="""Separate keywords and phrases with commas. See Twitter + target="_blank" href="https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/basic-stream-parameters#track"> track for more information.""") follow = forms.CharField(required=False, widget=forms.Textarea(attrs={'rows': 4}), help_text="""Use commas to separate user IDs (e.g. 1233718,6378678) of accounts whose tweets, retweets, and replies will be collected. See Twitter follow - documentation for a full list of what is returned.""") + href="https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/basic-stream-parameters#follow"> follow + documentation for a full list of what is returned. User TweeterID to get the user ID for a screen name.""") locations = forms.CharField(required=False, widget=forms.Textarea(attrs={'rows': 4}), help_text="""Provide a longitude and latitude (e.g. -74,40,-73,41) of a geographic bounding box. See Twitter + href="https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/basic-stream-parameters#locations"> locations for more information.""") def __init__(self, *args, **kwargs): diff --git a/sfm/ui/templates/ui/terms_snippet.html b/sfm/ui/templates/ui/terms_snippet.html index b40c6ac9..42e6f03e 100644 --- a/sfm/ui/templates/ui/terms_snippet.html +++ b/sfm/ui/templates/ui/terms_snippet.html @@ -2,7 +2,7 @@

Collecting and using data from social media platforms is subject to those platforms' terms (Twitter, Flickr, Sina Weibo, Tumblr), as you agreed to them when you created your social media account. Social Feed Manager respects those platforms' terms as an - application (Twitter, Flickr, Sina Weibo, Tumblr).

+ application (Twitter, Flickr, Sina Weibo, Tumblr).

Social Feed Manager provides data to you for your research and academic use. Social media platforms' terms of service generally do not allow republishing of full datasets, and you should refer to their terms to understand what you may share.