diff --git a/docs/assets/images/autocomplete_new_button.png b/docs/assets/images/autocomplete_new_button.png new file mode 100644 index 0000000000000000000000000000000000000000..7c3ddaf8122975d14a59baf1adde827c3bde5479 Binary files /dev/null and b/docs/assets/images/autocomplete_new_button.png differ diff --git a/docs/assets/images/autocomplete_new_doubletap.png b/docs/assets/images/autocomplete_new_doubletap.png new file mode 100644 index 0000000000000000000000000000000000000000..d0368a4314c7174231bad87478b60e6250943bbf Binary files /dev/null and b/docs/assets/images/autocomplete_new_doubletap.png differ diff --git a/docs/assets/images/autocomplete_new_prefix.png b/docs/assets/images/autocomplete_new_prefix.png new file mode 100644 index 0000000000000000000000000000000000000000..67ce64a4e75360050644e001c9e54d1aa0d79246 Binary files /dev/null and b/docs/assets/images/autocomplete_new_prefix.png differ diff --git a/docs/assets/images/autocomplete_old.png b/docs/assets/images/autocomplete_old.png new file mode 100644 index 0000000000000000000000000000000000000000..5809966146139d316c9000954d9d6c5a2cfa4225 Binary files /dev/null and b/docs/assets/images/autocomplete_old.png differ diff --git a/docs/usage/connection.md b/docs/usage/connection.md deleted file mode 100644 index 72ff41bfed527f7db30a9cd42204bfbd1d6dc5b0..0000000000000000000000000000000000000000 --- a/docs/usage/connection.md +++ /dev/null @@ -1 +0,0 @@ -# Connection \ No newline at end of file diff --git a/docs/usage/upgrade_guide.md b/docs/usage/upgrade_guide.md new file mode 100644 index 0000000000000000000000000000000000000000..ee68daa9ae652a739cd448cb2809749f458f2365 --- /dev/null +++ b/docs/usage/upgrade_guide.md @@ -0,0 +1,41 @@ +# Upgrade Guide + +## Autocomplete + +In the old versions, autocomplete was only possible through the use of the autocomplete button in the input line. + +<img src="/assets/images/autocomplete_old.png" alt="Old Autocomplete Example" style="max-width: 50%"> + +Nowadays, there are many possible solutions for autocomplete: + +1. **Prefix Autocomplete** + <img src="/assets/images/autocomplete_new_prefix.png" alt="New Autocomplete Example With Prefix" style="max-width: 50%"> + When typing an @ or # with the name of a nick or channel afterwards, Quasseldroid automatically recommends + You can also configure this to always autocomplete even without prefix + +2. **Double-Tap to Autocomplete** + <img src="/assets/images/autocomplete_new_doubletap.png" alt="New Autocomplete Example With Doubletap" style="max-width: 50%"> + When typing a name, you can double-tap the input box to autocomplete the name + +3. **Autocomplete Button** + <img src="/assets/images/autocomplete_new_button.png" alt="New Autocomplete Example With Button" style="max-width: 50%"> + Of course, the good old autocomplete button can be re-enabled again, too. + +## Avatars + +Quasseldroid nows display sender icons in messages, chat lists, the header, and notifications. + +You can enable Avatar fallbacks to load avatars for users if they are using Matrix or IRCCloud, or have a gravatar email +in their realname field. + +Avatars can be configured to be square or round, and additionally, you can disable the avatars in the message list as +well. + +## Highlights & Unread Activity + +In Quassel 0.13, highlights and unread activity are managed by the core. This means you won’t ever miss a highlight. +Additionally, your client only has to load unread messages of the channels you actually open, saving traffic and +improving performance. + +Quasseldroid relies on this functionality for showing highlights and unread activity, as well as configuring highlights. +Accordingly, a Quassel 0.13 Core is now required for this functionality to work. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 3421c4b178d044ff9885a5a865b6b06df173af36..3f93b69b143dca83a51f9f9f93689d3f0adcd121 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,12 +5,12 @@ site_author: 'Janne Koschinski' site_url: 'https://quasseldroid.info/docs/' # Copyright -copyright: 'Copyright © 2018 Janne Koschinski' +copyright: 'Copyright © 2019 Janne Koschinski' -pages: +nav: - "Overview": index.md - "Usage": - - "Connection": usage/connection.md + - "Upgrade Guide": usage/upgrade_guide.md - "Protocol": - "Serialization": - "Primitive Types": protocol/serialization/primitive.md