From 081154e78a4c907180eb7fb79df25853e3dda616 Mon Sep 17 00:00:00 2001 From: sudden6 Date: Wed, 23 Dec 2015 18:54:34 +0100 Subject: [PATCH 01/12] initial usermanual --- doc/user_manual_en.html | 43 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 doc/user_manual_en.html diff --git a/doc/user_manual_en.html b/doc/user_manual_en.html new file mode 100644 index 000000000..eb92d6345 --- /dev/null +++ b/doc/user_manual_en.html @@ -0,0 +1,43 @@ + + + + + + +qTox User Manual + + + +

qTox User Manual

+

Index

+
    +
  1. Settings
    2. +
  2. Groupchats
    3. +
  3. Multi Window Mode
    4. +
  4. Keyboard Shortcuts
    5. +
+ +
    +

  1. Settings

    2. + +
+ + \ No newline at end of file From bfe013c58b22edad8ad257c4d5a386b73e25b2c6 Mon Sep 17 00:00:00 2001 From: sudden6 Date: Fri, 1 Jan 2016 17:26:58 +0100 Subject: [PATCH 02/12] most settings documented --- doc/user_manual_en.html | 75 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 73 insertions(+), 2 deletions(-) diff --git a/doc/user_manual_en.html b/doc/user_manual_en.html index eb92d6345..16f0d5212 100644 --- a/doc/user_manual_en.html +++ b/doc/user_manual_en.html @@ -22,7 +22,7 @@ From 87ee8e966c52ab6e28af868e384d1aa478dc9e07 Mon Sep 17 00:00:00 2001 From: sudden6 Date: Sat, 9 Jan 2016 19:21:05 +0100 Subject: [PATCH 03/12] write it in markdown --- doc/user_manual_en.md | 107 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 107 insertions(+) create mode 100644 doc/user_manual_en.md diff --git a/doc/user_manual_en.md b/doc/user_manual_en.md new file mode 100644 index 000000000..10fbafd1c --- /dev/null +++ b/doc/user_manual_en.md @@ -0,0 +1,107 @@ +# qTox User Manual +## Index + +* [Settings](#Settings) +* [Groupchats](#Groupchats) +* Multi Window Mode +* Keyboard Shortcuts + +## Settings +### General + +#### General Settings +* _Language:_ Changes which language the qTox interface uses. +* _Autostart:_ If set, qTox will start when you login on your computer. +* _Light icon:_ If set, qTox will use a different icon, which is easier to read on black backgrounds. +* _Show system tray icon:_ If set, qTox will show its icon in your system tray. + * _Start in tray:_ On start, qTox will only show its tray icon and no window. + * _Minimize to tray:_ The minimize button on the top right, will minimize qTox to its tray icon. There won't be a taskbar item. + +* _Auto away after (0 to disable):_ After the specified amount of time, qTox will set your Status to "Away". A setting of 0 will never change your status. +* _Default directory to save files:_ You can set the directory where qTox puts files you recieved here. +* _Autoaccept files:_ If set, qTox will automatically accept filetransfers and put them in the directory specified above. + +#### Chat +* _Play sound:_ If checked, qTox will play a sound when you get a new message. +* _Open window:_ If checked, the qTox window will be opened. + * _Focus window:_ If checked, the qTox window will additionally be focused. +* _Show contacts' status changes:_ ??? +* _Group chats always notify:_ ??? +* _Place groupchats at top of friend list:_ If checked, your groupchats will be at the top of the contacts list. +* _Faux offline messaging:_ If enabled, qTox will attempt to send messages when a currently offline contact comes online again. +* _Compact contact list:_ If set, qTox will use a contact list layout which takes up less screen space. +* _Multiple windows mode:_ If enabled, the qTox user interface will be split into multiple independent windows. For details see TODO. + * _Open each chat in an individual window:_ If checked, a new window will be opened for every chat you open. + +#### Theme +* _Use emoticons:_ If enabled, qTox will replace simleys ( e.g. :-) ) with Unicode emoticons. +* _Smiley Pack:_ You can choose from different sets of shiped emoticon styles. You can also install your own, see ??? for details +* _Emoticon size:_ You can change the size of the emoticons here. +* _Style:_ Changes the appearance of qTox. +* _Theme color:_ Changes the colors qTox uses. +* _Timestamp format:_ Change the format in which qTox displays message timestamps. +* _Date format:_ Same as above for the date. + +#### Connection Settings +* _Enable IPv6 (recommended):_ If enabled, qTox will use IPv4 and IPv6 protocols, whichever is available. If disabled, qTox will only use IPv4. +* _Enable UDP (recommended):_ If enabled, qTox will use TCP and UDP protocols. If disabled, qTox will only use TCP. +* _Proxy type:_ If you want to use a proxy, set the type here. "None" disables the proxy. +* _Address:_ If you use a proxy, enter the address here. +* _Port:_ If you use a proxy, enter the port here. +* _Reconnect:_ Reconnect to the tox network, e.g. if you changed the proxy settings. + +### Privacy + +* _Send typing notifications:_ If enabled, notify your chat partner when you are currently typing. +* _Keep chat history:_ If enabled, qTox will save your sent and recieved messages. Encrypt your profile, if you want to encrypt the chat history. + +#### NoSpam + +NoSpam is a feature of Tox to prevent someone spamming you with friend requests. If you get spammed, enter or generate a new NoSpam value, this will alter your Tox ID. You don't need to tell your existing contacts your new Tox ID, but you have to tell new contacts your new Tox ID. Your Tox ID can be found ??? + +### Audio/Video +#### Audio Settings +* _Playback device:_ Select the device qTox should use for all audio output (notifications, calls,..). +* _Playback:_ Here you can adjust the playback volume to your needs. +* _Capture device:_ Select the device qTox should use for audio input in calls. +* _Microphone:_ Set the input volume of your microphone with this slider. When you are talking normaly, the the display should be in the green range. +* _Filter audio_ If enabled, qTox will try to remove noise and echo from your audio input. + +#### Video Settings +* _Video device:_ Select the video device qTox should use for video calls. "None" will show a dummy picture to your chat partner. "Desktop" will stream the content of your screen. +* _Resolution:_ You can select from the available resolutions and framerates here. Higher resolutions provide more quality, but if the bandwidth of your connection is low, the video may get choppy. + + If you set up everything correctly, you should see the preview of your video device in the box. + +* _Rescan devices_ Use this button to search for newly attached devices, e.g. you plugged in a webcam. + +### Advanced +* _Make Tox portable:_ ??? +* _Reset to default settings_ Use this button to delete any changes you made to the qTox settings. + +### About +* _Version_ The version of qTox and the libraries it depends on. Please append this information to every bugreport. +* _License_ The license under which the code of qTox is available. +* _Authors_ The people who developed this shiny piece of software. +* _Known Issues_ Links to our list of known issues and improvements. + +## Groupchats + +Groupchats are a way to talk with multiple friends at the same time, like when you are standing together in a group. To create a groupchat click the groupchat icon and set a name. Now you can invite people by right clicking on the contact and selecting "Invite to group". Currently, if the last person leaves the chat, it is closed and you have to create a new one. + +## Keyboard Shortcuts + +The following shortcuts are currently supported: + + + +| Shortcut | Action | +|----------|--------| +| ``CTRL`` + ``P`` | Push to talk | +| ``Arrow up`` | Paste last message | +| ``CTRL`` + ``SHIFT`` + ``L`` | Clear chat | +| ``CTRL`` + ``q`` | Quit qTox | +| `CTRL` + `Page Down` | Switch to the next contact | +| `CTRL` + `Page Up` | Switch to the previous contact| +| `CTRL` + `TAB` | Switch to the next contact | +| `CTRL` + `SHIFT` + `TAB` | Switch to the previous contact| From aeb80f1e78fc35f1dbc88cadd613fa3740d95c14 Mon Sep 17 00:00:00 2001 From: sudden6 Date: Sat, 9 Jan 2016 19:28:43 +0100 Subject: [PATCH 04/12] remove html version --- doc/user_manual_en.html | 114 ---------------------------------------- 1 file changed, 114 deletions(-) delete mode 100644 doc/user_manual_en.html diff --git a/doc/user_manual_en.html b/doc/user_manual_en.html deleted file mode 100644 index 16f0d5212..000000000 --- a/doc/user_manual_en.html +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - -qTox User Manual - - - -

qTox User Manual

-

Index

-
    -
  1. Settings
    2. -
  2. Groupchats
    3. -
  3. Multi Window Mode
    4. -
  4. Keyboard Shortcuts
    5. -
- -
    -

  1. Settings

    2. -
      -

    • General

      • -
        -

        General Settings

        -

      • Language: Changes which language the qTox interface uses.

        • -

      • Autostart: If set, qTox will start when you login on your computer.

        • -

      • Light icon: If set, qTox will use a different icon, which is easier to read on black backgrounds.

        • -

      • Show system tray icon: If set, qTox will show its icon in your system tray.

        • -
          -

        • Start in tray: On start, qTox will only show its tray icon and no window.

          • -

        • Minimize to tray: The minimize button on the top right, will minimize qTox to its tray icon. There won't be a taskbar item.

          • -

        • Close to tray The close button on the top right, will minimize qTox to its tray icon.

          • -
        -

      • Auto away after (0 to disable): After the specified amount of time, qTox will set your Status to away. A setting of 0 will never set your status.

        • -

      • Default directory to save files: You can set the directory where qTox puts files you recieved here.

        • -

      • Autoaccept files: If set, qTox will automatically accept filetransfers and put them in the directory specified above.

        • - -

        Chat

        -

      • Play sound: If checked, qTox will play a sound when you get a new message.

        • -

      • Open window: If checked, the qTox window will be opened.

        • -
          -

        • Focus window: If checked, the qTox window will additionally be focused.

          • -
        -

      • Show contacts' status changes: ???

        • -

      • Group chats always notify: ???

        • -

      • Place groupchats at top of friend list: If checked, your groupchats will be at the top of the contacts list.

        • -

      • Faux offline messaging: If enabled, qTox will attempt to send messages when a currently offline contact comes online again.

        • -

      • Compact contact list: If set, qTox will use a contact list layout which takes up less screen space.

        • -

      • Multiple windows mode: If enabled, the qTox user interface will be split into multiple independent windows. For details see TODO.

        • -
          -

        • Open each chat in an individual window: If checked, a new window will be opened for every chat you open.

          • -
        - -

        Theme

        -

      • Use emoticons: If enabled, qTox will replace simleys ( e.g. :-) ) with Unicode emoticons.

        • -

      • Smiley Pack: You can choose from different sets of shiped emoticon styles. You can also install your own, see ??? for details

        • -

      • Emoticon size: You can change the size of the emoticons here.

        • -

      • Style: Changes the appearance of qTox.

        • -

      • Theme color: Changes the colors qTox uses.

        • -

      • Timestamp format: Change the format in which qTox displays message timestamps.

        • -

      • Date format: Same as above for the date.

        • - -

        Connection Settings

        -

      • Enable IPv6 (recommended): If enabled, qTox will use IPv4 and IPv6 protocols, whichever is available. If disabled, qTox will only use IPv4.

        • -

      • Enable UDP (recommended): If enabled, qTox will use TCP and UDP protocols. If disabled, qTox will only use TCP.

        • -

      • Proxy type: If you want to use a proxy, set the type here. "None" disables the proxy.

        • -

      • Address: If you use a proxy, enter the address here.

        • -

      • Port: If you use a proxy, enter the port here.

        • -

      • Reconnect: Reconnect to the tox network, e.g. if you changed the proxy settings.

        • -
      -

    • Privacy

      • -
        -

      • Send typing notifications: If enabled, notify your chat partner when you are currently typing.

        • -

      • Keep chat history: If enabled, qTox will save your sent and recieved messages. Encrypt your profile, if you want to encrypt the chat history.

        • - -

      • NoSpam

        • - - NoSpam is a feature of Tox to prevent someone spamming you with friend requests. If you get spammed, enter or generate a new NoSpam value, this will alter your Tox ID. You don't need to tell your existing contacts your new Tox ID, but you have to tell new contacts your new Tox ID. Your Tox ID can be found ??? - -
      -

    • Audio/Video

      • -
        -

        Audio Settings

        -

      • Playback device: Select the device qTox should use for all audio output (notifications, calls,..).

        • -

      • Playback: Here you can adjust the playback volume to your needs.

        • -

      • Capture device: Select the device qTox should use for audio input in calls.

        • -

      • Microphone: Set the input volume of your microphone with this slider. When you are talking normaly, the the display should be in the green range.

        • -

      • Filter audio If enabled, qTox will try to remove noise and echo from your audio input.

        • - -

        Video Settings

        -

      • Video device: Select the video device qTox should use for video calls. "None" will show a dummy picture to your chat partner. "Desktop" will stream the content of your screen.

        • -

      • Resolution: You can select from the available resolutions and framerates here. Higher resolutions provide more quality, but if the bandwidth of your connection is low, the video may get choppy.

        • - - If you set up everything correctly, you should see the preview of your video device in the box. - -

      • Rescan devices Use this button to search for newly attached devices, e.g. you plugged in a webcam.

        • -
      -

    • Advanced

      • -
        -

      • Make Tox portable: ???

        • -

      • Reset to default settings Use this button to delete any changes you made to the qTox settings.

        • -
      -

    • About

      • -
        -

      • Version The version of qTox and the libraries it depends on. Please append this information to every bugreport.

        • -

      • License The license under which the code of qTox is available.

        • -

      • Authors The people who developed this shiny piece of software.

        • -

      • Known Issues Links to our list of known issues and improvements.

        • -
      -
    -
