Skip to content
Snippets Groups Projects
Commit e9c7d8fa authored by Amin Bandali's avatar Amin Bandali
Browse files

Merge user-manual/ into user/ and drop some old/unused files

Change-Id: Ie38849e9d979042a0d9057ae642b5012c795b70b
parent f6e68f58
No related branches found
No related tags found
No related merge requests found
Showing
with 0 additions and 320 deletions
libjamiclient coding style
==========================
**This page gives rules and/or guidances to all
developers that want to integrate some code to the LibRingClient (a
Daemon Middleware for Desktop Clients).**
- Following rules apply to this sub-project only. Others may re-use
this one in parts or whole, have their own, etc. Refer to their
pages for that.
<!-- -->
- Some rules are <u>strict</u> and are **strongly marked** or using
modals like SHALL or MUST.
**!!!Not respecting these rules results in code-review rejection!!!**
- Some are guidance or recommendation (using modals like SHOULD or
RECOMMEND), it's up to the developer to balance them with his own
way to write code.
<!-- -->
- Rules are based on following well known ones, we've modified them
for this project:
- [Google C++
CodingStyle](https://google.github.io/styleguide/cppguide.html)
for the general C++ domain
- [Qt Coding Conventions](https://wiki.qt.io/Coding_Conventions)
and [Qt Coding Style](https://wiki.qt.io/Qt_Coding_Style) as
this project use QtCore as framework.
<!-- -->
- This wiki is a permanent Work-In-Progress system. **So not all rules
are written yet.** That doesn't mean we don't have them yet (we =
core developer members).
<!-- -->
- We've changed some rules during the project. We update the code
iteratively, so tt's extremly possible to find whole files or parts
of code that not using these rules.
In such situation, if you need to change only few lines in a "logic"
block (i.e. a class declaration, a function body, ...) keep the local
rules to make easier the review: we can see what's the important change
without being disturbed by coding rules refactoring. If you need such
action, use a dedicated patch with a clear mention in the commit
message.
---
## Rules
### **Language Standard**
We SHALL use the **C++14 standard** syntax only.
For gnu-gcc and clang, use compiler command line option `-std=c++14` to
enforce this rule.
### **Maximum Line Length**
You SHOULD keep your line length under the **120 characters limit**.
This limitation is mainly due that integrators used splited view to
compare files, and keep it below 120 cols make easier to compare them,
even on wide screen. Configure your editing tools to this limit.
If keeping this rule make the code worst to read or non-valid than
exceed the limit, the rule can be transgressed. These why we've
**exceptions** to this rule:
- If a comment line contains an example command or a literal URL
longer than 120 characters, that line may be longer than 120
characters for ease of cut and paste.
- A raw-string literal may have content that exceeds 120 characters.
Except for test code, such literals should appear near top of
a file.
- An \#include statement with a long path may exceed 120 columns.
### **Non-ASCII Characters**
Non-ASCII characters should be rare, and MUST use **UTF-8** formatting.
You SHALL NOT use the C++11 char16\_t and char32\_t character types,
since they're for non-UTF-8 text. For similar reasons you also SHALL NOT
use wchar\_t (unless you're writing code that interacts with the Windows
API, which uses wchar\_t extensively).
### **Spaces vs. Tabs**
In code files (i.e. .cpp or .h), you SHALL use **spaces to indent**.
One indent level is 4 (four) consecutive spaces. You should set your
editor to emit spaces when you hit the tab key and when you save your
file.
### **Testing**
Each patch for LRC should be accompanied by a test. CppUnit is used to
write tests.
UI and UX development
=====================
The purpose of this page is to act as a reference during UI/UX development and to help synchronize the various Ring clients.
As a start, we should post screenshots from all important Ring views.
## Screenshots
**Disclaimer: This page is not up-to-date!**
Part | GNOME | OSX | WIN32 | UWP | Android
-----|-------|-----|-------|-----|--------
Main | ![Main-view-gnome](https://git.jami.net/savoirfairelinux/jami-project/uploads/4183b887eefad2454625f2f1bf762460/Main-view-gnome.png) | TODO | ![Main-view-win32](https://git.jami.net/savoirfairelinux/jami-project/uploads/b14921088125981999e22dbbd4f900e9/Main-view-win32.png) | TODO | TODO
New account creation (initial) | ![Account-wizard-1-gnome](https://git.jami.net/savoirfairelinux/jami-project/uploads/a68d5c796cd09a63f934fdebe1a90af4/Account-wizard-1-gnome.png) | TODO | ![Account-wizard-1-win32](https://git.jami.net/savoirfairelinux/jami-project/uploads/1d28dd7590538390202aaa8e2bd35423/Account-wizard-1-win32.png) | TODO | TODO
New account creation (main) | ![Account-wizard-2-gnome](https://git.jami.net/savoirfairelinux/jami-project/uploads/9f374098a9cbd04ecf2eca8a3a1acdde/Account-wizard-2-gnome.png) | TODO | ![Account-wizard-2-win32](https://git.jami.net/savoirfairelinux/jami-project/uploads/bd03d4962be96b4c3692c156904b91c9/Account-wizard-2-win32.png) | TODO | TODO
new account (clicked next) | Text with spinner + confirmation/error message | TODO | ![Account-wizard-3-win32](https://git.jami.net/savoirfairelinux/jami-project/uploads/312b56d8cf572ab1f6e7c7c056953087/Account-wizard-3-win32.png) | TODO | TODO
Link device (initial) | ![Account-wizard-1-gnome](https://git.jami.net/savoirfairelinux/jami-project/uploads/89f2e997b457fe2f824e0722031d307d/Account-wizard-1-gnome.png) | TODO | ![Account-wizard-1-win32](https://git.jami.net/savoirfairelinux/jami-project/uploads/ff1ac234eed8abeeb1b152ee0d1a7e18/Account-wizard-1-win32.png) | TODO | TODO
Link device (explanatory) | ![Account-link-device-1](https://git.jami.net/savoirfairelinux/jami-project/uploads/42aa54246a264a908370bb83e22d50c3/Account-link-device-1.png) | TODO | ![Account-link-device-1-win32](https://git.jami.net/savoirfairelinux/jami-project/uploads/e8b86b541b6da8c81e4a6c876d902097/Account-link-device-1-win32.png) | TODO | TODO
Link device (pin + password) | ![Account-link-device-2](https://git.jami.net/savoirfairelinux/jami-project/uploads/91f11432cb8e63e717b8460bc05d63a3/Account-link-device-2.png) | TODO | ![Account-link-device-2-win32](https://git.jami.net/savoirfairelinux/jami-project/uploads/3d659afe96b24dc222d8f88f5e616811/Account-link-device-2-win32.png) | TODO | TODO
Chat | ![Ring_gnome_chat_view](https://git.jami.net/savoirfairelinux/jami-project/uploads/fe6dac09b551f2922991fe956fae0bb5/Ring_gnome_chat_view.png) | TODO | TODO | TODO | TODO
## Future
[Ring_GNOME_client_mock-ups.pdf](https://git.jami.net/savoirfairelinux/jami-project/uploads/698997f2126004a2e82b3d6e32bcdae4/Ring_GNOME_client_mock-ups.pdf)
Miscellaneous
=============
This page mainly serves as a jump-in point for the pages of an earlier
version of these documents previously in form of a GitLab wiki.
The ultimate goal/plan for the following pages is to rewrite and/or
reorganize them into the three manuals of Jami: the :doc:`user manual
<user/index>`, the :doc:`build manual <build/index>`, and the
:doc:`developer manual <developer/index>`. Thus, the following links
may change at any time.
.. toctree::
:maxdepth: 1
user-manual/introduction
user-manual/installation
user-manual/create-jami-account
uploads/20037cbaaa4082ec73af44c4e76864f1/install_linux.png

74 KiB

uploads/2fc925933bbfb3296f48f9e1da3e0706/installed_android.jpg

17.6 KiB

uploads/5632dc645e41d02fa2458cba414ac67c/change_preference_android.jpg

22.8 KiB

uploads/695d77baaf669134d271c4f7c1c82301/uninstall_android.jpg

28.9 KiB

{
"version": "1.0",
"components": [
"Microsoft.VisualStudio.Component.CoreEditor",
"Microsoft.VisualStudio.Workload.CoreEditor",
"Microsoft.VisualStudio.Component.Roslyn.Compiler",
"Microsoft.Component.MSBuild",
"Microsoft.VisualStudio.Component.Static.Analysis.Tools",
"Microsoft.Net.Component.4.6.1.SDK",
"Microsoft.Net.Component.4.6.1.TargetingPack",
"Microsoft.VisualStudio.Component.TextTemplating",
"Microsoft.VisualStudio.Component.Debugger.JustInTime",
"Microsoft.VisualStudio.Component.VC.CoreIde",
"Microsoft.VisualStudio.Component.VC.Redist.14.Latest",
"Microsoft.VisualStudio.ComponentGroup.NativeDesktop.Core",
"Microsoft.VisualStudio.Component.VC.Tools.x86.x64",
"Microsoft.VisualStudio.Component.Graphics.Win81",
"Microsoft.VisualStudio.Component.Graphics.Tools",
"Microsoft.VisualStudio.Component.VC.DiagnosticTools",
"Microsoft.VisualStudio.Component.Windows10SDK.17763",
"Microsoft.VisualStudio.Component.Windows81SDK",
"Microsoft.VisualStudio.Component.VC.CLI.Support",
"Microsoft.VisualStudio.Component.Windows10SDK.17134",
"Microsoft.VisualStudio.Component.Windows10SDK.16299.UWP",
"Microsoft.VisualStudio.Component.Windows10SDK.16299.UWP.Native",
"Microsoft.VisualStudio.Component.Windows10SDK.16299.Desktop",
"Microsoft.VisualStudio.Component.Windows10SDK.15063.UWP",
"Microsoft.VisualStudio.Component.Windows10SDK.15063.UWP.Native",
"Microsoft.VisualStudio.Component.Windows10SDK.15063.Desktop",
"Microsoft.VisualStudio.Component.Windows10SDK.14393",
"Microsoft.VisualStudio.Component.Windows10SDK.10586",
"Microsoft.VisualStudio.Component.Windows10SDK.10240",
"Microsoft.VisualStudio.Workload.NativeDesktop",
"Microsoft.VisualStudio.Component.VC.Tools.ARM64",
"Microsoft.VisualStudio.Component.VC.Tools.ARM",
"Microsoft.VisualStudio.Component.Windows10SDK",
"Component.MDD.Linux",
"Microsoft.VisualStudio.Workload.NativeCrossPlat",
"Microsoft.VisualStudio.Component.VC.Tools.14.15"
]
}
\ No newline at end of file
uploads/764a9bba83310616e8b9cb057d4f7db4/use_linux.png

2.21 MiB

File deleted
File deleted
File deleted
{
"version": "1.0",
"components": [
"Microsoft.VisualStudio.Workload.NativeDesktop",
"microsoft.net.component.4.6.targetingpack",
"microsoft.visualstudio.component.debugger.justintime",
"microsoft.visualstudio.component.vc.diagnostictools",
"microsoft.visualstudio.component.vc.cmake.project",
"microsoft.visualstudio.component.vc.atl",
"microsoft.visualstudio.component.vc.testadapterforboosttest",
"microsoft.visualstudio.component.vc.testadapterforgoogletest",
"microsoft.component.vc.runtime.ucrtsdk",
"microsoft.visualstudio.component.windows81sdk",
"microsoft.visualstudio.component.windows10sdk.16299.desktop",
"microsoft.visualstudio.component.windows10sdk.15063.desktop",
"microsoft.visualstudio.component.windows10sdk.14393",
"microsoft.visualstudio.component.diagnostictools",
"microsoft.visualstudio.component.windows10sdk",
"component.wixtoolset.visualstudioextension.dev15"
]
}
\ No newline at end of file
uploads/984597d748a460637ad0858163f4a67f/installed_linux.png

85.6 KiB

Test id,Test case name, Steps description,Expected result,Status,actual result /comment,bug id
1001,Installation,"1- Go to https://jami.net
2- Download the appropriate package
3- Install Ring","1- Page opened
2- Type OS detected correctly
and appropriate choice/choices displayed
3- Package(s) downloaded succesfuly
4- Installation proceeded succesfuly",,,
1002,Starting Ring,"Run Jami from the Applications menu
Or from your Launcher","Jami started succesfuly
A wizard page will appear.",,,
1003,Creating new account,"Write your name or alias on the wizard page.
Enter a password and password confirmation.
And click on Next.","The window navigates to the About page with the contacts
tab selected. ",,,
1004,Creating an account avatar,Take a picture and change avatar,The user avatar should include the new picture uploaded,,,
1005,"Linking new device,generate pin","In existing account go to devices tab (Configuration)
Click on Add device
Enter password and click on ' Export on the Ring'",Pin generated and displayed,,,
1006,Linking second device,"On device that should be linked click
Link this device to an existing account
Enter Pin and password of existing account","device linked succesfuly , Ring ID is the same as at first device",,,
1007,QR code,Click on QR code button under Ring ID,QR code is displayed ,,,
1008,About Info,"Click on Jami icon on the window title bar (left corner )
and choose About","About window is opened and contained following:
Ring Logo and name on the top
Type version(Ex:Gnome Ring) and version ID
Short description of Jami
Link http://www.jami.net/ and copyright
License Link http://www.gnu.org/licenses/gpl.html
Credits button",,,
1009,Search Ring ID,Enter jami ID(user1) in Search field and press enter,"Appropriate account is found and added to
Conversation list
Conversation window appear at right side.
Input text field is active",,,
1010,Chat Functionality sending,Enter text in chat input field and press enter,Message sent succesfuly and recipient received it,,,
1011,Chat Functionality sending,Enter text in chat input field and press button Send (Envoyer),Message sent succesfuly and recipient received it,,,
1012,Search Ring ID,"Enter Ring ID(user2) in Search field
And click on ID from drop down menu","Appropriate account is found and added to
Conversation list
Conversation window appeared at right side.
Input text field is active",,,
1013,Chat on call,Click on Chat button (activate),"Conversation window appear at right side.
Input text field is active",,,
1014,Chat on call,Click on Chat button (deactivate),Conversation window disappear ,,,
1015,Mute call,Click on Mute button (activate),"Audio is muted , but you can still chat",,,
1016,Mute call,Click on Mute button (deactivate),"Audio is on , no errors",,,
1017,End call ,Press End Call button(Raccrocher) on your client,Call ended on both clients without errors,,,
1018,Video Call from Ring ID (user1),"1 Initiate video call to RingID(2devices linked)
2 On RING01 client side press Reject","1 Calling window appear on both devices with 2 active buttons:
Accept and Reject
2 Call ended without error message on every device",,,
1019,Video Call from Ring ID (user1),"1 Initiate video call to RingID(2devices linked)
2 at one of devices press Accept","1 Calling window appear on both devices with 2 active buttons:
Accept and Reject
2 Call started without error message , video is turned on and
streaming without problem , at other linked devices call stopped",,,
1020,Call on Hold,Click on Hold button (activate),"Audio is muted and video is interrupted , but you can still chat",,,
1021,Call on Hold,Click on Hold button (deactivate),Call returned to previous state: Video and audio ON,,,
1022,Deactivate Video,Click on deactivate video button ,"Video is turned off , audio not affected",,,
1023,Reactivate Video,Click on reactivate video button ,Video and audio ON,,,
1024,End call ,Press End Call button(Raccrocher) on RING01 side,Call ended on both clients without errors,,,
1025,Search Ring ID,Enter Ring ID(user3) in Search field and press enter,"Appropriate account is found and added to Conversation list.
Conversation window appear at right side.
Input text field is active",,,
1026,Contact List,Click to RING01,"Conversation window at right side show chat history
Input text field is active",,,
1027,Send Contact Request,"Enter Ring ID or username (user4) in Search field and press
Enter or click Add Contact","A contact should be added to the contact list, a contact request
should be sent and indicated in the contact list item. The contact
request should also be received by user4",,,
1028,Receive Contact Request,"From an new contact (R1), send a contact request to (R0)",A contact request should be received and indicated the the user,,,
1029,Accept Contact Request,"From the contact request list menu, click accept on the
contact request from (R1)","The contact request should no longer be visible, and the contact
should appear as a trusted contact in the contacts list",,,
1030,Ignore Contact Request,"After sending (R0) another contact request from (R2)
From the contact request list menu, click ignore on the
contact request from (R2)","The contact request should no longer be visible, and the contact
Should NOT appear in the contacts list",,,
1031,Block Contact Request,"After sending (R0) another contact request from (R3)
From the contact request list menu, click block on the
contact request from (R3)","The contact request should no longer be visible, and the contact
should NOT appear in the contacts list. The contact should appear
in the Blocked Contacts list within the account settings menu. (R0)
should not be able to receive any further contact requests from (R3)",,,
1032,Unblock Contact Request,"access the blocked user (R3) from the Blocked Contacts list
from within the account settings menu, and click
unblock/add to contacts","The contact (R3) should no longer appear in the blocked contact list,
but should show up in the contacts list as a trusted contact",,,
1033,Change camera channel,"After installing an external camera, the user should be able to change the camera channel in the settings",The camera channel would be changed and stay that way even after closing/reopening of the app,,,
1034,Change camera resolution,Change the camera resolution in the settings,the output resolution of the video should change in the next calls,,,
1035,Start recording,Press record and wait for the record button to blink,The conversation should be recording and saved in user files,,,
1036,Stop recording,Press record and wait for the record button to stop blinking,The recording should stop accuratly with the end of the video file,,,
1037,Conference calls,Initiate one call with user 1 and user 2 at the same time by draging and droping the names into each other,The call should start with no errors one the 3 devices,,,
1038,End conference call (Master),Master (the one who initiated the call) press End Call button on one of the devices,The conference Call should end on the 3 devices at the same time with no errors,,,
1039,End conference call,A member of the conference call (not the master) press end call,The conference Call should end on the user device but keep activated on the other 2 devices,,,
1040,Change HD setting,Go in settings→accept HD calls ON ,The video call should have a better resolution,,,
1041,Remove HD feature,Go in settings→accept HD calls OFF,The video call should have a lower resolution,,,
1042,Sip calls and Enable System Calls,Go in settings→place system calls using Jami ON,The user should be able to receive and make SIP calls directly with Jami. Hang up should work. Putting the call on mute should work. Putting the call on hold/off hold should work also,,,
1043,Multi-device Call,Go in settings→Accounts→Add an axisting account. Then call the account from a third device. ,The user should be able to receive the call from the third account directly on all the devices linked to his/her account.,,,
1044,Multi-device Text,Go in settings→Accounts→Add an axisting account. Then send a message text and an emoj to the account from a third device. ,The user should be able to receive the message text from the third account directly on all the devices linked to his/her account.,,,
1045,Presence,Go in the conversation page on USR1 device and make sure other device of USR2 is connected,The user should be able to see USR2 presence and vice-versa,,,
1046,Wake-up,Make sure USR2 device is in sleep mode and call USR2 with USR1 device,USR2 device should wake up and receive notification of an incoming call from USR1,,,
1047,,,,,,
1048,Uninstall,Right click on the Jami icon and click uninstall,The application should no longer be installed,,,
,,,,,,
,LEGEND,please include comments at the end of the file and specifications on the devices tested,,,,
,Test failed,,,,,
,,,,,,
,Test passed,,,,,
uploads/a2169faa90f759799d3f95d43727c7e5/Screenshot_from_2019-03-10_21-12-56.png

5.33 MiB

File deleted
File deleted
uploads/d79419990eeab6cfd022655c1e6405c4/05-24-19-11_10_12.png

90 KiB

File deleted
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment