diff --git a/source/import_documentation/Components/Solid-Form.rst b/source/import_documentation/Components/Solid-Form.rst
index f572ca6ab2aeb01cb137fdb4b77694f1d3eab447..6bd207ec539e385c72c9c0ca28ed9475174f77a1 100644
--- a/source/import_documentation/Components/Solid-Form.rst
+++ b/source/import_documentation/Components/Solid-Form.rst
@@ -28,7 +28,7 @@ Attributes
~~~~~~~~~~
List of the fields used to create the form (by default, all of them are used).
-``label-xyz``
+``label-[field]``
~~~~~~~~~~~~~
When displaying a form, the default labels are the fields names of the model.
If you want something fancier, you can set this attribute.
@@ -40,62 +40,62 @@ Attributes
removed. It’s particularly useful to prevent the nested forms to
display their own submit button.
-``upload-url-xyz``
+``upload-url-[field]``
~~~~~~~~~~~~~~~~~~
- URL to upload file for field ``xyz``, it
- automatically set ``widget-xyz`` to ``solid-form-file`` if net defined.
+ URL to upload file for field ``[field]``, it
+ automatically set ``widget-[field]`` to ``solid-form-file`` if net defined.
It’s particularly useful with a dropdown field.
``submit-button``
~~~~~~~~~~~~~~~~~
Text of the submit button of the form.
-``range-xyz``
+``range-[field]``
~~~~~~~~~~~~~
URL of a container which list the accepted values
- for the field ``xyz``. It’s particularly useful with a dropdown
+ for the field ``[field]``. It’s particularly useful with a dropdown
field.
-``enum-xyz``
+``enum-[field]``
~~~~~~~~~~~~~
- List of values of your choice for the field ``xyz``.
+ List of values of your choice for the field ``[field]``.
They have to be filled manually and must be separated by commas.
It’s particularly useful with a dropdown or radio field.
Two formats are possible:
- * ``enum-xyz="value 1, value 2, value 3"`` : each value will be displayed
+ * ``enum-[field]="value 1, value 2, value 3"`` : each value will be displayed
and loaded in value attribute
- * ``enum-xyz="value1 = a, value2 = b, value3 = c"``: each value will be displayed
+ * ``enum-[field]="value1 = a, value2 = b, value3 = c"``: each value will be displayed
and "a", "b", "c" will be loaded in value attribute.
-``order-asc-xyz`` or ``order-desc-xyz``
+``order-asc-[field]`` or ``order-desc-[field]``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Name of the field used to order the range list ``xyz``.
+ Name of the field used to order the range list ``[field]``.
``partial``
~~~~~~~~~~~
Add this attribute when the form does not include
all the fields of the resource to update.
-``min-xyz``
+``min-[field]``
~~~~~~~~~~~
- Add this attribute for the field ``xyz`` to define its minimum value.
+ Add this attribute for the field ``[field]`` to define its minimum value.
It works only with a ``solid-form-number`` widget.
-``max-xyz``
+``max-[field]``
~~~~~~~~~~~
- Add this attribute for the field ``xyz`` to define its maximum value.
+ Add this attribute for the field ``[field]`` to define its maximum value.
It works only with a ``solid-form-number`` widget.
-``pattern-xyz``
+``pattern-[field]``
~~~~~~~~~~~~~~~
- Add this attribute for the field ``xyz`` to define a regular expression to check the input's value.
+ Add this attribute for the field ``[field]`` to define a regular expression to check the input's value.
It works only with a ``solid-form-text`` widget.
-``title-xyz``
+``title-[field]``
~~~~~~~~~~~~~~
- Add this attribute for the field ``xyz`` to precise extra information about an element.
+ 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``
diff --git a/source/import_documentation/Components/Solid-Map.rst b/source/import_documentation/Components/Solid-Map.rst
index 403e0eac7f69751b6929b8a5ab6fabfb400663f8..028a5c97dc8f89fe05b9e7af64af8db75c16cd7d 100644
--- a/source/import_documentation/Components/Solid-Map.rst
+++ b/source/import_documentation/Components/Solid-Map.rst
@@ -57,6 +57,6 @@ Events
~~~~~~~~~~~~~~~~~~~
Triggered when a marker is clicked on the map
-Usefull links :
+Useful links:
---------------
- To find latitude and longitude : https://www.latlong.net/
\ No newline at end of file
+ To find latitude and longitude: https://www.latlong.net/
\ No newline at end of file
diff --git a/source/import_documentation/Mixins/widget-mixin.rst b/source/import_documentation/Mixins/widget-mixin.rst
index 565742b97abaafda5282f50f383d0c724a4da011..67992c1d413e7c2026ce2efde1d0970c5330ff13 100644
--- a/source/import_documentation/Mixins/widget-mixin.rst
+++ b/source/import_documentation/Mixins/widget-mixin.rst
@@ -87,7 +87,7 @@ Attributes
``action-[field]``
~~~~~~~~~~~~~~~~~~
- Displays a link inside a ``<solid-link>`` tag with ``src`` for the ``data-src`` attribute
+ Displays a link with a ``<solid-link>`` tag with the current resource as ``data-src`` and the value of the attribute as ``next``.
``label-[field]``
~~~~~~~~~~~~~~~~~
diff --git a/source/import_documentation/attributes-list.rst b/source/import_documentation/attributes-list.rst
index eb64e4f0b1cd175a08824893608074b17bdacbb3..6702574b3c03e65c69fb061e0be162f5b7d7db46 100644
--- a/source/import_documentation/attributes-list.rst
+++ b/source/import_documentation/attributes-list.rst
@@ -5,7 +5,7 @@ List of attributes (core framework)
~~~~~~~~~~~~~~~~~~
* :ref:`widget-mixin <widget-mixin>`
-``child-xyz``
+``child-[field]``
~~~~~~~~~~~~~
* :ref:`solid-display <solid-display>`
@@ -23,13 +23,6 @@ List of attributes (core framework)
``data-src``
~~~~~~~~~~~~
- * :ref:`solid-display <solid-display>`
- * :ref:`solid-form <solid-form>`
- * :ref:`solid-form-search <solid-form-search>`
- * :ref:`solid-delete <solid-delete>`
- * :ref:`solid-calendar <solid-calendar>`
- * :ref:`solid-map <solid-map>`
- * :ref:`solid-ac-checker <solid-ac-checker>`
* :ref:`store-mixin <store-mixin>`
``data-label``
@@ -61,8 +54,8 @@ List of attributes (core framework)
~~~~~~~~~~~~~~~~
* :ref:`list-mixin <list-mixin>`
-``enum-xyz``
-~~~~~~~~~~~~
+``enum-[field]``
+~~~~~~~~~~~~~~~~
* :ref:`solid-form <solid-form>`
* :ref:`solid-form-search <solid-form-search>`
@@ -72,10 +65,6 @@ List of attributes (core framework)
``fields``
~~~~~~~~~~
- * :ref:`solid-display <solid-display>`
- * :ref:`solid-form <solid-form>`
- * :ref:`solid-form-search <solid-form-search>`
- * :ref:`solid-map <solid-map>`
* :ref:`widget-mixin <widget-mixin>`
``filtered-by``
@@ -100,12 +89,9 @@ List of attributes (core framework)
``label-[field]``
~~~~~~~~~~~~~~~~~
- * :ref:`widget-mixin <widget-mixin>`
-
-``label-xyz``
-~~~~~~~~~~~~~
- * :ref:`solid-form <solid-form>`
+ * :ref:`solid-form <solid-form>`
* :ref:`solid-form-search <solid-form-search>`
+ * :ref:`widget-mixin <widget-mixin>`
``lang``
~~~~~~~~
@@ -115,11 +101,11 @@ List of attributes (core framework)
~~~~~~~~~~~~~
* :ref:`store-mixin <store-mixin>`
-``max-xyz``
+``max-[field]``
~~~~~~~~~~~
* :ref:`solid-form <solid-form>`
-``min-xyz``
+``min-[field]``
~~~~~~~~~~~
* :ref:`solid-form <solid-form>`
@@ -135,7 +121,7 @@ List of attributes (core framework)
~~~~~~~~~
* :ref:`solid-widget <solid-widget>`
-``nested-[field]``
+``nested-field``
~~~~~~~~~~~~~~~~~~
* :ref:`store-mixin <store-mixin>`
@@ -151,11 +137,10 @@ List of attributes (core framework)
~~~~~~~~~~~~~
* :ref:`sorter-mixin <sorter-mixin>`
-``order-asc-xyz``
+``order-asc-[field]``
~~~~~~~~~~~~~~~~~
* :ref:`solid-form <solid-form>`
-
``order-by-random``
~~~~~~~~~~~~~~~~~~~
* :ref:`sorter-mixin <sorter-mixin>`
@@ -164,7 +149,7 @@ List of attributes (core framework)
~~~~~~~~~~~~~~
* :ref:`sorter-mixin <sorter-mixin>`
-``order-desc-xyz``
+``order-desc-[field]``
~~~~~~~~~~~~~~~~~~
* :ref:`solid-form <solid-form>`
@@ -180,7 +165,7 @@ List of attributes (core framework)
~~~~~~~~~~~
* :ref:`solid-form <solid-form>`
-``pattern-xyz``
+``pattern-[field]``
~~~~~~~~~~~~~~~
* :ref:`solid-form <solid-form>`
@@ -192,12 +177,12 @@ List of attributes (core framework)
~~~~~~~~~~~~~~~~~~~~~~~
* :ref:`widget-mixin <widget-mixin>`
-``range-xyz``
+``range-[field]``
~~~~~~~~~~~~~
* :ref:`solid-form <solid-form>`
* :ref:`solid-form-search <solid-form-search>`
-``required-xyz``
+``required-[field]``
~~~~~~~~~~~~~~~~
* :ref:`required-mixin <required-mixin>`
@@ -210,11 +195,11 @@ List of attributes (core framework)
* :ref:`solid-form <solid-form>`
* :ref:`solid-form-search <solid-form-search>`
-``title-xyz``
+``title-[field]``
~~~~~~~~~~~~~
* :ref:`solid-form <solid-form>`
-``upload-url-xyz``
+``upload-url-[field]``
~~~~~~~~~~~~~~~~~~
* :ref:`solid-form <solid-form>`
diff --git a/source/import_documentation/faq.rst b/source/import_documentation/faq.rst
index f67822014c095eed33c678e1028bd8239f00c505..b4adbc4f51c8b68cb4613d6ec8163d053917340c 100644
--- a/source/import_documentation/faq.rst
+++ b/source/import_documentation/faq.rst
@@ -1,34 +1,33 @@
FAQ
****
-* **How to contribute ?**
+* **How to contribute?**
Have a look on our `contribution guidelines <https://git.startinblox.com/framework/sib-core/blob/master/CONTRIBUTING.md>`__.
If you want to add/change something on this documentation, `here are the instructions <https://git.startinblox.com/documentation/doc>`__.
-* **Where I can ask for help ?**
+* **Where I can ask for help?**
-`Come on our chat <https://community.startinblox.com/>`__ , we'll do our best to help you!
+`Come on our chat <https://community.startinblox.com/>`__, we'll do our best to help you!
-* **What is Solid ?**
+* **What is Solid?**
-We're working to make some popularizations for differents audiences. In the meanwhile, `have a look on the official presentation <solid.mit.edu//>`__ .
+We're working to make some popularizations for differents audiences. In the meanwhile, `have a look on the official presentation <solid.mit.edu//>`__.
-* **This is open source ?**
+* **This is open source?**
-The whole project is under `MIT licence <https://git.startinblox.com/framework/sib-core/blob/master/LICENSE/>`__ .
+The whole project is under `MIT licence <https://git.startinblox.com/framework/sib-core/blob/master/LICENSE/>`__.
-* **Why the documentation is not in makdown ?**
+* **Why the documentation is not in makdown?**
This documentation in is `Restructured Text <https://docutils.sourceforge.io/rst.html>`__. `Have a look to this article <https://www.ericholscher.com/blog/2016/mar/15/dont-use-markdown-for-technical-docs/>`__ if you want to understand our choice.
-* **You cannot find the question you have ?**
-`Send your question <https://mailto:alice@startinblox.com>`__ to the the maintainer of the doc.
-
-Or `open an issues on the doc <https://git.startinblox.com/documentation/doc/-/boards/>`__ .
+* **You cannot find the question you have?**
+`Send your question <https://mailto:alice@startinblox.com>`__ to the the maintainer of the doc or
+`open an issue on the doc <https://git.startinblox.com/documentation/doc/-/boards/>`__.
diff --git a/source/import_documentation/get-started.rst b/source/import_documentation/get-started.rst
index 2e3e8f739eee0ab932991dc4d3a0dc1fccf34a8e..a866c98caef491b2096bceaa33c0ad94e490eab1 100644
--- a/source/import_documentation/get-started.rst
+++ b/source/import_documentation/get-started.rst
@@ -36,8 +36,8 @@ It enables you to use Startin’blox technology and all the base components from
You will find it in almost all Startin'blox components. It is the attribute that defines the data source you want to interact with in the component. You can see what the API looks like at (`https://apiprod.happy-dev.fr/collectives/ <https://apiprod.happy-dev.fr/collectives/>`__ ).
-Extend Components
-~~~~~~~~~~~~~~~~~
+External Components
+~~~~~~~~~~~~~~~~~~~
Some useful components aren't in the core to keep it light and modular. It's the case for `Solid-Router <https://docs.startinblox.com/import_documentation/Components/SiB-Router.html>`__ or `Solid Auth <https://docs.startinblox.com/import_documentation/Components/Solid-Auth.html>`__ for example.
To use them, you have to import them independently.
diff --git a/source/import_documentation/introduction-framework-documentation.rst b/source/import_documentation/introduction-framework-documentation.rst
index dbff59314d1623c1776879fe38d790929b6601e7..96d8e867452e04bbaa45fa78dc1d3d8b20527ed7 100644
--- a/source/import_documentation/introduction-framework-documentation.rst
+++ b/source/import_documentation/introduction-framework-documentation.rst
@@ -3,20 +3,28 @@ Introduction of the framework documentation
In the following sections, the framework's components are detailed.
-Base components belong to the core of the framework.
-For each component, the functioning and the minimum content are introduced (and examples are related).
-Then, the accepted mixins, attributes and widgets by the component are listed.
-Finally, events are listed.
+**Base components** belong to the core of the framework.
+For each component, you will find:
+ * a minimal example of usage (and related examples),
+ * a list of mixins used by the component,
+ * a list of attributes,
+ * a list of events.
-As a reminder, components have their own attributes, they can also use attributes of mixins and custom widgets to display data.
+**External components** don’t belong to the core of the framework but are often used in applications.
-The next section is about extend components, they don’t belong to the core of the framework but they remain very used and useful.
+.. note::
-In the mixin section, each one has :
+ Each component have its own features, and is composed of mixins which provides new ones.
+ Therefore, attributes and events of a component are the combination of attributes and events of
+ all its mixins.
+
+In the **mixin** section, each one has:
* a description of its function,
- * a list of components able to use it,
- * a list of its attributes (and events if existing).
+ * a list of components using it,
+ * a list of attributes,
+ * a list of events.
+
+The **widget** section presents the API to create widgets and give examples about how to create and use them.
-Then, the widget section presents the API to create widgets and give examples about how to create and use them.
+The last section concerns **Javascript API** you can use with sib-core.
-The last section concerns Javascript API.
\ No newline at end of file
diff --git a/source/import_documentation/what-is-sib.rst b/source/import_documentation/what-is-sib.rst
index 49ca80a724efab8ef5a959633432999dd2ec283a..9b36b0a0a497902afca9fd1215ac1111bb442c7b 100644
--- a/source/import_documentation/what-is-sib.rst
+++ b/source/import_documentation/what-is-sib.rst
@@ -1,4 +1,4 @@
-What is Startin'blox ?
+What is Startin'blox?
***********************
Synopsis
@@ -26,7 +26,7 @@ Explanation
Global overview
---------------
-Startin'blox is composed of :
+Startin'blox is composed of:
A front framework
..................
@@ -70,7 +70,7 @@ Overview of the Framework
The section should be improve
-Here is a brief presentation :
+Here is a brief presentation:
.. figure:: ../_static/images/import_documentation/Framework-Overview.png
:alt: Framework Overview
diff --git a/source/import_documentation/why-use-sib.rst b/source/import_documentation/why-use-sib.rst
index 45a3a058b9d126553893b80cb26e792026cb1b70..8f54e98e33be904bd5753f93177ea1264b81829a 100644
--- a/source/import_documentation/why-use-sib.rst
+++ b/source/import_documentation/why-use-sib.rst
@@ -41,7 +41,7 @@ a component using data sources already available on the web.
Startin’Blox is designed to interconnect applications and their users. Our components can plug into an unlimited number of data sources, so your application connects you to the ecosystem of your choice.
-Our work is based on an international project : `The Solid
+Our work is based on an international project: `The Solid
Project <https://solid.mit.edu/>`__.
Natively modular
diff --git a/source/index.rst b/source/index.rst
index 712050089cf24c6859d21879df9e4d703d228e91..408e6cb3f018d783a0c52cb9e627c40c86f92aad 100644
--- a/source/index.rst
+++ b/source/index.rst
@@ -13,7 +13,7 @@ Welcome to Startinblox's documentation
.. toctree::
:maxdepth: 2
- :caption: How it work:
+ :caption: How it works:
import_documentation/How-to-make-components
import_documentation/install-sib-server
@@ -44,7 +44,7 @@ Welcome to Startinblox's documentation
.. toctree::
:maxdepth: 2
- :caption: Extend components:
+ :caption: External components:
import_documentation/Components/Solid-Auth
import_documentation/Components/Solid-Router
@@ -69,14 +69,14 @@ Welcome to Startinblox's documentation
.. toctree::
:maxdepth: 2
- :caption: Widget:
+ :caption: Widgets:
import_documentation/Widgets/Reference
import_documentation/Widgets/Examples
.. toctree::
- :maxdepth: 2
- :caption: Javascript Api:
+ :maxdepth: 2
+ :caption: Javascript API:
import_documentation/Events
import_documentation/Helpers-functions