aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBramastyo Harimukti Santoso <bramastyo.harimukti.santoso@pelagicore.com>2018-06-07 17:40:14 +0200
committerAlexandra Betouni <ABetouni@luxoft.com>2018-06-07 16:02:27 +0000
commit638006ba3ef05d97a34b5449f01e8b9f42752601 (patch)
tree4696ab3a72a914e6036cda6c9929cc3ff2af80ea
parent3867ac5b06fe49677e41a25f03cc504698c6fd32 (diff)
[doc] add documentation about the settings application
Change-Id: Ie75a403f7ce67da73d19f062f6d09a1bc9747c8c Reviewed-by: Alexandra Betouni <ABetouni@luxoft.com>
-rw-r--r--doc/src/images/neptune-accent-color1.jpgbin0 -> 23040 bytes
-rw-r--r--doc/src/images/neptune-accent-color2.jpgbin0 -> 26288 bytes
-rw-r--r--doc/src/images/neptune-dark-theme1.jpgbin0 -> 27121 bytes
-rw-r--r--doc/src/images/neptune-dark-theme2.jpgbin0 -> 21593 bytes
-rw-r--r--doc/src/images/settings-app-accent-color.jpgbin0 -> 23577 bytes
-rw-r--r--doc/src/images/settings-app-languages.jpgbin0 -> 25520 bytes
-rw-r--r--doc/src/images/settings-app-themes.jpgbin0 -> 21398 bytes
-rw-r--r--doc/src/images/settings-app-timezone.jpgbin0 -> 20058 bytes
-rw-r--r--doc/src/neptune3ui-index.qdoc2
-rw-r--r--doc/src/neptune3ui-settings-application.qdoc88
10 files changed, 89 insertions, 1 deletions
diff --git a/doc/src/images/neptune-accent-color1.jpg b/doc/src/images/neptune-accent-color1.jpg
new file mode 100644
index 00000000..137c4359
--- /dev/null
+++ b/doc/src/images/neptune-accent-color1.jpg
Binary files differ
diff --git a/doc/src/images/neptune-accent-color2.jpg b/doc/src/images/neptune-accent-color2.jpg
new file mode 100644
index 00000000..4d81ba0b
--- /dev/null
+++ b/doc/src/images/neptune-accent-color2.jpg
Binary files differ
diff --git a/doc/src/images/neptune-dark-theme1.jpg b/doc/src/images/neptune-dark-theme1.jpg
new file mode 100644
index 00000000..1f3a243c
--- /dev/null
+++ b/doc/src/images/neptune-dark-theme1.jpg
Binary files differ
diff --git a/doc/src/images/neptune-dark-theme2.jpg b/doc/src/images/neptune-dark-theme2.jpg
new file mode 100644
index 00000000..f346bade
--- /dev/null
+++ b/doc/src/images/neptune-dark-theme2.jpg
Binary files differ
diff --git a/doc/src/images/settings-app-accent-color.jpg b/doc/src/images/settings-app-accent-color.jpg
new file mode 100644
index 00000000..7662a11e
--- /dev/null
+++ b/doc/src/images/settings-app-accent-color.jpg
Binary files differ
diff --git a/doc/src/images/settings-app-languages.jpg b/doc/src/images/settings-app-languages.jpg
new file mode 100644
index 00000000..6b0e4397
--- /dev/null
+++ b/doc/src/images/settings-app-languages.jpg
Binary files differ
diff --git a/doc/src/images/settings-app-themes.jpg b/doc/src/images/settings-app-themes.jpg
new file mode 100644
index 00000000..1d3da403
--- /dev/null
+++ b/doc/src/images/settings-app-themes.jpg
Binary files differ
diff --git a/doc/src/images/settings-app-timezone.jpg b/doc/src/images/settings-app-timezone.jpg
new file mode 100644
index 00000000..ba8829af
--- /dev/null
+++ b/doc/src/images/settings-app-timezone.jpg
Binary files differ
diff --git a/doc/src/neptune3ui-index.qdoc b/doc/src/neptune3ui-index.qdoc
index dfa7b9e4..863abad2 100644
--- a/doc/src/neptune3ui-index.qdoc
+++ b/doc/src/neptune3ui-index.qdoc
@@ -146,7 +146,7 @@
Web Radio App, Same Game. User can also uninstall these external installed
apps using the Application Store.
\row
- \li General Settings (\c settingsapp)
+ \li \l{Neptune 3 UI - General Settings Application}{General Settings} (\c settingsapp)
\li General Settings provides a set of common UI settings, such as language
settings, theme settings, date and time settings, as well as color settings.
\endtable
diff --git a/doc/src/neptune3ui-settings-application.qdoc b/doc/src/neptune3ui-settings-application.qdoc
new file mode 100644
index 00000000..c61faf5b
--- /dev/null
+++ b/doc/src/neptune3ui-settings-application.qdoc
@@ -0,0 +1,88 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 Pelagicore AG
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the Neptune 3 IVI UI.
+**
+** $QT_BEGIN_LICENSE:FDL-QTAS$
+** Commercial License Usage
+** Licensees holding valid commercial Qt Automotive Suite licenses may use
+** this file in accordance with the commercial license agreement provided
+** with the Software or, alternatively, in accordance with the terms
+** contained in a written agreement between you and The Qt Company. For
+** licensing terms and conditions see https://www.qt.io/terms-conditions.
+** For further information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \page neptune3ui-settings-application.html
+ \title Neptune 3 UI - General Settings Application
+ \previouspage neptune3ui-index.html
+ \brief The Settings Application of Neptune 3 UI
+
+ In Neptune 3, an application called "com.pelagicore.apps.settings" is pre-installed
+ allowing the user to have their own preferences, such as languages, themes and colors.
+
+ \section1 Languages Settings
+
+ \image settings-app-languages.jpg
+
+ Settings application contains a language settings menu that allows the user to
+ set the global language used in Neptune 3 UI.
+
+ Neptune 3 UI supports following languages:
+ \list
+ \li American English
+ \li British English
+ \li Czech Language
+ \li German Language
+ \li Japanese Language
+ \li Chinese Language
+ \li Korean Language
+ \endlist
+
+ \section1 Date and Time Settings
+
+ \image settings-app-timezone.jpg
+
+ Settings application contains a date and time settings menu that allows the user to
+ set the time format and time zone.
+
+ \section1 Themes Settings
+
+ \image settings-app-themes.jpg
+
+ Neptune 3 UI supports two type of themes, dark theme and light theme. By default,
+ light theme is used. The user can change the UI theme through the Settings application
+ to switch between dark and light theme.
+
+ The images below show how the dark theme looks like:
+
+ \image neptune-dark-theme1.jpg
+
+ \image neptune-dark-theme2.jpg
+
+ \section1 Accent Color Settings
+
+ \image settings-app-accent-color.jpg
+
+ Neptune 3 UI provides eight options of color to be used as the accent color. The
+ default color is orange.
+
+ The following images show how it looks when the accent color is being changed.
+
+ \image neptune-accent-color1.jpg
+
+ \image neptune-accent-color2.jpg
+*/