add outputs docs

diff --git a/docs/exceptions.rst b/docs/exceptions.rst
index 22f0f3f309896fd442e3111c988e0b619eac0276..a7500a7d4115fe1dabcd0950a76e428d8492a7b1 100644 (file)
--- a/docs/exceptions.rst
+++ b/docs/exceptions.rst
@@ -4,14 +4,14 @@ Exceptions
 These are the most common errors and are handled by the ``waybacktweets`` package.
 
 ReadTimeoutError
-----------------
+------------------
 
 This error occurs when a request to the web.archive.org server takes too long to respond. The server could be overloaded or there could be network issues.
 
 The output message from the package would be: ``Connection to web.archive.org timed out.``
 
 ConnectionError
-----------------
+------------------
 
 This error is raised when the package fails to establish a new connection with web.archive.org. This could be due to network issues or the server being down.
 
@@ -23,15 +23,22 @@ This is the error often returned when performing experimental parsing of URLs wi
 The warning output message from the package would be: ``Connection error with https://web.archive.org/web/<TIMESTAMP>/https://twitter.com/<USERNAME>/status/<TWEET_ID>. Max retries exceeded. Error parsing the JSON, but the CDX data was saved.``
 
 HTTPError
-----------------
+------------------
 
 This error occurs when the Internet Archive services are temporarily offline. This could be due to maintenance or server issues.
 
 The output message from the package would be: ``Temporarily Offline: Internet Archive services are temporarily offline. Please check Internet Archive Twitter feed (https://twitter.com/internetarchive) for the latest information.``
 
 EmptyResponseError
-----------------------
+---------------------
 
 This exception raised for empty responses.
 
 The output message from the package would be: ``No data was saved due to an empty response.``
+
+Warning
+------------------
+
+It is possible to encounter the following warning when running the ``TweetsParser`` class (:ref:`parser`): ``<TWEET_URL> not available on the user's Twitter account, but the CDX data was saved.``
+
+This occurs when the original tweet is no longer available on Twitter and has possibly been deleted.

diff --git a/docs/index.rst b/docs/index.rst
index ce4e8af184b1b12930af8643fa667c2a2a176613..46b9945c0bbb50bce29e7bb7b1f5171d0a0a3942 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -25,6 +25,7 @@ User Guide
     quickstart
     workflow
     field_options
+    outputs
     exceptions
     contribute
     todo

diff --git a/docs/outputs.rst b/docs/outputs.rst
new file mode 100644 (file)
index 0000000..365db72
--- /dev/null
+++ b/docs/outputs.rst
@@ -0,0 +1,29 @@
+Outputs
+==========
+
+It is possible to save the CDX data in three formats. In the command line tool, these three formats are saved automatically.
+
+HTML
+--------
+
+This format allows for easy viewing of the archived tweets, through the use of the ``iframe`` tag. Each tweet contains four viewing options, which render when clicking on the accordion:
+
+- ``archived_tweet_url``: (`str`) The archived URL.
+
+- ``parsed_archived_tweet_url``: (`str`) The archived URL after parsing. It is not guaranteed that this option will be archived, it is just a facilitator, as the originally archived URL does not always exist, due to changes in URLs and web services of the social network Twitter. Check the :ref:`utils`.
+
+- ``original_tweet_url``: (`str`) The original tweet URL.
+
+- ``parsed_tweet_url``: (`str`) The original tweet URL after parsing. Old URLs were archived in a nested manner. The parsing applied here unnests these URLs, when necessary.  Check the :ref:`utils`.
+
+Additionally, other fields are displayed.
+
+CSV
+--------
+
+Option to analyze the CDX data in comma-separated values.
+
+JSON
+--------
+
+Option to analyze the data in JavaScript Object Notation.

diff --git a/docs/streamlit.rst b/docs/streamlit.rst
index 62ebc597895ca71feb1ba4cec4cea2e7417b4ba1..56e16f605e8040cface651df2aabb7592e9fb0c3 100644 (file)
--- a/docs/streamlit.rst
+++ b/docs/streamlit.rst
@@ -45,8 +45,7 @@ Community Comments
 Legacy App
 -------------
 
-To access the legacy version (v0.4.3) of Wayback Tweets `click here <https://waybacktweets-legacy.streamlit.app>`_.
-
+To access the legacy version of Wayback Tweets `click here <https://waybacktweets-legacy.streamlit.app>`_.
 
 .. note::