From 2db4caf251be32fb598f3dbec2f09c83764a762f Mon Sep 17 00:00:00 2001
From: Manon Bourgognon <manon.bourgognon@epitech.eu>
Date: Tue, 27 Jul 2021 15:07:47 +0200
Subject: [PATCH] tests on include directive, toctree, cross-ref
---
source/conf.py | 1 +
.../Components/Solid-Ac-Checker2.rst | 13 +-
.../framework_guide/attributes-list2.rst | 332 ++++++++++++++++++
.../framework_guide/list-base-components.rst | 20 +-
.../list-external-components.rst | 8 +-
.../list-external-components2.rst | 31 ++
6 files changed, 387 insertions(+), 18 deletions(-)
create mode 100644 source/import_documentation/framework_guide/attributes-list2.rst
create mode 100644 source/import_documentation/framework_guide/list-external-components2.rst
diff --git a/source/conf.py b/source/conf.py
index 1786aa3..5ef4d94 100644
--- a/source/conf.py
+++ b/source/conf.py
@@ -32,6 +32,7 @@ templates_path = []
exclude_patterns = []
+autosectionlabel_prefix_document = True
# -- Options for HTML output -------------------------------------------------
diff --git a/source/import_documentation/Components/Solid-Ac-Checker2.rst b/source/import_documentation/Components/Solid-Ac-Checker2.rst
index b7a23cd..be0b583 100644
--- a/source/import_documentation/Components/Solid-Ac-Checker2.rst
+++ b/source/import_documentation/Components/Solid-Ac-Checker2.rst
@@ -46,9 +46,14 @@ Mixin attributes
-----------------
.. include:: /import_documentation/Mixins/store-mixin.rst
- start-line : 21
- end-line : 122
+ :start-line: 21
+ :end-line: 122
.. include:: ../Mixins/store-mixin.rst
- start-line : 21
- end-line : 122
+ :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/framework_guide/attributes-list2.rst b/source/import_documentation/framework_guide/attributes-list2.rst
new file mode 100644
index 0000000..15d20cb
--- /dev/null
+++ b/source/import_documentation/framework_guide/attributes-list2.rst
@@ -0,0 +1,332 @@
+List of attributes (core framework)
+===================================
+
+Below are listed all the attributes of the core framework.
+They allow to add, to specify functionalities for base components.
+Attributes are specific to base components or they depend on mixins (they can be used by several components).
+
+``action-[field]``
+~~~~~~~~~~~~~~~~~~
+ * :ref:`widget-mixin<action-field>`
+ * :ref:`widget-mixin:action-field`
+ * :ref:`action-field`
+
+``alt-[field]``
+~~~~~~~~~~~~~~~
+ * :ref:`widget-mixin<alt-field>`
+ * :ref:`widget-mixin:alt-field`
+ * :ref:`alt-field`
+
+``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`
+
+``auto-range-[field]``
+~~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`solid-form-search <auto-range-field>`
+
+``autosave``
+~~~~~~~~~~~~
+ * :ref:`solid-form <autosave>`
+
+``child-[field]``
+~~~~~~~~~~~~~~~~~
+ * :ref:`solid-display <solid-display>`
+
+``class-[field]``
+~~~~~~~~~~~~~~~~~
+ * :ref:`widget-mixin <class-field>`
+
+``class-submit-button``
+~~~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`solid-form <class-submit-button-sf>`
+ * :ref:`solid-form-search <class-submit-button-sfs>`
+
+``clustering``
+~~~~~~~~~~~~~~
+ * :ref:`solid-map <solid-map>`
+
+``confirmation-cancel-text``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`validation-mixin <confirmation-cancel-text>`
+
+``confirmation-cancel-class``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`validation-mixin <confirmation-cancel-class>`
+
+``confirmation-message``
+~~~~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`validation-mixin <confirmation-message>`
+
+``confirmation-type``
+~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`validation-mixin <confirmation-type>`
+
+``confirmation-submit-class``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`validation-mixin <confirmation-submit-class>`
+
+``confirmation-submit-text``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`validation-mixin <confirmation-submit-text>`
+
+``confirmation-widget``
+~~~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`validation-mixin <confirmation-widget>`
+
+``counter-template``
+~~~~~~~~~~~~~~~~~~~~
+ * :ref:`counter-mixin <counter-mixin>`
+
+``data-src``
+~~~~~~~~~~~~
+ * :ref:`store-mixin <data-src>`
+
+``data-label``
+~~~~~~~~~~~~~~
+ * :ref:`solid-delete <solid-delete>`
+ * :ref:`solid-lang <solid-lang>`
+
+``default-[field]``
+~~~~~~~~~~~~~~~~~~~
+ * :ref:`widget-mixin <default-field>`
+
+``default-widget``
+~~~~~~~~~~~~~~~~~~
+ * :ref:`widget-mixin <default-widget>`
+
+``default-widget-[field]``
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`widget-mixin <default-widget-field>`
+
+``editable-[field]``
+~~~~~~~~~~~~~~~~~~~~
+ * :ref:`widget-mixin <editable-field-wm>`
+ * :ref:`solid-table <solid-table>`
+
+``empty-[set]``
+~~~~~~~~~~~~~~~
+ * :ref:`widget-mixin <empty-set>`
+
+``empty-[set]-value``
+~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`widget-mixin <empty-set-value>`
+
+``empty-value``
+~~~~~~~~~~~~~~~
+ * :ref:`list-mixin <list-mixin>`
+
+``empty-widget``
+~~~~~~~~~~~~~~~~
+ * :ref:`list-mixin <list-mixin>`
+
+``end-value-[field]``
+~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`solid-form-search <end-value-field>`
+
+``enum-[field]``
+~~~~~~~~~~~~~~~~
+ * :ref:`solid-form <enum-field-sf>`
+ * :ref:`solid-form-search <enum-field-sfs>`
+
+``extra-context``
+~~~~~~~~~~~~~~~~~
+ * :ref:`store-mixin <extra-context>`
+
+``fields``
+~~~~~~~~~~
+ * :ref:`widget-mixin <fields>`
+
+``filtered-by``
+~~~~~~~~~~~~~~~
+ * :ref:`filter-mixin <filter-mixin>`
+
+``group-by``
+~~~~~~~~~~~~
+ * :ref:`grouper-mixin <grouper-mixin>`
+
+``group-widget``
+~~~~~~~~~~~~~~~~
+ * :ref:`grouper-mixin <grouper-mixin>`
+
+``group-class``
+~~~~~~~~~~~~~~~
+ * :ref:`grouper-mixin <grouper-mixin>`
+
+``header``
+~~~~~~~~~~
+ * :ref:`solid-table <solid-table>`
+
+``hightlight-[field]``
+~~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`highlighter-mixin <highlighter-mixin>`
+
+``label-[field]``
+~~~~~~~~~~~~~~~~~
+ * :ref:`solid-form <label-field-sf>`
+ * :ref:`solid-form-search <label-field-sfs>`
+ * :ref:`widget-mixin <label-field-wm>`
+
+``lang``
+~~~~~~~~
+ * :ref:`solid-lang <solid-lang>`
+
+``loader-id``
+~~~~~~~~~~~~~
+ * :ref:`store-mixin <loader-id>`
+
+``max-[field]``
+~~~~~~~~~~~~~~~
+ * :ref:`solid-form <max-field>`
+
+``maxlength-[field]``
+~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`solid-form <maxlength-field>`
+
+``min-[field]``
+~~~~~~~~~~~~~~~
+ * :ref:`solid-form <min-field>`
+
+``minlength-[field]``
+~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`solid-form <minlength-field>`
+
+``multiple-[field]``
+~~~~~~~~~~~~~~~~~~~~
+ * :ref:`widget-mixin <multiple-field>`
+
+``naked``
+~~~~~~~~~
+ * :ref:`solid-form <naked>`
+
+``name``
+~~~~~~~~~
+ * :ref:`solid-widget <solid-widget>`
+
+``nested-field``
+~~~~~~~~~~~~~~~~
+ * :ref:`store-mixin <nested-field>`
+
+``next``
+~~~~~~~~
+ * :ref:`next-mixin <next-mixin>`
+
+``no-permission``
+~~~~~~~~~~~~~~~~~
+ * :ref:`solid-ac-checker <solid-ac-checker>`
+
+``no-render``
+~~~~~~~~~~~~~
+ * :ref:`store-mixin <no-render>`
+
+``order-asc``
+~~~~~~~~~~~~~
+ * :ref:`sorter-mixin <sorter-mixin>`
+
+``order-asc-[field]``
+~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`solid-form <order-asc-field>`
+
+``order-by-random``
+~~~~~~~~~~~~~~~~~~~
+ * :ref:`sorter-mixin <sorter-mixin>`
+
+``order-desc``
+~~~~~~~~~~~~~~
+ * :ref:`sorter-mixin <sorter-mixin>`
+
+``order-desc-[field]``
+~~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`solid-form <order-desc-field>`
+
+``paginate-by``
+~~~~~~~~~~~~~~~
+ * :ref:`paginate-mixin <paginate-mixin>`
+
+``paginate-loop``
+~~~~~~~~~~~~~~~~~
+ * :ref:`paginate-mixin <paginate-mixin>`
+
+``partial``
+~~~~~~~~~~~
+ * :ref:`solid-form <partial>`
+
+``pattern-[field]``
+~~~~~~~~~~~~~~~~~~~
+ * :ref:`solid-form <pattern-field>`
+
+``permission``
+~~~~~~~~~~~~~~
+ * :ref:`solid-ac-checker <solid-ac-checker>`
+
+``placeholder-[field]``
+~~~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`widget-mixin <placeholder-field>`
+
+``range-[field]``
+~~~~~~~~~~~~~~~~~
+ * :ref:`solid-form <range-field-sf>`
+ * :ref:`solid-form-search <range-field-sfs>`
+
+``required-[field]``
+~~~~~~~~~~~~~~~~~~~~
+ * :ref:`required-mixin <required-mixin>`
+ * :ref:`solid-form <solid-form>`
+
+``selectable``
+~~~~~~~~~~~~~~
+ * :ref:`solid-table <solid-table>`
+
+``sorted-by``
+~~~~~~~~~~~~~~~
+ * :ref:`sorter-mixin <sorter-mixin>`
+
+``start-value-[field]``
+~~~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`solid-form-search <start-value-field>`
+
+``step-[field]``
+~~~~~~~~~~~~~~~~
+ * :ref:`solid-form <step-field>`
+
+``(search-fields)`` deprecated
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`filter-mixin <filter-mixin>`
+
+``search-placeholder-[field]``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`solid-form-search <search-placeholder-field>`
+
+``search-text-[field]``
+~~~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`solid-form-search <search-text-field>`
+
+``src-[field]``
+~~~~~~~~~~~~~~~
+ * :ref:`widget-mixin <src-field>`
+
+``submit-button``
+~~~~~~~~~~~~~~~~~
+ * :ref:`solid-form <submit-button-sf>`
+ * :ref:`solid-form-search <submit-button-sfs>`
+
+``title-[field]``
+~~~~~~~~~~~~~~~~~
+ * :ref:`solid-form <title-field>`
+
+``upload-url-[field]``
+~~~~~~~~~~~~~~~~~~~~~~
+ * :ref:`solid-form <upload-url-field>`
+
+``value-[field]``
+~~~~~~~~~~~~~~~~~
+ * :ref:`widget-mixin <value-field>`
+
+``widget-[field]``
+~~~~~~~~~~~~~~~~~~
+ * :ref:`widget-mixin <widget-field>`
diff --git a/source/import_documentation/framework_guide/list-base-components.rst b/source/import_documentation/framework_guide/list-base-components.rst
index 4cc1c64..661c289 100644
--- a/source/import_documentation/framework_guide/list-base-components.rst
+++ b/source/import_documentation/framework_guide/list-base-components.rst
@@ -4,16 +4,16 @@ Base components
These components offer basic functionalities used in
an simple web application like display data, create data, search data, etc.
-- Solid-Ac-Checker : to manage permissions
-- Solid-Calendar : to display and manage data on a calendar
-- 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-Lang : to manage language
-- Solid-Map : to display and manage data on a map
-- Solid-Table : to manage data on a table
-- Solid-Widget : to create custom elements (pattern) to display data
+- ``Solid-Ac-Checker`` : to manage permissions
+- ``Solid-Calendar`` : to display and manage data on a calendar
+- ``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-Lang`` : to manage language
+- ``Solid-Map`` : to display and manage data on a map
+- ``Solid-Table`` : to manage data on a table
+- ``Solid-Widget`` : to create custom elements (pattern) to display data
To find out how to use them :
diff --git a/source/import_documentation/framework_guide/list-external-components.rst b/source/import_documentation/framework_guide/list-external-components.rst
index d1565ec..5ef2bb7 100644
--- a/source/import_documentation/framework_guide/list-external-components.rst
+++ b/source/import_documentation/framework_guide/list-external-components.rst
@@ -4,13 +4,13 @@ External components
The external components are not required for an application to be functional,
however they can be used to add useful features :
-- Solid-Auth : to manage user authentication
-- Solid-Router : to create menu and navigate between pages
+- ``Solid-Auth`` : to manage user authentication
+- ``Solid-Router`` : to create menu and navigate between pages
For more information on their use :
.. toctree::
:maxdepth: 1
- /import_documentation/Components/Solid-Auth : to manage authentification of users
- /import_documentation/Components/Solid-Router : to create menu and navigate between pages
+ /import_documentation/Components/Solid-Auth
+ /import_documentation/Components/Solid-Router
diff --git a/source/import_documentation/framework_guide/list-external-components2.rst b/source/import_documentation/framework_guide/list-external-components2.rst
new file mode 100644
index 0000000..24d5ba2
--- /dev/null
+++ b/source/import_documentation/framework_guide/list-external-components2.rst
@@ -0,0 +1,31 @@
+External components
+*******************
+
+The external components are not required for an application to be functional,
+however they can be used to add useful features :
+
+- ``Solid-Auth`` : to manage user authentication
+- ``Solid-Router`` : to create menu and navigate between pages
+
+For more information on their use :
+
+test 1
+.. toctree::
+ :maxdepth: 1
+
+ /import_documentation/Components/Solid-Auth
+ /import_documentation/Components/Solid-Router
+
+test 2
+.. toctree::
+ :maxdepth: 1
+
+ Solid-Auth to manage user authentication </import_documentation/Components/Solid-Auth>
+ Solid-Router : to create menu and navigate between pages </import_documentation/Components/Solid-Router>
+
+test 3
+.. toctree::
+ :maxdepth: 1
+
+ **Solid-Auth** : to manage user authentication <sib-auth>
+ ``Solid-Router`` : to create menu and navigate between pages <solid-router>
--
GitLab