Merge pull request #828 from MCV-Software/dependabot/pip/coverage-7.10.4

Bump coverage from 7.10.3 to 7.10.4

.github/dependabot.yml

@@ -0,0 +1,13 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+    ignore:
+      - dependency-name: "lief"

.github/workflows/release.yml

@@ -0,0 +1,49 @@
+# Release a new TW Blue installer on github.
+# This workflow runs on push.
+name: Release
+on:
+  push:
+    tags:
+      - v20*
+  workflow_dispatch:
+
+jobs:
+  build:
+  # Builds an x64 binary and an installer of TW Blue.
+    runs-on: windows-latest
+    steps:
+      - name: clone repo
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Get python interpreter
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Install python packages
+        run: python -m pip install -r requirements.txt
+
+      - name: Build binary
+        run: |
+          .\scripts\build.ps1
+          mv src/dist scripts\TWBlue64
+
+      - name: make installer
+        run: |
+          cd scripts
+          makensis twblue.nsi
+
+      - name: Create portable
+        working-directory: scripts\TWBlue64
+        run: |
+          7z a -tzip TWBlue_portable.zip .
+
+      - name: Create new release
+        env:
+          gh_token: ${{ github.token }}
+        run: |
+          mkdir .release-assets
+          mv scripts\TWBlue_setup.exe .release-assets\TWBlue_setup_${{github.ref_name}}.exe
+          mv scripts\TWBlue64\TWBlue_portable.zip .release-assets\TWBlue_portable_${{github.ref_name}}.zip
+          gh release create "${{github.ref_name}}" -F "release-notes.md" -t "${{github.ref_name}}" .release-assets\TWBlue_setup_${{github.ref_name}}.exe .release-assets\TWBlue_portable_${{github.ref_name}}.zip

.github/workflows/update-translations.yml

@@ -0,0 +1,32 @@
+name: Update translation files
+
+on: 
+  workflow_dispatch:
+  schedule:
+    - cron: "35 0 * * 0"
+
+permissions: write-all
+
+jobs:
+
+  update_catalogs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+        cache: 'pip'
+    - name: Install dependencies
+      run: pip install babel
+    - name: Extract messages
+      run: pybabel extract -o twblue.pot --msgid-bugs-address "manuel@manuelcortez.net" --copyright-holder "MCV software" --input-dirs .
+      working-directory: 'src'
+    - name: Update catalogs
+      run: pybabel update --input-file twblue.pot --domain twblue --output-dir locales
+      working-directory: 'src'
+    - uses: stefanzweifel/git-auto-commit-action@v4
+      with:
+        commit_message: Updated translation catalogs
+        repository: src/locales

.gitignore

@@ -16,4 +16,9 @@ src/Microsoft.VC90.CRT
 src/Microsoft.VC90.MFC
 src/launcher.bat
 src/sounds/iOs
-release-snapshot/
+release-snapshot/
+src/com_cache/
+doc/strings.py
+doc/changelog.py
+env/
+version.txt

COPYING

@@ -0,0 +1,6 @@
+Tw Blue is free software, licensed under the GNU GPL license, either version 2 or, at your option, any later version. You can view the license in the file named license.txt, or online at http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+Copyright © 2013-2018. Manuel Cortéz
+
+Documentation is written by Sukil Etxenike, Brian Hartgen and Bill Dengler, covered by the Creative Commons Attribution-NonCommercial-ShareAlike 2.5 license. You can read the license at https://creativecommons.org/licenses/by-nc-sa/2.5/
+
+The accessible_output2, audio_services, keyboard_handler, libloader, platform_utils and sound_lib modules are written  by Christofer Toth and modified by the TWBlue Team, released under a MIT license. You can get the original modules at http://hg.q-continuum.net.

README.md

@@ -1,81 +1,49 @@
-TWBlue -
+TWBlue
 ======
 
