diff --git a/source/import_documentation/Components/Solid-Ac-Checker.rst b/source/import_documentation/Components/Solid-Ac-Checker.rst index 68dc8b60c90005600478dc09deee589e0de3aa66..ee709cefebe4ffc1c85fbf7b32611118b1514e7b 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 be0b583501c8d86d14985c5b437c55a2499d3aee..e557c754c5896d30548e9793a6929019c8a1baba 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 95ea5eec4c776dbe22ecfc7a5ad192a3e268e7d3..bd8766e5d6615c13e69b2a06e8ec714820e41681 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 92c68b8f61a198b379dca59eb6c8b9d143cc613e..7f7fc828a1d58551b48b35512194a0291ad92fb3 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 043e6d295c504323569b5c19445db1a6cf5f9b4d..13819463d2ded72b8a26eb84a2c901207deaaa4f 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 93eeea9da39d993a59c3583687cb6810e89894b3..db9941f58fabf764c2697fb87e960ff5d6162ef2 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 1fe1e9bba588a3cf20157c671e40c1235f99383f..ba1cc1824e25c56f9f9fca591725c46a5364ab6e 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 498a2bb60125f39f9e8dc791b38ae9c3f32d2bb5..7faefd7fe340a5557647b79f421d111d7f969e43 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 24aa0c888885f8685bda17b7eb20a51bde4ae9ac..06f595698cf908c49a8abba9afc2636351ec6c57 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 de7bd2ee33812a1091b8d16979efb6cdac0e5a75..a718106f49446d7b414e30526cfbe82fad47e4bf 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 15d20cb239285a0cb318c2571a7497c8d35bbb5a..c6a3c57169c3a1726b57d207a0e80d2d1fcd5bbe 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 661c289dc615435e8ecaea797e7ce21745c1b658..f29bd1cdb0362f7902dc0d858a0047d5f085e376 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 24d5ba22d1bac5670737e419d07f47f75b66a4f0..7aa67a63738858a05604b586225e9e26ddea1110 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