Merge lp:~bpierre/ubuntu-ui-toolkit/doc-fixes into lp:ubuntu-ui-toolkit/staging

[Pierre Bertet]

Fix the lists style in the offline documentation

Fix the lists style in the offline documentation (fixes #1557472)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

FAILED: Continuous integration, rev:1895
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-armhf-stable/553/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/1984/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-armhf-stable/553/rebuild

review: Needs Fixing (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1895
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-stable/542/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/1989/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-stable/542/rebuild

review: Approve (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1895
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-devel/322/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/1991/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-devel/322/rebuild

review: Approve (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1895
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-i386-gles-stable/296/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2001/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-i386-gles-stable/296/rebuild

review: Approve (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

FAILED: Continuous integration, rev:1895
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci/187/
Executed test runs:
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-stable/542
    FAILURE: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-armhf-stable/553/console
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-devel/322
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-i386-gles-stable/296
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2002/console
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/1989
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/1984
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/1991
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2001

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci/187/rebuild

review: Needs Fixing (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1895
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-stable/549/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2025/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-stable/549/rebuild

review: Approve (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1895
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-devel/329/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2026/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-devel/329/rebuild

review: Approve (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1895
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-i386-gles-stable/303/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2030/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-i386-gles-stable/303/rebuild

review: Approve (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1895
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-armhf-stable/561/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2035/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-armhf-stable/561/rebuild

review: Approve (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1895
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci/192/
Executed test runs:
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-stable/549
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-armhf-stable/561
        deb: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-armhf-stable/561/artifact/artifacts/*zip*/artifacts.zip
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-devel/329
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-i386-gles-stable/303
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2036/console
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2025
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2035
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2026
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2030

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci/192/rebuild

review: Approve (continuous-integration)

[Zsombor Egri (zsombi)]

Thanks, things start to look much better in the docs now :)

review: Approve

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1895
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-stable/577/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2160/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-stable/577/rebuild

review: Approve (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1895
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-devel/357/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2161/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-devel/357/rebuild

review: Approve (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1895
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-armhf-stable/589/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2162/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-armhf-stable/589/rebuild

review: Approve (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1895
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-i386-gles-stable/332/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/2163/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-i386-gles-stable/332/rebuild

review: Approve (continuous-integration)

=== modified file 'documentation/css/qtquick.css'
--- documentation/css/qtquick.css	2013-07-25 13:19:45 +0000
+++ documentation/css/qtquick.css	2016-03-15 18:27:24 +0000
@@ -473,8 +473,19 @@
         color: red;
     }
 
-    .qmldoc
-    {
+    /* The `#details ~ ul` selector is used because there is no other way to
+     * target the content without overwriting the default styles of the page.
+     * A better solution would be to reset the list style on the parts where
+     * this style is required instead of doing it by default. */
+    .qmldoc ul,
+    #details ~ ul
+    {
+        margin: 0 10px 10px;
+    }
+    .qmldoc li,
+    #details ~ ul li
+    {
+        list-style: disc inside none;
     }
 
     .generic .alphaChar{

=== modified file 'src/Ubuntu/Components/Pickers/1.2/DatePicker.qml'
--- src/Ubuntu/Components/Pickers/1.2/DatePicker.qml	2015-04-30 08:32:44 +0000
+++ src/Ubuntu/Components/Pickers/1.2/DatePicker.qml	2016-03-15 18:27:24 +0000
@@ -98,10 +98,10 @@
     \a minimum and \a maximum properties. The interval can be altered considering
     the following rules:
     \list
-        \li - \a minimum must be less or equal than the \l date; if the \a date
+        \li \a minimum must be less or equal than the \l date; if the \a date
                 value is less than the given \a minimum, the date will be set to
                 the minimum's value
-        \li - \a maximum value must be greater than the \a minimum, or invalid.
+        \li \a maximum value must be greater than the \a minimum, or invalid.
                 When the maximum is smaller than the \l date, the \l date property
                 will be updated to get the maximum value.
                 When set to invalid date (see Date.getInvalidDate()), the upper
@@ -142,12 +142,12 @@
     The date picker consist of three pickers: year, month, and date. The exact
     contents of the month and date pickers depends on the available width:
     \list
-        \li * full name for month, number and full day for date (“August” “28 Wednesday”)
-        \li * otherwise full name for month, number and abbreviated day
+        \li full name for month, number and full day for date (“August” “28 Wednesday”)
+        \li otherwise full name for month, number and abbreviated day
             for date (“August” “28 Wed”);
-        \li * otherwise full name for month, number for date (“August” “28”);
-        \li * otherwise abbreviated name for month, number for date (“Aug” “28”).
-        \li * otherwise number for month, number for date (“08” “28”).
+        \li otherwise full name for month, number for date (“August” “28”);
+        \li otherwise abbreviated name for month, number for date (“Aug” “28”).
+        \li otherwise number for month, number for date (“08” “28”).
     \endlist
 
     \a{If the currently selected date becomes impossible due to year change (from a

=== modified file 'src/Ubuntu/Components/Pickers/1.3/DatePicker.qml'
--- src/Ubuntu/Components/Pickers/1.3/DatePicker.qml	2015-09-28 14:36:54 +0000
+++ src/Ubuntu/Components/Pickers/1.3/DatePicker.qml	2016-03-15 18:27:24 +0000
@@ -98,10 +98,10 @@
     \a minimum and \a maximum properties. The interval can be altered considering
     the following rules:
     \list
-        \li - \a minimum must be less or equal than the \l date; if the \a date
+        \li \a minimum must be less or equal than the \l date; if the \a date
                 value is less than the given \a minimum, the date will be set to
                 the minimum's value
-        \li - \a maximum value must be greater than the \a minimum, or invalid.
+        \li \a maximum value must be greater than the \a minimum, or invalid.
                 When the maximum is smaller than the \l date, the \l date property
                 will be updated to get the maximum value.
                 When set to invalid date (see Date.getInvalidDate()), the upper
@@ -142,12 +142,12 @@
     The date picker consist of three pickers: year, month, and date. The exact
     contents of the month and date pickers depends on the available width:
     \list
-        \li * full name for month, number and full day for date (“August” “28 Wednesday”)
-        \li * otherwise full name for month, number and abbreviated day
+        \li full name for month, number and full day for date (“August” “28 Wednesday”)
+        \li otherwise full name for month, number and abbreviated day
             for date (“August” “28 Wed”);
-        \li * otherwise full name for month, number for date (“August” “28”);
-        \li * otherwise abbreviated name for month, number for date (“Aug” “28”).
-        \li * otherwise number for month, number for date (“08” “28”).
+        \li otherwise full name for month, number for date (“August” “28”);
+        \li otherwise abbreviated name for month, number for date (“Aug” “28”).
+        \li otherwise number for month, number for date (“08” “28”).
     \endlist
 
     \a{If the currently selected date becomes impossible due to year change (from a

=== modified file 'src/Ubuntu/Components/plugin/uclistitem.cpp'
--- src/Ubuntu/Components/plugin/uclistitem.cpp	2016-02-25 19:42:11 +0000
+++ src/Ubuntu/Components/plugin/uclistitem.cpp	2016-03-15 18:27:24 +0000
@@ -1639,15 +1639,15 @@
  * An item is highlighted, thus highlight state toggled, when pressed and it has
  * one of the following conditions fulfilled:
  * \list
- *  \li * \l leadingActions or \l trailingActions set,
- *  \li * it has an \l action attached
- *  \li * if the ListItem has an active child component, such as a \l Button, a
+ *  \li \l leadingActions or \l trailingActions set,
+ *  \li it has an \l action attached
+ *  \li if the ListItem has an active child component, such as a \l Button, a
  *      \l Switch, etc.
- *  \li * in general, if an active (enabled and visible) \b MouseArea is added
+ *  \li in general, if an active (enabled and visible) \b MouseArea is added
  *      as a child component
- *  \li * \l clicked signal handler is implemented or there is a slot or function
+ *  \li \l clicked signal handler is implemented or there is a slot or function
  *      connected to it
- *  \li * \l pressAndHold signal handler is implemented or there is a slot or
+ *  \li \l pressAndHold signal handler is implemented or there is a slot or
  *      function connected to it.
  * \endlist
  *

=== modified file 'src/Ubuntu/Components/plugin/uclistitemstyle.cpp'
--- src/Ubuntu/Components/plugin/uclistitemstyle.cpp	2016-01-30 12:03:31 +0000
+++ src/Ubuntu/Components/plugin/uclistitemstyle.cpp	2016-03-15 18:27:24 +0000
@@ -131,11 +131,11 @@
  *
  * The \c event object properties are:
  * \list
- * \li * \c status - enumeration of \c {Started, Updated, Finished} values representing
+ * \li \c status - enumeration of \c {Started, Updated, Finished} values representing
  *                  the swipe event status
- * \li * \c to - (x, y) coordinates of the current mouse/touch point - read-only
- * \li * \c from - (x, y) coordinates of the previous mouse/touch point - read-only
- * \li * \c content - (x, y) updated coordinates of the \l {ListItem::contentItem}
+ * \li \c to - (x, y) coordinates of the current mouse/touch point - read-only
+ * \li \c from - (x, y) coordinates of the previous mouse/touch point - read-only
+ * \li \c content - (x, y) updated coordinates of the \l {ListItem::contentItem}
  *                  {ListItem.contentItem}, read-write
  * \endlist
  */

=== modified file 'src/Ubuntu/Components/plugin/ucslotslayout.cpp'
--- src/Ubuntu/Components/plugin/ucslotslayout.cpp	2016-01-30 10:51:22 +0000
+++ src/Ubuntu/Components/plugin/ucslotslayout.cpp	2016-03-15 18:27:24 +0000
@@ -617,12 +617,12 @@
 
     There are three conceptual types of slots:
     \list
-    \li * The \b {leading slots}, which are the ones positioned at the
+    \li The \b {leading slots}, which are the ones positioned at the
             beginning of the layout (i.e. they are the leftmost elements
             in left-to-right locales).
-    \li * The \b {trailing slots}, which are positioned after \l mainSlot,
+    \li The \b {trailing slots}, which are positioned after \l mainSlot,
             if any, or after the leading slots otherwise.
-    \li * The \b {main slot}, which drives the positioning of
+    \li The \b {main slot}, which drives the positioning of
             the vertical dimension of each slot as described in section
             \l {Automatic vertical positioning of slots}. This slot sits
             between leading and trailing slots, and can be set using the
@@ -738,12 +738,12 @@
     platform, SlotsLayout automatically handles the vertical positioning of its
     slots so that they comply with the following rules:
     \list
-        \li * if there's any slot which is taller or as tall as \l {mainSlot} or if
+        \li if there's any slot which is taller or as tall as \l {mainSlot} or if
             no \l {mainSlot} is defined, all slots will be \b {vertically centered} within the
             layout (still taking \l {SlotsLayout::padding.top} and \l {SlotsLayout::padding.bottom}
             into account).
             \image SlotsLayout_centerVertically.png
-        \li * \b{Otherwise}, all the slots (including \l {mainSlot}) will be \b {aligned to
+        \li \b{Otherwise}, all the slots (including \l {mainSlot}) will be \b {aligned to
             the top} of the layout with a padding of \l {SlotsLayout::padding.top} plus
             the top padding of the slot, defined in its attached properties.
             \image SlotsLayout_alignToTop.png
@@ -1035,10 +1035,10 @@
     The value of padding.top and padding.bottom depends on the size
     of the slots which are in the layout:
     \list
-    \li * if, according to the rules defined in \l {Automatic vertical positioning of slots},
+    \li if, according to the rules defined in \l {Automatic vertical positioning of slots},
         the slots are supposed to align to the top of the layout, padding.top
         and padding.bottom will have a value of \b{2} Grid Units.
-    \li * otherwise, if according to the rules defined in \l {Automatic vertical positioning of slots}
+    \li otherwise, if according to the rules defined in \l {Automatic vertical positioning of slots}
         the slots are supposed to be vertically centered in the layout, \b {and}
         the tallest slot (\l {mainSlot} excluded) has a height of at least 4 Grid Units,
         padding.top and padding.bottom will be set to \b{1} Grid Unit.
@@ -1096,14 +1096,14 @@
 
     Valid values for \l position are:
     \list
-    \li * SlotsLayout.First: the slot will be positioned at the
+    \li SlotsLayout.First: the slot will be positioned at the
         beginning of the layout
-    \li * SlotsLayout.Leading: the slot will be positioned in
+    \li SlotsLayout.Leading: the slot will be positioned in
         the leading slots
-    \li * SlotsLayout.Trailing: the slot will be positioned in
+    \li SlotsLayout.Trailing: the slot will be positioned in
         the trailing slots, i.e. the one towards the end of the
         layout.
-    \li * SlotsLayout.Last: the slot will be positioned at
+    \li SlotsLayout.Last: the slot will be positioned at
         the end of the layout.
     \endlist