-Copyright (C) 2015. [Technow S.L.](https://www.technow.es)
+![Release status badge](https://github.com/mcv-software/twblue/actions/workflows/release.yml/badge.svg)
 
-TW Blue is an app designed to use Twitter simply and efficiently while using minimal system resources.
-With this app you’ll have access to twitter features such as:
+TWBlue is a free and open source application that allows you to interact with the main features of mastodon from the comfort of a windows software, with 2 different interfaces specially designed for screen reader users.
 
-* Create, reply to, retweet and delete tweets,
-* Add and remove tweets from favourites,
-* Send and delete direct messages,
-* See your friends and followers,
-* Follow, unfollow, block and report users as spam,
-* Open a user’s timeline, which will allow you to get that user’s tweets separately,
-* Open URLs when attached to a tweet or direct message,
-* Play audio tweets
-* and more!
+See [TWBlue's webpage](https://twblue.mcvsoftware.com) for more details.
 
-See [TWBlue's webpage](http://twblue.es) for more details.
+## Running TWBlue from source
 
-## Using TWBlue from sources
-
-This document describes how to run tw blue from source, and, after that, how to build a binary version, which doesn't need Python and the other dependencies to run.
+This document describes how to run tw blue from source and how to build a binary version which doesn't need Python and the other dependencies to run.
 
 ### Required dependencies.
 
 Although most dependencies can be found in the windows-dependencies directory, we provide links to their official websites. If you are cloning with git, don't forget to initialize and update the submodules to get the windows-dependencies folder. You can use these two commands to perform this task from git bash:  
+```
     git submodule init  
     git submodule update
-
-	All the dependencies provided in this folder are prebuilt. If you want to build them from source, you will need Microsoft visual Studio 2008.
+```
 
 #### Dependencies packaged in windows installers
 
-* [Python,](http://python.org) version 2.7.10  
-If you want to build both x86 and x64 binaries, you can install python x86 to C:\python27 and python x64 to C:\python27x64, for example.
-* [wxPython](http://www.wxpython.org) for Python 2.7, version 3.0.2.0
-* [Python windows extensions (pywin32)](http://www.sourceforge.net/projects/pywin32/) for python 2.7, build 219
-* [Pycurl](http://pycurl.sourceforge.net) 7.19.5.1 for Python 2.7: [32-bit downloads,](https://pypi.python.org/pypi/pycurl/7.19.5.1) [64-bit downloads](http://www.lfd.uci.edu/~gohlke/pythonlibs/)
-Note: the x64 version is in wheel format instead of executable installer, so you have to install it using pip. For example: C:\python27x64\scripts\pip install pycurl-7.19.5.1-cp27-none-win_amd64.whl
-* [PyEnchant,](http://pythonhosted.org/pyenchant/) version 1.6.6.  
-x64 version has been built by TWBlue developers, so you only will find it in windows-dependencies folder
+* [Python,](https://python.org) version 3.10.8  
 
-The windows installers are available only in the windows-dependencies folder
+#### Dependencies that must be installed using pip
 
-To build a binary version:
+Python installs a tool called Pip that allows to install packages in a simple way. You can find it in the python scripts directory. To install packages using Pip, you have to navigate to the scripts directory using a command prompt, for example:
 
-* [Py2exe](http://www.sourceforge.net/projects/py2exe/) for Python 2.7, version 0.6.9
+    `cd C:\python310\scripts`
 
-#### Dependencies that must be installed using easy_install
-
-setuptools install a script, called easy_install. You can find it in the python scripts directory. To install packages using easy_install, you have to navigate to the scripts directory using a command prompt, for example:
-
-    cd C:\python27x64\scripts
-
-	You can also add the scripts folder to your path environment variable.
+	You can also add the scripts folder to your path environment variable or choose the corresponding option when installing Python.  
 	Note: pip and setuptools are included in the Python installer since version 2.7.9.
 
-	After that, run the following command to install a package, replacing packagename with the names listed below:
+Pip is able to install packages listed in a special text file, called the requirements file. To install all remaining dependencies, perform the following command:
 
-    easy_install -Z package
+    `pip install -r requirements.txt`
 
-	The -z switch unzips the package, instead of installing it compressed. If you add the --upgrade switch, you can upgrade a package to its latest version. The following packages need to be installed:
+Note that if you perform the command from the path where Pip is located, you need to specify the path to your Tw Blue root folder where the requirements file is located, for example:
 
-* pypubsub
-* configobj
-* requests-oauthlib
-* future
-* pygeocoder
-* suds
-* arrow
-* goslate
-* markdown
-* pocket
+    `pip install -r D:\repos\TwBlue\requirements.txt`
 
-easy_install will automatically get the additional libraries that these packages need to work properly.
-Run the following command to quickly install and upgrade all packages and their dependencies:
-easy_install -Z --upgrade six configobj goslate markdown future pocket suds requests oauthlib requests-oauthlib pypubsub pygeocoder arrow
+Pip will automatically get the additional libraries that the listed packages need to work properly.  
+If you need to update your dependencies, perform the following command:
+
+    `pip install --upgrade -r requirements.txt`
 
 #### Other dependencies
 
@@ -84,26 +52,34 @@ These dependencies are located in the windows-dependencies directory. You don't
 * Bootstrap 1.2.1: included in dependencies directory.  
 This dependency has been built using pure basic 4.61. Its source can be found at http://hg.q-continuum.net/updater
 * [oggenc2.exe,](http://www.rarewares.org/ogg-oggenc.php) version 2.87  
-* Microsoft Visual c++ 2008 redistributable dlls.
+* Microsoft Visual c++ 2019 redistributable dlls.
+* VLC plugins and DLL libraries.
 
 #### Dependencies required to build the installer
 
-* [NSIS unicode,](http://www.scratchpaper.com/) version 2.46.5
+* [NSIS,](http://nsis.sourceforge.net/) version 3.04
+
+#### Dependencies to make the spell checker multilingual
+
+In order to add the support for spell checking in more languages than english you need to add some additional dictionaries to pyenchant. These are located on the dictionaries folder under windows-dependencies. Simply copy them to the share/enchant/myspell folder located in your enchant installation. They will be automatically copied when building a binary version.
 
 ### Running TW Blue from source
 
-Now that you have installed all these packages, you can run TW Blue from source using a command prompt. Navigate to the repo's src directory, and type the following command:
+Now that you have installed all these packages, you can run TW Blue from source using a command prompt. Navigate to the repo's `src` directory, and type the following command:
 
-    python main.py
+    `python main.py`
 
-	If necessary, change the first part of the command to reflect the location of your python executable. You can run TW Blue using python x86 and x64
+	If necessary, change the first part of the command to reflect the location of your python executable.
 
 ### Generating the documentation
 
-To generate the documentation in html format, navigate to the doc folder inside this repo. After that, run this command:
-python generator.py
-The documentation will be generated, placing each language in a separate folder in the doc directory. Move these folders (for example de, en, es, fr, it, ...) to src/documentation, creating the directory if necesary.
-Also, copy the license.txt located in the root of the repo to the documentation folder.
+To generate the documentation in html format, navigate to the doc folder inside this repo. After that, run these commands:  
+
+    `python documentation_importer.py`  
+    `python generator.py`  
+
+The documentation will be generated, placing each language in a separate folder in the doc directory. Move these folders (for example `de`, `en`, `es`, `fr`, `it`, ...) to `src/documentation`, creating the directory if necessary.  
+Also, copy the `license.txt` file located in the root of the repo to the documentation folder.
 
 ### Building a binary version
 
@@ -111,21 +87,25 @@ A binary version doesn't need python and the other dependencies to run, it's the
 
 To build it, run the following command from the src folder:
 
-    python setup.py py2exe
+    `python setup.py build`
 
 	You will find the binaries in the dist directory.
 
 ### Building an installer
 
-If you want to install TWBlue in your computer, you must create the installer first. Follow these steps:
+If you want to install TWBlue on your computer, you must create the installer first. Follow these steps:
 
-* Navigate to the src directory, and create a binary version for x86: C:\python27\python setup.py py2exe
-* Move the dist directory to the scripts folder in this repo, and rename it to twblue
-* Repeat these steps with Python for x64: C:\python27x64\python setup.py py2exe
-* Move the new dist directory to the scripts folder, and rename it to twblue64
+* Navigate to the src directory, and create a binary version: C:\python310\python setup.py build
+* Move the dist directory to the scripts folder in this repo, and rename it to twblue64
 * Go to the scripts folder, right click on the twblue.nsi file, and choose compyle unicode NSIS script
 * This may take a while. After the process, you will find the installer in the scripts folder
 
 ### How to generate a translation template
 
-Run the gen_pot.bat file, located in the tools directory. Your python installation must be in your path environment variable. The pot file will appear in the tools directory.
+To manage translations in TWBlue, you can install the [Babel package.](https://pypi.org/project/Babel/) You can extract message catalogs and generate the main template file with the following command:
+
+```bash
+pybabel extract -o twblue.pot --msgid-bugs-address "manuel@manuelcortez.net" --copyright-holder "MCV software" --input-dirs ..\src
+```
+
+Take into account, though, that we use [weblate](https://weblate.mcvsoftware.com) to track translation work for TWBlue. If you wish to be part of our translation team, please open an issue so we can create an account for you in Weblate.

contributors.txt

@@ -1,12 +1,8 @@
 Manuel E. Cortéz
 Bill Dengler
-Johana Hidrobo
-Marcelo Sosa
-Isabel del Castillo
 José Manuel Delicado
 David Picón
 Vicente Llopis
-Javier Dorado
 Guillem León
 Marco Serrano
 Bryner Villalobos
@@ -34,4 +30,14 @@ Holly Scott-Gardner
 Anibal Hernández
 Sussan Leiva
 Brian Hartgen
-PEDRO REINA COLOBON
+PEDRO REINA COLOBON
+Blake Oliver
+Steffen Schultz
+Riku
+Burak Yüksek
+florian Ionașcu
+Christian Leo Mameli
+Natalia Hedlund (Наталья Хедлунд)
+Valeria (Валерия)
+Corentin Bacqué-Cazenave
+Artem Plaksin (maniyax)

doc/application.py

@@ -1,7 +0,0 @@
-# -*- coding: utf-8 -*-
-name = 'TWBlue'
-snapshot = False
-if snapshot == False:
- version = "0.80"
-else:
- version = "7"

doc/changelog.md

@@ -0,0 +1,446 @@
+TWBlue Changelog
+
+## changes in this version
+
+In this version, we have focused on providing initial support for Mastodon filters and pinned posts. From TWBlue, it is now possible to initially use filters for posts in most buffers, as well as manage them (create, edit, and delete filters, in addition to adding keywords). A new variable has also been added for post templates in the invisible interface that allows displaying whether a post has been pinned by its author.
+
+* Mastodon:
+    * Added filters support to TWBlue. Filters are only implemented in posts for the moment. TWBlue will, depending in the selected settings, hide behind a content warning or completely ignore a post based on filters. Also it is possible to add, delete or edit filters from the buffer menu in the menu bar.
+    * A language selector has been added for posting in TWBlue. It is now possible to choose the language in which a post will be made, which will be useful for content filtering and other language-dependent features. The default language can be chosen based on your Mastodon account’s language, the language of the post you’re replying to, or, if no automatic selection is possible, TWBlue’s own language will be used by default.
+    * TWBlue now supports announcing (via a new template variable for posts) pinned posts. You can edit your posts template and use the $pinned variable. When reading the post, TWBlue will indicate if the post is pinned. Also, when loading an user timeline, pinned posts will be loaded at the top or bottom of the buffer according to local settings.
+    * TWBlue should be able to display all posts in the post displayer dialog.
+    * reading long posts in the graphical user interface should work better.
+
+## Changes in version 2024.5.23
+
+* Core:
+    * The way sessions are named has been changed. Now the account is indicated first, followed by the social network it belongs to.
+    * An option has been added to the global options dialog that allows for the reading of long posts in the graphical interface. This is especially useful since, by default, the graphical interface can only display a limited number of characters in the post.
+    * Some options that are no longer necessary in the application have been removed from the global settings dialog.
+* Mastodon:
+    * fixed an error that caused TWBlue to not display some posts correctly.
+    * Fixed name for community timelines when created during startup. Now it should be clear if it's a federated or local timeline.
+    * Defined shortcuts to fields on the update profile dialog so it will be easier to navigate.
+    * Now it is possible to load conversations directly from community timelines.
+
+## Changes in version 2024.5.19
+
+In this version of TWBlue, which is being released several months after the previous one, we focused on adding initial support for GoToSocial-type networks. GoToSocial is a server for creating decentralized networks similar to Mastodon. Its API is very similar but retains some differences. In this version, TWBlue can be used to log into GoToSocial accounts, although there will be some features, such as the Streaming API and Markdown support, that are not yet functional. Another significant addition is support for creating community timelines, which will allow you to load the local and public timeline of remote instances. This is useful if your instance does not federate directly with them, as it will allow you to see posts from other communities and interact directly with them. Finally, the translation module has been rewritten; it now supports using LibreTranslate by default and DeepL, for which an API key is required. Below is the detailed list of changes:
+
+* Core:
+    * Added Initial Support to GoToSocial. Some features are not fully implemented yet, although GoToXocial instances should be able to be used as normal sessions in TWBlue. Streaming, poll options and markdown are not supported but planned for the near future.
+    * The translation module has been rewritten. Now, instead of offering translations with Google Translator, the user can choose between [LibreTranslate,](https://github.com/LibreTranslate/LibreTranslate) which requires no configuration thanks to the [instance of the NVDA Spanish community;](https://translate.nvda.es) or translate using [DeepL,](https://deepl.com) for which it is necessary to create an account on DeepL and [subscribe to a DeepL API Free plan](https://support.deepl.com/hc/en-us/articles/360021200939-DeepL-API-Free) to obtain the API key which can be used to translate up to 500000 characters every month. The API key can be entered in the global options dialog, under a new tab called translation services. When translating a text, the translation engine can be changed. When changing the translation engine, the target language must be selected again before translation takes place.
+    * TWBlue should be able to switch to Windows 11 Keymap when running under Windows 11. ([#494](https://github.com/mcv-software/twblue/issues/494))
+* Mastodon:
+    * Added support for viewing communities: A community timeline is the local or public timeline of another instance. This is especially useful when the instance one is part of does not federate with other remote instances. The posts displayed are only those that are shared publicly. It is possible to interact with the posts from community timelines, but it should be noted that TWBlue will take some time to retrieve the post one wishes to interact with.
+    * When viewing a post, a button displays the number of boosts and times it has been added to favorites. Clicking on that button will open a list of users who have interacted with the post. From that list, it is possible to view profiles and perform common user actions.
+    * Now it is possible to mute conversations in Mastodon sessions. To do this, there is a button that can be called "Mute" or "Unmute Conversation" in the dialog to display the post. Conversations that have been muted will not generate notifications or mentions when they receive new replies. Only conversations that you are a part of can be muted.
+    * Fixed an error that caused TWBlue to be unable to properly display the user action dialog from the followers or following buffer. ([#575](https://github.com/mcv-software/twblue/issues/575))
+
+## changes in version 2024.01.05
+
+* Core:
+    * The TWBlue website will no longer be available on the twblue.es domain. Beginning in January 2024, TWBlue will live at https://twblue.mcvsoftware.com. Also, we will start releasing versions on [gitHub releases](https://github.com/mcv-software/twblue/releases) so it will be easier to track specific versions.
+    * As of the first release of TWBlue in 2024, we will officially stop generating 32-bit (X86) compatible binaries due to the increasing difficulty of generating versions compatible with this architecture in modern Python.
+    * TWBlue should be more reliable when checking for updates.
+    * If running from source, automatic updates will not be checked as this works only for distribution. ([#540](https://github.com/MCV-Software/TWBlue/pull/540))
+    * Fixed the 'report an error' item in the help menu. Now this item redirects to our gitHub issue tracker. ([#524](https://github.com/MCV-Software/TWBlue/pull/524))
+* Mastodon:
+    * Implemented actions for the notifications buffer on a mastodon instance. Actions can be performed from the contextual menu on every notification, or by using invisible keystrokes. ([#517](https://github.com/mcv-software/twblue/issues/517))
+    * Implemented update profile dialog. ([#547](https://github.com/MCV-Software/TWBlue/pull/547))
+    * It is possible to display an user profile from the user menu within the menu bar, or by using the invisible keystroke for user details. ([#555](https://github.com/MCV-Software/TWBlue/pull/555))
+    * Added possibility to vote in polls. This is mapped to Alt+Win+Shift+V in the invisible keymaps for windows 10/11.
+    * Added posts search. Take into account that Mastodon instances should be configured with full text search enabled. Search for posts only include posts the logged-in user has interacted with. ([#541](https://github.com/MCV-Software/TWBlue/pull/541))
+    * Added user autocompletion settings in account settings dialog, so it is possible to ask TWBlue to scan mastodon accounts and add people from followers and following buffers. For now, user autocompletion can be used only when composing new posts or replies.
+    * TWBlue should be able to ignore deleted direct messages or messages from deleted accounts. Previously, a direct message that no longer existed in the instance caused errors when loading the direct messages buffer and could potentially affect notifications as well.
+    * TWBlue should be able to ignore notifications from deleted accounts or posts.
+
+## changes in version 2023.4.13
+
+During the development of the current TWBlue version, Twitter has cut out access from their API, meaning TWBlue will no longer be able to communicate with Twitter. This is the end of the support of TWBlue for Twitter sessions. No new sessions will be available for this social network, and we will focus in adding more features to our Mastodon support and writing support for more websites and networks. Thank you everyone who have been using TWBlue to manage your Twitter accounts since 2013.
+
+* TWBlue should be able to display variables within templates (for example, now it is possible to send a template inside a post's text). Before, it was removing $variables so it was difficult to show how to edit templates from the client. ([#515](https://github.com/MCV-Software/TWBlue/issues/515))
+* Mastodon:
+    * it is possible to add descriptions for all media available on Mastodon (audio, photos, video and Givs). ([#516](https://github.com/MCV-Software/TWBlue/issues/516))
+    * TWBlue can now perform OCR in attached images.
+    * It is possible to add aliases to mastodon users. Also, the "manage user aliases" setting, located on the application menu within the menu bar can be used to add, edit or remove aliases.
+    * Implemented "Hide emojis on usernames" in both GUI and invisible interface.
+    * Added an experimental feature to recover from connection errors. When making a post, if the post cannot be published due to any kind of error, TWBlue will bring up the dialog where the post was composed, so you can give the post a second chance or save the post's text. This feature should work for threads, posts with attachments, polls and replies. ([#527,](https://github.com/MCV-Software/TWBlue/issues/527) [#526,](https://github.com/MCV-Software/TWBlue/issues/526) [#377,](https://github.com/MCV-Software/TWBlue/issues/377) [#137,](https://github.com/MCV-Software/TWBlue/issues/137) [#108](https://github.com/MCV-Software/TWBlue/issues/108))
+    * When playing media items, TWBlue will prefer remote URL streams and fall back to instance cached stream URL'S.
+    * Fixed an error on mentions buffer that was making TWBlue unable to load posts if there were mentions from a blocked or deleted account.
+    * Fixed an error when loading timelines during startup where TWBlue was unable to change the buffer title properly.
+
+## Changes on version 2023.2.8
+
+This release focuses on fixing some important bugs that have been reported in the previous version. Particularly, TWBlue should be able to authorize on some instances that have blocked the Mastodon.py library, and should be able to avoid repeatedly calling some endpoints that cause excessive connections for some instances. Additionally, it is possible to disable Streaming from the account options in Mastodon. This can be especially useful if TWBlue keeps making a lot of API calls for some instances.
+
+* Fixed the update system.
+* Fixed a bug when attempting to switch between different accounts using the invisible interface, if the focused account is not an active session.
+* Mastodon:
+    * Improved the way TWBlue counts characters in Mastodon. Now it counts only the username part in a remote user (@domain is not counted against character limit), adds content warning text to character count, also emojis and CJK characters are counted as 1 as opposed to 2. ([#511](https://github.com/MCV-Software/TWBlue/issues/511))
+    * Added notification when a user joins an instance. This notification is only available for administrators.
+    * Added option to disable Streaming in the account options. This can be useful if TWBlue, for some reason, repeatedly calls the instance API.
+    * Improved the code that works with the Streaming API to reduce the number of reconnection attempts TWBlue performs.
+    * Fixed media uploads for audio, video and gifvs. ([#513](https://github.com/MCV-Software/TWBlue/issues/513))
+
+## Changes in version 2023.2.3
+
+In this version, TWBlue will no longer support Twitter sessions starting on February 9, due to Twitter's policies prohibiting third-party clients, in addition to the shutdown of the free access to the Twitter API. All Twitter sessions that are active on TWBlue will stop working as of February 9, when the free API access will finally be shut down. It will not be possible to display or add Twitter sessions from the Session manager. From the TWBlue team, we will continue working to improve our support for Mastodon instances and add other social networks in the near future. If you want to keep in touch with the project, you can follow us in our mastodon account, at [@twblue@maaw.social.](https://maaw.social/@twblue)
+
+* In the graphical interface, TWBlue will update menu items, in the menu bar, depending on whether you are focusing a Twitter or Mastodon session. This makes it possible for TWBlue to display the correct terms in each social network. Take into account that there might be unavailable items for the currently active session.
+* in the keystroke editor for the invisible interface, TWBlue displays the available shortcuts for the currently active session. Descriptions of those keystrokes are also different for Twitter and mastodon sessions to use correct terms for both networks.
+* In the invisible interface, TWBlue will skip sessions that have not been started when using the keyboard shortcut to switch between different accounts.
+* Fixed a bug when deleting a session in the session manager dialog. Sessions can now be deleted correctly.
+* Mastodon:
+    * Added basic support to notifications buffer. This buffer shows mastodon notifications in real time. Every notification is attached to a kind of object (posts, users, relationships or polls). At the moment, the only supported action for notification is dismissing, which allows you to remove the notification from the buffer (take into account, though, that mention notifications will remove also the mention in its corresponding buffer, due to the way TWBlue reads mentions from mastodon instances).
+    * Fixed an issue that was preventing TWBlue to create more than one user timeline during startup.
+    * Fixed getting more items in mentions buffer. ([#508](https://github.com/mcv-software/twblue/issues/508))
+    * TWBlue will display properly new paragraphs in mastodon posts.
+    * In the session manager, Mastodon sessions are now displayed including the instance to avoid confusion.
+    * TWBlue will now read default visibility preferences when posting new statuses, and display sensitive content. These preferences can be set on the mastodon instance, in the account's preferences section. If you wish to change TWBlue's behavior and have it not read those preferences from your instance, but instead set the default public visibility and hide sensitive content, you can uncheck the Read preferences from instance checkbox in the account options.
+    * If a mastodon instance is not active or there are errors during login, TWBlue will report it in the log file and will continue with other sessions.
+    * When replying to someone in a public post, TWBlue will default to "unlisted" as its visibility setting. This is done so replies will not clutter local and federated timelines. This setting might be changed when writing the reply, though. ([#504,](https://github.com/MCV-Software/TWBlue/issues/504))
+    * TWBlue uses its own user agent in Mastodon sessions, so it will be easier to identify the client for instance admins.
+    * TWBlue will check if the streaming API endpoints are available before attempting to start Streaming for the current session. Before, TWBlue caused load issues in misconfigured mastodon instances where the streaming API were not available.
+
+## Changes in version 2022.12.13
+
+* per popular request, We will generate a 32-bit portable version of TWBlue available for Windows 7 operating systems. This version will not be supported in our automatic updater, so in case of using such version, you would need to download it manually every time there is a new update. TWBlue will continue to be available for Windows 7 as long as it is possible to build it using Python 3.7.
+* Fixed a couple of bugs that were making TWBlue unable to be opened in some computers, related to our translator module and some COM objects handled incorrectly.
+* Fixed an issue that was making TWBlue unable to open in certain computers due to errors related to Win32 API'S.
+* Twitter:
+    * Fixed a bug that was making sent direct messages to be placed in received direct messages buffer.
+    * When quoting a tweet, you can use all 280 characters to send your quoted tweet, as opposed to the 256 characters TWBlue allowed before.
+    * Fixed a bug that was making TWBlue unable to reply to direct messages by using the "reply" keystroke.
+* Mastodon:
+    * Added account settings dialog.
+    * Added template editing functionality for mastodon accounts.
+    * When a post is edited, TWBlue will update the post object in the buffer to reflect the latest edit.
+    * Fixed a small issue that was preventing TWBlue to display some posts in their corresponding dialog.
+
+## Changes in version 2022.12.6
+
+Most of all changes in this release are focused on adding Mastodon support to TWBlue. The features present to handle Twitter should not have been altered in any way. We were not intended to release this version so soon, but unfortunately, Twitter started to present issues in some regions with one particular API endpoint we were using, making impossible for everyone in such regions to use the application. We will release more updates to fix any possible issue regarding Twitter API, but please take into account that this is sometimes an issue happening in Twitter's servers and while we do our best to make TWBlue work despite those problems, you might encounter glitches from time to time.
+
+* TWBlue now builds with Python 3.10.8. ([#493](https://github.com/MCV-Software/TWBlue/issues/493))
+    * This change also drops support for Windows 7.
+* The TWBlue interface has not been translated yet, as we are releasing this update to fix an important Twitter issue for some regions.
+* Twitter sessions should be able to be opened properly again in TWBlue, in regions where it didn't work since last week.
+* It is now possible to log in to instances of mastodon, hometown and similar software (Pleroma should work as well, although it has not been tested at this time). From the session manager, clicking on the “new account” button will bring up a menu from which you can select whether you want to log in to Twitter or Mastodon. For instances that have a different character limit than the one set by Mastodon, TWBlue will detect the new limit and adjust the dialogs to allow you to use it correctly.
+* Most of the TWBlue GUI has been adapted so that the buffers reflect the change of social network (in mastodon, for example, the buttons to write posts say post instead of tweet). However, the menu bar has not yet been updated. This means that most of the options still refer to Twitter, although they can be used with mastodon accounts. For example, if you select the “tweet” menu in the menu bar, and then select the “Retweet” option, TWBlue will actually do a “boost” if the buffer you are in is a Mastodon account buffer.
+* Keystrokes for the invisible interface also refer to terms used in Twitter, but can be applied to Mastodon as well.
+* There are some features, within TWBlue, that are not yet compatible with mastodon accounts. These are as follows:
+    * User autocompletion.
+    * Currently, it is not possible to update account settings for mastodon sessions. However, if you know how to edit configuration files, you can close TWBlue, change your session file with any text editor and restart the application to update what you want.
+    * The template editor is not yet available for mastodon accounts.
+    * Filters have not yet been implemented in TWBlue mastodon support.
+    * User aliases are not implemented yet.
+    * It is not possible to view a user’s profile, nor edit your own, for now. However, you can use the keystroke to open the item in the browser when focusing a user to access their profile website. This only works in buffers where users are listed.
+    * You cannot manage lists in TWBlue at the moment.
+* Most of the buffers planned for mastodon should just work. Among those currently tested are: home (main timeline for the logged-in user), Local (public posts for the instance), federated (public posts for all federating instances), mentions, direct messages, sent posts, favorites, bookmarks, followers, following, blocked users, muted users, user searches and timelines for users.
+    *  The difference between favorites and bookmarks is that the author of the post can see who has marked his posts as favorites, but bookmarks are completely private. In any buffer containing mastodon posts, except direct messages, the GUI will display an option to add the post to favorites or bookmarks.
+    * Direct messages in mastodon are posts, exactly like normal posts, but with their privacy setting set so that they can only be seen by the accounts that are mentioned. In the direct message buffer, a conversation will appear for each item in the buffer. The conversation represents a thread of messages, but TWBlue can only display the last of the messages sent. This is similar to what happens on platforms like Telegram, where you can only see the list of conversations at the beginning. To see the entire thread of direct messages present in a conversation, you can use the command to open the conversation, or go to the “tweet” menu in the menu bar, and then towards the “view conversation” option. This will create a new conversation buffer that will be located just after the direct messages buffer (for the GUI, the buffer will be located just inside the direct messages buffer in the buffer tree). When a private post appears (whose visibility only allows the mentioned accounts to see it), TWBlue will display that post in the home buffer, in mentions and also will update/create the conversation with that item. This is because Mastodon does not differentiate between a private message and a normal post. You can reply to the post in any buffer to continue the conversation. If you reply to any post, the privacy set in the original post is maintained by default, but can also be changed.
+    * The buffer showing the federated timeline has been disabled from settings. This is because on servers that federate with many instances it can load many posts in a very short time. To enable this buffer, for now, edit the TWBlue configuration while the application is closed, and add the “federated” buffer in the option called “buffer_order”. As soon as buffers can be shown or hidden, this process can be done through the GUI.
+    * There is a Streaming API that allows the elements for the start buffers, mentions, direct messages, sent posts and followers to appear in real time. This feature is implemented by default and should also just work.
+    * Timelines for users only allow to get all posts from users who are in the same instance. For users belonging to other instances, you can get the posts that have been downloaded to your instance since your instance “knows” the remote user.
+    * Timelines for followers and following can be fully retrieved only for users belonging to the same instance. Remote users may yield unclear results.
+    * You can search by users (by opening a search and selecting the “users” radio button). The search can be done by local users, such as twblue, or by remote users, such as @twblue@maaw.social.
+* In all buffers, a maximum of 40 items are retrieved per load, but more can be retrieved by using the option to load more items in the buffer.
+* In post buffers, you can do most of the actions already supported in TWBlue (boost, add/remove from favorites or bookmarks, reply, send message to user, open post URL, play audio or video, open post on web, view conversation, open action dialog for user).
+* In user buffers, you can send private message to the user, and open user actions dialog, which in turn allows you to follow/unfollow, block/unblock and mute/unmute.
+* When writing posts, it is possible to attach up to 4 images, 4 givs, or even a video, poll, or audio. It is also possible to add the “sensitive content” tag to posts, change privacy and write a content warning text. It is possible to create threads using the “add post” button.
+* When replying to a post, TWBlue will place the username of all participants in the item you reply to. The privacy options will default to those of the original post.
+
+## Changes in version 2022.8.28
+
+* the user autocompletion feature has been completely rewritten to be easier to use, particularly for people with many followers/following users:
+    * In the account settings dialog, there's a button that opens up a new dialog that allows you to "scan" your account in order to add all users from your followers/following list. This process will read your data directly from Twitter and depending in the amount of people you have in your account it might take too many API calls. Please use it with caution. You can, for example, do the process separately for your followers/following people so it will be easier to handle, in case you have a massive amount of people. If TWBlue is unable to complete the scan, you will see an error and will be prompted to try again in 15 minutes, once your API calls have refreshed.
+    * It is possible to use the user autocompletion functionality in dialogs where you can select an user, for example when adding or removing someone from a list, or displaying lists for someone.
+* Implemented a new setting, available in the account settings dialog, that allows to hide emojis in twitter usernames.
+* TWBlue should be able to sort conversations in a more logical way. This should make it easier to follow a long thread in Twitter.
+* When opening a thread, TWBlue should be able to load the right conversation if the original tweet from where the thread was loaded was a retweet.
+* TWBlue will restart the Streaming subsystem every time there are changes to followed, muted or blocked users within the application.
+* Fixed error when attempting to mention an user by using the "mention" button in any people buffer. Now tweets should be posted normally.
+* Fixed error when loading other user lists. ([#465](https://github.com/MCV-Software/TWBlue/issues/465))
+* Fixed an issue that was making TWBlue to display incorrectly some retweets of quoted tweets.
+* If TWBlue is unable to open a timeline for someone who has blocked you, this will be reported in a dialog. ([#485,](https://github.com/mcv-software/twblue/issues/485))
+* Added "find a string in the currently focused buffer" action into Windows 10 and windows 11 keymap. ([#476](https://github.com/MCV-Software/TWBlue/pull/476))
+
+## changes in version 22.2.23
+
+* We have added Experimental support for templates in the invisible interface. The GUI will remain unchanged for now:
+    * Each object (tweet, received direct message, sent direct message and people) has its own template in the settings. You can edit those templates from the account settings dialog, in the new "templates" tab.
+    * Every template is composed of the group of variables you want to display for each object. Each variable will start with a dollar sign ($) and cannot contain spaces or special characters. Templates can include arbitrary text that will not be processed. When editing the example templates, you can get an idea of the variables that are available for each object by using the template editing dialog. When you press enter on a variable from the list of available variables, it will be added to the template automatically. When you try to save a template, TWBlue will warn you if the template is incorrectly formatted or if it includes variables that do not exist in the information provided by objects. It is also possible to return to default values from the same dialog when editing a template.
+    * TWBlue can display image descriptions within Tweet templates. For that, you can use the $image_description variable in your template.
+* We have restored conversation and threads support powered by Twitter API V2 thanks to a set of improvements we have done in the application, as well as more generous limits to Tweet monthly cap by Twitter.
+* In the Windows 11 Keymap, the default shortcut to open the keystrokes editor is now CTRL+Alt+Windows+K to avoid conflicts with the new global mute microphone shortcut.
+* TWBlue show display properly HTML entities in tweet's text.
+* TWBlue should no longer load old tweets in buffers.
+* Fixed issue when uploading attachments (images, videos or gif files) while sending tweets or replies.
+* Fixed an error that was making TWBlue to ask for a restart after saving account settings, even if such restart was not required. ([#413,](https://github.com/manuelcortez/TWBlue/issues/413))
+
+## Changes in version 2021.11.12
+
+* Now it is possible to create a tweet from a trending topics buffer again.
+* TWBlue now includes a completely new set of dialogs to handle tweeting, replying and sending direct messages that takes advantage of more Twitter features.
+    * It is possible to add videos in tweets and direct messages by using the new "add" button, located in every dialog where  media can be added. Twitter suggests to add videos from 5 seconds up to 2 minutes lenght, in mp4 format (video Codec H.264 and audio codec AAC). Currently, TWBlue does not check if the uploaded video complies with Twitter media requirements. You can add only a video in a tweet or direct message. No other kind of media can be added after a video is in a tweet. If the video was unable to be uploaded successfully, the tweet or direct message won't be created.
+    * Now you can add a poll to tweets. Polls can have up to 4 different options and allow voting up to 7 days after being created. Take into account, though, that currently TWBlue does not support reading polls in tweets.
+    * TWBlue now support threads while creating a new tweet. There is a new button, called add tweet which will add the current tweet to the thread and will allow you to write another tweet in the thread. Every tweet might include media (up to 4 photos, or one GIF image or a video) or up to one poll.
+    * Some functionality was removed from tweet dialogs within TWBlue. Particularly, URL shorteners and long tweets via Twishort. You still can read long tweets posted via Twishort, though.
+
+## Changes in version 2021.11.07
+
+* TWBlue should retrieve tweets from threads and conversations in a more reliable way. Tweets in the same thread (made by the same author) will be sorted correctly, although replies to the thread (made by different people) may not be ordered in the same way they are displayed in Twitter apps. ([#417](https://github.com/manuelcortez/TWBlue/issues/417))
+* When creating a filter, TWBlue will show an error if user has not provided a name for the filter. Before, unnamed filters were a cause of config breaks in the application.
+* It is again possible to read the changelog for TWBlue from the help menu in the menu bar.
+* fixed a bug when clearing the direct messages buffer. ([#418](https://github.com/manuelcortez/TWBlue/issues/418))
+* fixed an issue that was making TWBlue to show incorrectly titles for trending topic buffers upon startup. ([#421](https://github.com/manuelcortez/TWBlue/issues/421))
+* fixed an issue that was making users of the graphical user interface to delete a buffer if a trends buffer was opened in the same session.
+* Updated Spanish, Japanese and french translations.
+
+## Changes in Version 2021.10.30
+
+* Fixed many errors in the way we compile TWBlue, so users of 64 bits systems and particularly windows 7 users would be able to install TWBlue again. In case of issues with versions prior to 2021.10.30, please remove everything related to TWBlue (except configs) and reinstall the version 2021.10.30 to fix any possible error. This step won't be needed again in 23 months. ([#416,](https://github.com/manuelcortez/TWBlue/issues/416), [#415,](https://github.com/manuelcortez/TWBlue/issues/415))
+* fixed an issue that was making impossible to manually add an user to the autocomplete users database.
+* Started to improve support to conversations by searching for conversation_id.
+
+## changes in version 2021.10.27
+
+* Added an user alias manager, located in the application menu in the menu bar. From this dialog, it is possible to review, add, edit or remove user aliases for the current account. ([#401](https://github.com/manuelcortez/TWBlue/issues/401))
+* TWBlue now closes the VLC player window automatically when a video reaches its end. ([#399](https://github.com/manuelcortez/TWBlue/issues/399))
+* After a lot of time, TWBlue now uses a new default Soundpack, called FreakyBlue. This soundpack will be set by default in all new sessions created in the application. Thanks to [Andre Louis](https://twitter.com/FreakyFwoof) for the pack. ([#247](https://github.com/manuelcortez/TWBlue/issues/247))
+* When reading a tweet, if the tweet contains more than 2 consecutive mentions, TWBlue will announce how many more users the tweet includes, as opposed to read every user in the conversation. You still can display the tweet to read all users.
+* In the tweet displayer, It is possible to copy a link to the current tweet or person by pressing a button called "copy link to clipboard".
+* Added a keymap capable to work under Windows 11. ([#391](https://github.com/manuelcortez/TWBlue/pull/391))
+* Added user aliases to TWBlue. This feature allows you to rename user's display names on Twitter, so the next time you'll read an user it will be announced as you configured. For adding an alias to an user, select the "add alias" option in the user menu, located in the menu bar. This feature works only if you have set display screen names unchecked. Users are displayed with their display name in people buffers only. This action is supported in all keymaps, although it is undefined by default. ([#389](https://github.com/manuelcortez/TWBlue/pull/389))
+* There are some changes to the autocomplete users feature:
+    * Now users can search for twitter screen names or display names in the database.
+* It is possible to undefine keystrokes in the current keymap in TWBlue. This allows you, for example, to redefine keystrokes completely.
+* We have changed our Geocoding service to the Nominatim API from OpenStreetMap. Addresses present in tweets are going to be determined by this service, as the Google Maps API now requires an API key. ([#390](https://github.com/manuelcortez/TWBlue/issues/390))
+* Added a limited version of the Twitter's Streaming API: The Streaming API will work only for tweets, and will receive tweets only by people you follow. Protected users are not possible to be streamed. It is possible that during high tweet traffic, the Stream might get disconnected at times, but TWBlue should be capable of detecting this problem and reconnecting the stream again. ([#385](https://github.com/manuelcortez/TWBlue/pull/385))
+* Fixed an issue that made TWBlue to not show a dialog when attempting to show a profile for a suspended user. ([#387](https://github.com/manuelcortez/TWBlue/issues/387))
+* Added support for Twitter audio and videos: Tweets which contains audio or videos will be detected as audio items, and you can playback those with the regular command to play audios. ([#384,](https://github.com/manuelcortez/TWBlue/pull/384))
+* We just implemented some changes in the way TWBlue handles tweets in order to reduce its RAM memory usage [#380](https://github.com/manuelcortez/TWBlue/pull/380):
+    * We reduced the tweets size by storing only the tweet fields we currently use. This should reduce tweet's size in memory for every object up to 75%.
+    * When using the cache database to store your tweets, there is a new setting present in the account settings dialog, in the general tab. This setting allows you to control whether TWBlue will load the whole database into memory (which is the current behaviour) or not.
+        * Loading the whole database into memory has the advantage of being extremely fast to access any element (for example when moving through tweets in a buffer), but it requires more memory as the tweet buffers grow up. This should, however, use less memory than before thanks to the optimizations performed in tweet objects. If you have a machine with enough memory, this should be a good option for your case.
+        * If you uncheck this setting, TWBlue will read the whole database from disk. This is significantly slower, but the advantage of this setting is that it will consume almost no extra memory, no matter how big is the tweets dataset. Be ware, though, that TWBlue might start to feel slower when accessing elements (for example when reading tweets) as the buffers grow up. This setting is suggested for computers with low memory or for those people not wanting to keep a really big amount of tweets stored.
+* Changed the label in the direct message's text control so it will indicate that the user needs to write the text there, without referring to any username in particular. ([#366,](https://github.com/manuelcortez/TWBlue/issues/366))
+* TWBlue will take Shift+F10 again as the contextual menu key in the list of items in a buffer. This stopped working after we have migrated to WX 4.1. ([#353,](https://github.com/manuelcortez/TWBlue/issues/353))
+* TWBlue should render correctly retweets of quoted tweets. ([#365,](https://github.com/manuelcortez/TWBlue/issues/365))
+* Fixed an error that was causing TWBlue to be unable to output to screen readers at times. ([#369,](https://github.com/manuelcortez/TWBlue/issues/369))
+* Fixed autocomplete users feature. ([#367,](https://github.com/manuelcortez/TWBlue/issues/367))
+* Fixed error when displaying an URL at the end of a line, when the tweet or direct message contained multiple lines. Now the URL should be displayed correctly. ([#305,](https://github.com/manuelcortez/TWBlue/issues/305) [#272,](https://github.com/manuelcortez/TWBlue/issues/272))
+* TWBlue has been migrated completely to Python 3 (currently, the software builds with Python 3.8).
+* TWBlue should be restarted gracefully. Before, the application was alerting users of not being closed properly every time the application restarted by itself.
+* If TWBlue attemps to load an account with invalid tokens (this happens when reactivating a previously deactivated account, or when access to the ap is revoqued), TWBlue will inform the user about this error and will skip the account. Before, the app was unable to start due to a critical error. ([#328,](https://github.com/manuelcortez/TWBlue/issues/328))
+* When sending a direct message, the title of the window will change appropiately when the recipient is edited. ([#276,](https://github.com/manuelcortez/TWBlue/issues/276))
+* URL'S in user profiles are expanded automatically. ([#275,](https://github.com/manuelcortez/TWBlue/issues/275))
+* TWBlue now uses [Tweepy,](https://github.com/tweepy/tweepy) to connect with Twitter. We have adopted this change in order to support Twitter'S API V 2 in the very near future. ([#333,](https://github.com/manuelcortez/TWBlue/issues/337) [#347](https://github.com/manuelcortez/TWBlue/pull/347))
+* TWBlue can upload images in Tweets and replies again. ([#240,](https://github.com/manuelcortez/TWBlue/issues/240))
+* Fixed the way we use to count characters in Twitter. The new methods in TWBlue take into account special characters and URLS as documented in Twitter. ([#199,](https://github.com/manuelcortez/TWBlue/issues/199) [#315](https://github.com/manuelcortez/TWBlue/issues/315))
+* Proxy support now works as expected.
+* Changed translation service from yandex.translate to Google Translator. ([#355,](https://github.com/manuelcortez/TWBlue/issues/355))
+* Improved method to load direct messages in the buffers. Now it should be faster due to less calls to Twitter API performed from the client.
+* And more. ([#352,](https://github.com/manuelcortez/TWBlue/issues/352))
+
+## Changes in version 0.95
+
+* TWBlue can open a Tweet or user directly in Twitter. There is a new option in the context menu for people and tweet buffers, and also, the shortcut control+win+alt+Enter will open the focused item in Twitter.
+* Some keystrokes were remapped in the Windows 10 Keymap:
+    * Read location of a tweet: Ctrl+Win+G. ([#177](https://github.com/manuelcortez/TWBlue/pull/177))
+    * Open global settings dialogue: Ctrl+Win+Alt+O.
+    * Mute/unmute current session: Control + Windows + Alt + M.
+* Fixed an error that was preventing TWBlue to load the direct messages buffer if an user who sent a message has been deleted.
+* Added support for playing audios posted in [AnyAudio.net](http://anyaudio.net) directly from TWBlue. Thanks to [Sam Tupy](http://www.samtupy.com/)
+* Custom buffer ordering will not be reset every time the application restarts after an account setting has been modified.
+* When adding or removing an user from a list, it is possible to press enter in the focused list instead of having to search for the "add" or "delete" button.
+* Quoted and long tweets are displayed properly in the sent tweets buffer after being send. ([#253](https://github.com/manuelcortez/TWBlue/issues/253))
+* Fixed an issue that was making the list manager keystroke unable to be shown in the keystroke editor. Now the keystroke is listed properly. ([#260](https://github.com/manuelcortez/TWBlue/issues/260))
+* The volume slider, located in the account settings of TWBlue, now should decrease and increase value properly when up and down arrows are pressed. Before it was doing it in inverted order. ([#261](https://github.com/manuelcortez/TWBlue/issues/261))
+* autoreading has been redesigned to work in a similar way for almost all buffers. Needs testing. ([#221](https://github.com/manuelcortez/TWBlue/issues/221))
+* When displaying tweets or direct messages, a new field has been added to show the date when the item has been posted to Twitter.
+* Added support for deleting direct messages by using the new Twitter API methods.
+* When quoting a retweet, the quote will be made to the original tweet instead of the retweet.
+* If the sent direct messages buffer is hidden, TWBlue should keep loading everything as expected. ([#246](https://github.com/manuelcortez/TWBlue/issues/246))
+* There is a new soundpack, called FreakyBlue (Thanks to [Andre Louis](https://twitter.com/FreakyFwoof)) as a new option in TWBlue. This pack can be the default in the next stable, so users can take a look and share their opinion in snapshot versions. ([#247](https://github.com/manuelcortez/TWBlue/issues/247))
+* There is a new option in the help menu that allows you to visit the soundpacks section in the TWBlue website. ([#247](https://github.com/manuelcortez/TWBlue/issues/247))
+* When reading location of a geotagged tweet, it will be translated for users of other languages. ([#251](https://github.com/manuelcortez/TWBlue/pull/251))
+* When there are no more items to retrieve in direct messages and people buffers, a message will announce it.
+* Fixed an issue reported by some users that was making them unable to load more items in their direct messages.
+* It is possible to add a tweet to the likes buffer from the menu bar again.
+* Tweets, replies and retweets will be added to sent tweets right after being posted in Twitter.
+* Extended Tweets should be displayed properly in list buffers.
+
+## Changes in version 0.94
+
+* Added an option in the global settings dialog to disable the Streaming features of TWBlue. TWBlue will remove all Streaming features after August 16, so this option will give people an idea about how it will be. ([#219](https://github.com/manuelcortez/TWBlue/issues/219))
+* Due to Twitter API changes, Switched authorisation method to Pin-code based authorisation. When you add new accounts to TWBlue, you will be required to paste a code displayed in the Twitter website in order to grant access to TWBlue. ([#216](https://github.com/manuelcortez/TWBlue/issues/216))
+* In order to comply with latest Twitter changes, TWBlue has switched to the new method used to send and receive direct messages, according to issue [#215.](https://github.com/manuelcortez/twblue/issues/215)
+    * The new method does not allow direct messages to be processed in real time. Direct messages will be updated periodically.
+* After august 16 or when streaming is disabled, the events buffer will no longer be created in TWBlue.
+* You can configure frequency for buffer updates in TWBlue. By default, TWBlue will update all buffers every 2 minutes, but you can change this setting in the global settings dialog. ([#223](https://github.com/manuelcortez/TWBlue/issues/223))
+* Added a new tab called feedback, in the account settings dialog. This tab allows you to control whether automatic speech or Braille feedbak in certain events (mentions and direct messages received) is enabled. Take into account that this option will take preference over automatic reading of buffers and any kind of automatic output. ([#203](https://github.com/manuelcortez/TWBlue/issues/203))
+* The spell checking dialog now has access keys defined for the most important actions. ([#211](https://github.com/manuelcortez/TWBlue/issues/211))
+* TWBlue now Uses WXPython 4.0.1. This will allow us to migrate all important components to Python 3 in the future. ([#207](https://github.com/manuelcortez/TWBlue/issues/207))
+* When you quote a Tweet, if the original tweet was posted with Twishort, TWBlue should display properly the quoted tweet. Before it was displaying the original tweet only. ([#206](https://github.com/manuelcortez/TWBlue/issues/206))
+* It is possible to filter by retweets, quotes and replies when creating a new filter.
+* Added support for playing youtube Links directly from the client. ([#94](https://github.com/manuelcortez/TWBlue/issues/94))
+* Replaced Bass with libVLC for playing URL streams.
+* the checkbox for indicating whether TWBlue will include everyone in a reply or not, will be unchecked by default.
+* You can request TWBlue to save the state for two checkboxes: Long tweet and mention all, from the global settings dialogue.
+* For windows 10 users, some keystrokes in the invisible user interface have been changed or merged:
+    * control+Windows+alt+F will be used for toggling between adding and removing a tweet to user's likes. This function will execute the needed action based in the current status for the focused tweet.
+* TWBlue will show an error if something goes wrong in an audio upload.
+* And more. ([#171,](https://github.com/manuelcortez/TWBlue/issues/171) 
+
+## Changes in version 0.93
+
+* A new soundpack has been added to TWBlue. Thanks to [@ValeriaK305](https://twitter.com/ValeriaK305)
+* In the Windows 10 keymap, we have changed some default keystrokes as windows now uses some previously assigned shortcuts:
+    * For liking a tweet, press Control+Windows+alt+f
+    * for opening a trends buffer, press control+Windows+T
+* TWBlue has received improvements in some functions for handling extended tweets, long tweets and quoted retweets. It should render some tweets in a better way.
+* In the spell checker module, there is a new button that will allow you to add your own words to your personal dictionary so the module won't mark them as mispelled the next time you will check spelling.
+* Added filtering capabilities to TWBlue. ([#102](https://github.com/manuelcortez/TWBlue/issues/102))
+    * You can create a filter for the current buffer from the buffer menu in the menu bar. At this moment, invisible interface does not have any shorcut for this.
+    * You can create filters by word or languages.
+    * For deleting already created filters, you can go to the filter manager in the buffer menu and delete the filters you won't need.
+* Links should be opened properly in quoted tweets ([#167,](https://github.com/manuelcortez/TWBlue/issues/167) [#184](https://github.com/manuelcortez/TWBlue/issues/184))
+* Increased display name limit up to 50 characters in update profile dialog.
+* When authorising an account, you will see a dialogue with a cancel button, in case you want to abort the process. Also, NVDA will not be blocked when the process starts. ([#101](https://github.com/manuelcortez/TWBlue/issues/101))
+* In the translator module, the list of available languages is fetched automatically from the provider. That means all of these languages will work and there will not be inconsistencies. Also we've removed the first combo box, because the language is detected automatically by Yandex'S API. ([#153](https://github.com/manuelcortez/TWBlue/issues/153))
+* Trending topics, searches and conversation buffers will use mute settings set for the session in wich  they were opened. ([#157](https://github.com/manuelcortez/TWBlue/issues/157))
+* The Tweet limit is now 280 characters lenght instead 140. It means you can tweet longer tweets. ([#172](https://github.com/manuelcortez/TWBlue/issues/172))
+* Per popular request, Status for mention to all and long tweet checkboxes will not be saved in settings. ([#170](https://github.com/manuelcortez/TWBlue/issues/170))
+* Fixed a problem that was making TWBlue unable to start if it was being ran in Windows with Serbian language. ([#175](https://github.com/manuelcortez/TWBlue/issues/175))
+* Added Danish translation.
+* And more. ([#156,](https://github.com/manuelcortez/TWBlue/issues/156) [#163,](https://github.com/manuelcortez/TWBlue/issues/163) [#159,](https://github.com/manuelcortez/TWBlue/issues/159) [#173,](https://github.com/manuelcortez/TWBlue/issues/173) [#174,](https://github.com/manuelcortez/TWBlue/issues/174) [#176,](https://github.com/manuelcortez/TWBlue/issues/176))
+
+## changes in version 0.91 and 0.92
+
+* Fixed incorrect unicode handling when copying tweet to clipboard. ([#150](https://github.com/manuelcortez/TWBlue/issues/150))
+* TWBlue will show an error when trying to open a timeline for a suspended user. ([#128](https://github.com/manuelcortez/TWBlue/issues/128))
+* Removed TwUp as service as it no longer exists. ([#112](https://github.com/manuelcortez/TWBlue/issues/112))
+* Release audio files after uploading them. ([#130](https://github.com/manuelcortez/TWBlue/issues/130))
+* Now TWBlue will use Yandex's translation services instead microsoft translator. ([#132](https://github.com/manuelcortez/TWBlue/issues/132))
+* SndUp users will be able to upload audio in their account by using their API Key again. ([#134](https://github.com/manuelcortez/TWBlue/issues/134))
+* old tweets shouldn't be added as new items in buffers. ([#116,](https://github.com/manuelcortez/TWBlue/issues/116)) ([#133](https://github.com/manuelcortez/TWBlue/issues/133))
+* All mentionned users should be displayed correctly in Twishort's long tweets. ([#116,](https://github.com/manuelcortez/TWBlue/issues/116)) ([#135](https://github.com/manuelcortez/TWBlue/issues/135))
+* It is possible to select a language for OCR service from the extras panel, in the account settings dialogue. You can, however, set this to detect automatically. OCR should work better in languages with special characters or non-english symbols. ([#107](https://github.com/manuelcortez/TWBlue/issues/107))
+* Fixed a problem with JAWS for Windows and TWBlue. Now JAWS will work normally in this update. [#100](https://github.com/manuelcortez/twblue/issues/100)
+* And more ([#136,](https://github.com/manuelcortez/TWBlue/issues/136))
+
+## Changes in version 0.90
+
+* Fixed a bug in long tweet parsing that was making TWBlue to disconnect the streaming API. ([#103](https://github.com/manuelcortez/TWBlue/issues/103))
+* Now OCR will work in images from retweets. It fixes a bug where TWBlue was detecting images but couldn't apply OCR on them. ([#105](https://github.com/manuelcortez/TWBlue/issues/105))
+* TWBlue won't try to load tweets already deleted, made with Twishort. Before, if someone posted a long tweet but deleted it in the Twishort's site, TWBlue was trying to load the tweet and it was causing problems in all the client. ([#113](https://github.com/manuelcortez/TWBlue/issues/113))
+* TWBlue shows an error message when you try to view the profile of an user that does not exist or has been suspended. ([#114,](https://github.com/manuelcortez/TWBlue/issues/114) [#115](https://github.com/manuelcortez/TWBlue/issues/115))
+* The spellchecker module should select the right language when is set to "user default". ([#117](https://github.com/manuelcortez/TWBlue/issues/117))
+* Image description will be displayed in retweets too. ([#119](https://github.com/manuelcortez/TWBlue/issues/119))
+* When reading a long tweet, you shouldn't read strange entities anymore. ([#118](https://github.com/manuelcortez/twblue/issues/118))
+* TWBlue will not try to load timelines if the user is blocking you. ([#125](https://github.com/manuelcortez/twblue/issues/125))
+
+## Changes in version 0.88 and 0.89
+
+* Fixed more issues with streams and reconnections.
+* newer updates will indicate the release date in the updater.
+* Changes to keystrokes are reflected in keystroke editor automatically.
+* In replies with multiple users, if the mention to all checkbox is unchecked, you will see a checkbox per user so you will be able to control who will be mentioned in the reply.
+* Fixed a bug that caused duplicated user mentions in replies when the tweet was made with Twishort.
+* Retweets should be displayed normally again when the originating tweet is a Twishort's long tweet.
+* Changed the way TWBlue saves user timelines in configuration. Now it uses user IDS instead usernames. With user IDS, if an user changes the username, TWBlue still will create his/her timeline. This was not possible by using usernames.
+* Added a new setting in the account settings dialogue that makes TWBlue to show twitter usernames instead the full name.
+* Added OCR in twitter pictures. There is a new item in the tweet menu that allows you to extract and display text in images. Also the keystroke alt+Win+o has been added for the same purpose from the invisible interface.
+* Now TWBlue will play a sound when the focused tweet contains  images.
+* Your own quoted tweets will not appear in the mentions buffer anymore.
+* The config file is saved in a different way, it should fix the bug where TWBlue needs to be restarted after the config folder is deleted.
+* Mentioning people from friends or followers buffers works again.
+* Support for proxy servers has been improved. Now TWBlue supports http, https, socks4 and socks5 proxies, with and without autentication.
+
+## Changes in version 0.87
+
+* Fixed stream connection errors.
+* Now TWBlue can handle properly a reply to the sender without including all other mentioned users.
+* Updated translations.
+* The status of the mention to all checkbox will be remembered the next time you  reply to multiple users.
+
+## Changes in version 0.86
+
+* Fixed a very important security issue. Now TWBlue will send tweets to twishort without using any other server.
+* When you add a comment to a tweet, it will be sent as a quoted tweet, even if your reply plus the original tweet is not exceeding 140 characters.
+* Updated windows 10 keymap for reflecting changes made in the last windows 10 build.
+* Added last changes in the twitter API.
+* When replying, it will not show the twitter username in the text box. When you send the tweet, the username will be added automatically.
+* When replying to multiple users, you'll have a checkbox instead a button for mentioning all people. If this is checked, twitter usernames will be added automatically when you send your reply.
+
+## Changes in version 0.85
+
+* Long and quoted tweets should be displayed properly In lists.
+* The connection should be more stable.
+* Added an autostart option in the global settings dialogue.
+* Updated translation.
+* Updated russian documentation.
+* Tweets in cached database should be loaded properly.
+* Added some missed dictionaries for spelling correction.
+* Timelines, lists and other buffer should be created in the right order at startup.
+
+## Changes in version 0.84 
+
+* More improvements in quoted and long tweets.
+* Updated translations: Russian, Italian, French, Romanian, Galician and Finnish.
+* Improvements in the audio uploader module: Now it can handle audio with non-english characters.
+* the title of the window should be updated properly when spellcheck, translate or shorten/unshorten URL buttons are pressed.
+* the bug that changes the selected tweet in the home timeline shouldn't be happening so often.
+
+## Changes in version 0.82 and 0.83
+
+* If the tweet source (client) is an application with unicode characters (example: российская газета) it will not break the tweet displayer.
+* Added a new field for image description in tweet displayer. When available, it will show description for images posted in tweets.
+* users can add image descriptions to their photos. When uploading an image, a dialog will show for asking a description.
+* Redesigned upload image dialog.
+* Fixed photo uploads when posting tweets.
+* When getting tweets for a conversation, ignores deleted tweets or some errors, now TWBlue will try to get as much tweets as possible, even if some of these are no longer available.
+* Added audio playback from soundcloud.
+* Now the session mute option don't makes the screen reader speaks.
+* Fixed the direct message dialog. Now it should be displayed properly.
+* when a tweet is deleted in twitter, TWBlue should reflect this change and delete that tweet in every buffer it is displayed.
+* If your session is broken, TWBlue will be able to remove it automatically instead just crashing.
+* audio uploader should display the current progress.
+* users can disable the check for updates feature at startup from the general tab, in the global settings dialogue.
+* The invisible interface and the window should be synchronized when the client reconnects.
+* The documentation option in the systray icon should be enabled.
+* In trending buffers, you can press enter for posting a tweet about  the focused trend.
+* Updated russian documentation and main program interface (thanks to Natalia Hedlund (Наталья Хедлунд), [@lifestar_n](https://twitter.com/lifestar_n) in twitter)
+* updated translations.
+
+## Changes in Version 0.81
+
+* Updated translations
+* The updater module has received some improvements. Now it includes a Mirror URL for checking updates  if the main URL is not available at the moment. If something is wrong and both locations don't work, the program will start anyway.
+* some GUI elements now use keyboard shortcuts for common actions.
+* fixed a bug in the geolocation dialog.
+* the chicken nugget keymap should work properly.
+* Added a new soundpack to the default installation of TWBlue, thanks to [@Deng90](https://twitter.com/deng90)
+* Now the changelog is  written in an html File.
+* Added some missed dictionaries in last version for the spell checking feature.
+* Trimmed the beginnings of the sounds in the default soundpack. Thanks to [@masonasons](https://github.com/masonasons)
+* Added Opus support for sound playback in TWBlue. Thanks to [@masonasons](https://github.com/masonasons)
+* Added a source field in view tweet dialogue. Thanks to [@masonasons](https://github.com/masonasons)
+* You can load previous items in followers and friend buffers for others.
+* The Spell Checker dialogue should not display an error message when you have set "default language" in the global settings dialogue if your language is supported [#168](http://twblue.es/bugs/view.php?id=168)
+* Updated romanian translation.
+* Some code cleanups.
+* The bug reports feature is fully operational again.
+* TWBlue should work again for users that contains special characters in windows usernames.
+* Added more options for the tweet searches.
+* Added play_audio to the keymap editor.
+* Windows key is no longer required in the keymap editor
+* Switched to the Microsoft translator.
+* You can update the current buffer by pressing ctrl+win+shift+u in the default keymap or in the buffer menu.
+* Changed some keystrokes in the windows 10 default keymap
+* New followers and friends buffer for user timelines.
+
+---
+Copyright © 2014-2021, Manuel Cortez.

doc/documentation_importer.py

@@ -2,22 +2,27 @@
 """ This script converts the hold documentation (saved in markdown files) in a python file with a list of strings to translate it using gettext."""
 
 def prepare_documentation_in_file(fileSource, fileDest):
-	""" This takes documentation written in a markdown file and put all the contents in a python file, to create a internationalized documentation.
-	 @fileSource str: A markdown(.md) file.
-	 @fileDest str: A file where this will put the new strings"""
+    """ This takes documentation written in a markdown file and put all the contents in a python file, to create a translatable  documentation.
+        @fileSource str: A markdown(.md) file.
+        @fileDest str: A file where this will put the new strings"""
 
-	f1 = open(fileSource, "r")
-	f2 = open(fileDest, "w")
-	lns = f1.readlines()
-	f2.write("# -*- coding: utf-8 -*-\n")
-	f2.write("documentation = []\n")
-	for i in lns:
-		if len(i) > 2:
-			newvar = "documentation.append(_(u\"\"\"%s\"\"\"))\n" % (i[:-2])
-		else:
-			newvar = "documentation.append(_(u\"\"\"%s\"\"\"))\n" % (i)
-		f2.write(newvar)
-	f1.close()
-	f2.close()
+    f1 = open(fileSource, "r", encoding="utf-8")
+    f2 = open(fileDest, "w", encoding="utf-8")
+    lns = f1.readlines()
+    f2.write("# -*- coding: utf-8 -*-\n")
+    f2.write("documentation = [\n")
+    for i in lns:
+        if "\n" == i:
+            newvar = "\"\",\n"
+        elif "\n" == i[-1]:
+            newvar = "_(\"\"\"%s\"\"\"),\n" % (i[:-1])
+        else:
+            newvar = "_(\"\"\"%s\"\"\"),\n" % (i)
+        f2.write(newvar)
+    f1.close()
+    f2.write("]")
+    f2.close()
 
 
+prepare_documentation_in_file("manual.md", "strings.py")
+prepare_documentation_in_file("changelog.md", "changelog.py")

doc/generator.py

@@ -1,42 +1,91 @@
 # -*- coding: utf-8 -*-
-import markdown
+import gettext
 import os
-from codecs import open as _open
-import languageHandler
-languageHandler.setLanguage("en")
-import strings
+import locale
+import paths
+import markdown
+import shutil
+from importlib import reload
 
-# the list of supported language codes of TW Blue
-languages = ["en", "es", "fr", "de", "it"]
-#"eu", "ar", "ca", "es", "fi", "fr", "gl", "hu", "it", "pl", "pt", "ru", "tr"]
+# Languages already translated or translating the documentation.
+documentation_languages = ["en", "es", "fr", "de", "it", "gl", "ja", "ru", "ro", "eu", "ca", "da", "sr"]
 
-def generate_document(language):
- reload(languageHandler)
- languageHandler.setLanguage(language)
- reload(strings)
- markdown_file = markdown.markdown("\n".join(strings.documentation[1:]), extensions=["markdown.extensions.toc"])
- first_html_block = """<!doctype html>
- <html lang="%s">
- <head>
-  <title>%s</title>
-  <meta charset="utf-8">
-  </head>
-  <body>
-  <header><h1>%s</h1></header>
-  """ %  (language, strings.documentation[0], strings.documentation[0])
- first_html_block = first_html_block+ markdown_file
- first_html_block = first_html_block + "\n</body>\n</html>"
- if not os.path.exists(language):
-  os.mkdir(language)
- mdfile = _open("%s/manual.html" % language, "w", encoding="utf-8")
- mdfile.write(first_html_block)
- mdfile.close()
+# Changelog translated languages.
+changelog_languages = ["en", "ca", "de", "es", "eu", "fr", "gl", "ja", "ro", "ru", "sr"]
+
+# this function will help us to have both strings.py and changelog.py without issues by installing a global dummy translation function.
+def install_null_translation(name):
+    _ = gettext.NullTranslations()
+    _.install()
+    return
+
+def get_translations(name):
+    """ Create translation instances for every language of the translated document. """
+    translations = {}
+    if "documentation" in name:
+        langs = documentation_languages
+    else:
+        langs = changelog_languages
+    for l in langs:
+        if l != "en":
+            try:
+                _ = gettext.translation(name, os.path.join(paths.app_path(), "locales"), languages=[l])
+                translations[l] = _
+                print(l, name)
+            except FileNotFoundError:
+                _ = gettext.NullTranslations()
+                translations[l] = _
+        else:
+            _ = gettext.NullTranslations()
+            translations[l] = _
+    return translations
+
+def generate_document(lang, lang_name, document_type="documentation"):
+    """ Generates a document by using the provided lang object, which should be a translation, and lang_name, which should be the two letter code representing the language. """
+    if document_type == "documentation":
+        translation_file = "twblue-documentation"
+        markdown_file = markdown.markdown("\n".join([lang.gettext(s) if s != "" else s for s in strings.documentation[1:]]), extensions=["markdown.extensions.toc"])
+        title = lang.gettext(strings.documentation[0])
+        filename = "manual.html"
+    elif document_type == "changelog":
+        translation_file = "twblue-changelog"
+        markdown_file = markdown.markdown("\n".join([lang.gettext(s) if s != "" else s for s in changelog.documentation[1:]]), extensions=["markdown.extensions.toc"])
+        title = lang.gettext(changelog.documentation[0])
+        filename = "changelog.html"
+    first_html_block = """<!doctype html>
+    <html lang="%s">
+    <head>
+        <title>%s</title>
+        <meta charset="utf-8">
+        </head>
+        <body>
+        <header><h1>%s</h1></header>
+        """ %  (lang_name, title, title)
+    first_html_block = first_html_block+ markdown_file
+    first_html_block = first_html_block + "\n</body>\n</html>"
+    if not os.path.exists(os.path.join("documentation", lang_name)):
+        os.mkdir(os.path.join("documentation", lang_name))
+    mdfile = open(os.path.join("documentation", lang_name, filename), "w", encoding="utf-8")
+    mdfile.write(first_html_block)
+    mdfile.close()
 
 def create_documentation():
- print("Creating documentation in the supported languages...\n")
- for i in languages:
-  print("Creating documentation for: %s" % (i,))
-  generate_document(i)
- print("Done")
+    changelog_translations = get_translations("twblue-changelog")
+    documentation_translations = get_translations("twblue-documentation")
+    print("Creating documentation in the supported languages...\n")
+    if not os.path.exists("documentation"):
+        os.mkdir("documentation")
+    if os.path.exists(os.path.join("documentation", "license.txt")) == False:
+        shutil.copy(os.path.join("..", "license.txt"), os.path.join("documentation", "license.txt"))
+    for i in documentation_languages:
+        print("Creating documentation for: %s" % (i,))
+        generate_document(lang_name=i, lang=documentation_translations.get(i))
+    for i in changelog_languages:
+        print("Creating changelog  for: %s" % (i,))
+        generate_document(lang_name=i, lang=changelog_translations.get(i), document_type="changelog")
+    print("Done")
 
+install_null_translation("twblue-documentation")
+import strings
+import changelog
 create_documentation()

doc/languageHandler.py

@@ -1,176 +0,0 @@
-import __builtin__
-import os
-import sys
-import ctypes
-import locale
-import gettext
-#import paths
-import platform
-
-# A fix for the mac locales
-if platform.system() != 'Windows':
- if locale.getlocale()[0] is None:
-  locale.setlocale(locale.LC_ALL, 'en_US')
-
-#a few Windows locale constants
-LOCALE_SLANGUAGE=0x2
-LOCALE_SLANGDISPLAYNAME=0x6f
-
-curLang="en"
-
-def localeNameToWindowsLCID(localeName):
-	"""Retreave the Windows locale identifier (LCID) for the given locale name
-	@param localeName: a string of 2letterLanguage_2letterCountry or or just 2letterLanguage
-	@type localeName: string
-	@returns: a Windows LCID
-	@rtype: integer
-	""" 
-	#Windows Vista is able to convert locale names to LCIDs
-	func_LocaleNameToLCID=getattr(ctypes.windll.kernel32,'LocaleNameToLCID',None)
-	if func_LocaleNameToLCID is not None:
-		localeName=localeName.replace('_','-')
-		LCID=func_LocaleNameToLCID(unicode(localeName),0)
-	else: #Windows doesn't have this functionality, manually search Python's windows_locale dictionary for the LCID
-		localeName=locale.normalize(localeName)
-		if '.' in localeName:
-			localeName=localeName.split('.')[0]
-		LCList=[x[0] for x in locale.windows_locale.iteritems() if x[1]==localeName]
-		if len(LCList)>0:
-			LCID=LCList[0]
-		else:
-			LCID=0
-	return LCID
-
-def getLanguageDescription(language):
-	"""Finds out the description (localized full name) of a given local name"""
-	desc=None
-	if platform.system() == "Windows":
-		LCID=localeNameToWindowsLCID(language)
-		if LCID!=0:
-			buf=ctypes.create_unicode_buffer(1024)
-			if '_' not in language:
-				res=ctypes.windll.kernel32.GetLocaleInfoW(LCID,LOCALE_SLANGDISPLAYNAME,buf,1024)
-			else:
-				res=0
-			if res==0:
-				res=ctypes.windll.kernel32.GetLocaleInfoW(LCID,LOCALE_SLANGUAGE,buf,1024)
-			desc=buf.value
-	elif platform.system() == "Linux" or not desc:
-		desc={
-			"am":pgettext("languageName","Amharic"),
-			"an":pgettext("languageName","Aragonese"),
-			"es":pgettext("languageName","Spanish"),
-			"pt":pgettext("languageName","Portuguese"),
-			"ru":pgettext("languageName","Russian"),
-			"it":pgettext("languageName","italian"),
-			"tr":pgettext("languageName","Turkey"),
-			"gl":pgettext("languageName","Galician"),
-			"ca":pgettext("languageName","Catala"),
-			"eu":pgettext("languageName","Vasque"),
-			"pl":pgettext("languageName","polish"),
-			"ar":pgettext("languageName","Arabic"),
-			"ne":pgettext("languageName","Nepali"),
-			"sr":pgettext("languageName","Serbian (Latin)"),
-		}.get(language,None)
-	return desc
-
-def getAvailableLanguages():
-	"""generates a list of locale names, plus their full localized language and country names.
-	@rtype: list of tuples
-	"""
-	#Make a list of all the locales found in NVDA's locale dir
-	l=[x for x in os.listdir("locales") if not x.startswith('.')]
-	l=[x for x in l if os.path.isfile('locales/%s/LC_MESSAGES/twblue-documentation.mo' % x)]
-	#Make sure that en (english) is in the list as it may not have any locale files, but is default
-	if 'en' not in l:
-		l.append('en')
-		l.sort()
-	#For each locale, ask Windows for its human readable display name
-	d=[]
-	for i in l:
-		desc=getLanguageDescription(i)
-		label="%s, %s"%(desc,i) if desc else i
-		d.append(label)
-	#include a 'user default, windows' language, which just represents the default language for this user account
-	l.append("system")
-	# Translators: the label for the Windows default NVDA interface language.
-	d.append(_("User default"))
-	#return a zipped up version of both the lists (a list with tuples of locale,label)
-	return zip(l,d)
-
-def makePgettext(translations):
-	"""Obtaina  pgettext function for use with a gettext translations instance.
-	pgettext is used to support message contexts,
-	but Python 2.7's gettext module doesn't support this,
-	so NVDA must provide its own implementation.
-	"""
-	if isinstance(translations, gettext.GNUTranslations):
-		def pgettext(context, message):
-			message = unicode(message)
-			try:
-				# Look up the message with its context.
-				return translations._catalog[u"%s\x04%s" % (context, message)]
-			except KeyError:
-				return message
-	else:
-		def pgettext(context, message):
-			return unicode(message)
-	return pgettext
-
-def setLanguage(lang):
-	system = platform.system()
-	global curLang
-	try:
-		if lang=="system":
-			if system == "Windows":
-				windowsLCID=ctypes.windll.kernel32.GetUserDefaultUILanguage()
-				localeName=locale.windows_locale[windowsLCID]
-			else:
-				localeName=locale.getlocale()[0]
-			trans=gettext.translation('twblue-documentation', localedir="locales", languages=[localeName])
-			curLang=localeName
-		else:
-			trans=gettext.translation("twblue-documentation", localedir="locales", languages=[lang])
-			curLang=lang
-			localeChanged=False
-			#Try setting Python's locale to lang
-			try:
-				locale.setlocale(locale.LC_ALL, lang)
-				localeChanged=True
-			except:
-				pass
-			if not localeChanged and '_' in lang:
-				#Python couldn'tsupport the language_country locale, just try language.
-				try:
-					locale.setlocale(locale.LC_ALL, lang.split('_')[0])
-				except:
-					pass
-			#Set the windows locale for this thread (NVDA core) to this locale.
-			if system == "Windows":
-				LCID=localeNameToWindowsLCID(lang)
-				ctypes.windll.kernel32.SetThreadLocale(LCID)
-	except IOError:
-		trans=gettext.translation("twblue-documentation",fallback=True)
-		curLang="en"
-	trans.install(unicode=True)
-	# Install our pgettext function.
-	__builtin__.__dict__["pgettext"] = makePgettext(trans)
-
-def getLanguage():
-	return curLang
-
-def normalizeLanguage(lang):
-	"""
-	Normalizes a  language-dialect string  in to a standard form we can deal with.
-	Converts  any dash to underline, and makes sure that language is lowercase and dialect is upercase.
-	"""
-	lang=lang.replace('-','_')
-	ld=lang.split('_')
-	ld[0]=ld[0].lower()
-	#Filter out meta languages such as x-western
-	if ld[0]=='x':
-		return None
-	if len(ld)>=2:
-		ld[1]=ld[1].upper()
-	return "_".join(ld)
-

doc/manual.md

@@ -0,0 +1,361 @@
+Documentation for TWBlue
+
+## Table of contents
+
+[TOC]
+
+## Warning!
+
+You are reading documentation produced for a program still in development. The object of this manual is to explain some details of the operation of the program. Bear in mind that as the software is in the process of active development, parts of this user guide may change in the near future, so it is advisable to keep checking from time to time to avoid missing important information.
+
+If you want to see what has changed from the previous version, [read the list of updates here.](changes.html)
+
+## Introduction
+
+TWBlue is an application to make Twitter simple and fast, while using as few resources as possible. With TWBlue, you can do things like the following:
+
+* Tweet, reply to, retweet and delete tweets,
+* Like and unlike a tweet,
+* Send and delete direct messages,
+* See your friends and followers,
+* Follow, unfollow, report and block a user,
+* Open a user's timeline to see their tweets separately,
+* Open URLs from a tweet or direct message,
+* Play several types of audio files from addresses,
+* And more.
+
+## Usage
+
+Twitter is a social networking or micro-blogging tool which allows you to compose short status updates of your activities in 280 characters or less. Twitter is a way for friends, family and co-workers to communicate and stay connected through the exchange of quick, frequent messages. You can restrict delivery of updates to those in your circle of friends or, by default, allow anyone to access them.
+
+You can monitor the status of updates from your friends, family or co-workers (known as following), and they in turn can read any updates you create, (known as followers). The updates are referred to as Tweets. The Tweets are posted to your Twitter profile or Blog and are searchable using Twitter Search.
+
+In order to use TWBlue, you must first have created an account on the Twitter website. The process for signing up for a Twitter account is very accessible. During the account registration, you will need to choose a Twitter username. This serves two purposes. This is the method through which people will comunicate with you, but most importantly, your username and password will be required to connect TWBlue to your Twitter account. We suggest you choose a username which is memorable both to you and the people you hope will follow you.
+
+We'll start from the premise that you have a Twitter account with its corresponding username and password.
+
+### Authorising the application
+
+First of all, it's necessary to authorise the program so it can access your Twitter account and act on your behalf. The authorisation process is quite simple, and the program never retains data such as your password. In order to authorise the application, you just need to run the main executable file, called TWBlue.exe (on some computers it may appear simply as TWBlue if Windows Explorer is not set to display file extensions). We suggest you may like to place a Windows shortcut on your Desktop pointing to this executable file for quick and easy location.
+
+You can log into several Twitter accounts simultaneously. The program refers to each Twitter account you have configured as a "Session". If this is the first time you have launched TWBlue, and if no Twitter session exists, you will see the Session Manager. This dialogue box allows you to authorise as many accounts as you wish. If you press the Tab key to reach the "new account" button and activate it by pressing the Space Bar, a dialogue box will advise you that your default internet browser will be opened in order to authorise the application and you will be asked if you would like to continue. Activate the "yes" Button by pressing the letter "Y" so the process may start.
+
+Your default browser will open on the Twitter page to request authorisation. Enter your username and password into the appropriate edit fields if you're not already logged in, select the authorise button, and press it.
+
+Once you've authorised your twitter account, the website will redirect you to a page which will notify you that TWBlue has been authorised successfully. On this page, you will be shown a code composed of several numbers that you must paste in the TWBlue authorization dialogue in order to allow the application to access your account. Once you have pasted the code in the corresponding text field, press enter to finish the account setup and go back to the session manager. On the session list, you will see a new item temporarily called "Authorised account x" -where x is a number. The session name will change once you open that session.
+
+To start running TWBlue, press the Ok button in the Session Manager dialogue. By default, the program starts all the configured sessions automatically, however, you can change this behavior.
+
+If all went well, the application will start playing sounds, indicating your data is being updated.
+
+When the process is finished, by default the program will play another sound, and the screen reader will say "ready" (this behaviour can be configured).
+
+## General concepts
+
+Before starting to describe TWBlue's usage, we'll explain some concepts that will be used extensively throughout this manual.
+
+### Buffer
+
+A buffer is a list of items to manage the data which arrives from Twitter, after being processed by the application. When you configure a new session on TWBlue and start it, many buffers are created. Each of them may contain some of the items which this program works with: Tweets, direct messages, users, trends or. According to the buffer you are focusing, you will be able to do different actions with these items.
+
+The following is a description for every one of TWBlue's buffers and the kind of items they work with.
+
+* Home: this shows all the tweets on the main timeline. These are the tweets by users you follow.
+* Mentions: if a user, whether you follow them or not, mentions you on Twitter, you will find it in this list.
+* Direct messages: here you will find the private direct messages you exchange with users who follow you , or with any user, if you allow direct messages from everyone (this setting is configurable from Twitter). This list only shows received messages.
+* Sent direct messages: this buffer shows all the direct messages sent from your account.
+* Sent tweets: this shows all the tweets sent from your account.
+* Likes: here you will see all the tweets you have liked.
+* Followers: when users follow you, you'll be able to see them on this buffer, with some of their account details.
+* Friends: the same as the previous buffer, but these are the users you follow.
+* User timelines: these are buffers you may create. They contain only the tweets by a specific user. They're used so you can see the tweets by a single person and you don't want to look all over your timeline. You may create as many as you like.
+* Lists: A list is similar to a user timeline, except that you can configure it to contain tweets from multiple users.
+* Search: A search buffer contains the results of a search operation.
+* User likes: You can have the program create a buffer containing tweets liked by a particular user.
+* Followers or following timeline: You can have TWBlue create a buffer containing all users who follow, or are followed by a specific user.
+* Trending Topics: a trend buffer shows the top ten most used terms in a geographical region. This region may be a country or a city. Trends are updated every five minutes.
+
+If a tweet contains a URL, you can press enter in the GUI or Control + Windows + Enter in the invisible interface to open it. If it contains video or audio, including live stream content, you can press Control + Enter or Control + Windows + Alt + Enter to play it, respectively. TWBlue will play a sound if the tweet contains video metadata or the \#audio hashtag, but there may be tweets which contain media without this. Finally, if a tweet contains geographical information, you can press Control + Windows + G in the invisible interface to retrieve it.
+
+### Username fields
+
+These fields accept a Twitter username (without the at sign) as the input. They are present in the send direct message, the user actions dialogue and the user alias dialogue boxes, to name a few examples. Those dialogues will be discussed later. The initial value of these fields depends on where they were opened from. They are prepopulated with the username of the sender of the focused tweet (if they were opened from the home and sent timelines, from users' timelines or from lists), the sender of the focused direct message (if from the received or sent direct message buffers) or in the focused user (if from the followers' or friends' buffer). If one of those dialogue boxes is opened from a tweet, and if there are more users mentioned in it, you can use the arrow keys to switch between them. Alternatively, you can also type a username.
+
+## The program's interfaces
+
+### The graphical user interface (GUI)
+
+The graphical user interface of TWBlue consists of a window containing:
+
+* a menu bar accomodating six  menus (application, tweet, user, buffer, audio and help);
+* One tree view,
+* One list of items
+* Four buttons in most dialogs: Tweet, retweet , reply and direct message.
+
+The actions that are available for every item will be described later.
+
+In summary, the GUI contains two core components. These are the controls you will find while pressing the Tab key within the program's interface, and the different elements present on the menu bar.
+
+#### Buttons in the application
+
+* Tweet: this button opens up a dialogue box to write your tweet. Normal tweets must not exceed 280 characters. However you can press the long tweet checkbox and your tweet will be posted throught Twishort, wich will allow you to write longer tweets (10000 characters). If you write past this limit, a sound will play to warn you. Note that the character count is displayed in the title bar. You can upload a picture, check spelling, attach audio or translate your message by selecting one of the available buttons in the dialogue box. In addition, you can autocomplete the entering of users by pressing Alt + C or the button for that purpose if you have the database of users configured. Press enter to send the tweet. If all goes well, you'll hear a sound confirming it. Otherwise, the screen reader will speak an error message in English describing the problem.
+* Retweet: this button retweets the message you're reading. After you press it, if you haven't configured the application not to do so, you'll be asked if you want to add a comment or simply send it as written. If you choose to add a comment,  it will post a quoted tweet, that is,  the comment with a  link to the originating tweet.
+* Reply: when you're viewing a tweet, you can reply to the user who sent it by pressing this button. A dialogue will open up similar to the one for tweeting. If there are more users referred to in the tweet, you can press tab and activate the mention to all checkbox, or enabling checkbox for the users you want to mention separately. Note, however, that sometimes -especially when replying to a retweet or quoted tweet, the user who made the retweet or quote may also be mentioned. This is done by Twitter automatically. When you're on the friends or followers lists, the button will be called mention instead.
+* Direct message: exactly like sending a tweet, but it's a private message which can only be read by the user you send it to. Press shift-tab twice to see the recipient. If there were other users mentioned in the tweet you were reading, you can arrow up or down to choose which one to send it to, or write the username yourself without the at sign. In addition, you can autocomplete the entering of users by pressing Alt + C or the button for that purpose if you have the database of users configured.
+
+Bear in mind that buttons will appear according to which actions are possible on the list you are browsing. For example, on the home timeline, mentions, sent, likes and user timelines you will see the four buttons, while on the direct messages list you'll only get the direct message and tweet buttons, and on friends and followers lists the direct message, tweet, and mention buttons will be available.
+
+#### Menus
+
+Visually, Towards the top of the main application window, can be found a menu bar which contains many of the same functions as listed in the previous section, together with some additional items. To access the menu bar, press the alt key. You will find six menus listed: application, tweet, user, buffer, audio and help. This section describes the items on each one of them.
+
+##### Application menu
+
+* Manage accounts: Opens a window with all the sessions configured in TWBlue, where you can add new sessions or delete the ones you've already created.
+* Update profile: opens a dialogue where you can update your information on Twitter: name, location, website and bio. If you have already set this up the fields will be prefilled with the existing information. Also, you can upload a photo to your profile.
+* Hide window: turns off the Graphical User Interface. Read the section on the invisible interface for further details.
+* Search: shows a dialogue box where you can search for tweets or users on Twitter.
+* Lists Manager: This dialogue box allows you to manage your Twitter lists. In order to use them, you must first create them. Here, you can view, edit, create, delete or, optionally, open them in buffers similar to user timelines.
+* Manage user aliases: Opens up a dialogue where you can manage user aliases for the active session. In this dialog you can add new aliases, as well as edit and delete existing ones.
+* Edit keystrokes: this opens a dialogue where you can see and edit the shortcuts used in the invisible interface.
+* Account settings: Opens a dialogue box which lets you customize settings for the current account.
+* Global settings: Opens a dialogue which lets you configure settings for the entire application.
+* Exit: asks whether you want to exit the program. If the answer is yes, it closes the application. If you do not want to be asked for confirmation before exiting, uncheck the checkbox from the global settings dialogue box.
+
+##### Tweet menu
+
+* You will first find the items to tweet, reply and retweet, which are equivalent to the buttons with the same name.
+* Like: Adds the tweet you're viewing to your likes list.
+* Unlike: removes the tweet from your likes, but not from Twitter.
+* Show tweet: opens up a dialogue box where you can read the tweet, direct message, friend or follower which has focus. You can read the text with the arrow keys. It's a similar dialog box as used for composing tweets, without the ability to send the tweet, file attachment and autocompleting capabilities. It does however include a retweets and likes count. If you are in the followers or the friends list, it will only contain a read-only edit box with the information in the focused item and a close button.
+* View address: If the selected tweet has geographical information, TWBlue may display a dialogue box where you can read the tweet address. This address is retrieved by sending the geographical coordinates of the tweet to Google maps.
+* View conversation: If you are focusing a tweet with a mention, it opens a buffer where you can view the whole conversation.
+* Read text in pictures: Attempt to apply OCR technology to the image attached to the tweet. The result will be displayed in another dialog.
+* Delete: permanently removes the tweet or direct message which has focus from Twitter and from your lists. Bear in mind that Twitter only allows you to delete tweets you have posted yourself.
+
+##### User menu
+
+* Actions: Opens a dialogue where you can interact with a user. This dialogue box will be populated with the user who sent the tweet or direct message in focus or the selected user in the friends or followers buffer. You can edit it or leave it as is and choose one of the following actions:
+ * Follow: Follows a user. This means you'll see his/her tweets on your home timeline, and if he/she also follows you, you'll be able to exchange direct messages. You may also send / receive direct messages from each other if you have configured the option to allow direct messages from anyone.
+ * Unfollow: Stops following a user, which causes you not being able to see his/her tweets on your main timeline neither exchanging direct messages, unless they have enabled receiving direct messages from anyone.
+ * Mute: While muting someone, TWBlue won't show you nor his/her tweets on your main timeline; neither will you see that person's mentions. But you both will be able to exchange direct messages. The muted user is not informed of this action.
+ * Unmute: this option allows TWBlue to display the user's tweets and mentions again.
+ * Block: Blocks a user. This forces the user to unfollow you .
+ * Unblock: Stops blocking a user.
+ * Report as spam: this option sends a message to Twitter suggesting the user is performing prohibited practices on the social network.
+ * Ignore tweets from this client: Adds the client from which the focused tweet was sent to the ignored clients list.
+* View timeline: Lets you open a user's timeline by choosing the user in a dialog box. It is created when you press enter. If you invoke this option relative to a user that has no tweets, the operation will fail. If you try creating an existing timeline the program will warn you and will not create it again.
+* Direct message: same action as the button.
+* Add Alias: An user alias allows you to rename user's display names on Twitter, so the next time you'll read an user it will be announced as you configured. This feature works only if you have set display screen names unchecked, in account settings.
+* Add to List: In order to see someone's tweets in one or more of your lists, you must add them first. In the dialogue box that opens after selecting the user, you will be asked to select the list you wish to add the user to. Thereafter, the list will contain a new member and their tweets will be displayed there.
+* Remove from list: lets you remove a user from a list.
+* View lists: Shows the lists created by a specified user.
+* Show user profile: opens a dialogue with the profile of the specified user.
+* View likes: Opens a buffer where you can see the tweets which have been liked by a particular user.
+
+##### Buffer menu
+
+* Update buffer: Retrieves the newest items for the focused buffer. Normally, every buffer gets updated every couple of minutes, however you can force a specific buffer to be updated inmediately. Take into account, however, that the usage of this option repeatedly might exceed your allowed Twitter's API usage, in which case you would have to wait until it gets reset, tipycally within the next 15 minutes.
+* New trending topics buffer: This opens a buffer to get the worlwide trending topics or those of a country or a city. You'll be able to select from a dialogue box if you wish to retrieve countries' trends, cities' trends or worldwide trends (this option is in the cities' list) and choose one from the selected list. The trending topics buffer will be created once the "OK" button has been activated within the dialogue box. Remember this kind of buffer will be updated every five minutes.
+* Load previous items: This allows more items to be loaded for the specified buffer.
+* Create filter: Creates a filter in the current buffer. Filters allow loading or ignoring tweets that meet certain conditions into a buffer. You can, for example, set a filter in the "home" buffer that loads tweets that are in English language only. By default, the filter creation dialog will place the focus on the field to name the filter. Currently, you can filter by word, by language, or both. In the filter by word, you can make TWBlue allow or ignore tweets with the desired word. In the filter by language, you can make the program load tweets in the languages you want, or ignore tweets written in certain languages. Once created, every filter will be saved in the session config and will be kept across application restarts.
+* Manage filters: Opens up a dialogue which allows you to delete filters for the current session.
+* Find a string in the currently focused buffer: Opens a dialogue where you can search for items in the current buffer.
+* Mute: Mutes notifications of a particular buffer so you will not hear when new tweets arrive.
+* autoread: When enabled, the screen reader or SAPI 5 Text to Speech voice (if enabled) will read the text of incoming tweets. Please note that this could get rather chatty if there are a lot of incoming tweets.
+* Clear buffer: Deletes all items from the buffer.
+* Destroy: dismisses the list you're on.
+
+##### Audio menu
+
+* Play/pause: try to play audio for the selected item (if available), or stop the currently played audio.
+* Seek back 5 seconds: If an audio is being played, seek 5 seconds back in the playback. This will work only in audio files. This feature cannot be used in radio stations or other streamed files.
+* Seek forward 5 seconds: If an audio is being played, seek 5 seconds forward  in the playback. This feature cannot be used in radio stations or other streamed files.
+
+##### Help menu
+
+* Documentation: opens up this file, where you can read some useful program concepts.
+* Sounds tutorial: Opens a dialog box where you can familiarize yourself with the different sounds of the program.
+* What's new in this version?: opens up a document with the list of changes from the current version to the earliest.
+* Check for updates: every time you open the program it automatically checks for new versions. If an update is available, it will ask you if you want to download the update. If you accept, the updating process will commence. When complete, TWBlue will be restarted. This item checks for new updates without having to restart the application.
+* TWBlue's website: visit our [home page](https://twblue.mcvsoftware.com) where you can find all relevant information and downloads for TWBlue and become a part of the community.
+* Get soundpacks for TWBlue: 
+* Make a Donation: Opens a website from which you can donate to the TWBlue project. Donations are made through paypal and you don't need an account to donate.
+* About TWBlue: shows the credits of the program.
+
+### The invisible user interface
+
+The invisible interface, as its name suggests, has no graphical window and works directly with screen readers such as JAWS for Windows, NVDA and System Access. This interface is disabled by default, but you can enable it by pressing Control + M. It works similarly to TheQube and Chicken Nugget. Its shortcuts are similar to those found in these two clients. In addition, the program has builtin support for the keymaps for these applications, configurable through the global settings dialogue. By default, you cannot use this interface's shortcuts in the GUI, but you can configure this in the global settings dialogue.
+
+The next section contains a list of keyboard shortcuts for both interfaces. Bear in mind that we will only describe the default keymap.
+
+## Keyboard shortcuts
+
+### Shortcuts of the graphical user interface (GUI)
+
+* Enter: Open URL.
+* Control + Enter: Play audio.
+* Control + M: Hide the GUI.
+* Control + N: Compose a new tweet.
+* Control + R: Reply / mention.
+* Control + Shift + R: Retweet.
+* Control + D: Send a direct message.
+* control + F: Add tweet to likes.
+* Control + Shift + F: Remove a tweet from likes.
+* Control + S: Open the user actions dialogue.
+* Control + Shift + V: Show tweet.
+* Control + Q: Quit this program.
+* Control + I: Open user timeline.
+* Control + Shift + i: Destroy buffer.
+* F5: Increase volume by 5%.
+* F6: Decrease volume by 5%.
+* Control + P: Edit your profile.
+* Control + Delete: Delete a tweet or direct message.
+* Control + Shift + Delete: Empty the current buffer.
+
+### Shortcuts of the invisible interface (default keymap)
+
+The invisible interface of TWBlue can be customised by using a keymap. Every keymap defines a set of keystrokes to be used along with the invisible interface. You can change the keymap in the global settings dialogue, under the application menu in the menu bar, and check or edit keystrokes for the selected keymap in the keystroke editor, also available in the application menu.
+
+* Control + Windows + Up Arrow: moves to the previous item in the buffer.
+* Control + Windows + Down Arrow: moves to the next item in the buffer.
+* Control + Windows + Left Arrow: Move to the previous buffer.
+* Control + Windows + Right Arrow: Move to the next buffer.
+* Control + Windows + Shift + Left: Focus the previous session.
+* Control + Windows + Shift + Right: Focus the next session.
+* Control + Windows + C: View conversation.
+* Control + Windows + Enter: Open URL.
+* Control + Windows + ALT + Enter: Play audio.
+* Control + Windows + M: Show or hide the GUI.
+* Control + Windows + N: New tweet.
+* Control + Windows + R: Reply / Mention.
+* Control + Windows + Shift + R: Retweet.
+* Control + Windows + D: Send direct message.
+* Windows+ Alt + F: Like a tweet.
+* Alt + Windows + Shift + F: Remove from likes.
+* Control + Windows + S: Open the user actions dialogue.
+* Control + Windows + Alt + N: See user details.
+* Control + Windows + V: Show tweet.
+* Control + Windows + F4: Quit TWBlue.
+* Control + Windows + I: Open user timeline.
+* Control + Windows + Shift + I: Destroy buffer.
+* Control + Windows + Alt + Up: Increase volume by 5%.
+* Control + Windows + Alt + Down: Decrease volume by 5%.
+* Control + Windows + Home: Jump to the first element of the current buffer.
+* Control + Windows + End: Jump to the last element of the current buffer.
+* Control + Windows + PageUp: Jump 20 elements up in the current buffer.
+* Control + Windows + PageDown: Jump 20 elements down in the current buffer.
+* Windows + Alt + P: Edit profile.
+* Control + Windows + Delete: Delete a tweet or direct message.
+* Control + Windows + Shift + Delete: Empty the current buffer.
+* Control + Windows + Space: Repeat last item.
+* Control + Windows + Shift + C: Copy to clipboard.
+* Control + Windows+ A: Add user to list.
+* Control + Windows + Shift + A: Remove user from list.
+* Control + Windows + Shift + M: Mute / unmute the current buffer.
+* Windows + Alt + M: Mute / unmute the current session.
+* Control + Windows + E: Toggle the automatic reading of incoming tweets in the current buffer.
+* Control + Windows + -: Search on Twitter.
+* Control + Windows + K: Show the keystroke editor.
+* Control + Windows + L: Show lists for a specified user.
+* Windows + Alt + PageUp: Load previous items for the current buffer.
+* Control + Windows + G: Get geolocation.
+* Control + Windows + Shift + G: Display the tweet's geolocation in a dialogue.
+* Control + Windows + T: Create a trending topics' buffer.
+* Control + Windows + {: Find a string in the current buffer.
+* Alt + Windows + O: Extracts text from the picture and display the result in a dialog.
+
+## Configuration
+
+As described above, this application has two configuration dialogues, the global settings dialogue and the account settings dialogue.
+
+### The account settings dialogue
+
+#### General tab
+
+* Autocompletion settings: Allows you to configure the autocompletion database. You can add users manually or let TWBlue add your followers, friends or both.
+* Relative timestamps: Allows you to configure whether the application will calculate the time the tweet or direct message was sent or received based on the current time, or simply say the time it was received or sent.
+* API calls: Allows you to adjust the number of API calls to be made to Twitter by this program.
+* Items on each API call: Allows you to specify how many items should be retrieved from Twitter for each API call (default and maximum is 200).
+* Inverted buffers: Allows you to specify whether the buffers should be inverted, which means that the oldest items will show at the end of them and the newest at the beginning.
+* Retweet mode: Allows you to specify the behaviour when posting a retweet: you can choose between retweeting with a comment, retweeting without comment or being asked.
+* Number of items per buffer to cache in database: This allows you to specify how many items TWBlue should cache in a database. You can type any number, 0 to cache all items, or leave blank to disable caching entirely.
+
+#### buffers tab
+
+This tab displays a list for each buffer you have available in TWBlue, except for searches, timelines, likes' timelines and lists. You can show, hide and move them.
+
+#### The ignored clients tab
+
+In this tab, you can add and remove clients to be ignored by the program.
+
+#### Sound tab
+
+In this tab, you can adjust the sound volume, select the input and output device and set the soundpack used by the program.
+
+#### Audio service tab
+
+In this tab, you can enter your SndUp API key (if you have one) to upload audio to SndUp with your account. Note that if account credentials are not specified you will upload anonimously.
+
+### Global settings
+
+This dialogue allows you to configure some settings which will affect the entire application.
+
+#### General tab {#general-tab_1}
+
+* Language: This allows you to change the language of this program. Currently supported languages are arabic, Catalan, German, English, Spanish, Basque, Finnish, French, Galician, Croatian, Hungarian, Italian, Polish, Portuguese, Russian and Turkish.
+* Ask before exiting TWBlue: This checkbox allows you to control whetherthe program will ask for confirmation before exiting.
+* Play a sound when TWBlue launches: This checkbox allows you to configure whether the application will play a sound when it has finished loading the buffers.
+* Speak a message when TWBlue launches: This is the same as the previous option, but this checkbox configures whether the screen reader will say "ready".
+* Use the invisible interface's shortcuts in the GUI: As the invisible interface and the Graphical User Interface have their own shortcuts, you may want to use the invisible interface's keystrokes all the time. If this option is checked, the invisible interface's shortcuts will be usable in the GUI.
+* Activate SAPI5 when any other screen reader is not being run: This checkbox allows to activate SAPI 5 TTS when no other screen reader is being run.
+* Hide GUI on launch: This allows you to configure whether TWBlue will start with the GUI or the invisible interface.
+* Keymap: This option allows you to change the keymap used by the program in the invisible interface. The shipped keymaps are Default, Qwitter, Windows 10 and Chicken Nugget. The keymaps are in the "keymaps" folder, and you can create new ones. Just create a new ".keymap" file and change the keystrokes associated with the actions, as it is done in the shipped keymaps.
+
+#### Proxi tab
+
+In this tab you can configure TWBlue to use a Proxy server by completing the fields displayed (type, server, port, user and password).
+
+## License, source code and donations
+
+Tw Blue is free software, licensed under the GNU GPL license, either version 2 or, at your option, any later version. You can view the license in the file named license.txt, or online at <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>.
+
+The source code of the program is available on GitHub at <https://www.github.com/manuelcortez/twblue>.
+
+If you want to donate to the project, you can do so at <https://twblue.mcvsoftware.com/donate>. Thank you for your support!
+
+## Contact
+
+If you still have questions after reading this document, if you wish to collaborate to the project in some other way, or if you simply want to get in touch with the application developer, follow the Twitter account [@tw\_blue2](https://twitter.com/tw_blue2) or [@manuelcortez00.](https://twitter.com/manuelcortez00) You can also visit [our website](https://twblue.mcvsoftware.com)
+
+## Credits
+
+TWBlue is developed and maintained by [Manuel Cortéz](https://twitter.com/manuelcortez00) and [José Manuel Delicado](https://twitter.com/jmdaweb).
+
+We would also like to thank the translators of TWBlue, who have allowed the spreading of the application.
+
+* Arabic: [Mohammed Al Shara,](https://twitter.com/mohammed0204) [Hatoun Felemban](https://twitter.com/HatounFelemban)
+* Basque: [Sukil Etxenike](https://twitter.com/sukil2011).
+* Catalan: [Francisco Torres](https://twitter.com/ftgalleg)
+* Croatian: [Zvonimir Stanečić](https://twitter.com/zvonimirek222).
+* English: [Manuel Cortéz](https://twitter.com/manuelcortez00).
+* Finnish: [Jani Kinnunen](https://twitter.com/jani_kinnunen).
+* French: [Rémy Ruiz](https://twitter.com/blindhelp38).
+* Galician: [Juan Buño](https://twitter.com/Quetzatl_).
+* German: [Steffen Schultz](https://twitter.com/schulle4u).
+* Hungarian: Robert Osztolykan.
+* Italian: [Christian Leo Mameli](https://twitter.com/llajta2012).
+* Japanese: [Riku](https://twitter.com/_riku02)
+* Polish: [Pawel Masarczyk.](https://twitter.com/Piciok)
+* Portuguese: [Odenilton Júnior Santos.](https://twitter.com/romaleif)
+* Romanian: [Florian Ionașcu](https://twitter.com/florianionascu7) and [Nicușor Untilă](https://twitter.com/dj_storm2001)
+* Russian: [Наталья Хедлунд](https://twitter.com/Lifestar_n) and [Валерия Кузнецова](https://twitter.com/ValeriaK305).
+* Serbian: [Aleksandar Đurić](https://twitter.com/sokodtreshnje)
+* Spanish: [Manuel Cortéz](https://twitter.com/manuelcortez00).
+* Turkish: [Burak Yüksek](https://twitter.com/burakyuksek).
+
+Many thanks also to the people who worked on the documentation. Initially, [Manuel Cortez](https://twitter.com/manuelcortez00) did the documentation in Spanish, and translated to English by [Bryner Villalobos](https://twitter.com/Bry_StarkCR), [Robert Spangler](https://twitter.com/glasscity1837), [Sussan Rey](https://twitter.com/sussanrey17), [Anibal Hernandez](https://twitter.com/AnimalMetal), and [Holly Scott-Gardner](https://twitter.com/CatchTheseWords). It was updated by [Sukil Etxenike](https://twitter.com/sukil2011), with some valuable corrections by [Brian Hartgen](https://twitter.com/brianhartgen) and [Bill Dengler](https://twitter.com/codeofdusk).
+
+------------------------------------------------------------------------
+
+Copyright © 2013-2021. Manuel Cortéz

doc/paths.py

@@ -0,0 +1,67 @@
+# -*- coding: utf-8 -*-
+import sys
+import platform
+import os
+import glob
+from platform_utils import paths as paths_
+
+mode = "portable"
+directory = None
+fsencoding = sys.getfilesystemencoding()
+
+if len(glob.glob("Uninstall.exe")) > 0: # installed copy
+	mode= "installed"
+
+def app_path():
+	return paths_.app_path()
+
+def config_path():
+	global mode, directory
+	if mode == "portable":
+		if directory != None: path = os.path.join(directory, "config")
+		elif directory == None: path = os.path.join(app_path(), "config")
+	elif mode == "installed":
+		path = os.path.join(data_path(), "config")
+	if not os.path.exists(path):
+#		log.debug("%s path does not exist, creating..." % (path,))
+		os.mkdir(path)
+	return path
+
+def logs_path():
+	global mode, directory
+	if mode == "portable":
+		if directory != None: path = os.path.join(directory, "logs")
+		elif directory == None: path = os.path.join(app_path(), "logs")
+	elif mode == "installed":
+		path = os.path.join(data_path(), "logs")
+	if not os.path.exists(path):
+#		log.debug("%s path does not exist, creating..." % (path,))
+		os.mkdir(path)
+	return path
+
+def data_path(app_name='socializer'):
+	if platform.system() == "Windows":
+		data_path = os.path.join(os.getenv("AppData"), app_name)
+	else:
+		data_path = os.path.join(os.environ['HOME'], ".%s" % app_name)
+	if not os.path.exists(data_path):
+		os.mkdir(data_path)
+	return data_path
+
+def locale_path():
+	return os.path.join(app_path(), "locales")
+
+def sound_path():
+	return os.path.join(app_path(), "sounds")
+
+def com_path():
+	global mode, directory
+	if mode == "portable":
+		if directory != None: path = os.path.join(directory, "com_cache")
+		elif directory == None: path = os.path.join(app_path(), "com_cache")
+	elif mode == "installed":
+		path = os.path.join(data_path(), "com_cache")
+	if not os.path.exists(path):
+#		log.debug("%s path does not exist, creating..." % (path,))
+		os.mkdir(path)
+	return path

doc/strings.py

@@ -1,427 +0,0 @@
-# -*- coding: utf-8 -*-
-import application
-documentation = []
-documentation.append(_(u"""Documentation for TWBlue - {0}""").format(application.version))
-# Translators: This is the new line character, don't change it in the translations.
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""## Table of contents"""))
-# Table of contents for the python markdown extension
-documentation.append("""[TOC]""")
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""## Warning!"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""You are reading documentation produced for a program still in development. The object of this manual is to explain some details of the operation of the program. Bear in mind that as the software is in the process of active development, parts of this user guide may change in the near future, so it is advisable to keep checking from time to time to avoid missing important information."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""If you want to see what has changed from the previous version, [read the list of updates here.](changes.html)"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""## Introduction"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""TWBlue is an application to make Twitter simple and fast, while using as few resources as possible. With TWBlue, you can do things like the following:"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""* Tweet, reply to, retweet and delete tweets,"""))
-documentation.append(_(u"""* Mark and unmark a tweet as favourite,"""))
-documentation.append(_(u"""* Send and delete direct messages,"""))
-documentation.append(_(u"""* See your friends and followers,"""))
-documentation.append(_(u"""* Follow, unfollow, report and block a user,"""))
-documentation.append(_(u"""* Open a user's timeline to see their tweets separately,"""))
-documentation.append(_(u"""* Open URLs from a tweet or direct message,"""))
-documentation.append(_(u"""* Play several types of audio files from addresses,"""))
-documentation.append(_(u"""* And more."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""## Usage"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""Twitter is a social networking or micro-blogging tool which allows you to compose short status updates of your activities in 140 characters or less. Twitter is a way for friends, family and co-workers to communicate and stay connected through the exchange of quick, frequent messages. You can restrict delivery of updates to those in your circle of friends or, by default, allow anyone to access them."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""You can monitor the status of updates from your friends, family or co-workers (known as following), and they in turn can read any updates you create, (known as followers). The updates are referred to as Tweets. The Tweets are posted to your Twitter profile or Blog and are searchable using Twitter Search."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""In order to use TWBlue, you must first have created an account on the Twitter website. The process for signing up for a Twitter account is very accessible. During the account registration, you will need to choose a Twitter username. This serves two purposes. This is the method through which people will comunicate with you, but most importantly, your username and password will be required to connect TWBlue to your Twitter account. We suggest you choose a username which is memorable both to you and the people you hope will follow you."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""We'll start from the premise that you have a Twitter account with its corresponding username and password."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""### Authorising the application"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""First of all, it's necessary to authorise the program so it can access your Twitter account and act on your behalf. The authorisation process is quite simple, and the program never retains data such as your password. In order to authorise the application, you just need to run the main executable file, called TWBlue.exe (on some computers it may appear simply as TWBlue if Windows Explorer is not set to display file extensions). We suggest you may like to place a Windows shortcut on your Desktop pointing to this executable file for quick and easy location."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""You can log into several Twitter accounts simultaneously. The program refers to each Twitter account you have configured as a "Session". If this is the first time you have launched TWBlue, and if no Twitter session exists, you will see the Session Manager. This dialogue box allows you to authorise as many accounts as you wish. If you press the Tab key to reach the "new account" button and activate it by pressing the Space Bar, a dialogue box will advise you that your default internet browser will be opened in order to authorise the application and you will be asked if you would like to continue. Activate the "yes" Button by pressing the letter "Y" so the process may start."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""Your default browser will open on the Twitter page to request authorisation. Enter your username and password into the appropriate edit fields if you're not already logged in, select the authorise button, and press it."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""Once you've authorised your twitter account, the website will redirect you to a page which will notify you that TWBlue has been authorised successfully. Now you are able to close the page by pressing ALT+F4 which will return you to the Session Manager. On the session list, you will see a new item temporarily called "Authorised account x" -where x is a number. The session name will change once you open that session."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""To start running TWBlue, press the Ok button in the Session Manager dialogue. By default, the program starts all the configured sessions automatically, however, you can change this behavior."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""If all went well, the application will start playing sounds, indicating your data is being updated."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""When the process is finished, by default the program will play another sound, and the screen reader will say "ready" (this behaviour can be configured)."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""## General concepts"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""Before starting to describe TWBlue's usage, we'll explain some concepts that will be used extensively throughout this manual."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""### Buffer"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""A buffer is a list of items to manage the data which arrives from Twitter, after being processed by the application. When you configure a new session on TWBlue and start it, many buffers are created. Each of them may contain some of the items which this program works with: Tweets, direct messages, users, trends or events. According to the buffer you are focusing, you will be able to do different actions with these items."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""The following is a description for every one of TWBlue's buffers and the kind of items they work with."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""* Home: this shows all the tweets on the main timeline. These are the tweets by users you follow."""))
-documentation.append(_(u"""* Mentions: if a user, whether you follow them or not, mentions you on Twitter, you will find it in this list."""))
-documentation.append(_(u"""* Direct messages: here you will find the private direct messages you exchange with users who follow you , or with any user, if you allow direct messages from everyone (this setting is configurable from Twitter). This list only shows received messages."""))
-documentation.append(_(u"""* Sent direct messages: this buffer shows all the direct messages sent from your account."""))
-documentation.append(_(u"""* Sent tweets: this shows all the tweets sent from your account."""))
-documentation.append(_(u"""* Favourites: here you will see all the tweets you have favourited."""))
-documentation.append(_(u"""* Followers: when users follow you, you'll be able to see them on this buffer, with some of their account details."""))
-documentation.append(_(u"""* Friends: the same as the previous buffer, but these are the users you follow."""))
-documentation.append(_(u"""* User timelines: these are buffers you may create. They contain only the tweets by a specific user. They're used so you can see the tweets by a single person and you don't want to look all over your timeline. You may create as many as you like."""))
-documentation.append(_(u"""* Events: An event is anything that happens on Twitter, such as when someone follows you, when someone adds or removes one of your tweets from their favourites list, or when you subscribe to a list. There are many more, but the program shows the most common ones in the events buffer so that you can easily keep track of what is happening on your account."""))
-documentation.append(_(u"""* Lists: A list is similar to a user timeline, except that you can configure it to contain tweets from multiple users."""))
-documentation.append(_(u"""* Search: A search buffer contains the results of a search operation."""))
-documentation.append(_(u"""* User favourites: You can have the program create a buffer containing tweets favourited by a particular user."""))
-documentation.append(_(u"""* Trending Topics: a trend buffer shows the top ten most used terms in a geographical region. This region may be a country or a city. Trends are updated every five minutes."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""If a tweet contains a URL, you can press enter in the GUI or Control + Windows + Enter in the invisible interface to open it. If it contains audio, you can press Control + Enter or Control + Windows + Alt + Enter to play it, respectively. TWBlue will play a sound if the tweet contains the #audio hashtag, but there may be tweets which contain audio without this. Finally, if a tweet contains geographical information, you can press Control + Windows + G in the invisible interface to retrieve it."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""### Username fields"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""These fields accept a Twitter username (without the at sign) as the input. They are present in the send direct message and the user actions dialogue boxes. Those dialogues will be discussed later. The initial value of these fields depends on where they were opened from. They are prepopulated with the username of the sender of the focused tweet (if they were opened from the home and sent timelines, from users' timelines or from lists), the sender of the focused direct message (if from the received or sent direct message buffers) or in the focused user (if from the followers' or friends' buffer). If one of those dialogue boxes is opened from a tweet, and if there are more users mentioned in it, you can use the arrow keys to switch between them. Alternatively, you can also type a username."""))
-documentation.append(_(u"""## The program's interfaces"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""### The graphical user interface (GUI)"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""The graphical user interface of TWBlue consists of a window containing:"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""* a menu bar accomodating five menus (application, tweet, user, buffer and help);"""))
-documentation.append(_(u"""* One tree view,"""))
-documentation.append(_(u"""* One list of items"""))
-documentation.append(_(u"""* Four buttons in most dialogs: Tweet, retweet , reply and direct message."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""The actions that are available for every item will be described later."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""In summary, the GUI contains two core components. These are the controls you will find while pressing the Tab key within the program's interface, and the different elements present on the menu bar."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""#### Buttons in the application"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""* Tweet: this button opens up a dialogue box to write your tweet. The message must not exceed 140 characters. If you write past this limit, a sound will play to warn you. Note that the character count is displayed in the title bar. You may use the shorten and expand URL buttons to comply with the character limit. You can upload a picture, check spelling, attach audio or translate your message by selecting one of the available buttons in the dialogue box. In addition, you can autocomplete the entering of users by pressing Alt + A or the button for that purpose if you have the database of users configured. Press enter to send the tweet. If all goes well, you'll hear a sound confirming it. Otherwise, the screen reader will speak an error message in English describing the problem."""))
-documentation.append(_(u"""* Retweet: this button retweets the message you're reading. After you press it, if you haven't configured the application not to do so, you'll be asked if you want to add a comment or simply send it as written. If you choose to add a comment, and if the original tweet plus the comment exceeds 140 characters, you will be asked if you want to post it as a comment with a mention to the original user and a link to the originating tweet."""))
-documentation.append(_(u"""* Reply: when you're viewing a tweet, you can reply to the user who sent it by pressing this button. A dialogue will open up similar to the one for tweeting, but with the name of the user already filled in (for example @user) so you only need to write your message. If there are more users referred to in the tweet, you can press shift-tab and activate the mention all users button. When you're on the friends or followers lists, the button will be called mention instead."""))
-documentation.append(_(u"""* Direct message: exactly like sending a tweet, but it's a private message which can only be read by the user you send it to. Press shift-tab to see the recipient. If there were other users mentioned in the tweet you were reading, you can arrow up or down to choose which one to send it to, or write the username yourself without the at sign."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""Bear in mind that buttons will appear according to which actions are possible on the list you are browsing. For example, on the home timeline, mentions, sent, favourites and user timelines you will see the four buttons, while on the direct messages list you'll only get the direct message and tweet buttons, and on friends and followers lists the direct message, tweet, and mention buttons will be available."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""#### Menus"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""Visually, Towards the top of the main application window, can be found a menu bar which contains many of the same functions as listed in the previous section, together with some additional items. To access the menu bar, press the alt key. You will find five menus listed: application, tweet, user, buffer and help. This section describes the items on each one of them."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""##### Application menu"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""* Manage accounts: Opens a window with all the sessions configured in TWBlue, where you can add new sessions or delete the ones you've already created."""))
-documentation.append(_(u"""* Update profile: opens a dialogue where you can update your information on Twitter: name, location, website and bio. If you have already set this up the fields will be prefilled with the existing information. Also, you can upload a photo to your profile."""))
-documentation.append(_(u"""* Hide window: turns off the Graphical User Interface. Read the section on the invisible interface for further details."""))
-documentation.append(_(u"""* Search: shows a dialogue box where you can search for tweets or users on Twitter."""))
-documentation.append(_(u"""* Lists Manager: This dialogue box allows you to manage your Twitter lists. In order to use them, you must first create them. Here, you can view, edit, create, delete or, optionally, open them in buffers similar to user timelines."""))
-documentation.append(_(u"""* Edit keystrokes: this opens a dialogue where you can see and edit the shortcuts used in the invisible interface."""))
-documentation.append(_(u"""* Account settings: Opens a dialogue box which lets you customize settings for the current account."""))
-documentation.append(_(u"""* Global settings: Opens a dialogue which lets you configure settings for the entire application."""))
-documentation.append(_(u"""* Exit: asks whether you want to exit the program. If the answer is yes, it closes the application. If you do not want to be asked for confirmation before exiting, uncheck the checkbox from the global settings dialogue box."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""##### Tweet menu"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""* You will first find the items to tweet, reply and retweet, which are equivalent to the buttons with the same name."""))
-documentation.append(_(u"""* Add to favourites: marks the tweet you're viewing as a favourite."""))
-documentation.append(_(u"""* Remove from favourites: removes the tweet from your favourites, but not from Twitter."""))
-documentation.append(_(u"""* Show tweet: opens up a dialogue box where you can read the tweet, direct message, friend or follower which has focus. You can read the text with the arrow keys. It's a similar dialog box as used for composing tweets, without the ability to send the tweet, file attachment and autocompleting capabilities. It does however include a retweets and favourites count. If you are in the followers or the friends list, it will only contain a read-only edit box with the information in the focused item and a close button."""))
-documentation.append(_(u"""* View address: If the selected tweet has geographical information, TWBlue may display a dialogue box where you can read the tweet address. This address is retrieved by sending the geographical coordinates of the tweet to Google maps."""))
-documentation.append(_(u"""* View conversation: If you are focusing a tweet with a mention, it opens a buffer where you can view the whole conversation."""))
-documentation.append(_(u"""* Delete: permanently removes the tweet or direct message which has focus from Twitter and from your lists. Bear in mind that Twitter only allows you to delete tweets you have posted yourself."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""##### User menu"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""* Actions: Opens a dialogue where you can interact with a user. This dialogue box will be populated with the user who sent the tweet or direct message in focus or the selected user in the friends or followers buffer. You can edit it or leave it as is and choose one of the following actions:"""))
-documentation.append(_(u"""    * Follow: Follows a user. This means you'll see his/her tweets on your home timeline, and if he/she also follows you, you'll be able to exchange direct messages. You may also send / receive direct messages from each other if you have configured the option to allow direct messages from anyone."""))
-documentation.append(_(u"""    * Unfollow: Stops following a user, which causes you not being able to see his/her tweets on your main timeline neither exchanging direct messages, unless they have enabled receiving direct messages from anyone."""))
-documentation.append(_(u"""    * Mute: While muting someone, TWBlue won't show you nor his/her tweets on your main timeline; neither will you see that person's mentions. But you both will be able to exchange direct messages. The muted user is not informed of this action."""))
-documentation.append(_(u"""    * Unmute: this option allows TWBlue to display the user's tweets and mentions again."""))
-documentation.append(_(u"""    * Block: Blocks a user. This forces the user to unfollow you ."""))
-documentation.append(_(u"""    * Unblock: Stops blocking a user."""))
-documentation.append(_(u"""    * Report as spam: this option sends a message to Twitter suggesting the user is performing prohibited practices on the social network."""))
-documentation.append(_(u"""    * Ignore tweets from this client: Adds the client from which the focused tweet was sent to the ignored clients list."""))
-documentation.append(_(u"""* View timeline: Lets you open a user's timeline by choosing the user in a dialog box. It is created when you press enter. If you invoke this option relative to a user that has no tweets, the operation will fail. If you try creating an existing timeline the program will warn you and will not create it again."""))
-documentation.append(_(u"""* Direct message: same action as the button."""))
-documentation.append(_(u"""* Add to List: In order to see someone's tweets in one or more of your lists, you must add them first. In the dialogue box that opens after selecting the user, you will be asked to select the list you wish to add the user to. Thereafter, the list will contain a new member and their tweets will be displayed there."""))
-documentation.append(_(u"""* Remove from list: lets you remove a user from a list."""))
-documentation.append(_(u"""* View lists: Shows the lists created by a specified user."""))
-documentation.append(_(u"""* Show user profile: opens a dialogue with the profile of the specified user."""))
-documentation.append(_(u"""* View favourites: Opens a buffer where you can see the tweets which have been favourited by a particular user."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""##### Buffer menu"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""* New trending topics buffer: This opens a buffer to get the worlwide trending topics or those of a country or a city. You'll be able to select from a dialogue box if you wish to retrieve countries' trends, cities' trends or worldwide trends (this option is in the cities' list) and choose one from the selected list. The trending topics buffer will be created once the "OK" button has been activated within the dialogue box. Remember this kind of buffer will be updated every five minutes."""))
-documentation.append(_(u"""* Load previous items: This allows more items to be loaded for the specified buffer."""))
-documentation.append(_(u"""* Mute: Mutes notifications of a particular buffer so you will not hear when new tweets arrive."""))
-documentation.append(_(u"""* autoread: When enabled, the screen reader or SAPI 5 Text to Speech voice (if enabled) will read the text of incoming tweets. Please note that this could get rather chatty if there are a lot of incoming tweets."""))
-documentation.append(_(u"""* Clear buffer: Deletes all items from the buffer."""))
-documentation.append(_(u"""* Destroy: dismisses the list you're on."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""##### Help menu"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""* Documentation: opens up this file, where you can read some useful program concepts."""))
-documentation.append(_(u"""* Sounds tutorial: Opens a dialog box where you can familiarize yourself with the different sounds of the program."""))
-documentation.append(_(u"""* What's new in this version?: opens up a document with the list of changes from the current version to the earliest."""))
-documentation.append(_(u"""* Check for updates: every time you open the program it automatically checks for new versions. If an update is available, it will ask you if you want to download the update. If you accept, the updating process will commence. When complete, TWBlue will be restarted. This item checks for new updates without having to restart the application."""))
-documentation.append(_(u"""* Report an error: opens up a dialogue box to report a bug by completing a small number of fields. Pressing enter will send the report. If the operation doesn't succeed the program will display a warning."""))
-documentation.append(_(u"""* TWBlue's website: visit our [home page](http://twblue.es) where you can find all relevant information and downloads for TWBlue and become a part of the community."""))
-documentation.append(_(u"""* About TWBlue: shows the credits of the program."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""### The invisible user interface"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""The invisible interface, as its name suggests, has no graphical window and works directly with screen readers such as JAWS for Windows, NVDA and System Access. This interface is disabled by default, but you can enable it by pressing Control + M. It works similarly to TheQube and Chicken Nugget. Its shortcuts are similar to those found in these two clients. In addition, the program has builtin support for the keymaps for these applications, configurable through the global settings dialogue. By default, you cannot use this interface's shortcuts in the GUI, but you can configure this in the global settings dialogue."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""The next section contains a list of keyboard shortcuts for both interfaces. Bear in mind that we will only describe the default keymap."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""## Keyboard shortcuts"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""### Shortcuts of the graphical user interface (GUI)"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""* Enter: Open URL."""))
-documentation.append(_(u"""* Control + Enter: Play audio."""))
-documentation.append(_(u"""* Control + M: Hide the GUI."""))
-documentation.append(_(u"""* Control + N: Compose a new tweet."""))
-documentation.append(_(u"""* Control + R: Reply / mention."""))
-documentation.append(_(u"""* Control + Shift + R: Retweet."""))
-documentation.append(_(u"""* Control + D: Send a direct message."""))
-documentation.append(_(u"""* control + F: Add tweet to favourites."""))
-documentation.append(_(u"""* Control + Shift + F: Remove a tweet from favourites."""))
-documentation.append(_(u"""* Control + S: Open the user actions dialogue."""))
-documentation.append(_(u"""* Control + Shift + V: Show tweet."""))
-documentation.append(_(u"""* Control + Q: Quit this program."""))
-documentation.append(_(u"""* Control + I: Open user timeline."""))
-documentation.append(_(u"""* Control + Shift + i: Destroy buffer."""))
-documentation.append(_(u"""* F5: Increase volume by 5%."""))
-documentation.append(_(u"""* F6: Decrease volume by 5%."""))
-documentation.append(_(u"""* Control + P: Edit your profile."""))
-documentation.append(_(u"""* Control + Delete: Delete a tweet or direct message."""))
-documentation.append(_(u"""* Control + Shift + Delete: Empty the current buffer."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""### Shortcuts of the invisible interface (default keymap)"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""* Control + Windows + Up Arrow: moves to the previous item in the buffer."""))
-documentation.append(_(u"""* Control + Windows + Down Arrow: moves to the next item in the buffer."""))
-documentation.append(_(u"""* Control + Windows + Left Arrow: Move to the previous buffer."""))
-documentation.append(_(u"""* Control + Windows + Right Arrow: Move to the next buffer."""))
-documentation.append(_(u"""* Control + Windows + Shift + Left: Focus the previous session."""))
-documentation.append(_(u"""* Control + Windows + Shift + Right: Focus the next session."""))
-documentation.append(_(u"""* Control + Windows + C: View conversation."""))
-documentation.append(_(u"""* Control + Enter: Open URL."""))
-documentation.append(_(u"""* Control + Windows + Enter: Play audio."""))
-documentation.append(_(u"""* Control + Windows + M: Show or hide the GUI."""))
-documentation.append(_(u"""* Control + Windows + N: New tweet."""))
-documentation.append(_(u"""* Control + Windows + R: Reply / Mention."""))
-documentation.append(_(u"""* Control + Windows + Shift + R: Retweet."""))
-documentation.append(_(u"""* Control + Windows + D: Send direct message."""))
-documentation.append(_(u"""* Windows+ Alt + F: Mark as favourite."""))
-documentation.append(_(u"""* Alt + Windows + Shift + F: Remove from favourites."""))
-documentation.append(_(u"""* Control + Windows + S: Open the user actions dialogue."""))
-documentation.append(_(u"""* Control + Windows + Alt + N: See user details."""))
-documentation.append(_(u"""* Control + Windows + V: Show tweet."""))
-documentation.append(_(u"""* Control + Windows + F4: Quit TWBlue."""))
-documentation.append(_(u"""* Control + Windows + I: Open user timeline."""))
-documentation.append(_(u"""* Control + Windows + Shift + I: Destroy buffer."""))
-documentation.append(_(u"""* Control + Windows + Alt + Up: Increase volume by 5%."""))
-documentation.append(_(u"""* Control + Windows + Alt + Down: Decrease volume by 5%."""))
-documentation.append(_(u"""* Control + Windows + Home: Jump to the first element of the current buffer."""))
-documentation.append(_(u"""* Control + Windows + End: Jump to the last element of the current buffer."""))
-documentation.append(_(u"""* Control + Windows + PageUp: Jump 20 elements up in the current buffer."""))
-documentation.append(_(u"""* Control + Windows + PageDown: Jump 20 elements down in the current buffer."""))
-documentation.append(_(u"""* Windows + Alt + P: Edit profile."""))
-documentation.append(_(u"""* Control + Windows + Delete: Delete a tweet or direct message."""))
-documentation.append(_(u"""* Control + Windows + Shift + Delete: Empty the current buffer."""))
-documentation.append(_(u"""* Control + Windows + Space: Repeat last item."""))
-documentation.append(_(u"""* Control + Windows + Shift + C: Copy to clipboard."""))
-documentation.append(_(u"""* Control + Windows+ A: Add user to list."""))
-documentation.append(_(u"""* Control + Windows + Shift + A: Remove user from list."""))
-documentation.append(_(u"""* Control + Windows + M: Mute / unmute the current buffer."""))
-documentation.append(_(u"""* Windows + Alt + M: Mute / unmute the current session."""))
-documentation.append(_(u"""* Control + Windows + E: Toggle the automatic reading of incoming tweets in the current buffer."""))
-documentation.append(_(u"""* Control + Windows + -: Search on Twitter."""))
-documentation.append(_(u"""* Control + Windows + K: Show the keystroke editor."""))
-documentation.append(_(u"""* Control + Windows + L: Show lists for a specified user."""))
-documentation.append(_(u"""* Windows + Alt + PageUp: Load previous items for the current buffer."""))
-documentation.append(_(u"""* Control + Windows + G: Get geolocation."""))
-documentation.append(_(u"""* Control + Windows + Shift + G: Display the tweet's geolocation in a dialogue."""))
-documentation.append(_(u"""* Control + Windows + T: Create a trending topics' buffer."""))
-documentation.append(_(u"""* Control + Windows + {: Find a string in the current buffer."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""## Configuration"""))
-documentation.append(_(u"""As described above, this application has two configuration dialogues, the global settings dialogue and the account settings dialogue."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""### The account settings dialogue"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""#### General tab"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""* Autocompletion settings: Allows you to configure the autocompletion database. You can add users manually or let TWBlue add your followers, friends or both."""))
-documentation.append(_(u"""* Relative timestamps: Allows you to configure whether the application will calculate the time the tweet or direct message was sent or received based on the current time, or simply say the time it was received or sent."""))
-documentation.append(_(u"""* API calls: Allows you to adjust the number of API calls to be made to Twitter by this program."""))
-documentation.append(_(u"""* Items on each API call: Allows you to specify how many items should be retrieved from Twitter for each API call (default and maximum is 200)."""))
-documentation.append(_(u"""* Inverted buffers: Allows you to specify whether the buffers should be inverted, which means that the oldest items will show at the end of them and the newest at the beginning."""))
-documentation.append(_(u"""* Retweet mode: Allows you to specify the behaviour when posting a retweet: you can choose between retweeting with a comment, retweeting without comment or being asked."""))
-documentation.append(_(u"""* Number of items per buffer to cache in database: This allows you to specify how many items TWBlue should cache in a database. You can type any number, 0 to cache all items, or leave blank to disable caching entirely."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""#### buffers tab"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""This tab displays a list for each buffer you have available in TWBlue, except for searches, timelines, favourites' timelines and lists. You can show, hide and move them."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""#### The ignored clients tab"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""In this tab, you can add and remove clients to be ignored by the program."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""#### Sound tab"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""In this tab, you can adjust the sound volume, select the input and output device and set the soundpack used by the program."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""#### Audio service tab"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""In this tab, you can enter your SndUp API key (if you have one) to upload audio to SndUp with your account. Note that if account credentials are not specified you will upload anonimously."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""### Global settings"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""This dialogue allows you to configure some settings which will affect the entire application."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""#### General tab"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""* Language: This allows you to change the language of this program. Currently supported languages are arabic, Catalan, German, English, Spanish, Basque, Finnish, French, Galician, Croatian, Hungarian, Italian, Polish, Portuguese, Russian and Turkish."""))
-documentation.append(_(u"""* Ask before exiting TWBlue: This checkbox allows you to control whetherthe program will ask for confirmation before exiting."""))
-documentation.append(_(u"""* Play a sound when TWBlue launches: This checkbox allows you to configure whether the application will play a sound when it has finished loading the buffers."""))
-documentation.append(_(u"""* Speak a message when TWBlue launches: This is the same as the previous option, but this checkbox configures whether the screen reader will say \"ready\"."""))
-documentation.append(_(u"""* Use the invisible interface's shortcuts in the GUI: As the invisible interface and the Graphical User Interface have their own shortcuts, you may want to use the invisible interface's keystrokes all the time. If this option is checked, the invisible interface's shortcuts will be usable in the GUI."""))
-documentation.append(_(u"""* Activate SAPI5 when any other screen reader is not being run: This checkbox allows to activate SAPI 5 TTS when no other screen reader is being run."""))
-documentation.append(_(u"""* Hide GUI on launch: This allows you to configure whether TWBlue will start with the GUI or the invisible interface."""))
-documentation.append(_(u"""* Keymap: This option allows you to change the keymap used by the program in the invisible interface. The shipped keymaps are Default, Qwitter,  Windows 10 and Chicken Nugget. The keymaps are in the \"keymaps\" folder, and you can create new ones. Just create a new \".keymap\" file and change the keystrokes associated with the actions, as it is done in the shipped keymaps."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""#### Proxi tab"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""In this tab you can configure TWBlue to use a Proxy server by completing the fields displayed (server, port, user and password)."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""## License, source code and donations"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""Tw Blue is free software, licensed under the GNU GPL license, either version 2 or, at your option, any later version. You can view the license in the file named license.txt, or online at <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""The source code of the program is available on GitHub at <https://www.github.com/manuelcortez/twblue>."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""If you want to donate to the project, you can do so at <http://twblue.es/?q=node/3&language=en>. Thank you for your support!"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""## Contact"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""If you still have questions after reading this document, if you wish to collaborate to the project in some other way, or if you simply want to get in touch with the application developer, follow the Twitter account [@tw_blue2](https://twitter.com/tw_blue2) or [@manuelcortez00.](https://twitter.com/manuelcortez00) You can also visit [our website](http://twblue.es)"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""## Credits"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""TWBlue is developed and mantained by [Manuel Cortéz](https://twitter.com/manuelcortez00), [José Manuel Delicado](https://twitter.com/jmdaweb), and [Bill Dengler](https://twitter.com/codeofdusk). It's supported and sponsored by [Technow S. L.](https://twitter.com/technow)"""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""We would also like to thank the translators of TWBlue, who have allowed the spreading of the application."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""* English: [Bryner Villalobos](https://twitter.com/Bry_StarkCR) and [Bill Dengler](https://twitter.com/codeofdusk)."""))
-documentation.append(_(u"""* Arabic: Mohammed Al Shara."""))
-documentation.append(_(u"""* Catalan: [Joan Rabat](https://twitter.com/joanrabat) and Juan Carlos Rivilla."""))
-documentation.append(_(u"""* Spanish: [Manuel Cortéz](https://twitter.com/manuelcortez00)."""))
-documentation.append(_(u"""* Basque: [Sukil Etxenike](https://twitter.com/sukil2011)."""))
-documentation.append(_(u"""* Finnish: Jani Kinnunen."""))
-documentation.append(_(u"""* French: Rémi Ruiz."""))
-documentation.append(_(u"""* Galician: [Alba Kinteiro](https://twitter.com/albasmileforeve)."""))
-documentation.append(_(u"""* German: Steffen Schultz."""))
-documentation.append(_(u"""* Hungarian: Robert Osztolykan."""))
-documentation.append(_(u"""* Polish: Pawel Masarczyk."""))
-documentation.append(_(u"""* Portuguese: Odenilton Júnior Santos."""))
-documentation.append(_(u"""* Russian: Alexander Jaszyn."""))
-documentation.append(_(u"""* Turkish: Burak."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""Many thanks also to the people who worked on the documentation. Initially, [Manuel Cortez](https://twitter.com/manuelcortez00) did the documentation in Spanish, and translated to English by [Bryner Villalobos](https://twitter.com/Bry_StarkCR), [Robert Spangler](https://twitter.com/glasscity1837), [Sussan Rey](https://twitter.com/sussanrey17), [Anibal Hernandez](https://twitter.com/anibalmetal), and [Holly Scott-Gardner](https://twitter.com/holly1994). It was updated by [Sukil Etxenike](https://twitter.com/sukil2011), with some valuable corrections by [Brian Hartgen](https://twitter.com/brianhartgen) and [Bill Dengler](https://twitter.com/codeofdusk)."""))
-documentation.append(_(u"""
-"""))
-documentation.append(_(u"""---"""))
-documentation.append(_(u"""Copyright © 2013-2015. Manuel Cortéz"""))

documentation/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

documentation/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

documentation/source/basic_concepts.rst

@@ -0,0 +1,31 @@
+Basic concepts
+----------------------
+
+Before starting to describe TWBlue's usage, we'll explain some concepts that will be used extensively throughout this manual.
+
+Session
+++++++
+
+A session is an account set up on a service. When you authorize TWBlue to use any of your social network accounts, a session will be created in the application. In this session, TWBlue creates buffers that allow you to display different types of items present in the social network. TWBlue allows you to have any number of sessions authorized and started. You can have TWBlue automatically start all your sessions, which is the default setting, although it is also possible to make certain sessions not start when you open the application.
+
+Buffer
+++++++
+
+A buffer is a list of items that come from your configured account, after being processed by TWBlue. TWBlue will create buffers with different types of items. For example, your posts sent on a social network, or your private messages with other users. You can perform certain actions on each of these elements depending on the type of buffer you are focusing.
+
+Graphical user Interface (GUI)
++++++++++++++++++++++++++++++++++
+
+TWBlue has two different interfaces: The graphical user interface (GUI) and the invisible interface. The GUI allows you to interact with the application through a window containing two important elements: A menu bar, which can be accessed by pressing the Alt key, and the list of sessions, buffers and available actions for them, which you can access by pressing the Tab key.
+
+The list of sessions and buffers is grouped in a tree view, where sessions are located at the root level and each session contains the buffers that belong to it. When you select one of these buffers, you can access the list of items it contains by using the Tab key. Depending on the selected buffer, you can find, also with the Tab key, a list of buttons representing actions you can perform on the session (such as posting a message on the social network) or on the focused item.
+
+Invisible interface
+++++++++++++++++++
+
+The invisible interface, as its name suggests, has no graphical window and works directly with screen readers such as JAWS for Windows, NVDA and System Access through keyboard shortcuts that you can use in any window. This interface is disabled by default, but you can enable it by pressing Control + M, which will hide the TWBlue window. If you use other applications to manage Twitter, such as The Qube and chicken Nugget, TWBlue includes support for keymaps for these clients, which you can configure from the global options dialog. It is also possible to use the invisible interface from TWBlue's graphical window, although this option can be disabled to avoid conflicting with other applications that require the keyboard shortcuts globally.
+
+Global settings and session settings
+++++++++++++++++++++++++++++++++++++++++++++++
+
+TWBlue has two different configuration dialogs: the global configuration dialog, which affects how TWBlue works for all sessions, and the session configuration dialog, which only affects how the current session works. You will find specific information about the session settings dialog for Twitter and Mastodon in its corresponding chapter in this guide.

documentation/source/changelog.rst

@@ -0,0 +1,390 @@
+TWBlue Changelog
+===========================
+
+Changes in this version
++++++++++++++++++++++++++
+
+* per popular request, We will generate a 32-bit portable version of TWBlue available for Windows 7 operating systems. This version will not be supported in our automatic updater, so in case of using such version, you would need to download it manually every time there is a new update. TWBlue will continue to be available for Windows 7 as long as it is possible to build it using Python 3.7.
+* Fixed a couple of bugs that were making TWBlue unable to be opened in some computers, related to our translator module and some COM objects handled incorrectly.
+* Fixed an issue that was making TWBlue unable to open in certain computers due to errors related to Win32 API'S.
+
+* Twitter:
+
+  * Fixed a bug that was making sent direct messages to be placed in received direct messages buffer.
+  * When quoting a tweet, you can use all 280 characters to send your quoted tweet, as opposed to the 256 characters TWBlue allowed before.
+  * Fixed a bug that was making TWBlue unable to reply to direct messages by using the "reply" keystroke.
+
+* Mastodon:
+
+  * Added account settings dialog.
+  * Added template editing functionality for mastodon accounts.
+  * When a post is edited, TWBlue will update the post object in the buffer to reflect the latest edit.
+  * Fixed a small issue that was preventing TWBlue to display some posts in their corresponding dialog.
+
+Version 2022.12.6
+-----------------
+
+Most of all changes in this release are focused on adding Mastodon support to TWBlue. The features present to handle Twitter should not have been altered in any way. We were not intended to release this version so soon, but unfortunately, Twitter started to present issues in some regions with one particular API endpoint we were using, making impossible for everyone in such regions to use the application. We will release more updates to fix any possible issue regarding Twitter API, but please take into account that this is sometimes an issue happening in Twitter's servers and while we do our best to make TWBlue work despite those problems, you might encounter glitches from time to time.
+
+* TWBlue now builds with Python 3.10.8. (`#493 <https://github.com/MCV-Software/TWBlue/issues/493>`_)
+
+  * This change also drops support for Windows 7.
+
+* The TWBlue interface has not been translated yet, as we are releasing this update to fix an important Twitter issue for some regions.
+* Twitter sessions should be able to be opened properly again in TWBlue, in regions where it didn't work since last week.
+* It is now possible to log in to instances of mastodon, hometown and similar software (Pleroma should work as well, although it has not been tested at this time). From the session manager, clicking on the “new account” button will bring up a menu from which you can select whether you want to log in to Twitter or Mastodon. For instances that have a different character limit than the one set by Mastodon, TWBlue will detect the new limit and adjust the dialogs to allow you to use it correctly.
+* Most of the TWBlue GUI has been adapted so that the buffers reflect the change of social network (in mastodon, for example, the buttons to write posts say post instead of tweet). However, the menu bar has not yet been updated. This means that most of the options still refer to Twitter, although they can be used with mastodon accounts. For example, if you select the “tweet” menu in the menu bar, and then select the “Retweet” option, TWBlue will actually do a “boost” if the buffer you are in is a Mastodon account buffer.
+* Keystrokes for the invisible interface also refer to terms used in Twitter, but can be applied to Mastodon as well.
+* There are some features, within TWBlue, that are not yet compatible with mastodon accounts. These are as follows:
+
+  * User autocompletion.
+  * Currently, it is not possible to update account settings for mastodon sessions. However, if you know how to edit configuration files, you can close TWBlue, change your session file with any text editor and restart the application to update what you want.
+  * The template editor is not yet available for mastodon accounts.
+  * Filters have not yet been implemented in TWBlue mastodon support.
+  * User aliases are not implemented yet.
+  * It is not possible to view a user’s profile, nor edit your own, for now. However, you can use the keystroke to open the item in the browser when focusing a user to access their profile website. This only works in buffers where users are listed.
+  * You cannot manage lists in TWBlue at the moment.
+
+* Most of the buffers planned for mastodon should just work. Among those currently tested are: home (main timeline for the logged-in user), Local (public posts for the instance), federated (public posts for all federating instances), mentions, direct messages, sent posts, favorites, bookmarks, followers, following, blocked users, muted users, user searches and timelines for users.
+
+  *  The difference between favorites and bookmarks is that the author of the post can see who has marked his posts as favorites, but bookmarks are completely private. In any buffer containing mastodon posts, except direct messages, the GUI will display an option to add the post to favorites or bookmarks.
+  * Direct messages in mastodon are posts, exactly like normal posts, but with their privacy setting set so that they can only be seen by the accounts that are mentioned. In the direct message buffer, a conversation will appear for each item in the buffer. The conversation represents a thread of messages, but TWBlue can only display the last of the messages sent. This is similar to what happens on platforms like Telegram, where you can only see the list of conversations at the beginning. To see the entire thread of direct messages present in a conversation, you can use the command to open the conversation, or go to the “tweet” menu in the menu bar, and then towards the “view conversation” option. This will create a new conversation buffer that will be located just after the direct messages buffer (for the GUI, the buffer will be located just inside the direct messages buffer in the buffer tree). When a private post appears (whose visibility only allows the mentioned accounts to see it), TWBlue will display that post in the home buffer, in mentions and also will update/create the conversation with that item. This is because Mastodon does not differentiate between a private message and a normal post. You can reply to the post in any buffer to continue the conversation. If you reply to any post, the privacy set in the original post is maintained by default, but can also be changed.
+  * The buffer showing the federated timeline has been disabled from settings. This is because on servers that federate with many instances it can load many posts in a very short time. To enable this buffer, for now, edit the TWBlue configuration while the application is closed, and add the “federated” buffer in the option called “buffer_order”. As soon as buffers can be shown or hidden, this process can be done through the GUI.
+  * There is a Streaming API that allows the elements for the start buffers, mentions, direct messages, sent posts and followers to appear in real time. This feature is implemented by default and should also just work.
+  * Timelines for users only allow to get all posts from users who are in the same instance. For users belonging to other instances, you can get the posts that have been downloaded to your instance since your instance “knows” the remote user.
+  * Timelines for followers and following can be fully retrieved only for users belonging to the same instance. Remote users may yield unclear results.
+  * You can search by users (by opening a search and selecting the “users” radio button). The search can be done by local users, such as twblue, or by remote users, such as @twblue@maaw.social.
+* In all buffers, a maximum of 40 items are retrieved per load, but more can be retrieved by using the option to load more items in the buffer.
+* In post buffers, you can do most of the actions already supported in TWBlue (boost, add/remove from favorites or bookmarks, reply, send message to user, open post URL, play audio or video, open post on web, view conversation, open action dialog for user).
+* In user buffers, you can send private message to the user, and open user actions dialog, which in turn allows you to follow/unfollow, block/unblock and mute/unmute.
+* When writing posts, it is possible to attach up to 4 images, 4 givs, or even a video, poll, or audio. It is also possible to add the “sensitive content” tag to posts, change privacy and write a content warning text. It is possible to create threads using the “add post” button.
+* When replying to a post, TWBlue will place the username of all participants in the item you reply to. The privacy options will default to those of the original post.
+
+Version 2022.8.28
+------------------
+
+* the user autocompletion feature has been completely rewritten to be easier to use, particularly for people with many followers/following users:
+
+  * In the account settings dialog, there's a button that opens up a new dialog that allows you to "scan" your account in order to add all users from your followers/following list. This process will read your data directly from Twitter and depending in the amount of people you have in your account it might take too many API calls. Please use it with caution. You can, for example, do the process separately for your followers/following people so it will be easier to handle, in case you have a massive amount of people. If TWBlue is unable to complete the scan, you will see an error and will be prompted to try again in 15 minutes, once your API calls have refreshed.
+  * It is possible to use the user autocompletion functionality in dialogs where you can select an user, for example when adding or removing someone from a list, or displaying lists for someone.
+
+* Implemented a new setting, available in the account settings dialog, that allows to hide emojis in twitter usernames.
+* TWBlue should be able to sort conversations in a more logical way. This should make it easier to follow a long thread in Twitter.
+* When opening a thread, TWBlue should be able to load the right conversation if the original tweet from where the thread was loaded was a retweet.
+* TWBlue will restart the Streaming subsystem every time there are changes to followed, muted or blocked users within the application.
+* Fixed error when attempting to mention an user by using the "mention" button in any people buffer. Now tweets should be posted normally.
+* Fixed error when loading other user lists. (`#465 <https://github.com/MCV-Software/TWBlue/issues/465>`_)
+* Fixed an issue that was making TWBlue to display incorrectly some retweets of quoted tweets.
+* If TWBlue is unable to open a timeline for someone who has blocked you, this will be reported in a dialog. (`#485, <https://github.com/mcv-software/twblue/issues/485>`_)
+* Added "find a string in the currently focused buffer" action into Windows 10 and windows 11 keymap. (`#476 <https://github.com/MCV-Software/TWBlue/pull/476>`_)
+
+Version 2022.2.23
+--------------------
+
+* We have added Experimental support for templates in the invisible interface. The GUI will remain unchanged for now:
+
+  * Each object (tweet, received direct message, sent direct message and people) has its own template in the settings. You can edit those templates from the account settings dialog, in the new "templates" tab.
+  * Every template is composed of the group of variables you want to display for each object. Each variable will start with a dollar sign ($) and cannot contain spaces or special characters. Templates can include arbitrary text that will not be processed. When editing the example templates, you can get an idea of the variables that are available for each object by using the template editing dialog. When you press enter on a variable from the list of available variables, it will be added to the template automatically. When you try to save a template, TWBlue will warn you if the template is incorrectly formatted or if it includes variables that do not exist in the information provided by objects. It is also possible to return to default values from the same dialog when editing a template.
+  * TWBlue can display image descriptions within Tweet templates. For that, you can use the $image_description variable in your template.
+
+* We have restored conversation and threads support powered by Twitter API V2 thanks to a set of improvements we have done in the application, as well as more generous limits to Tweet monthly cap by Twitter.
+* In the Windows 11 Keymap, the default shortcut to open the keystrokes editor is now CTRL+Alt+Windows+K to avoid conflicts with the new global mute microphone shortcut.
+* TWBlue show display properly HTML entities in tweet's text.
+* TWBlue should no longer load old tweets in buffers.
+* Fixed issue when uploading attachments (images, videos or gif files) while sending tweets or replies.
+* Fixed an error that was making TWBlue to ask for a restart after saving account settings, even if such restart was not required. (`#413, <https://github.com/manuelcortez/TWBlue/issues/413>`_)
+
+Version 2021.11.12
+------------------
+
+* Now it is possible to create a tweet from a trending topics buffer again.
+* TWBlue now includes a completely new set of dialogs to handle tweeting, replying and sending direct messages that take advantage of more Twitter features.
+
+  * It is possible to add videos in tweets and direct messages by using the new "add" button, located in every dialog where  media can be added. Twitter suggests to add videos from 5 seconds up to 2 minutes lenght, in mp4 format (video Codec H.264 and audio codec AAC). Currently, TWBlue does not check if the uploaded video complies with Twitter media requirements. You can add only a video in a tweet or direct message. No other kind of media can be added after a video is in a tweet. If the video was unable to be uploaded successfully, the tweet or direct message won't be created.
+  * Now you can add a poll to tweets. Polls can have up to 4 different options and allow voting up to 7 days after being created. Take into account, though, that currently TWBlue does not support reading polls in tweets.
+  * TWBlue now support threads while creating a new tweet. There is a new button, called add tweet which will add the current tweet to the thread and will allow you to write another tweet in the thread. Every tweet might include media (up to 4 photos, or one GIF image or a video) or up to one poll.
+  * Some functionality was removed from tweet dialogs within TWBlue. Particularly, URL shorteners and long tweets via Twishort. You still can read long tweets posted via Twishort, though.
+
+Version 2021.11.07
+------------------
+
+* TWBlue should retrieve tweets from threads and conversations in a more reliable way. Tweets in the same thread (made by the same author) will be sorted correctly, although replies to the thread (made by different people) may not be ordered in the same way they are displayed in Twitter apps. (`#417 <https://github.com/manuelcortez/TWBlue/issues/417>`_)
+* When creating a filter, TWBlue will show an error if user has not provided a name for the filter. Before, unnamed filters were a cause of config breaks in the application.
+* It is again possible to read the changelog for TWBlue from the help menu in the menu bar.
+* fixed a bug when clearing the direct messages buffer. (`#418 <https://github.com/manuelcortez/TWBlue/issues/418>`_)
+* fixed an issue that was making TWBlue to show incorrectly titles for trending topic buffers upon startup. (`#421 <https://github.com/manuelcortez/TWBlue/issues/421>`_)
+* fixed an issue that was making users of the graphical user interface to delete a buffer if a trends buffer was opened in the same session.
+* Updated Spanish, Japanese and french translations.
+
+Version 2021.10.30
+------------------
+
+* Fixed many errors in the way we compile TWBlue, so users of 64 bits systems and particularly windows 7 users would be able to install TWBlue again. In case of issues with versions prior to 2021.10.30, please remove everything related to TWBlue (except configs) and reinstall the version 2021.10.30 to fix any possible error. This step won't be needed again in 23 months. (`#416, <https://github.com/manuelcortez/TWBlue/issues/416>`_, `#415, <https://github.com/manuelcortez/TWBlue/issues/415>`_)
+* fixed an issue that was making impossible to manually add an user to the autocomplete users database.
+* Started to improve support to conversations by searching for conversation_id.
+
+Version 2021.10.27
+------------------
+
+* Added an user alias manager, located in the application menu in the menu bar. From this dialog, it is possible to review, add, edit or remove user aliases for the current account. (`#401 <https://github.com/manuelcortez/TWBlue/issues/401>`_)
+* TWBlue now closes the VLC player window automatically when a video reaches its end. (`#399 <https://github.com/manuelcortez/TWBlue/issues/399>`_)
+* After a lot of time, TWBlue now uses a new default Soundpack, called FreakyBlue. This soundpack will be set by default in all new sessions created in the application. Thanks to `Andre Louis <https://twitter.com/FreakyFwoof>`_ for the pack. (`#247 <https://github.com/manuelcortez/TWBlue/issues/247>`_)
+* When reading a tweet, if the tweet contains more than 2 consecutive mentions, TWBlue will announce how many more users the tweet includes, as opposed to read every user in the conversation. You still can display the tweet to read all users.
+* In the tweet displayer, It is possible to copy a link to the current tweet or person by pressing a button called "copy link to clipboard".
+* Added a keymap capable to work under Windows 11. (`#391 <https://github.com/manuelcortez/TWBlue/pull/391>`_)
+* Added user aliases to TWBlue. This feature allows you to rename user's display names on Twitter, so the next time you'll read an user it will be announced as you configured. For adding an alias to an user, select the "add alias" option in the user menu, located in the menu bar. This feature works only if you have set display screen names unchecked. Users are displayed with their display name in people buffers only. This action is supported in all keymaps, although it is undefined by default. (`#389 <https://github.com/manuelcortez/TWBlue/pull/389>`_)
+* There are some changes to the autocomplete users feature:
+
+  * Now users can search for twitter screen names or display names in the database.
+
+* It is possible to undefine keystrokes in the current keymap in TWBlue. This allows you, for example, to redefine keystrokes completely.
+* We have changed our Geocoding service to the Nominatim API from OpenStreetMap. Addresses present in tweets are going to be determined by this service, as the Google Maps API now requires an API key. (`#390 <https://github.com/manuelcortez/TWBlue/issues/390>`_)
+* Added a limited version of the Twitter's Streaming API: The Streaming API will work only for tweets, and will receive tweets only by people you follow. Protected users are not possible to be streamed. It is possible that during high tweet traffic, the Stream might get disconnected at times, but TWBlue should be capable of detecting this problem and reconnecting the stream again. (`#385 <https://github.com/manuelcortez/TWBlue/pull/385>`_)
+* Fixed an issue that made TWBlue to not show a dialog when attempting to show a profile for a suspended user. (`#387 <https://github.com/manuelcortez/TWBlue/issues/387>`_)
+* Added support for Twitter audio and videos: Tweets which contain audio or videos will be detected as audio items, and you can playback those with the regular command to play audios. (`#384, <https://github.com/manuelcortez/TWBlue/pull/384>`_)
+* We just implemented some changes in the way TWBlue handles tweets in order to reduce its RAM memory usage (`#380 <https://github.com/manuelcortez/TWBlue/pull/380>`_):
+
+  * We reduced the tweets size by storing only the tweet fields we currently use. This should reduce tweet's size in memory for every object up to 75%.
+  * When using the cache database to store your tweets, there is a new setting present in the account settings dialog, in the general tab. This setting allows you to control whether TWBlue will load the whole database into memory (which is the current behaviour) or not.
+
+    * Loading the whole database into memory has the advantage of being extremely fast to access any element (for example when moving through tweets in a buffer), but it requires more memory as the tweet buffers grow up. This should, however, use less memory than before thanks to the optimizations performed in tweet objects. If you have a machine with enough memory, this should be a good option for your case.
+    * If you uncheck this setting, TWBlue will read the whole database from disk. This is significantly slower, but the advantage of this setting is that it will consume almost no extra memory, no matter how big is the tweets dataset. Be ware, though, that TWBlue might start to feel slower when accessing elements (for example when reading tweets) as the buffers grow up. This setting is suggested for computers with low memory or for those people not wanting to keep a really big amount of tweets stored.
+
+* Changed the label in the direct message's text control so it will indicate that the user needs to write the text there, without referring to any username in particular. (`#366, <https://github.com/manuelcortez/TWBlue/issues/366>`_)
+* TWBlue will take Shift+F10 again as the contextual menu key in the list of items in a buffer. This stopped working after we have migrated to WX 4.1. (`#353, <https://github.com/manuelcortez/TWBlue/issues/353>`_)
+* TWBlue should render correctly retweets of quoted tweets. (`#365, <https://github.com/manuelcortez/TWBlue/issues/365>`_)
+* Fixed an error that was causing TWBlue to be unable to output to screen readers at times. (`#369, <https://github.com/manuelcortez/TWBlue/issues/369>`_)
+* Fixed autocomplete users feature. (`#367, <https://github.com/manuelcortez/TWBlue/issues/367>`_)
+* Fixed error when displaying an URL at the end of a line, when the tweet or direct message contained multiple lines. Now the URL should be displayed correctly. (`#305, <https://github.com/manuelcortez/TWBlue/issues/305>`_ `#272, <https://github.com/manuelcortez/TWBlue/issues/272>`_)
+* TWBlue has been migrated completely to Python 3 (currently, the software builds with Python 3.8).
+* TWBlue should be restarted gracefully. Before, the application was alerting users of not being closed properly every time the application restarted by itself.
+* If TWBlue attemps to load an account with invalid tokens (this happens when reactivating a previously deactivated account, or when access to the ap is revoqued), TWBlue will inform the user about this error and will skip the account. Before, the app was unable to start due to a critical error. (`#328, <https://github.com/manuelcortez/TWBlue/issues/328>`_)
+* When sending a direct message, the title of the window will change appropiately when the recipient is edited. (`#276, <https://github.com/manuelcortez/TWBlue/issues/276>`_)
+* URL'S in user profiles are expanded automatically. (`#275, <https://github.com/manuelcortez/TWBlue/issues/275>`_)
+* TWBlue now uses `Tweepy, <https://github.com/tweepy/tweepy>`_ to connect with Twitter. We have adopted this change in order to support Twitter'S API V 2 in the very near future. (`#333, <https://github.com/manuelcortez/TWBlue/issues/337>`_ `#347 <https://github.com/manuelcortez/TWBlue/pull/347>`_)
+* TWBlue can upload images in Tweets and replies again. (`#240, <https://github.com/manuelcortez/TWBlue/issues/240>`_)
+* Fixed the way we use to count characters in Twitter. The new methods in TWBlue take into account special characters and URLS as documented in Twitter. (`#199, <https://github.com/manuelcortez/TWBlue/issues/199>`_ `#315 <https://github.com/manuelcortez/TWBlue/issues/315>`_)
+* Proxy support now works as expected.
+* Changed translation service from yandex.translate to Google Translator. (`#355, <https://github.com/manuelcortez/TWBlue/issues/355>`_)
+* Improved method to load direct messages in the buffers. Now it should be faster due to less calls to Twitter API performed from the client.
+* And more. (`#352, <https://github.com/manuelcortez/TWBlue/issues/352>`_)
+
+Version 0.95
+-------------
+
+* TWBlue can open a Tweet or user directly in Twitter. There is a new option in the context menu for people and tweet buffers, and also, the shortcut control+win+alt+Enter will open the focused item in Twitter.
+* Some keystrokes were remapped in the Windows 10 Keymap:
+
+  * Read location of a tweet: Ctrl+Win+G. (`#177 <https://github.com/manuelcortez/TWBlue/pull/177>`_)
+  * Open global settings dialogue: Ctrl+Win+Alt+O.
+  * Mute/unmute current session: Control + Windows + Alt + M.
+
+* Fixed an error that was preventing TWBlue to load the direct messages buffer if an user who sent a message has been deleted.
+* Added support for playing audios posted in `AnyAudio.net <http://anyaudio.net>`_ directly from TWBlue. Thanks to `Sam Tupy <http://www.samtupy.com/>`_
+* Custom buffer ordering will not be reset every time the application restarts after an account setting has been modified.
+* When adding or removing an user from a list, it is possible to press enter in the focused list instead of having to search for the "add" or "delete" button.
+* Quoted and long tweets are displayed properly in the sent tweets buffer after being send. (`#253 <https://github.com/manuelcortez/TWBlue/issues/253>`_)
+* Fixed an issue that was making the list manager keystroke unable to be shown in the keystroke editor. Now the keystroke is listed properly. (`#260 <https://github.com/manuelcortez/TWBlue/issues/260>`_)
+* The volume slider, located in the account settings of TWBlue, now should decrease and increase value properly when up and down arrows are pressed. Before it was doing it in inverted order. (`#261 <https://github.com/manuelcortez/TWBlue/issues/261>`_)
+* autoreading has been redesigned to work in a similar way for almost all buffers. Needs testing. (`#221 <https://github.com/manuelcortez/TWBlue/issues/221>`_)
+* When displaying tweets or direct messages, a new field has been added to show the date when the item has been posted to Twitter.
+* Added support for deleting direct messages by using the new Twitter API methods.
+* When quoting a retweet, the quote will be made to the original tweet instead of the retweet.
+* If the sent direct messages buffer is hidden, TWBlue should keep loading everything as expected. (`#246 <https://github.com/manuelcortez/TWBlue/issues/246>`_)
+* There is a new soundpack, called FreakyBlue (Thanks to `Andre Louis <https://twitter.com/FreakyFwoof>`_) as a new option in TWBlue. This pack can be the default in the next stable, so users can take a look and share their opinion in snapshot versions. (`#247 <https://github.com/manuelcortez/TWBlue/issues/247>`_)
+* There is a new option in the help menu that allows you to visit the soundpacks section in the TWBlue website. (`#247 <https://github.com/manuelcortez/TWBlue/issues/247>`_)
+* When reading location of a geotagged tweet, it will be translated for users of other languages. (`#251 <https://github.com/manuelcortez/TWBlue/pull/251>`_)
+* When there are no more items to retrieve in direct messages and people buffers, a message will announce it.
+* Fixed an issue reported by some users that was making them unable to load more items in their direct messages.
+* It is possible to add a tweet to the likes buffer from the menu bar again.
+* Tweets, replies and retweets will be added to sent tweets right after being posted in Twitter.
+* Extended Tweets should be displayed properly in list buffers.
+
+Version 0.94
+-------------
+
+* Added an option in the global settings dialog to disable the Streaming features of TWBlue. TWBlue will remove all Streaming features after August 16, so this option will give people an idea about how it will be. (`#219 <https://github.com/manuelcortez/TWBlue/issues/219>`_)
+* Due to Twitter API changes, Switched authorisation method to Pin-code based authorisation. When you add new accounts to TWBlue, you will be required to paste a code displayed in the Twitter website in order to grant access to TWBlue. (`#216 <https://github.com/manuelcortez/TWBlue/issues/216>`_)
+* In order to comply with latest Twitter changes, TWBlue has switched to the new method used to send and receive direct messages, according to issue `#215. <https://github.com/manuelcortez/twblue/issues/215>`_
+
+  * The new method does not allow direct messages to be processed in real time. Direct messages will be updated periodically.
+
+* After august 16 or when streaming is disabled, the events buffer will no longer be created in TWBlue.
+* You can configure frequency for buffer updates in TWBlue. By default, TWBlue will update all buffers every 2 minutes, but you can change this setting in the global settings dialog. (`#223 <https://github.com/manuelcortez/TWBlue/issues/223>`_)
+* Added a new tab called feedback, in the account settings dialog. This tab allows you to control whether automatic speech or Braille feedbak in certain events (mentions and direct messages received) is enabled. Take into account that this option will take preference over automatic reading of buffers and any kind of automatic output. (`#203 <https://github.com/manuelcortez/TWBlue/issues/203>`_)
+* The spell checking dialog now has access keys defined for the most important actions. (`#211 <https://github.com/manuelcortez/TWBlue/issues/211>`_)
+* TWBlue now Uses WXPython 4.0.1. This will allow us to migrate all important components to Python 3 in the future. (`#207 <https://github.com/manuelcortez/TWBlue/issues/207>`_)
+* When you quote a Tweet, if the original tweet was posted with Twishort, TWBlue should display properly the quoted tweet. Before it was displaying the original tweet only. (`#206 <https://github.com/manuelcortez/TWBlue/issues/206>`_)
+* It is possible to filter by retweets, quotes and replies when creating a new filter.
+* Added support for playing youtube Links directly from the client. (`#94 <https://github.com/manuelcortez/TWBlue/issues/94>`_)
+* Replaced Bass with libVLC for playing URL streams.
+* the checkbox for indicating whether TWBlue will include everyone in a reply or not, will be unchecked by default.
+* You can request TWBlue to save the state for two checkboxes: Long tweet and mention all, from the global settings dialogue.
+* For windows 10 users, some keystrokes in the invisible user interface have been changed or merged:
+
+  * control+Windows+alt+F will be used for toggling between adding and removing a tweet to user's likes. This function will execute the needed action based in the current status for the focused tweet.
+
+* TWBlue will show an error if something goes wrong in an audio upload.
+* And more. (`#171, <https://github.com/manuelcortez/TWBlue/issues/171>`_) 
+
+Version 0.93
+--------------
+
+* A new soundpack has been added to TWBlue. Thanks to `@ValeriaK305 <https://twitter.com/ValeriaK305>`_
+* In the Windows 10 keymap, we have changed some default keystrokes as windows now uses some previously assigned shortcuts:
+
+  * For liking a tweet, press Control+Windows+alt+f
+  * for opening a trends buffer, press control+Windows+T
+
+* TWBlue has received improvements in some functions for handling extended tweets, long tweets and quoted retweets. It should render some tweets in a better way.
+* In the spell checker module, there is a new button that will allow you to add your own words to your personal dictionary so the module won't mark them as mispelled the next time you will check spelling.
+* Added filtering capabilities to TWBlue. (`#102 <https://github.com/manuelcortez/TWBlue/issues/102>`_)
+
+  * You can create a filter for the current buffer from the buffer menu in the menu bar. At this moment, invisible interface does not have any shorcut for this.
+  * You can create filters by word or languages.
+  * For deleting already created filters, you can go to the filter manager in the buffer menu and delete the filters you won't need.
+
+* Links should be opened properly in quoted tweets (`#167, <https://github.com/manuelcortez/TWBlue/issues/167>`_ `#184 <https://github.com/manuelcortez/TWBlue/issues/184>`_)
+* Increased display name limit up to 50 characters in update profile dialog.
+* When authorising an account, you will see a dialogue with a cancel button, in case you want to abort the process. Also, NVDA will not be blocked when the process starts. (`#101 <https://github.com/manuelcortez/TWBlue/issues/101>`_)
+* In the translator module, the list of available languages is fetched automatically from the provider. That means all of these languages will work and there will not be inconsistencies. Also we've removed the first combo box, because the language is detected automatically by Yandex'S API. (`#153 <https://github.com/manuelcortez/TWBlue/issues/153>`_)
+* Trending topics, searches and conversation buffers will use mute settings set for the session in wich  they were opened. (`#157 <https://github.com/manuelcortez/TWBlue/issues/157>`_)
+* The Tweet limit is now 280 characters lenght instead 140. It means you can tweet longer tweets. (`#172 <https://github.com/manuelcortez/TWBlue/issues/172>`_)
+* Per popular request, Status for mention to all and long tweet checkboxes will not be saved in settings. (`#170 <https://github.com/manuelcortez/TWBlue/issues/170>`_)
+* Fixed a problem that was making TWBlue unable to start if it was being ran in Windows with Serbian language. (`#175 <https://github.com/manuelcortez/TWBlue/issues/175>`_)
+* Added Danish translation.
+* And more. (`#156, <https://github.com/manuelcortez/TWBlue/issues/156>`_ `#163, <https://github.com/manuelcortez/TWBlue/issues/163>`_ `#159, <https://github.com/manuelcortez/TWBlue/issues/159>`_ `#173, <https://github.com/manuelcortez/TWBlue/issues/173>`_ `#174, <https://github.com/manuelcortez/TWBlue/issues/174>`_ `#176, <https://github.com/manuelcortez/TWBlue/issues/176>`_)
+
+Versions 0.91 and 0.92
+-------------------------
+
+* Fixed incorrect unicode handling when copying tweet to clipboard. (`#150 <https://github.com/manuelcortez/TWBlue/issues/150>`_)
+* TWBlue will show an error when trying to open a timeline for a suspended user. (`#128 <https://github.com/manuelcortez/TWBlue/issues/128>`_)
+* Removed TwUp as service as it no longer exists. (`#112 <https://github.com/manuelcortez/TWBlue/issues/112>`_)
+* Release audio files after uploading them. (`#130 <https://github.com/manuelcortez/TWBlue/issues/130>`_)
+* Now TWBlue will use Yandex's translation services instead microsoft translator. (`#132 <https://github.com/manuelcortez/TWBlue/issues/132>`_)
+* SndUp users will be able to upload audio in their account by using their API Key again. (`#134 <https://github.com/manuelcortez/TWBlue/issues/134>`_)
+* old tweets shouldn't be added as new items in buffers. (`#116, <https://github.com/manuelcortez/TWBlue/issues/116>`_ `#133 <https://github.com/manuelcortez/TWBlue/issues/133>`_)
+* All mentionned users should be displayed correctly in Twishort's long tweets. (`#116, <https://github.com/manuelcortez/TWBlue/issues/116>`_ `#135 <https://github.com/manuelcortez/TWBlue/issues/135>`_)
+* It is possible to select a language for OCR service from the extras panel, in the account settings dialogue. You can, however, set this to detect automatically. OCR should work better in languages with special characters or non-english symbols. (`#107 <https://github.com/manuelcortez/TWBlue/issues/107>`_)
+* Fixed a problem with JAWS for Windows and TWBlue. Now JAWS will work normally in this update. (`#100 <https://github.com/manuelcortez/twblue/issues/100>`_)
+* And more (`#136, <https://github.com/manuelcortez/TWBlue/issues/136>`_)
+
+Version 0.90
+--------------
+
+* Fixed a bug in long tweet parsing that was making TWBlue to disconnect the streaming API. (`#103 <https://github.com/manuelcortez/TWBlue/issues/103>`_)
+* Now OCR will work in images from retweets. It fixes a bug where TWBlue was detecting images but couldn't apply OCR on them. (`#105 <https://github.com/manuelcortez/TWBlue/issues/105>`_)
+* TWBlue won't try to load tweets already deleted, made with Twishort. Before, if someone posted a long tweet but deleted it in the Twishort's site, TWBlue was trying to load the tweet and it was causing problems in all the client. (`#113 <https://github.com/manuelcortez/TWBlue/issues/113>`_)
+* TWBlue shows an error message when you try to view the profile of an user that does not exist or has been suspended. (`#114, <https://github.com/manuelcortez/TWBlue/issues/114>`_ `#115 <https://github.com/manuelcortez/TWBlue/issues/115>`_)
+* The spell checker module should select the right language when is set to "user default". (`#117 <https://github.com/manuelcortez/TWBlue/issues/117>`_)
+* Image description will be displayed in retweets too. (`#119 <https://github.com/manuelcortez/TWBlue/issues/119>`_)
+* When reading a long tweet, you shouldn't read strange entities anymore. (`#118 <https://github.com/manuelcortez/twblue/issues/118>`_)
+* TWBlue will not try to load timelines if the user is blocking you. (`#125 <https://github.com/manuelcortez/twblue/issues/125>`_)
+
+Versions 0.88 and 0.89
+------------------------
+
+* Fixed more issues with streams and reconnections.
+* newer updates will indicate the release date in the updater.
+* Changes to keystrokes are reflected in keystroke editor automatically.
+* In replies with multiple users, if the mention to all checkbox is unchecked, you will see a checkbox per user so you will be able to control who will be mentioned in the reply.
+* Fixed a bug that caused duplicated user mentions in replies when the tweet was made with Twishort.
+* Retweets should be displayed normally again when the originating tweet is a Twishort's long tweet.
+* Changed the way TWBlue saves user timelines in configuration. Now it uses user IDS instead usernames. With user IDS, if an user changes the username, TWBlue still will create his/her timeline. This was not possible by using usernames.
+* Added a new setting in the account settings dialogue that makes TWBlue to show twitter usernames instead the full name.
+* Added OCR in twitter pictures. There is a new item in the tweet menu that allows you to extract and display text in images. Also the keystroke alt+Win+o has been added for the same purpose from the invisible interface.
+* Now TWBlue will play a sound when the focused tweet contains  images.
+* Your own quoted tweets will not appear in the mentions buffer anymore.
+* The config file is saved in a different way, it should fix the bug where TWBlue needs to be restarted after the config folder is deleted.
+* Mentioning people from friends or followers buffers works again.
+* Support for proxy servers has been improved. Now TWBlue supports http, https, socks4 and socks5 proxies, with and without autentication.
+
+Version 0.87
+--------------
+
+* Fixed stream connection errors.
+* Now TWBlue can handle properly a reply to the sender without including all other mentioned users.
+* Updated translations.
+* The status of the mention to all checkbox will be remembered the next time you  reply to multiple users.
+
+Version 0.86
+--------------
+
+* Fixed a very important security issue. Now TWBlue will send tweets to twishort without using any other server.
+* When you add a comment to a tweet, it will be sent as a quoted tweet, even if your reply plus the original tweet is not exceeding 140 characters.
+* Updated windows 10 keymap for reflecting changes made in the last windows 10 build.
+* Added last changes in the twitter API.
+* When replying, it will not show the twitter username in the text box. When you send the tweet, the username will be added automatically.
+* When replying to multiple users, you'll have a checkbox instead a button for mentioning all people. If this is checked, twitter usernames will be added automatically when you send your reply.
+
+Version 0.85
+--------------
+
+* Long and quoted tweets should be displayed properly In lists.
+* The connection should be more stable.
+* Added an autostart option in the global settings dialogue.
+* Updated translations.
+* Updated russian documentation.
+* Tweets in cached database should be loaded properly.
+* Added some missed dictionaries for spelling correction.
+* Timelines, lists and other buffer should be created in the right order at startup.
+
+Version 0.84 
+--------------
+
+* More improvements in quoted and long tweets.
+* Updated translations: Russian, Italian, French, Romanian, Galician and Finnish.
+* Improvements in the audio uploader module: Now it can handle audio with non-english characters.
+* the title of the window should be updated properly when spellcheck, translate or shorten/unshorten URL buttons are pressed.
+* the bug that changes the selected tweet in the home timeline shouldn't be happening so often.
+
+Version 0.82 and 0.83
+------------------------
+
+* If the tweet source (client) is an application with unicode characters (example: российская газета) it will not break the tweet displayer.
+* Added a new field for image description in tweet displayer. When available, it will show description for images posted in tweets.
+* users can add image descriptions to their photos. When uploading an image, a dialog will show for asking a description.
+* Redesigned upload image dialog.
+* Fixed photo uploads when posting tweets.
+* When getting tweets for a conversation, ignores deleted tweets or some errors, now TWBlue will try to get as much tweets as possible, even if some of these are no longer available.
+* Added audio playback from soundcloud.
+* Now the session mute option don't makes the screen reader speaks.
+* Fixed the direct message dialog. Now it should be displayed properly.
+* when a tweet is deleted in twitter, TWBlue should reflect this change and delete that tweet in every buffer it is displayed.
+* If your session is broken, TWBlue will be able to remove it automatically instead just crashing.
+* audio uploader should display the current progress.
+* users can disable the check for updates feature at startup from the general tab, in the global settings dialogue.
+* The invisible interface and the window should be synchronized when the client reconnects.
+* The documentation option in the systray icon should be enabled.
+* In trending buffers, you can press enter for posting a tweet about  the focused trend.
+* Updated russian documentation and main program interface (thanks to Natalia Hedlund (Наталья Хедлунд), `@lifestar_n <https://twitter.com/lifestar_n>`_ in twitter)
+* updated translations.
+
+Version 0.81
+--------------
+
+* Updated translations
+* The updater module has received some improvements. Now it includes a Mirror URL for checking updates  if the main URL is not available at the moment. If something is wrong and both locations don't work, the program will start anyway.
+* some GUI elements now use keyboard shortcuts for common actions.
+* fixed a bug in the geolocation dialog.
+* the chicken nugget keymap should work properly.
+* Added a new soundpack to the default installation of TWBlue, thanks to `@Deng90 <https://twitter.com/deng90>`_
+* Now the changelog is  written in an html File.
+* Added some missed dictionaries in last version for the spell checking feature.
+* Trimmed the beginnings of the sounds in the default soundpack. Thanks to `@masonasons <https://github.com/masonasons>`_
+* Added Opus support for sound playback in TWBlue. Thanks to `@masonasons <https://github.com/masonasons>`_
+* Added a source field in view tweet dialogue. Thanks to `@masonasons <https://github.com/masonasons>`_
+* You can load previous items in followers and friend buffers for others.
+* The Spell Checker dialogue should not display an error message when you have set "default language" in the global settings dialogue if your language is supported.
+* Updated romanian translation.
+* Some code cleanups.
+* The bug reports feature is fully operational again.
+* TWBlue should work again for users that contains special characters in windows usernames.
+* Added more options for the tweet searches.
+* Added play_audio to the keymap editor.
+* Windows key is no longer required in the keymap editor
+* Switched to the Microsoft translator.
+* You can update the current buffer by pressing ctrl+win+shift+u in the default keymap or in the buffer menu.
+* Changed some keystrokes in the windows 10 default keymap
+* New followers and friends buffer for user timelines.

documentation/source/conf.py

@@ -0,0 +1,56 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'TWBlue'
+copyright = '2013 - 2022, MCV Software'
+author = 'MCV Software'
+
+# The full version, including alpha/beta/rc tags
+release = '2022.12.9'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+'sphinx_rtd_theme',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

documentation/source/credits.rst

@@ -0,0 +1,20 @@
+Credits, contact and acknowledgments
+--------------------------------------
+
+Tw Blue is free software, licensed under the GNU GPL license, either version 2 or, at your option, any later version. You can view the license in the file named license.txt, or online at http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
+
+The source code of the program is available on GitHub at https://www.github.com/mcv-software/twblue.
+
+If you want to donate to the project, you can do so at https://twblue.es/donate. Thank you for your support!
+
+Contact
+========
+
+If you still have questions after reading this document, if you wish to collaborate to the project in some other way, or if you simply want to get in touch with the application developers, you can follow the accounts of TWBlue (`@tw_blue2 in Twitter <https://twitter.com/tw_blue2>`_ and `@twblue@maaw.social in mastodon <https://maaw.social/@twble>`_).
+
+Credits
+---------
+
+TWBlue is developed and maintained by `Manuel Cortéz <https://twitter.com/manuelcortez00>`_.
+
+We would also like to thank the translators of TWBlue, who have allowed the spreading of the application.

documentation/source/global_settings.rst

@@ -0,0 +1,3 @@
+global settings
+----------------
+

documentation/source/index.rst

@@ -0,0 +1,22 @@
+.. TWBlue documentation master file, created by
+   sphinx-quickstart on Mon Dec 12 18:50:18 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+TWBlue documentation
+==========================================
+
+This is the user guide for the latest available version of TWBlue. The purpose of this manual, which has been divided into several chapters, is to inform about the use of this application. It is possible that this documentation will be updated throughout the development of TWBlue with new features. You can always find the latest version of this guide at its URL address: https://twblue.es/documentation
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Topics:
+   
+   introduction
+   system_requirements
+   installation
+   basic_concepts
+   usage
+   global_settings
+   credits
+   changelog

documentation/source/installation.rst

@@ -0,0 +1,20 @@
+Installation
+-------------
+
+TWBlue is available from its `Download page. <https://twblue.es/downloads>`_ On this page, you can always find the latest version of the application, completely free of charge. Currently, 4 different packages are distributed: two portable packages, for 32-bit and 64-bit systems; an installer, which selects the version to install depending on the architecture of the system where it runs, and a portable package for 32-bit, specially generated to be compatible with Windows 7.
+
+:note: Windows 7 users must download the Windows 7 compatible package. Any other TWBlue package will be impossible to run under this operating system.
+
+If you downloaded a portable version, simply unzip the file into an empty directory and run the twblue.exe file.
+
+If you downloaded the installer, open the twblue_setup.exe file and follow the instructions to install the software. The installer will select the best version for your operating system architecture. When finished, you will be able to run TWBlue from the desktop or the windows start menu.
+
+Troubleshooting
+++++++++++++++++
+
+In case TWBlue doesn't work for any reason, please verify the following before getting in touch, just to make sure everything is alright in your system:
+
+* for windows 7 Users, please have in mind that you will need to apply all available Windows Updates. Also you'll need the Service Pack 1 installed.
+* If TWBlue is unable to run and you are using Windows 8.1 or earlier, please make sure you have installed the Microsoft Visual C++ 2019 redistributable package. Download the `32 bit <https://aka.ms/vs/16/release/vc_redist.x86.exe>`_ or `64 bit <https://aka.ms/vs/16/release/vc_redist.x64.exe>`_ versiom.
+
+If the application still doesn't work after you have checked this, please `Get in touch <contact.rst>`_ so we can help to determine what might b the issue and fix it for future versions. 

documentation/source/introduction.rst

@@ -0,0 +1,6 @@
+Introduction
+==========================================
+
+TWBlue is a free and open source application that allows you to interact with the main features of Twitter and mastodon from the comfort of a windows software, with two different interfaces specially designed for screen reader users.
+
+Please note that in order to use TWBlue, as well as to read this documentation, an internet connection and a Windows computer are required.

documentation/source/mastodon.rst

@@ -0,0 +1,62 @@
+Mastodon
+--------
+
+Authorizing TWBlue
+==================
+
+Buffer types
+============
+
+Actions
+=======
+
+Context menus
+==============
+
+Posts
+++++++
+
+Conversations
+++++++++++++++++
+
+Users
+++++++
+
+Hashtags
++++++++++++++++
+
+Composing posts
+==============
+
+Sending Direct messages
+=======================
+
+User actions
+============
+
+Timelines
+=========
+
+Hashtags
+======
+
+Searches
+========
+
+User aliases
+==============
+
+Lists management
+===================
+
+Account settings
+=================
+
+User Autocomplete
+==================
+
+Template editor
+================
+
+Filters
+=======

documentation/source/system_requirements.rst

@@ -0,0 +1,11 @@
+System requirements
+==========================================
+
+In order to run TWBlue successfully on a computer, these are the minimum system requirements. Please note that while it may be possible to use TWBlue under more limited resources, it is not recommended because the experience may be degraded or the application may not work as expected:
+
+* Processor: Dual core processor, 1.3 GHZ or higher.
+* Operating system: Windows 7 (service pack 1), Windows 8/8.1, Windows 10 or Windows 11.
+* Hard Drive: Minimum 200 MB of free space.
+* RAM memory: 4 GB.
+
+:note: TWBlue is compatible with Windows 7 systems (requires service pack 1 to be installed) in a special version, available on the `Project downloads page. <https://twblue.es/downloads>`_ This version is only available in a portable package, for 32-bit systems, and cannot be updated automatically. Windows 7 users will need to update TWBlue manually every time there is a new version to keep using the application.

documentation/source/twitter.rst

@@ -0,0 +1,153 @@
+Twitter
+-------
+
+Twitter is a social networking or micro-blogging tool which allows you to compose short status updates of your activities in 280 characters or less. Twitter is a way for friends, family and co-workers to communicate and stay connected through the exchange of quick, frequent messages. You can restrict delivery of updates to those in your circle of friends or, by default, allow anyone to access them.
+
+You can monitor the status of updates from your friends, family or co-workers (known as following), and they in turn can read any updates you create, (known as followers). The updates are referred to as Tweets. The Tweets are posted to your Twitter profile or Blog and are searchable using Twitter Search.
+
+In order to use TWBlue, you must first have created an account on the Twitter website. The process for signing up for a Twitter account is very accessible. During the account registration, you will need to choose a Twitter username. This serves two purposes. This is the method through which people will comunicate with you, but most importantly, your username and password will be required to connect TWBlue to your Twitter account. We suggest you choose a username which is memorable both to you and the people you hope will follow you.
+
+We'll start from the premise that you have a Twitter account with its corresponding username and password.
+
+authorizing TWBlue
+==================
+
+First of all, it's necessary to authorise the program so it can access your Twitter account and act on your behalf. The authorisation process is quite simple, and the program never retains data such as your password. In order to authorise the application, you just need to run the main executable file, called TWBlue.exe (on some computers it may appear simply as TWBlue if Windows Explorer is not set to display file extensions). We suggest you may like to place a Windows shortcut on your Desktop pointing to this executable file for quick and easy location.
+
+You can log into several Twitter accounts simultaneously. The program refers to each Twitter account you have configured as a "Session". If this is the first time you have launched TWBlue, and if no Twitter session exists, you will see the Session Manager. This dialogue box allows you to authorise as many accounts as you wish. If you press the Tab key to reach the "new account" button and activate it by pressing the Space Bar, you will see a menu with all available services to configure in TWBlue. By choosing Twitter, a dialogue box will advise you that your default internet browser will be opened in order to authorise the application and you will be asked if you would like to continue. Activate the "yes" Button by pressing the letter "Y" so the process may start.
+
+Your default browser will open on the Twitter page to request authorisation. Enter your username and password into the appropriate edit fields if you're not already logged in, select the authorise button, and press it.
+
+Once you've authorised your twitter account, the website will redirect you to a page which will notify you that TWBlue has been authorised successfully. On this page, you will be shown a code composed of several numbers that you must paste in the TWBlue authorization dialogue in order to allow the application to access your account. Once you have pasted the code in the corresponding text field, press enter to finish the account setup and go back to the session manager. On the session list, you will see a new item temporarily called "Authorised account x" -where x is a number. The session name will change once you open that session.
+
+To start running TWBlue, press the Ok button in the Session Manager dialogue. By default, the program starts all the configured sessions automatically, however, you can change this behavior.
+
+If all went well, the application will start playing sounds, indicating your data is being updated.
+
+When the process is finished, by default the program will play another sound, and the screen reader will say "ready" (this behaviour can be configured).
+
+Buffer types
+============
+
+The following is a description for every one of TWBlue's buffers available for Twitter sessions, and the kind of items they work with.
+
+* Home: this shows all the tweets on the main timeline. These are the tweets by users you follow.
+* Mentions: if a user, whether you follow them or not, mentions you on Twitter, you will find it in this list.
+* Direct messages: here you will find the private direct messages you exchange with users who follow you , or with any user, if you allow direct messages from everyone (this setting is configurable from Twitter). This list only shows received messages.
+* Sent direct messages: this buffer shows all the direct messages sent from your account.
+* Sent tweets: this shows all the tweets sent from your account.
+* Likes: here you will see all the tweets you have liked.
+* Followers: when users follow you, you'll be able to see them on this buffer, with some of their account details.
+* Following: the same as the previous buffer, but these are the users you follow.
+* Muted users: when you mute someone in Twitter, you no longer see their tweets in any of your buffers. However, you still can receive direct messages from them. This buffer contains the list of your muted users.
+* Blocked users: Contains a list with all people you have blocked in Twitter. When blocking an user, they cannot see your profile, timelines or exchange direct messages with your account.
+* User timelines: these are buffers you may create. They contain only the tweets by a specific user. They're used so you can see the tweets by a single person and you don't want to look all over your timeline. You may create as many as you like.
+* Lists: A list is similar to a user timeline, except that you can configure it to contain tweets from multiple users.
+* Search: A search buffer contains the results of a search operation.
+* User likes: You can have the program create a buffer containing tweets liked by a particular user.
+* Followers or following timeline: You can have TWBlue create a buffer containing all users who follow, or are followed by a specific user.
+* Trending Topics: a trend buffer shows the top 50 most used terms in a geographical region. This region may be a country or a city. Trends are updated every five minutes.
+
+If a tweet contains a URL, you can press enter in the GUI to open it. If it contains video or audio, including live stream content, you can press Control + Enter to play it, respectively. TWBlue will play a sound if the tweet contains video metadata or the \#audio hashtag, but there may be tweets which contain media without this.
+
+Actions
+=======
+
+The available actions for each buffer may vary, and are found by pressing the Tab key, once a specific buffer has been focused. Note that these are not all the actions available for the Twitter session in TWBlue. Generally, you can perform the actions you want from 3 different ways: 
+
+* In each buffer, by pressing the Tab key until you find the action panel.
+* By using the menu bar, which can be accessed by pressing the Alt key.
+* Using the keyboard shortcuts, either from the graphical interface or the invisible interface.
+
+You can find more information on the meaning of these actions later in this topic:
+
+* For all sessions, you can log in or log out of TWBlue, as well as control whether the session should start automatically when you start the application.
+* For buffers containing tweets (home, mentions, favorites, timelines and searches), you can write a new tweet, reply to the currently selected tweet, retweet it or send a direct message to the user who wrote it.
+* For buffers containing direct messages, you can reply to the selected direct message.
+* For buffers containing users (followers, following, blocked users, muted, timelines and searches), the available actions are to mention the selected user, send a direct message or open the actions dialog for that user.
+* Buffers showing trends allow you to write a Tweet about the selected trend.
+
+Context menus
+==============
+
+By pressing the contextual menu key, or the right mouse button on a focused item, TWBlue will display a list of some actions that can be performed on it. These actions will be different depending on the type of item that is selected (for example, tweets allow you to retweet them, while a trend will allow you to perform a Twitter search on it). Below are the options that you will be able to see in the menus, sorted according to the type of element that is selected when displayed:
+
+Tweets
+++++++
+
+* Retweet: this option retweets the message you're reading. After you press it, if you haven't configured the application not to do so, you'll be asked if you want to add a comment or simply send it as written. If you choose to add a comment,  it will post a quoted tweet, that is,  the comment with a  link to the originating tweet.
+* Reply: when you're viewing a tweet, you can reply to the user who sent it by pressing this option. A dialogue will open up similar to the one for tweeting. If there are more users referred to in the tweet, you can press tab and activate the mention to all checkbox, or enabling checkbox for the users you want to mention separately. Note, however, that sometimes -especially when replying to a retweet or quoted tweet, the user who made the retweet or quote may also be mentioned. This is done by Twitter automatically.
+* Like: Adds the tweet you're viewing to your likes list.
+* Unlike: removes the tweet from your likes, but not from Twitter.
+* Open URL: if the focused tweet contains URL addresses, shows up a dialogue where you can choose which one to open in the default web browser. Bear in mind that if the tweet contains only one URL, it will open it automatically.
+* Open in Twitter: Opens the focused tweet in Twitter's website.
+* Play audio: if the focused tweet contains audio or video streams, shows up a dialogue where you can choose which one to play. TWBlue uses a reduced version of VLC media player to play most audio and video streams. Bear in mind that if the tweet contains only one audio or video URL, it will play it automatically.
+* Show tweet: opens up a dialogue box where you can read the item which has focus. You can read the text with the arrow keys. It's a similar dialog box as used for composing tweets, without the ability to send the tweet, file attachment and autocompleting capabilities. It does however include a retweets and likes count.
+* Copy to clipboard: copies focused item text to clipboard.
+* Delete: permanently removes the tweet which has focus from Twitter and from your lists. Bear in mind that Twitter only allows you to delete tweets you have posted yourself.
+* User actions: Opens a dialogue where you can interact with a user. This dialogue box will be populated with the user who sent the item in focus. User actions are described later.
+
+Direct messages
+++++++++++++++++
+
+* Reply: Opens a direct message dialogue, from where you can reply to the focused direct message. Sending direct messages will be described later.
+* Open URL: if the focused item contains URL addresses, shows up a dialogue where you can choose which one to open in the default web browser. Bear in mind that if the item contains only one URL, it will open it automatically.
+* Play audio: if the focused item contains audio or video streams, shows up a dialogue where you can choose which one to play. TWBlue uses a reduced version of VLC media player to play most audio and video streams. Bear in mind that if the item contains only one audio or video URL, it will play it automatically.
+* Show direct message: opens up a dialogue box where you can read the item which has focus. You can read the text with the arrow keys. It's a dialogue with the text to be read and a close button.
+* Copy to clipboard: copies focused item text to clipboard.
+* Delete: permanently removes the direct message which has focus from your account. Note that this will not remove the message from its recipient's account.
+* User actions: Opens a dialogue where you can interact with a user. This dialogue box will be populated with the user who sent the item in focus. User actions are described later.
+
+Users
+++++++
+
+* Direct message: Opens up a dialogue box from where it is possible to send a private message to the focused user.
+* Show user profile: Opens up a dialog box from where it is possible to see details for the focused user. You can read the dialog by using the up and down arrow keys. If the user has a website in their profile, you can press tab and find a button to open it in your default browser.
+* Show user:
+* Open in Twitter: 
+* Copy to clipboard:
+* User actions:
+
+Trending topics
++++++++++++++++
+
+* Search topic:
+* Tweet about this trend: 
+* Show item:
+* Copy to clipboard:
+
+Posting Tweets
+==============
+
+Sending Direct messages
+=======================
+
+User actions
+============
+
+Timelines
+=========
+
+Trends
+======
+
+Searches
+========
+
+User aliases
+==============
+
+Lists management
+===================
+
+Account settings
+=================
+
+User Autocomplete
+==================
+
+Template editor
+================
+
+Filters
+=======