- - \ No newline at end of file From 861697d86e5c8832b4825a843f33193ca1e39d2f Mon Sep 17 00:00:00 2001 From: sudden6 Date: Sat, 9 Jan 2016 22:23:19 +0100 Subject: [PATCH 05/12] Update user_manual_en.md --- doc/user_manual_en.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/user_manual_en.md b/doc/user_manual_en.md index 10fbafd1c..dd5dae35c 100644 --- a/doc/user_manual_en.md +++ b/doc/user_manual_en.md @@ -3,8 +3,8 @@ * [Settings](#Settings) * [Groupchats](#Groupchats) -* Multi Window Mode -* Keyboard Shortcuts +* [Multi Window Mode](#multi-window-mode) +* [Keyboard Shortcuts](#keyboard-shortcuts) ## Settings ### General @@ -89,6 +89,10 @@ NoSpam is a feature of Tox to prevent someone spamming you with friend requests. Groupchats are a way to talk with multiple friends at the same time, like when you are standing together in a group. To create a groupchat click the groupchat icon and set a name. Now you can invite people by right clicking on the contact and selecting "Invite to group". Currently, if the last person leaves the chat, it is closed and you have to create a new one. +## Multi Window Mode + +If you activated this mode in the [settings](#Settings), qTox will seperata its main window into a contact list and chat windows, which allows you to have multiple conversations on your screen on the same time. + ## Keyboard Shortcuts The following shortcuts are currently supported: From 71bdb23246722a34c57f386c40092dfb76d7457b Mon Sep 17 00:00:00 2001 From: sudden6 Date: Mon, 11 Jan 2016 23:46:37 +0100 Subject: [PATCH 06/12] update user manual with @zetok s suggestions --- doc/user_manual_en.md | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/doc/user_manual_en.md b/doc/user_manual_en.md index dd5dae35c..77b4f2370 100644 --- a/doc/user_manual_en.md +++ b/doc/user_manual_en.md @@ -11,8 +11,8 @@ #### General Settings * _Language:_ Changes which language the qTox interface uses. -* _Autostart:_ If set, qTox will start when you login on your computer. -* _Light icon:_ If set, qTox will use a different icon, which is easier to read on black backgrounds. +* _Autostart:_ If set, qTox will start when you login on your computer. qTox will also autmatically open the profile which was active when you ticked the checkbox, but this only works if your profile isn't encrypted (has no password set). +* _Light icon:_ If set, qTox will use a different icon, which is easier to see on black backgrounds. * _Show system tray icon:_ If set, qTox will show its icon in your system tray. * _Start in tray:_ On start, qTox will only show its tray icon and no window. * _Minimize to tray:_ The minimize button on the top right, will minimize qTox to its tray icon. There won't be a taskbar item. @@ -23,28 +23,30 @@ #### Chat * _Play sound:_ If checked, qTox will play a sound when you get a new message. -* _Open window:_ If checked, the qTox window will be opened. +* _Open window:_ If checked, the qTox window will be opened. If you use the multiple windows mode, see [Multi Window Mode](#multi-window-mode) for details. * _Focus window:_ If checked, the qTox window will additionally be focused. -* _Show contacts' status changes:_ ??? -* _Group chats always notify:_ ??? -* _Place groupchats at top of friend list:_ If checked, your groupchats will be at the top of the contacts list. -* _Faux offline messaging:_ If enabled, qTox will attempt to send messages when a currently offline contact comes online again. +* _Show contacts' status changes:_ If set, qTox will show contact status changes in your chat history. +* _Group chats always notify:_ If set, qTox will notify you on every new message in a groupchat. +* _Place groupchats at top of friend list:_ If checked, your groupchats will be at the top of the contacts list, else they will be sorted with your other contacts. +* _Faux offline messaging:_ If enabled, qTox will attempt to send messages when a currently offline contact comes online again. * _Compact contact list:_ If set, qTox will use a contact list layout which takes up less screen space. -* _Multiple windows mode:_ If enabled, the qTox user interface will be split into multiple independent windows. For details see TODO. - * _Open each chat in an individual window:_ If checked, a new window will be opened for every chat you open. +* _Multiple windows mode:_ If enabled, the qTox user interface will be split into multiple independent windows. For details see [Multi Window Mode](#multi-window-mode). + * _Open each chat in an individual window:_ If checked, a new window will be opened for every chat you open. If you manually grouped the chat into another window, the window which hosts the chat will be focused. #### Theme * _Use emoticons:_ If enabled, qTox will replace simleys ( e.g. :-) ) with Unicode emoticons. * _Smiley Pack:_ You can choose from different sets of shiped emoticon styles. You can also install your own, see ??? for details * _Emoticon size:_ You can change the size of the emoticons here. -* _Style:_ Changes the appearance of qTox. -* _Theme color:_ Changes the colors qTox uses. +* _Style:_ Changes the appearance of qTox. +* _Theme color:_ Changes the colors qTox uses. * _Timestamp format:_ Change the format in which qTox displays message timestamps. * _Date format:_ Same as above for the date. #### Connection Settings * _Enable IPv6 (recommended):_ If enabled, qTox will use IPv4 and IPv6 protocols, whichever is available. If disabled, qTox will only use IPv4. -* _Enable UDP (recommended):_ If enabled, qTox will use TCP and UDP protocols. If disabled, qTox will only use TCP. +* _Enable UDP (recommended):_ If enabled, qTox will use TCP and UDP protocols. If disabled, qTox will only use TCP, which is supposed to lower the amount of traffic, but is also slower and puts more load on other network participants. +Most users will want the two settings enabled, but if qTox crashes your router, you can try to disable them. + * _Proxy type:_ If you want to use a proxy, set the type here. "None" disables the proxy. * _Address:_ If you use a proxy, enter the address here. * _Port:_ If you use a proxy, enter the port here. @@ -76,7 +78,7 @@ NoSpam is a feature of Tox to prevent someone spamming you with friend requests. * _Rescan devices_ Use this button to search for newly attached devices, e.g. you plugged in a webcam. ### Advanced -* _Make Tox portable:_ ??? +* _Make Tox portable:_ If enabled, qTox will load/save user data from the working directory, instead of ``` ~/.config/tox/ ```. * _Reset to default settings_ Use this button to delete any changes you made to the qTox settings. ### About @@ -97,11 +99,8 @@ If you activated this mode in the [settings](#Settings), qTox will seperata its The following shortcuts are currently supported: - - | Shortcut | Action | |----------|--------| -| ``CTRL`` + ``P`` | Push to talk | | ``Arrow up`` | Paste last message | | ``CTRL`` + ``SHIFT`` + ``L`` | Clear chat | | ``CTRL`` + ``q`` | Quit qTox | From 212f97fd4143662a34376fc27a33cc74cee08442 Mon Sep 17 00:00:00 2001 From: sudden6 Date: Mon, 11 Jan 2016 23:52:28 +0100 Subject: [PATCH 07/12] fix some links and better wording in user manual --- doc/user_manual_en.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/user_manual_en.md b/doc/user_manual_en.md index 77b4f2370..87862159b 100644 --- a/doc/user_manual_en.md +++ b/doc/user_manual_en.md @@ -1,8 +1,8 @@ # qTox User Manual ## Index -* [Settings](#Settings) -* [Groupchats](#Groupchats) +* [Settings](#settings) +* [Groupchats](#groupchats) * [Multi Window Mode](#multi-window-mode) * [Keyboard Shortcuts](#keyboard-shortcuts) @@ -66,7 +66,7 @@ NoSpam is a feature of Tox to prevent someone spamming you with friend requests. * _Playback device:_ Select the device qTox should use for all audio output (notifications, calls,..). * _Playback:_ Here you can adjust the playback volume to your needs. * _Capture device:_ Select the device qTox should use for audio input in calls. -* _Microphone:_ Set the input volume of your microphone with this slider. When you are talking normaly, the the display should be in the green range. +* _Microphone:_ Set the input volume of your microphone with this slider. When you are talking normaly, the display should be in the green range. * _Filter audio_ If enabled, qTox will try to remove noise and echo from your audio input. #### Video Settings @@ -93,7 +93,7 @@ Groupchats are a way to talk with multiple friends at the same time, like when y ## Multi Window Mode -If you activated this mode in the [settings](#Settings), qTox will seperata its main window into a contact list and chat windows, which allows you to have multiple conversations on your screen on the same time. +If you activated this mode in the [settings](#settings), qTox will seperata its main window into a contact list and chat windows, which allows you to have multiple conversations on your screen on the same time. Additionally you can manually group chats into a window by dragging and dropping them onto eachother. ## Keyboard Shortcuts From 38313d1e0a65de990b11680b33d32783f2ee44ae Mon Sep 17 00:00:00 2001 From: sudden6 Date: Fri, 15 Jan 2016 15:34:35 +0100 Subject: [PATCH 08/12] Add section about user profile to manual --- doc/user_manual_en.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/doc/user_manual_en.md b/doc/user_manual_en.md index 87862159b..0215ba973 100644 --- a/doc/user_manual_en.md +++ b/doc/user_manual_en.md @@ -1,11 +1,39 @@ # qTox User Manual ## Index +* [User Profile](#user-profile) * [Settings](#settings) * [Groupchats](#groupchats) * [Multi Window Mode](#multi-window-mode) * [Keyboard Shortcuts](#keyboard-shortcuts) +## User Profile +Your User Profile contains everything you share with other people on Tox. You can open it by clicking the picture on the top right corner. It contains the following settings: + +### Public Information +* _Name:_ This is your nickname which everyone who has your Tox ID can see. +* _Status:_ You can post a status message here, which again everyone on who has your ToxID can see. + +### Tox ID + +The long code in hexadecimal format is your Tox ID, share this with everyone you want to talk to. Click it to copy it to your clipboard. +Your Tox ID is also shown as QR-Code to easily share it with friends over a smartphone. + +The "Save image" button saves the QR-Code into a image file, while the "Copy image" button copies into your clipboard. + +### Profile + +qTox allows you to use multiple Tox IDs with different profiles, which each can have different nicknames, status messages and friends. + ++ _Current profile:_ Shows the filename which stores your information. ++ _Current profile locatation:_ Shows the path to the profile file. ++ _Rename_ This button allows you to rename your profile. Your nickname and profile name don't have to be the same. ++ _Delete_ This button deletes your profile. ++ _Export_ Allows you to export your profile in a format compatible with other Tox clients. You can also manually backup your *.tox files. ++ _Logout_ Close your current profile and show the login window. ++ _Remove password_ If you set a password for your profile, you can remove it with this button. ++ _Change password_ If you set a password for your profile, you can change the password with this button. You can also set a password for unencrypted profiles here. + ## Settings ### General From 50081a51d2237fc850e4a720a3cb6059fb9c8a77 Mon Sep 17 00:00:00 2001 From: sudden6 Date: Fri, 15 Jan 2016 22:04:39 +0100 Subject: [PATCH 09/12] remove last todos --- doc/user_manual_en.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/user_manual_en.md b/doc/user_manual_en.md index 0215ba973..2ddb10321 100644 --- a/doc/user_manual_en.md +++ b/doc/user_manual_en.md @@ -28,7 +28,7 @@ qTox allows you to use multiple Tox IDs with different profiles, which each can + _Current profile:_ Shows the filename which stores your information. + _Current profile locatation:_ Shows the path to the profile file. + _Rename_ This button allows you to rename your profile. Your nickname and profile name don't have to be the same. -+ _Delete_ This button deletes your profile. ++ _Delete_ This button deletes your profile and the corresponding chat history. + _Export_ Allows you to export your profile in a format compatible with other Tox clients. You can also manually backup your *.tox files. + _Logout_ Close your current profile and show the login window. + _Remove password_ If you set a password for your profile, you can remove it with this button. @@ -63,7 +63,7 @@ qTox allows you to use multiple Tox IDs with different profiles, which each can #### Theme * _Use emoticons:_ If enabled, qTox will replace simleys ( e.g. :-) ) with Unicode emoticons. -* _Smiley Pack:_ You can choose from different sets of shiped emoticon styles. You can also install your own, see ??? for details +* _Smiley Pack:_ You can choose from different sets of shiped emoticon styles. * _Emoticon size:_ You can change the size of the emoticons here. * _Style:_ Changes the appearance of qTox. * _Theme color:_ Changes the colors qTox uses. @@ -87,7 +87,7 @@ Most users will want the two settings enabled, but if qTox crashes your router, #### NoSpam -NoSpam is a feature of Tox to prevent someone spamming you with friend requests. If you get spammed, enter or generate a new NoSpam value, this will alter your Tox ID. You don't need to tell your existing contacts your new Tox ID, but you have to tell new contacts your new Tox ID. Your Tox ID can be found ??? +NoSpam is a feature of Tox to prevent someone spamming you with friend requests. If you get spammed, enter or generate a new NoSpam value, this will alter your Tox ID. You don't need to tell your existing contacts your new Tox ID, but you have to tell new contacts your new Tox ID. Your Tox ID can be found in your [User Profile](#user-profile) ### Audio/Video #### Audio Settings @@ -117,7 +117,7 @@ NoSpam is a feature of Tox to prevent someone spamming you with friend requests. ## Groupchats -Groupchats are a way to talk with multiple friends at the same time, like when you are standing together in a group. To create a groupchat click the groupchat icon and set a name. Now you can invite people by right clicking on the contact and selecting "Invite to group". Currently, if the last person leaves the chat, it is closed and you have to create a new one. +Groupchats are a way to talk with multiple friends at the same time, like when you are standing together in a group. To create a groupchat click the groupchat icon and set a name. Now you can invite people by right clicking on the contact and selecting "Invite to group". Currently, if the last person leaves the chat, it is closed and you have to create a new one. Sending files and videochats are currently unsupported in groupchats. ## Multi Window Mode From 376d685b25b7a6156a352dbfae19defb730979bb Mon Sep 17 00:00:00 2001 From: sudden6 Date: Fri, 15 Jan 2016 22:53:55 +0100 Subject: [PATCH 10/12] slight clarifications in manual --- doc/user_manual_en.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/user_manual_en.md b/doc/user_manual_en.md index 2ddb10321..bd5b0a849 100644 --- a/doc/user_manual_en.md +++ b/doc/user_manual_en.md @@ -47,13 +47,13 @@ qTox allows you to use multiple Tox IDs with different profiles, which each can * _Auto away after (0 to disable):_ After the specified amount of time, qTox will set your Status to "Away". A setting of 0 will never change your status. * _Default directory to save files:_ You can set the directory where qTox puts files you recieved here. -* _Autoaccept files:_ If set, qTox will automatically accept filetransfers and put them in the directory specified above. +* _Autoaccept files:_ If set, qTox will automatically accept file transfers and put them in the directory specified above. #### Chat * _Play sound:_ If checked, qTox will play a sound when you get a new message. * _Open window:_ If checked, the qTox window will be opened. If you use the multiple windows mode, see [Multi Window Mode](#multi-window-mode) for details. * _Focus window:_ If checked, the qTox window will additionally be focused. -* _Show contacts' status changes:_ If set, qTox will show contact status changes in your chat history. +* _Show contacts' status changes:_ If set, qTox will show contact status changes in your chat window. * _Group chats always notify:_ If set, qTox will notify you on every new message in a groupchat. * _Place groupchats at top of friend list:_ If checked, your groupchats will be at the top of the contacts list, else they will be sorted with your other contacts. * _Faux offline messaging:_ If enabled, qTox will attempt to send messages when a currently offline contact comes online again. From c408cf404541490ea88277dac3e77e550dc2c1c7 Mon Sep 17 00:00:00 2001 From: sudden6 Date: Fri, 15 Jan 2016 22:56:34 +0100 Subject: [PATCH 11/12] Add user manual in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6c00c362f..9dba892ca 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ qTox [![Build Status](https://travis-ci.org/tux3/qTox.svg)](https://travis-ci.org/tux3/qTox) ====== - [**Compile**](/INSTALL.md) **⦁** [**Contribute**](https://github.com/tux3/qTox/wiki#contributing) **⦁** [**Report bugs**](https://github.com/tux3/qTox/wiki/Writing-Useful-Bug-Reports) **⦁** [**Translate**](https://github.com/tux3/qTox/wiki/Translating) **⦁** [**Jenkins builds**](https://build.tox.chat/) **⦁** [**Keyboard shortcuts**](https://github.com/tux3/qTox/wiki/Keyboard-shortcuts) **⦁** [**Mailing list**](https://lists.tox.chat) **⦁** **IRC Channel:** [#qtox@freenode](https://webchat.freenode.net/?channels=qtox) + [**User Manual**](/doc/user_manual_en.md) **⦁** [**Compile**](/INSTALL.md) **⦁** [**Contribute**](https://github.com/tux3/qTox/wiki#contributing) **⦁** [**Report bugs**](https://github.com/tux3/qTox/wiki/Writing-Useful-Bug-Reports) **⦁** [**Translate**](https://github.com/tux3/qTox/wiki/Translating) **⦁** [**Jenkins builds**](https://build.tox.chat/) **⦁** [**Keyboard shortcuts**](https://github.com/tux3/qTox/wiki/Keyboard-shortcuts) **⦁** [**Mailing list**](https://lists.tox.chat) **⦁** **IRC Channel:** [#qtox@freenode](https://webchat.freenode.net/?channels=qtox) **qTox is a powerful Tox client that follows the Tox design guidelines while running on all major platforms.** From 878b3d65bdcd8417cc04c035f5443d27cc7dc149 Mon Sep 17 00:00:00 2001 From: sudden6 Date: Fri, 15 Jan 2016 23:19:03 +0100 Subject: [PATCH 12/12] fix formatting in manual --- doc/user_manual_en.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/user_manual_en.md b/doc/user_manual_en.md index bd5b0a849..b3c508153 100644 --- a/doc/user_manual_en.md +++ b/doc/user_manual_en.md @@ -73,6 +73,7 @@ qTox allows you to use multiple Tox IDs with different profiles, which each can #### Connection Settings * _Enable IPv6 (recommended):_ If enabled, qTox will use IPv4 and IPv6 protocols, whichever is available. If disabled, qTox will only use IPv4. * _Enable UDP (recommended):_ If enabled, qTox will use TCP and UDP protocols. If disabled, qTox will only use TCP, which is supposed to lower the amount of traffic, but is also slower and puts more load on other network participants. + Most users will want the two settings enabled, but if qTox crashes your router, you can try to disable them. * _Proxy type:_ If you want to use a proxy, set the type here. "None" disables the proxy. @@ -110,7 +111,7 @@ NoSpam is a feature of Tox to prevent someone spamming you with friend requests. * _Reset to default settings_ Use this button to delete any changes you made to the qTox settings. ### About -* _Version_ The version of qTox and the libraries it depends on. Please append this information to every bugreport. +* _Version_ The version of qTox and the libraries it depends on. Please append this information to every bug report. * _License_ The license under which the code of qTox is available. * _Authors_ The people who developed this shiny piece of software. * _Known Issues_ Links to our list of known issues and improvements. @@ -129,7 +130,7 @@ The following shortcuts are currently supported: | Shortcut | Action | |----------|--------| -| ``Arrow up`` | Paste last message | +| ``Arrow up`` | Paste last sent message | | ``CTRL`` + ``SHIFT`` + ``L`` | Clear chat | | ``CTRL`` + ``q`` | Quit qTox | | `CTRL` + `Page Down` | Switch to the next contact |