From 6ebac1bffcf72ee074e02d69cab70fc4a2b74339 Mon Sep 17 00:00:00 2001
From: Manon Bourgognon <manon.bourgognon@epitech.eu>
Date: Wed, 28 Jul 2021 19:02:52 +0200
Subject: [PATCH] use include on all components, additional tests
---
.../Components/Solid-Ac-Checker.rst | 16 +++-
.../Components/Solid-Ac-Checker2.rst | 12 +--
.../Components/Solid-Auth.rst | 4 +-
.../Components/Solid-Calendar.rst | 24 ++++++
.../Components/Solid-Delete.rst | 23 ++++--
.../Components/Solid-Display.rst | 77 ++++++++++++++++++-
.../Components/Solid-Form-Search.rst | 16 +++-
.../Components/Solid-Form.rst | 38 +++++++--
.../Components/Solid-Map.rst | 51 +++++++++++-
.../Components/Solid-Table.rst | 71 ++++++++++++++++-
.../framework_guide/attributes-list2.rst | 15 ++--
.../framework_guide/list-base-components.rst | 2 +-
.../list-external-components2.rst | 3 +
13 files changed, 306 insertions(+), 46 deletions(-)
diff --git a/source/import_documentation/Components/Solid-Ac-Checker.rst b/source/import_documentation/Components/Solid-Ac-Checker.rst
index 68dc8b6..ee709ce 100644
--- a/source/import_documentation/Components/Solid-Ac-Checker.rst
+++ b/source/import_documentation/Components/Solid-Ac-Checker.rst
@@ -23,8 +23,9 @@ This component uses the following mixins:
Please check their documentation to know more about their capabilities.
-Attributes
-----------
+
+Specific attributes
+-------------------
``permission``
~~~~~~~~~~~~~~
@@ -35,10 +36,19 @@ Attributes
Displays the element if the user has not the specified right
-
Possible values:
- `acl:Read <https://github.com/solid/web-access-control-spec#aclread>`__
- `acl:Write <https://github.com/solid/web-access-control-spec#aclwrite>`__
- `acl:Append <https://github.com/solid/web-access-control-spec#aclappend>`__
- `acl:Control <https://github.com/solid/web-access-control-spec#aclcontrol>`__
+
+
+Mixin attributes
+-----------------
+
+**From store-mixin :**
+
+.. include:: ../Mixins/store-mixin.rst
+ :start-line: 21
+ :end-line: 122
\ No newline at end of file
diff --git a/source/import_documentation/Components/Solid-Ac-Checker2.rst b/source/import_documentation/Components/Solid-Ac-Checker2.rst
index be0b583..e557c75 100644
--- a/source/import_documentation/Components/Solid-Ac-Checker2.rst
+++ b/source/import_documentation/Components/Solid-Ac-Checker2.rst
@@ -17,10 +17,8 @@ Mixins
------
This component uses the following mixins:
-
* :ref:`store-mixin <store-mixin>`
-
Please check their documentation to know more about their capabilities.
Personnal attributes
@@ -45,15 +43,9 @@ Possible values:
Mixin attributes
-----------------
-.. include:: /import_documentation/Mixins/store-mixin.rst
- :start-line: 21
- :end-line: 122
+From store-mixin
+~~~~~~~~~~~~~~~~
.. include:: ../Mixins/store-mixin.rst
:start-line: 21
:end-line: 122
-
-.. include:: /import_documentation/Mixins/store-mixin.rst
-
-
-.. include:: ../Mixins/store-mixin.rst
\ No newline at end of file
diff --git a/source/import_documentation/Components/Solid-Auth.rst b/source/import_documentation/Components/Solid-Auth.rst
index 95ea5ee..bd8766e 100644
--- a/source/import_documentation/Components/Solid-Auth.rst
+++ b/source/import_documentation/Components/Solid-Auth.rst
@@ -6,7 +6,7 @@ Allows your users to login via a given OIDC provider.
Installation
--------------
- Initialize ``sib-auth`` in your HTML file:
+Initialize ``sib-auth`` in your HTML file :
.. code:: html
@@ -90,7 +90,7 @@ Example:
</sib-auth>
Methods
-------------------
+-------
``login``
~~~~~~~~~
diff --git a/source/import_documentation/Components/Solid-Calendar.rst b/source/import_documentation/Components/Solid-Calendar.rst
index 92c68b8..7f7fc82 100644
--- a/source/import_documentation/Components/Solid-Calendar.rst
+++ b/source/import_documentation/Components/Solid-Calendar.rst
@@ -23,6 +23,30 @@ This component uses the following mixins:
Please check their documentation to know more about their capabilities.
+
+Mixin attributes
+-----------------
+
+**From list-mixin :**
+
+.. include:: ../Mixins/list-mixin.rst
+ :start-line: 25
+ :end-line: 50
+
+**From next-mixin :**
+
+.. include:: ../Mixins/next-mixin.rst
+ :start-line: 21
+ :end-line: 30
+
+
+**From store-mixin :**
+
+.. include:: ../Mixins/store-mixin.rst
+ :start-line: 21
+ :end-line: 122
+
+
Events
-------
diff --git a/source/import_documentation/Components/Solid-Delete.rst b/source/import_documentation/Components/Solid-Delete.rst
index 043e6d2..1381946 100644
--- a/source/import_documentation/Components/Solid-Delete.rst
+++ b/source/import_documentation/Components/Solid-Delete.rst
@@ -21,8 +21,8 @@ This component uses the following mixin:
Please check their documentation to know more about its capabilities.
-Attributes
-----------
+Specific attributes
+-------------------
``data-src``
~~~~~~~~~~~~
@@ -32,9 +32,22 @@ Attributes
~~~~~~~~~~~~~~
The text to display on the delete button.
-``confirmation-message``
-~~~~~~~~~~~~~~~~~~~~~~~~~
- **Migrated to the :ref:`validation-mixin <validation-mixin>` page in version 0.16**
+
+Mixin attributes
+-----------------
+
+**From next-mixin :**
+
+.. include:: ../Mixins/next-mixin.rst
+ :start-line: 21
+ :end-line: 30
+
+**From validation-mixin :**
+
+.. include:: ../Mixins/validation-mixin.rst
+ :start-line: 17
+ :end-line: 100
+
Events
-------
diff --git a/source/import_documentation/Components/Solid-Display.rst b/source/import_documentation/Components/Solid-Display.rst
index 93eeea9..db9941f 100644
--- a/source/import_documentation/Components/Solid-Display.rst
+++ b/source/import_documentation/Components/Solid-Display.rst
@@ -29,7 +29,6 @@ Mixins
------
This component uses the following mixins:
- * :ref:`required-mixin <required-mixin>`
* :ref:`counter-mixin <counter-mixin>`
* :ref:`federation-mixin <federation-mixin>`
* :ref:`filter-mixin <filter-mixin>`
@@ -38,6 +37,7 @@ This component uses the following mixins:
* :ref:`list-mixin <list-mixin>`
* :ref:`next-mixin <next-mixin>`
* :ref:`paginate-mixin <paginate-mixin>`
+ * :ref:`required-mixin <required-mixin>`
* :ref:`sorter-mixin <sorter-mixin>`
* :ref:`store-mixin <store-mixin>`
* :ref:`widget-mixin <widget-mixin>`
@@ -45,8 +45,8 @@ This component uses the following mixins:
Please check their documentation to know more about their capabilities.
-Attributes
-----------
+Specific attributes
+-------------------
``fields``
~~~~~~~~~~
@@ -59,8 +59,79 @@ Attributes
Add attribute ``[field]`` to all children.
+Mixin attributes
+-----------------
+
+**From counter-mixin :**
+
+.. include:: ../Mixins/counter-mixin.rst
+ :start-line: 17
+ :end-line: 30
+
+**From filter-mixin :**
+
+.. include:: ../Mixins/filter-mixin.rst
+ :start-line: 18
+ :end-line: 66
+
+**From grouper-mixin :**
+
+.. include:: ../Mixins/grouper-mixin.rst
+ :start-line: 18
+ :end-line: 60
+
+**From highlighter-mixin :**
+
+.. include:: ../Mixins/highlighter-mixin.rst
+ :start-line: 17
+ :end-line: 30
+
+**From list-mixin :**
+
+.. include:: ../Mixins/list-mixin.rst
+ :start-line: 25
+ :end-line: 50
+
+**From next-mixin :**
+
+.. include:: ../Mixins/next-mixin.rst
+ :start-line: 21
+ :end-line: 30
+
+**From paginate-mixin :**
+
+.. include:: ../Mixins/paginate-mixin.rst
+ :start-line: 17
+ :end-line: 47
+
+**From required-mixin :**
+
+.. include:: ../Mixins/required-mixin.rst
+ :start-line: 17
+ :end-line: 33
+
+**From sorter-mixin :**
+
+.. include:: ../Mixins/sorter-mixin.rst
+ :start-line: 17
+ :end-line: 76
+
+**From store-mixin :**
+
+.. include:: ../Mixins/store-mixin.rst
+ :start-line: 21
+ :end-line: 122
+
+**From widget-mixin :**
+
+.. include:: ../Mixins/widget-mixin.rst
+ :start-line: 18
+ :end-line: 223
+
+
Widgets
-------
+
By default, the widget used is ``<solid-display-div>``. Cf the
:ref:`Widget <reference>` page for more info.
diff --git a/source/import_documentation/Components/Solid-Form-Search.rst b/source/import_documentation/Components/Solid-Form-Search.rst
index 1fe1e9b..ba1cc18 100644
--- a/source/import_documentation/Components/Solid-Form-Search.rst
+++ b/source/import_documentation/Components/Solid-Form-Search.rst
@@ -29,8 +29,9 @@ This component uses the following mixins:
Please check their documentation to know more about their capabilities.
-Attributes
-----------
+
+Specific attributes
+-------------------
``fields``
~~~~~~~~~~
@@ -140,7 +141,6 @@ Attributes
filtered-by="filter-multiselectautocomp"
></solid-display>
-
.. _auto-range-field:
``auto-range-[field]``
~~~~~~~~~~~~~~~~~~~~~~~
@@ -167,6 +167,16 @@ Attributes
></solid-display>
+Mixin attributes
+-----------------
+
+**From widget-mixin :**
+
+.. include:: ../Mixins/widget-mixin.rst
+ :start-line: 18
+ :end-line: 223
+
+
Widgets
-------
By default, the widget used is ``<solid-form-label-text>``. Cf the
diff --git a/source/import_documentation/Components/Solid-Form.rst b/source/import_documentation/Components/Solid-Form.rst
index 498a2bb..7faefd7 100644
--- a/source/import_documentation/Components/Solid-Form.rst
+++ b/source/import_documentation/Components/Solid-Form.rst
@@ -22,8 +22,9 @@ This component uses the following mixins:
Please check their documentation to know more about their capabilities.
-Attributes
-----------
+
+Specific attributes
+-------------------
``fields``
~~~~~~~~~~
@@ -131,10 +132,6 @@ Define the ``class`` of the ``div`` containing the submit button.
Add this attribute for the field ``[field]`` to precise extra information about an element.
It works only with a ``solid-form-text`` widget.
-``confirmation-message``
-~~~~~~~~~~~~~~~~~~~~~~~~
- **Migrated to the :ref:`validation-mixin <validation-mixin>` page in version 0.16**
-
.. _autocomplete-field-sf:
``autocomplete-[field]``
~~~~~~~~~~~~~~~~~~~~~~~~
@@ -177,6 +174,35 @@ Define the ``class`` of the ``div`` containing the submit button.
- ``solid-form-time`` widget : Its value is given in seconds (default value is 60).
- ``solid-form-number`` widget : Its default value is 1.
+
+Mixin attributes
+-----------------
+
+**From next-mixin :**
+
+.. include:: ../Mixins/next-mixin.rst
+ :start-line: 21
+ :end-line: 30
+
+**From store-mixin :**
+
+.. include:: ../Mixins/store-mixin.rst
+ :start-line: 21
+ :end-line: 122
+
+**From validation-mixin :**
+
+.. include:: ../Mixins/validation-mixin.rst
+ :start-line: 17
+ :end-line: 100
+
+**From widget-mixin :**
+
+.. include:: ../Mixins/widget-mixin.rst
+ :start-line: 18
+ :end-line: 223
+
+
Widgets
-------
By default, the widget used is ``<solid-form-label-text>``. Cf the
diff --git a/source/import_documentation/Components/Solid-Map.rst b/source/import_documentation/Components/Solid-Map.rst
index 24aa0c8..06f5956 100644
--- a/source/import_documentation/Components/Solid-Map.rst
+++ b/source/import_documentation/Components/Solid-Map.rst
@@ -30,8 +30,8 @@ This component uses the following mixins:
Please check their documentation to know more about their capabilities.
-Attributes
-----------
+Specific attributes
+-------------------
Like for ``solid-display``, fields can be displayed and filters or searching capabilities can be
added to interact with the list of data being displayed.
@@ -46,6 +46,53 @@ added to interact with the list of data being displayed.
If this attribute is defined, markers spacially close are grouped in clusters.
+
+Mixin attributes
+-----------------
+
+**From counter-mixin :**
+
+.. include:: ../Mixins/counter-mixin.rst
+ :start-line: 17
+ :end-line: 30
+
+**From filter-mixin :**
+
+.. include:: ../Mixins/filter-mixin.rst
+ :start-line: 18
+ :end-line: 66
+
+**From grouper-mixin :**
+
+.. include:: ../Mixins/grouper-mixin.rst
+ :start-line: 18
+ :end-line: 60
+
+**From list-mixin :**
+
+.. include:: ../Mixins/list-mixin.rst
+ :start-line: 25
+ :end-line: 50
+
+**From next-mixin :**
+
+.. include:: ../Mixins/next-mixin.rst
+ :start-line: 21
+ :end-line: 30
+
+**From store-mixin :**
+
+.. include:: ../Mixins/store-mixin.rst
+ :start-line: 21
+ :end-line: 122
+
+**From widget-mixin :**
+
+.. include:: ../Mixins/widget-mixin.rst
+ :start-line: 18
+ :end-line: 223
+
+
Events
-------
diff --git a/source/import_documentation/Components/Solid-Table.rst b/source/import_documentation/Components/Solid-Table.rst
index de7bd2e..a718106 100644
--- a/source/import_documentation/Components/Solid-Table.rst
+++ b/source/import_documentation/Components/Solid-Table.rst
@@ -24,7 +24,6 @@ Mixins
------
This component uses the following mixins:
- * :ref:`required-mixin <required-mixin>`
* :ref:`counter-mixin <counter-mixin>`
* :ref:`federation-mixin <federation-mixin>`
* :ref:`filter-mixin <filter-mixin>`
@@ -32,6 +31,7 @@ This component uses the following mixins:
* :ref:`highlighter-mixin <highlighter-mixin>`
* :ref:`list-mixin <list-mixin>`
* :ref:`paginate-mixin <paginate-mixin>`
+ * :ref:`required-mixin <required-mixin>`
* :ref:`sorter-mixin <sorter-mixin>`
* :ref:`store-mixin <store-mixin>`
* :ref:`widget-mixin <widget-mixin>`
@@ -39,8 +39,8 @@ This component uses the following mixins:
Please check their documentation to know more about their capabilities.
-Attributes
-----------
+Specific attributes
+-------------------
``fields``
~~~~~~~~~~
@@ -84,6 +84,71 @@ Attributes
placeholder-first_name="Your First Name"
></solid-table>
+
+Mixin attributes
+-----------------
+
+**From counter-mixin :**
+
+.. include:: ../Mixins/counter-mixin.rst
+ :start-line: 17
+ :end-line: 30
+
+**From filter-mixin :**
+
+.. include:: ../Mixins/filter-mixin.rst
+ :start-line: 18
+ :end-line: 66
+
+**From grouper-mixin :**
+
+.. include:: ../Mixins/grouper-mixin.rst
+ :start-line: 18
+ :end-line: 60
+
+**From highlighter-mixin :**
+
+.. include:: ../Mixins/highlighter-mixin.rst
+ :start-line: 17
+ :end-line: 30
+
+**From list-mixin :**
+
+.. include:: ../Mixins/list-mixin.rst
+ :start-line: 25
+ :end-line: 50
+
+**From paginate-mixin :**
+
+.. include:: ../Mixins/paginate-mixin.rst
+ :start-line: 17
+ :end-line: 47
+
+**From required-mixin :**
+
+.. include:: ../Mixins/required-mixin.rst
+ :start-line: 17
+ :end-line: 33
+
+**From sorter-mixin :**
+
+.. include:: ../Mixins/sorter-mixin.rst
+ :start-line: 17
+ :end-line: 76
+
+**From store-mixin :**
+
+.. include:: ../Mixins/store-mixin.rst
+ :start-line: 21
+ :end-line: 122
+
+**From widget-mixin :**
+
+.. include:: ../Mixins/widget-mixin.rst
+ :start-line: 18
+ :end-line: 223
+
+
Widgets
-------
By default, the widget used is ``<solid-display-value>``. Cf the
diff --git a/source/import_documentation/framework_guide/attributes-list2.rst b/source/import_documentation/framework_guide/attributes-list2.rst
index 15d20cb..c6a3c57 100644
--- a/source/import_documentation/framework_guide/attributes-list2.rst
+++ b/source/import_documentation/framework_guide/attributes-list2.rst
@@ -7,9 +7,10 @@ Attributes are specific to base components or they depend on mixins (they can be
``action-[field]``
~~~~~~~~~~~~~~~~~~
- * :ref:`widget-mixin<action-field>`
- * :ref:`widget-mixin:action-field`
+ * :ref:`widget-mixin <action-[field]>`
+ * :ref:`widget-mixin:action-[field]`
* :ref:`action-field`
+ * :ref:`action-[field]`
``alt-[field]``
~~~~~~~~~~~~~~~
@@ -19,12 +20,10 @@ Attributes are specific to base components or they depend on mixins (they can be
``autocomplete-[field]``
~~~~~~~~~~~~~~~~~~~~~~~~
- * :ref:`solid-form<autocomplete-field-sf>`
- * :ref:`solid-form:autocomplete-field-sf`
- * :ref:`autocomplete-field-sf`
- * :ref:`solid-form-search<autocomplete-field-sfs>`
- * :ref:`solid-form-search:autocomplete-field-sfs`
- * :ref:`autocomplete-field-sfs`
+ * :ref:`solid-form <autocomplete-field-sf>`
+ * :ref:`solid-form-search <autocomplete-field-sfs>`
+ * :ref:`Solid-Form-Search:autocomplete-[field]`
+ * :ref:`solid-form <Solid-Form-Search:autocomplete-[field]>`
``auto-range-[field]``
~~~~~~~~~~~~~~~~~~~~~~
diff --git a/source/import_documentation/framework_guide/list-base-components.rst b/source/import_documentation/framework_guide/list-base-components.rst
index 661c289..f29bd1c 100644
--- a/source/import_documentation/framework_guide/list-base-components.rst
+++ b/source/import_documentation/framework_guide/list-base-components.rst
@@ -9,7 +9,7 @@ an simple web application like display data, create data, search data, etc.
- ``Solid-Delete`` : to delete data
- ``Solid-Display`` : to display data
- ``Solid-Form`` : to create forms and modify data
-- ``Solid-Form-Search ``: to search data
+- ``Solid-Form-Search`` : to search data
- ``Solid-Lang`` : to manage language
- ``Solid-Map`` : to display and manage data on a map
- ``Solid-Table`` : to manage data on a table
diff --git a/source/import_documentation/framework_guide/list-external-components2.rst b/source/import_documentation/framework_guide/list-external-components2.rst
index 24d5ba2..7aa67a6 100644
--- a/source/import_documentation/framework_guide/list-external-components2.rst
+++ b/source/import_documentation/framework_guide/list-external-components2.rst
@@ -10,6 +10,7 @@ however they can be used to add useful features :
For more information on their use :
test 1
+
.. toctree::
:maxdepth: 1
@@ -17,6 +18,7 @@ test 1
/import_documentation/Components/Solid-Router
test 2
+
.. toctree::
:maxdepth: 1
@@ -24,6 +26,7 @@ test 2
Solid-Router : to create menu and navigate between pages </import_documentation/Components/Solid-Router>
test 3
+
.. toctree::
:maxdepth: 1
--
GitLab