This repository was archived by the owner on Jun 4, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathreadme.html
More file actions
229 lines (229 loc) · 16.4 KB
/
readme.html
File metadata and controls
229 lines (229 loc) · 16.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>Quinter</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
span.underline{text-decoration: underline;}
div.column{display: inline-block; vertical-align: top; width: 50%;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
ul.task-list{list-style: none;}
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
</style>
<!--[if lt IE 9]>
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
<![endif]-->
</head>
<body>
<header id="title-block-header">
<h1 class="title">Quinter</h1>
</header>
<nav id="TOC" role="doc-toc">
<ul>
<li><a href="#project-links."><span class="toc-section-number">1</span> Project links.</a></li>
<li><a href="#what-is-quinter"><span class="toc-section-number">2</span> What is Quinter?</a></li>
<li><a href="#interfaces"><span class="toc-section-number">3</span> Interfaces</a></li>
<li><a href="#main-window."><span class="toc-section-number">4</span> Main window.</a></li>
<li><a href="#keys."><span class="toc-section-number">5</span> Keys.</a>
<ul>
<li><a href="#gui"><span class="toc-section-number">5.1</span> GUI</a></li>
<li><a href="#invisible"><span class="toc-section-number">5.2</span> Invisible:</a></li>
</ul></li>
<li><a href="#templates."><span class="toc-section-number">6</span> Templates.</a>
<ul>
<li><a href="#tweets-retweets-and-quotes."><span class="toc-section-number">6.1</span> Tweets: , retweets, and quotes.</a></li>
<li><a href="#direct-messages"><span class="toc-section-number">6.2</span> Direct Messages:</a></li>
<li><a href="#users"><span class="toc-section-number">6.3</span> Users</a></li>
</ul></li>
<li><a href="#options"><span class="toc-section-number">7</span> Options</a>
<ul>
<li><a href="#global-options"><span class="toc-section-number">7.1</span> Global options</a>
<ul>
<li><a href="#general"><span class="toc-section-number">7.1.1</span> General</a></li>
<li><a href="#templates.-1"><span class="toc-section-number">7.1.2</span> templates.</a></li>
<li><a href="#advanced"><span class="toc-section-number">7.1.3</span> Advanced</a></li>
</ul></li>
<li><a href="#account-options."><span class="toc-section-number">7.2</span> Account options.</a>
<ul>
<li><a href="#general."><span class="toc-section-number">7.2.1</span> General.</a></li>
</ul></li>
</ul></li>
<li><a href="#soundpacks"><span class="toc-section-number">8</span> Soundpacks</a></li>
</ul>
</nav>
<p>Welcome to Quinter!</p>
<h1 data-number="1" id="project-links."><span class="header-section-number">1</span> Project links.</h1>
<ol type="1">
<li><a href="http://github.com/quinterapp/quinter">Source code</a></li>
<li><a href="http://github.com/quinterapp/quinter-soundpacks">Soundpacks repository</a></li>
<li><a href="http://quinterapp.github.io">Main website</a></li>
<li><a href="https://twitter.com/QuinterApp">Main Twitter account</a></li>
<li><a href="https://twitter.com/DevQuinter">Developer updates Twitter account</a></li>
</ol>
<h1 data-number="2" id="what-is-quinter"><span class="header-section-number">2</span> What is Quinter?</h1>
<p>Quinter is a fully accessible, easy-to-use, light-weight Twitter client. It works on both Windows and Mac, and is open sourced, allowing anyone to contribute if they so wish!</p>
<h1 data-number="3" id="interfaces"><span class="header-section-number">3</span> Interfaces</h1>
<p>Quinter has two interfaces. GUI and invisible. Invisible allows you to control Quinter from anywhere on your computer. This is disabled by default, but can be easily enabled in settings. GUI allows you to control Quinter like any other application, with buttons, lists, menus, etc.</p>
<h1 data-number="4" id="main-window."><span class="header-section-number">4</span> Main window.</h1>
<p>The main window of Quinter is simple, allowing anyone (no matter their skill level), to use the application without any issues. It contains two list boxes. One contains all your different timelines (e.g. Home, Mentions, Messages, Likes, etc.), and the other contains all the tweets/messages in that particular timeline.</p>
<p>Quinter also has a standard menu bar, allowing you to carry out many functions right from the menu, without having to remember keys! The menus are as follows.</p>
<ul>
<li>Application: Various application related functions, such as options, update profile, and exit.</li>
<li>Actions: This menu contains various different actions, such as tweet, reply, retweet, like, send direct message, etc.</li>
<li>Users: This menu contains options that let you see mutual follows, people you follow that don’t follow you, and vice versa.</li>
<li>Timeline: The timeline menu let’s you control your currently focused timeline. Refreshing it, getting older items, hiding it, etc.</li>
<li>Audio: The audio menu let’s you handle Quinter’s audio. It let’s you play audio, and adjust the volume of the application.</li>
<li>Navigation: This menu let’s you navigate timelines in advanced ways (e.g. jumping to the next and previous tweet from a user).</li>
<li>Help: This is your standard help menu. You can view this document, view stats for nerds, and a lot more!</li>
</ul>
<h1 data-number="5" id="keys."><span class="header-section-number">5</span> Keys.</h1>
<h2 data-number="5.1" id="gui"><span class="header-section-number">5.1</span> GUI</h2>
<p>You can find out what keys perform what actions by reading through all of the menu options. For example. Reply (Control+R) or command+r on mac.</p>
<h2 data-number="5.2" id="invisible"><span class="header-section-number">5.2</span> Invisible:</h2>
<p>Here are the default keys for the invisible interface on Windows only, as it does not work on Mac. These keys can be easily remapped by editing keymap.keymap.</p>
<ul>
<li>Control+Windows+Shift+T: Show or hide the window. Note: This works even if invisible interface is not enabled.</li>
<li>Control+Windows+T: Send a tweet.</li>
<li>Alt+Windows+left arrow: Previous timeline</li>
<li>Alt+Windows+right Arrow: Next Timeline.</li>
<li>Alt+Windows+Up Arrow: Previous Buffer item.</li>
<li>Alt+Windows+Down Arrow: Next buffer item.</li>
<li>Control+Windows+r: Reply to a tweet.</li>
<li>Control+Windows+Shift+r: Send a retweet.</li>
<li>Alt+Windows+L: Like or unlike a tweet.</li>
<li>Alt+Windows+Q: Quote a Tweet.</li>
<li>Alt+Windows+Control+D: Send a direct message.</li>
<li>Alt+Windows+C: Open a conversation.</li>
<li>Alt+Windows+V: Open the Tweet Viewer</li>
<li>Alt+Windows+Control+Up Arrow: Increase volume.</li>
<li>Alt+Windows+Control+Down Arrow: Turn down the volume.</li>
<li>Alt+Windows+Enter: Open a URL</li>
<li>shift+windows+alt+enter: Play audio in tweet.</li>
<li>control+windows+alt+enter: Play audio in tweet using external media player. Note: You must set the media player up in the options dialog first.</li>
<li>Alt+Windows+Semi Colon: Speak a brief profile overview.</li>
<li>Alt+Windows+Shift+Semi Colon: Speak what a tweet is in reply to.</li>
<li>Alt+Windows+Page Up: Load previous items.</li>
<li>Alt+Windows+U: Open a user’s timeline</li>
<li>Alt+Windows+Shift+U: Open a user’s profile.</li>
<li>Alt+Windows+Tick: Destroy a timeline.</li>
<li>Alt+Windows+Control+U: Refresh.</li>
<li>Alt+Windows+Home: Go to the top of the buffer.</li>
<li>Alt+Windows+End: Go to the end of the buffer.</li>
<li>Alt+Windows+Delete: Delete a tweet.</li>
<li>Alt+Windows+Shift+Q: Exit the program.</li>
<li>Alt+Windows+Left Bracket: View followers.</li>
<li>Alt+Windows+Right bracket: View Friends.</li>
<li>alt+windows+o: Options</li>
<li>control+alt+windows+o: account Options</li>
<li>alt+windows+shift+left: previous tweet from same user</li>
<li>alt+windows+shift+right: next tweet from same user</li>
<li>alt+windows+shift+up: previous tweet in thread</li>
<li>alt+windows+shift+down: next tweet in thread</li>
<li>Control+Windows+Shift+C: Copy the last tweet to the clipboard.</li>
<li>alt+windows+a: Add user to a list</li>
<li>alt+windows+shift+a: Remove user from a list.</li>
<li>alt+windows+control+l: View your lists.</li>
<li>alt+windows+slash: Perform a twitter search.</li>
<li>Control+Windows+A: Open the account manager.</li>
<li>Alt+windows+space: Repeat currently focused item.</li>
<li>Alt+windows+control+a: Speak the current account.</li>
<li>alt + windows + control + shift + enter: open URL to tweet in browser.</li>
<li>alt + windows + e: Toggle autoread for current timeline.</li>
<li>alt + windows + M: Toggle mute for current timeline.</li>
<li>Control+Windows+Page up: Move up 20 items.</li>
<li>Control+Windows+Page down: Move down 20 items.</li>
</ul>
<h1 data-number="6" id="templates."><span class="header-section-number">6</span> Templates.</h1>
<p>Quinter supports a template system, allowing you to choose what information you want shown when viewing tweets, direct messages, retweets, etc. Each bit of information goes between two dollar signs ($), and you can have other symbols outside of the dollar signs. The possible objects are as follows:</p>
<h2 data-number="6.1" id="tweets-retweets-and-quotes."><span class="header-section-number">6.1</span> Tweets: , retweets, and quotes.</h2>
<ul>
<li>user.screen_name: The <span class="citation" data-cites="HANDLE">@HANDLE</span> of the user.</li>
<li>user.name: The display name of the user.</li>
<li>text: The text of the tweet.</li>
<li>created_at: The timestamp of when the item was created.</li>
<li>source: The client it was sent from.</li>
<li>retweet_count: The number of retweets.</li>
<li>favorite_count: The likes count</li>
<li>possibly_sensitive: Is this tweet marked as possibly containing sensative content?</li>
<li>lang: The language of the Tweet</li>
</ul>
<h2 data-number="6.2" id="direct-messages"><span class="header-section-number">6.2</span> Direct Messages:</h2>
<ul>
<li>sender.screen_name: The <span class="citation" data-cites="HANDLE">@HANDLE</span> of the user that sent the message.</li>
<li>sender.name: The display name of the user that sent the message.</li>
<li>recipient.screen_name: The <span class="citation" data-cites="HANDLE">@HANDLE</span> of the user the message was sent to.</li>
<li>recipient.name: The display name of the user that received the message.</li>
<li>text: The text of the message.</li>
<li>created_at: The timestamp of when the item was created.</li>
</ul>
<h2 data-number="6.3" id="users"><span class="header-section-number">6.3</span> Users</h2>
<ul>
<li>name: The display name of the user.</li>
<li>screen_name: the <span class="citation" data-cites="HANDLE">@HANDLE</span> of the user</li>
<li>followers_count: The amount of followers the user has.</li>
<li>friends_count: The number of friends the user has.</li>
<li>statuses_count: The number of tweets sent by the user.</li>
<li>description: The user’s bio.</li>
</ul>
<h1 data-number="7" id="options"><span class="header-section-number">7</span> Options</h1>
<p>Quinter has two different options dialogs. One is for global settings that apply across the hole app. The other is for the currently selected account.</p>
<h2 data-number="7.1" id="global-options"><span class="header-section-number">7.1</span> Global options</h2>
<p>This dialog is divided into multiple tabs. They are as follows.</p>
<ul>
<li>General: General options, such as ask before dismissing timelines.</li>
<li>Templates: Template settings.</li>
<li>Advanced: Options that are exparamental, or could possibly break the app if not used propperly.</li>
</ul>
<h3 data-number="7.1.1" id="general"><span class="header-section-number">7.1.1</span> General</h3>
<ul>
<li>Ask before dismissing timelines: If checked, this will show a warning message when destroying timelines.</li>
<li>Play a sound when a tweet contains audio that is playable by either the client or an external media player: If checked, this option will make Quinter make a sound if you come across a tweet with playable media.</li>
<li>Play a sound when you navigate to a timeline that may have new items: This option will play a sound if a timeline you navigate to has items that might be new (i.e. you’re not at the edge of the timeline).</li>
<li>Remove emojis and other unicode characters from display names: Tired of people with 50 emojis in their names? Check this box, and suffer no more! If the user in questoin has only emojis, the screen name will show instead.</li>
<li>Remove emojis and other unicode characters from tweet text: This option is similar to the username one, but it works with tweet text.</li>
<li>Number of tweets to move when using control+windows+page up/down: This option only applies to the invisible interface. It let’s you choose how much control+windows+page up/down moves you. The default is 20. Allowed ranges are 5 to 50. Anything lower or higher than this, Quinter will round for you.</li>
<li>Reverse timelines (newest on bottom): This option puts the newest tweets at the bottom, rather than at the top.</li>
<li>Word wrap in text fields: If checked, long lines will wrap onto new lines in any text field, including the new tweet dialog.</li>
<li>when getting URLs from a tweet, automatically open the first URL if it is the only one : If a tweet contains only one URL, pressing the open URL command will open it by default if this is checked.</li>
</ul>
<h3 data-number="7.1.2" id="templates.-1"><span class="header-section-number">7.1.2</span> templates.</h3>
<ul>
<li>Tweet template: Customizehow standard tweets and replies are displayed.</li>
<li>Quote template: Customize how quotes are displayed.</li>
<li>Retweet template: Customize how your retweets are shown.</li>
<li>Copy template: Customize what data gets coppied when you copy a tweet to your clipboard.</li>
<li>Direct message template: Customize how your DM’s are shown.</li>
<li>User template: Customize what info is shown in user summaries.</li>
</ul>
<h3 data-number="7.1.3" id="advanced"><span class="header-section-number">7.1.3</span> Advanced</h3>
<ul>
<li>Enable invisible interface (exparimental): Enables the global hotkeys.</li>
<li>Sync invisible interface with UI (uncheck for reduced lag in invisible interface): If unchecked, this optoin aims to way improve performance in the invisible interface.</li>
<li>Repeat items at edges of invisible interface: If this is checked, when you hit an edge in the invisible interface, it will repeat.</li>
<li>Speak position information when navigating between timelines of invisible interface and switching timelines: If checked, you will be told how far down a timeline you are when navigating to it.</li>
<li>Update time (in minutes): This changes how frequently the API tries to pull for new tweets.</li>
<li>Max API calls when fetching users in user viewer: This changes how many followers and friends you can pull when viewing them. One request = 200 followers/friends.</li>
<li>Number of tweets to fetch per call (Maximum is 200): Changes how many tweets you pull per request (mainly noticeable on startup).</li>
<li>Enable streaming for home, mentions, and list timelines (This is very experimental! Requires restart to disable): Enables very, very exparamental and breaky streaming API support.</li>
<li>External media player. You can choose your media player of choice here.</li>
</ul>
<h2 data-number="7.2" id="account-options."><span class="header-section-number">7.2</span> Account options.</h2>
<p>This dialog doesn’t currently contain much, and currently only contains the following tabs:</p>
<ul>
<li>General: General options.</li>
</ul>
<h3 data-number="7.2.1" id="general."><span class="header-section-number">7.2.1</span> General.</h3>
<ul>
<li>Soundpacks: Let’s you choose your soundpack.</li>
<li>Sound pan: This allows you to pan account-specific sounds to a different position in the stereo field, so you don’t have to use different sound packs for different accounts.</li>
<li>Tweet Footer (optional): This allows you to automatically append some text to the end of your tweets. Like a hashtag if tweeting about an event.</li>
</ul>
<h1 data-number="8" id="soundpacks"><span class="header-section-number">8</span> Soundpacks</h1>
<p>Quinter supports soundpacks, allowing you to customize Quinter to sound however you like! The official soundpacks repository can be found <a href="https://github.com/quinterApp/quinter-soundpacks">here</a>. To use a soundpack, put the folder containing all the sounds into either the sounds folder in your quinter directory, or in .config/quinter/sounds. Select it from the list in account options, and you’re good to go!</p>
<p>Enjoy!</p>
</body>
</html>