Skip to content

Commit

Permalink
refs #925. Fixes Twitter links. Also, restore missing doc images.
Browse files Browse the repository at this point in the history
  • Loading branch information
Justin Littman committed May 25, 2018
1 parent 637f45b commit d0a6578
Show file tree
Hide file tree
Showing 16 changed files with 15 additions and 12 deletions.
6 changes: 3 additions & 3 deletions docs/collections.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,13 @@ 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 <https://developer.twitter.com/en/docs/tweets/search/overview/basic-search>`_.
the `Twitter Search API <https://developer.twitter.com/en/docs/tweets/search/overview/standard>`_.
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
<https://developer.twitter.com/en/docs/tweets/search/overview/operator_descriptions>`_,
<https://developer.twitter.com/en/docs/tweets/search/guides/standard-operators>`_,
or you can construct a query
using the `Twitter Advanced Search query builder
<https://twitter.com/search-advanced>`_.
Expand Down Expand Up @@ -154,7 +154,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
<https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/basic-stream-parameters#location>`_ for
<https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/basic-stream-parameters#locations>`_ for
more information.

Twitter will return a limited number of tweets, so filters that return many
Expand Down
2 changes: 1 addition & 1 deletion docs/credentials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ To manually add credentials:
*This is a social media research and archival tool, which collects data for
academic researchers through an accessible user interface.*
* **Enter a Website** such as the SFM url. Any website will work.
* **Enter a Callback URL** such as the same url used for the website field.
* **Enter a Callback URL** that is the SFM url.
* **Review and agree to the Twitter Developer Agreement** and click *Create
your Twitter Application.*
* Recommended:
Expand Down
2 changes: 1 addition & 1 deletion docs/data_dictionary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Twitter Dictionary

For more info about source tweet data, see the `Twitter API documentation
<https://developer.twitter.com/en/docs>`_, including `Tweet data dictionaries
<https://developer.twitter.com/en/docs/tweets/data-dictionary/overview/intro-to-tweet-json.html>`_.
<https://developer.twitter.com/en/docs/tweets/data-dictionary/overview/intro-to-tweet-json>`_.

Documentation about older archived tweets is archived by the Wayback Machine for
the `Twitter API
Expand Down
Binary file added docs/images/quickstart/collection_set.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/quickstart/collection_types.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/quickstart/edit.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/quickstart/excel.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/quickstart/export.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/quickstart/export_page.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/quickstart/harvests.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/quickstart/next_harvest.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/quickstart/on.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/quickstart/options.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/quickstart/seeds.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/quickstart/viz.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 10 additions & 7 deletions sfm/ui/forms.py
Original file line number Diff line number Diff line change
Expand Up @@ -574,12 +574,13 @@ def clean_token(self):

class SeedTwitterSearchForm(BaseSeedForm):
query = forms.CharField(required=False, widget=forms.Textarea(attrs={'rows': 4}),
help_text='See <a href="https://developer.twitter.com/en/docs/tweets/search/overview/operator_descriptions" target="_blank">' \
'these instructions</a> for writing a query. ' \
'Example: firefly OR "lightning bug"')
help_text='See <a href="https://developer.twitter.com/en/docs/tweets/search/guides/'
'standard-operators" target="_blank">'
'these instructions</a> for writing a query. '
'Example: firefly OR "lightning bug"')
geocode = forms.CharField(required=False,
help_text='Geocode in the format latitude,longitude,radius. ' \
'Example: 38.899434,-77.036449,50mi')
help_text='Geocode in the format latitude,longitude,radius. '
'Example: 38.899434,-77.036449,50mi')

def __init__(self, *args, **kwargs):
super(SeedTwitterSearchForm, self).__init__(*args, **kwargs)
Expand Down Expand Up @@ -647,13 +648,15 @@ 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 <a
target="_blank" href="https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/basic-stream-parameters#track">
target="_blank" href="https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/
basic-stream-parameters#track">
track</a> 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 <a
target="_blank"
href="https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/basic-stream-parameters#follow"> follow</a>
href="https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/
basic-stream-parameters#follow"> follow</a>
documentation for a full list of what is returned. User <a target="_blank"
href="https://tweeterid.com/">TweeterID</a> to get the user ID for a screen name.""")
locations = forms.CharField(required=False, widget=forms.Textarea(attrs={'rows': 4}),
Expand Down

0 comments on commit d0a6578

Please sign in to comment.