From d1a417863073ac920142ef33f46b6bd41a0287b1 Mon Sep 17 00:00:00 2001 From: Alice <alice.poggioli@hotmail.fr> Date: Tue, 14 Apr 2020 15:05:17 +0200 Subject: [PATCH] test --- .../Components/SiB-Ac-Checker.rst | 2 +- .../Components/SiB-Delete.rst | 2 +- .../Components/SiB-Display.rst | 2 +- .../import_documentation/Components/SiB-Form.rst | 2 +- .../import_documentation/Components/SiB-Map.rst | 2 +- .../Components/SiB-Widget.rst | 2 +- .../Components/Sib-Calendar.rst | 2 +- .../Components/community-components.rst | 14 ++++++++++++++ .../Components/framework-components.rst | 15 +++++++++++++++ source/import_documentation/Components/index.rst | 3 ++- .../Components/official-components.rst | 14 ++++++++++++++ .../build-full-application.rst | 5 +++-- source/index.rst | 1 + 13 files changed, 56 insertions(+), 10 deletions(-) create mode 100644 source/import_documentation/Components/community-components.rst create mode 100644 source/import_documentation/Components/framework-components.rst create mode 100644 source/import_documentation/Components/official-components.rst diff --git a/source/import_documentation/Components/SiB-Ac-Checker.rst b/source/import_documentation/Components/SiB-Ac-Checker.rst index d6c0feb..321909c 100644 --- a/source/import_documentation/Components/SiB-Ac-Checker.rst +++ b/source/import_documentation/Components/SiB-Ac-Checker.rst @@ -1,5 +1,5 @@ sib-ac-checker -~~~~~~~~~~~~~~ +============== Hides an element from the page if the current user doesn’t have the required permissions on it. diff --git a/source/import_documentation/Components/SiB-Delete.rst b/source/import_documentation/Components/SiB-Delete.rst index 27656f8..3c47f3f 100644 --- a/source/import_documentation/Components/SiB-Delete.rst +++ b/source/import_documentation/Components/SiB-Delete.rst @@ -1,5 +1,5 @@ sib-delete -~~~~~~~~~~ +=========== Receives the URL of a resource or of a container of resources via its ``data-src`` attribute, and displays a button to delete it when clicked. diff --git a/source/import_documentation/Components/SiB-Display.rst b/source/import_documentation/Components/SiB-Display.rst index 0347ef9..dbf5d35 100644 --- a/source/import_documentation/Components/SiB-Display.rst +++ b/source/import_documentation/Components/SiB-Display.rst @@ -1,5 +1,5 @@ sib-display -~~~~~~~~~~~ +=========== Receives the URL of a resource or of a container of resources via its ``data-src`` attribute, and displays it. Each field of the displayed diff --git a/source/import_documentation/Components/SiB-Form.rst b/source/import_documentation/Components/SiB-Form.rst index fe7edd6..b1eb377 100644 --- a/source/import_documentation/Components/SiB-Form.rst +++ b/source/import_documentation/Components/SiB-Form.rst @@ -1,5 +1,5 @@ sib-form -~~~~~~~~ +========= Receives the URL of a ressource via its ``data-src`` attribute, and displays a form to edit the resource. If given the URL of a container of diff --git a/source/import_documentation/Components/SiB-Map.rst b/source/import_documentation/Components/SiB-Map.rst index f67f344..c66ae4f 100644 --- a/source/import_documentation/Components/SiB-Map.rst +++ b/source/import_documentation/Components/SiB-Map.rst @@ -1,5 +1,5 @@ sib-map -~~~~~~~ +======== Receives the URL of a resource or of a container of resources via its ``data-src`` attribute, and displays it on a **map**. Here is the list diff --git a/source/import_documentation/Components/SiB-Widget.rst b/source/import_documentation/Components/SiB-Widget.rst index 4da8364..76252c9 100644 --- a/source/import_documentation/Components/SiB-Widget.rst +++ b/source/import_documentation/Components/SiB-Widget.rst @@ -1,5 +1,5 @@ sib-widget -~~~~~~~~~~ +=========== Take a ``name`` as an attribute and a HTML template, and create an HTML custom element you can use as a widget. i.e. diff --git a/source/import_documentation/Components/Sib-Calendar.rst b/source/import_documentation/Components/Sib-Calendar.rst index 6f35a6b..2e356ae 100644 --- a/source/import_documentation/Components/Sib-Calendar.rst +++ b/source/import_documentation/Components/Sib-Calendar.rst @@ -1,5 +1,5 @@ sib-calendar -~~~~~~~~~~~~ +============ Receives the URL of a resource or of a container of resources via its ``data-src`` attribute, and displays it in a **calendar**. Here is the diff --git a/source/import_documentation/Components/community-components.rst b/source/import_documentation/Components/community-components.rst new file mode 100644 index 0000000..c59e270 --- /dev/null +++ b/source/import_documentation/Components/community-components.rst @@ -0,0 +1,14 @@ +The community components +************************* + +.. toctree:: + :maxdepth: 2 + :caption: Components: + + SiB-Ac-Checker + Sib-Calendar + SiB-Delete + SiB-Display + SiB-Form + SiB-Map + SiB-Widget diff --git a/source/import_documentation/Components/framework-components.rst b/source/import_documentation/Components/framework-components.rst new file mode 100644 index 0000000..2df5ccd --- /dev/null +++ b/source/import_documentation/Components/framework-components.rst @@ -0,0 +1,15 @@ +The framework components +************************* + +.. toctree:: + :maxdepth: 2 + :caption: Components: + + SiB-Ac-Checker + Sib-Calendar + SiB-Delete + SiB-Display + SiB-Form + SiB-Map + SiB-Widget + diff --git a/source/import_documentation/Components/index.rst b/source/import_documentation/Components/index.rst index a3d4aff..81514e3 100644 --- a/source/import_documentation/Components/index.rst +++ b/source/import_documentation/Components/index.rst @@ -1,5 +1,6 @@ +************ Components -========== +************ .. toctree:: :maxdepth: 2 diff --git a/source/import_documentation/Components/official-components.rst b/source/import_documentation/Components/official-components.rst new file mode 100644 index 0000000..2c236b3 --- /dev/null +++ b/source/import_documentation/Components/official-components.rst @@ -0,0 +1,14 @@ +The official components +************************* + +.. toctree:: + :maxdepth: 2 + :caption: Components: + + SiB-Ac-Checker + Sib-Calendar + SiB-Delete + SiB-Display + SiB-Form + SiB-Map + SiB-Widget diff --git a/source/import_documentation/build-full-application.rst b/source/import_documentation/build-full-application.rst index 5013771..3ef2cf3 100644 --- a/source/import_documentation/build-full-application.rst +++ b/source/import_documentation/build-full-application.rst @@ -9,8 +9,9 @@ With the core of the framework and some offical components, we'll be able to bui To start, simply import the core in your HTML file: .. code:: html - <!-- ... Import the core ... --> - <script type="module" src="https://unpkg.com/@startinblox/core"></script> + <!-- ... Import the core ... --> + <script type="module" src="https://unpkg.com/@startinblox/core"></script> + </head> 2. Use core components diff --git a/source/index.rst b/source/index.rst index 49fe3f8..1b2b815 100644 --- a/source/index.rst +++ b/source/index.rst @@ -9,6 +9,7 @@ Welcome to Startinblox's documentation! import_documentation/Use-a-component-alone-in-an-existing-application import_documentation/build-full-application import_documentation/the-basics + import_documentation/Components/index import_documentation/Documentation-Component-Model import_documentation/Events import_documentation/Helpers-functions -- GitLab