Files
tuir/rtv/docs.py
woorst cdee4ab615 typo
2019-02-02 21:27:35 -05:00

189 lines
5.0 KiB
Python

# -*- coding: utf-8 -*-
from __future__ import unicode_literals
AGENT = """\
desktop:https://github.com/michael-lazar/rtv:{version}\
(by /u/civilization_phaze_3)\
"""
SUMMARY = """
RTV (Reddit Terminal Viewer) is a terminal interface to view and interact with reddit.
"""
USAGE = """\
rtv [URL] [-s SUBREDDIT]
$ rtv https://www.reddit.com/r/programming/comments/7h9l31
$ rtv -s linux
"""
CONTROLS = """
Move the cursor using the arrow keys or vim style movement.
Press `?` to open the help screen.
"""
HELP = """\
====================================
Reddit Terminal Viewer
https://github.com/michael-lazar/rtv
====================================
[Commands]
j : Move the cursor down
k : Move the cursor up
n : Move down one page
m : Move up one page
gg : Jump to the first post
G : Jump to the last post
J : Jump to the next sibling comment
K : Jump to the parent comment
1 : Sort by hot
2 : Sort by top
3 : Sort by rising
4 : Sort by new
5 : Sort by controversial
6 : Sort by gilded
p : Return to the front page
r : Refresh page
u : Login or logout
/ : Open the subreddit prompt
f : Open the search prompt
? : Show the help screen
q : Quit
Q : Force quit
a : Upvote
z : Downvote
c : Compose a new submission/comment
e : Edit a submission/comment
d : Delete a submission/comment
i : Display new messages
s : Show subscribed subreddits
S : Show subscribed multireddits
w : Save a submission/comment
l : View comments, or open comment in pager
h : Return to subreddit
o : Open the submission or comment url
SPACE : Hide a submission, or fold/expand the selected comment tree
b : Display urls with urlview
y : Copy submission permalink to clipboard
Y : Copy submission or comment urls to clipboard
F2 : Cycle to previous theme
F3 : Cycle to next theme
[Prompt]
The `/` prompt accepts subreddits in the following formats
- python
- /r/python
- /r/python/new (sort)
- /r/python/controversial-year (sort and order)
- /r/python/gilded (gilded within subreddit)
- /r/python+linux (multireddit)
- /r/python/comments/30rwj2 (submission comments)
- /comments/30rwj2 (submission comments shorthand)
- /r/front (front page)
- /u/me (your submissions overview)
- /u/me/{saved,hidden} (your saved or hidden posts)
- /u/me/{upvoted,downvoted} (your voted posts)
- /u/spez (a user's submissions overview)
- /u/spez/{submitted,comments} (a user's posts or comments)
- /u/multi-mod/m/android (curated multireddit)
- /domain/python.org (search by domain)
"""
BANNER_SUBREDDIT = """
[1]hot [2]top [3]rising [4]new [5]controversial [6]gilded
"""
BANNER_SUBMISSION = """
[1]hot [2]top [3]rising [4]new [5]controversial
"""
BANNER_SEARCH = """
[1]relevance [2]top [3]comments [4]new
"""
FOOTER_SUBREDDIT = """
[?]Help [q]Quit [l]Comments [/]Prompt [u]Login [o]Open [c]Post [a/z]Vote [r]Refresh
"""
FOOTER_SUBMISSION = """
[?]Help [q]Quit [h]Return [space]Fold/Expand [o]Open [c]Comment [a/z]Vote [r]Refresh
"""
FOOTER_SUBSCRIPTION = """
[?]Help [q]Quit [h]Return [l]Select
"""
TOKEN = "INSTRUCTIONS"
COMMENT_FILE = """<!--{token}
Replying to {{author}}'s {{type}}:
{{content}}
Enter your reply below this instruction block,
an empty message will abort the comment.
{token}-->
""".format(token=TOKEN)
COMMENT_EDIT_FILE = """<!--{token}
Editing comment #{{id}}.
The comment is shown below, update it and save the file.
{token}-->
{{content}}
""".format(token=TOKEN)
SUBMISSION_FILE = """<!--{token}
Submitting a selfpost to {{name}}.
Enter your submission below this instruction block:
- The first line will be interpreted as the title
- The following lines will be interpreted as the body
- An empty message will abort the submission
{token}-->
""".format(token=TOKEN)
SUBMISSION_EDIT_FILE = """<!--{token}
Editing submission #{{id}}.
The submission is shown below, update it and save the file.
{token}-->
{{content}}
""".format(token=TOKEN)
OAUTH_ACCESS_DENIED = """\
<h1 style="color: red">Access Denied</h1><hr>
<p><span style="font-weight: bold">Reddit Terminal Viewer</span> was
denied access and will continue to operate in unauthenticated mode,
you can close this window.</p>
"""
OAUTH_ERROR = """\
<h1 style="color: red">Error</h1><hr>
<p>{error}</p>
"""
OAUTH_INVALID = """\
<h1>Wait...</h1><hr>
<p>This page is supposed to be a Reddit OAuth callback.
You can't just come here hands in your pocket!</p>
"""
OAUTH_SUCCESS = """\
<h1 style="color: green">Access Granted</h1><hr>
<p><span style="font-weight: bold">Reddit Terminal Viewer</span>
will now log in, you can close this window.</p>
"""
TIME_ORDER_MENU = """
Links from:
[1] Past hour
[2] Past 24 hours
[3] Past week
[4] Past month
[5] Past year
[6] All time
"""