Skip to content
Snippets Groups Projects
Verified Commit a2980edd authored by Janne Mareike Koschinski's avatar Janne Mareike Koschinski
Browse files

Cleanup a bit

parent bbd0aa68
Branches
No related tags found
No related merge requests found
......@@ -5,3 +5,7 @@
font-weight: bold;
font-family: "Roboto Mono", "Courier New", Courier, monospace;
}
img[src*="#half-width"] {
max-width: 50%;
}
\ No newline at end of file
File moved
File moved
......@@ -2,5 +2,9 @@
Welcome to the Quasseldroid documentation!
!!! danger
The documentation is still being worked on.
\ No newline at end of file
!!! warning
This documentation is still being worked on. Most of it is already ready,
but a lot is still missing.
This documentation is split into two parts — the [Usage](usage/faq.md) and
[Developer](protocol/overview.md) sections.
\ No newline at end of file
......@@ -13,7 +13,7 @@ It starts off in `HANDSHAKE` state.
In this state, messages are encoded/decoded according to the
[Handshake Messages](../serialization/handshake_messages.md) specification.
[![Init Diagram](../../assets/images/message_init.png)](../../assets/images/message_init.png)
[![Init Diagram](../../images/message_init.png)](../../images/message_init.png)
Client and core exchange messages according to the diagram described above, when
a ClientLoginAck and SessionInit have been received, the state advances into
......@@ -21,7 +21,7 @@ a ClientLoginAck and SessionInit have been received, the state advances into
### Core Setup
[![Core Setup Diagram](../../assets/images/message_setup.png)](../../assets/images/message_setup.png)
[![Core Setup Diagram](../../images/message_setup.png)](../../images/message_setup.png)
When the client receives a CoreInitAck message, with "Configured" set to "False", it will display to the user a list, allowing them to choose a StorageBackend from the ones present in CoreInitAck’s "StorageBackends" attribute.
......
# FAQ
## What is a quassel core? Why do I need one to use Quasseldroid?
A quassel core is a server which connects to IRC servers, and ensures you are
always online — storing logs of the messages in the channel, etc.
Quasseldroid connects to the core instead of connecting directly to the IRC
server, so if you turn your phone off, or your phone’s internet connection
drops, your unread messages are still saved, and Quasseldroid can show them
whenever your phone turns on again.
Without the quassel core, you’d miss any messages on IRC that were sent while
you weren’t using Quasseldroid.
## Where is autocomplete?
Quasseldroid supports many options for nick autocompletion:
1. **Prefix Autocomplete**
![New Autocomplete Example With Prefix](../images/autocomplete_new_prefix.png#half-width)
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**
![New Autocomplete Example With Doubletap](../images/autocomplete_new_doubletap.png#half-width)
When typing a name, you can double-tap the input box to autocomplete the name
3. **Autocomplete Button**
![New Autocomplete Example With Button](../images/autocomplete_new_button.png#half-width)
Of course, the good old autocomplete button can be re-enabled again, too.
......@@ -6,21 +6,21 @@ This guide is intended to help users upgrading from older versions with the rece
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%">
![Old Autocomplete Example](../images/autocomplete_old.png#half-width)
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%">
![New Autocomplete Example With Prefix](../images/autocomplete_new_prefix.png#half-width)
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%">
![New Autocomplete Example With Doubletap](../images/autocomplete_new_doubletap.png#half-width)
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%">
![New Autocomplete Example With Button](../images/autocomplete_new_button.png#half-width)
Of course, the good old autocomplete button can be re-enabled again, too.
## Avatars
......
......@@ -10,6 +10,7 @@ copyright: 'Copyright &copy; 2020 Janne Koschinski'
nav:
- "Overview": index.md
- "Usage":
- "FAQ": usage/faq.md
- "Upgrade Guide": usage/upgrade_guide.md
- "Protocol":
- "Overview": protocol/overview.md
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment