diff --git a/typo3/sysext/sys_note/Documentation/Editor/Index.rst b/typo3/sysext/sys_note/Documentation/Editor/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..d038096057c531cc6b111d1ec303cbd149616894 --- /dev/null +++ b/typo3/sysext/sys_note/Documentation/Editor/Index.rst @@ -0,0 +1,100 @@ +.. include:: /Includes.rst.txt + +.. _for-editors: + +=========== +For Editors +=========== + +Target group: **Editors** + +The internal notes are a useful feature for adding context and notes to +pages. It provides a way for users to document important information +related to specific pages. + +Usage +===== + +.. contents:: Table of Contents + :depth: 2 + :local: + +Adding a note +------------- +To add a note to a page: + +#. Log in to the TYPO3 backend as a user with appropriate permissions. + +#. Navigate to the page where you want to add a note. + +#. Click on :guilabel:`Create internal note for this page` . + + .. figure:: /Images/sys_note_create.png + :alt: Creating a new sys_note note + :class: with-shadow + + Button to create a new internal note + +#. Create a new internal note, select the appropriate category and add + the desired text content. + +#. Save the note. + + +Categories +---------- + +You can choose between: + +Instructions + Used to provide instructions to the backend user. + +Notes + Used for simple notes. + +To-Do + Used to allow a backend user to see and complete pending to-dos. + +Template + Used to output a template. + +.. note:: + Each category is represented by a distinct icon. + +.. figure:: /Images/sys_note_backend_formular.png + :alt: Creating a new internal note + :class: with-shadow + + Create a new internal note + +Describing the note +------------------- + +Enter the title of your note in the :guilabel:`Subject` field and the +description in the :guilabel:`Message` field. + +Activate the :guilabel:`Personal` toggle in the :guilabel:`Access` tab, if the +note should be displayed only for you. + +.. figure:: /Images/sys_note_personal.png + :alt: Personal field + :class: with-shadow + + Using the :guilabel:`Personal` feature + +How does the internal note look in the backend? +=============================================== + +When a backend user opens the corresponding page, they will see a box displaying +the internal note, if at least one is available. The various colors represent +the different categories. + +.. figure:: /Images/sys_note_adding_note.png + :alt: Different internal note categories + :class: with-shadow + + Different internal note categories + +.. note:: + After creating the note, you can see who created the note and the + creation date of the note. diff --git a/typo3/sysext/sys_note/Documentation/Images/em.png b/typo3/sysext/sys_note/Documentation/Images/em.png new file mode 100644 index 0000000000000000000000000000000000000000..59f5089df3d3d1bcf48cf3fb0fa9ecee2007a245 Binary files /dev/null and b/typo3/sysext/sys_note/Documentation/Images/em.png differ diff --git a/typo3/sysext/sys_note/Documentation/Images/sys_note_access.png b/typo3/sysext/sys_note/Documentation/Images/sys_note_access.png new file mode 100644 index 0000000000000000000000000000000000000000..c9893e52b2c673325577e812cef0a9260aae2659 Binary files /dev/null and b/typo3/sysext/sys_note/Documentation/Images/sys_note_access.png differ diff --git a/typo3/sysext/sys_note/Documentation/Images/sys_note_adding_note.png b/typo3/sysext/sys_note/Documentation/Images/sys_note_adding_note.png new file mode 100644 index 0000000000000000000000000000000000000000..0721e520022f4cc6a391884288740f72bc46e7ce Binary files /dev/null and b/typo3/sysext/sys_note/Documentation/Images/sys_note_adding_note.png differ diff --git a/typo3/sysext/sys_note/Documentation/Images/sys_note_backend_formular.png b/typo3/sysext/sys_note/Documentation/Images/sys_note_backend_formular.png new file mode 100644 index 0000000000000000000000000000000000000000..129e320797381517b45e0137849755fac4ef0d7c Binary files /dev/null and b/typo3/sysext/sys_note/Documentation/Images/sys_note_backend_formular.png differ diff --git a/typo3/sysext/sys_note/Documentation/Images/sys_note_create.png b/typo3/sysext/sys_note/Documentation/Images/sys_note_create.png new file mode 100644 index 0000000000000000000000000000000000000000..7b7bb22fce3137e3c22ffcb41370628eb4ed6a7e Binary files /dev/null and b/typo3/sysext/sys_note/Documentation/Images/sys_note_create.png differ diff --git a/typo3/sysext/sys_note/Documentation/Images/sys_note_personal.png b/typo3/sysext/sys_note/Documentation/Images/sys_note_personal.png new file mode 100644 index 0000000000000000000000000000000000000000..7837be00d7d3a0df30ba0dc42bf5851ed153ff2b Binary files /dev/null and b/typo3/sysext/sys_note/Documentation/Images/sys_note_personal.png differ diff --git a/typo3/sysext/sys_note/Documentation/Includes.rst.txt b/typo3/sysext/sys_note/Documentation/Includes.rst.txt new file mode 100644 index 0000000000000000000000000000000000000000..af7f7005ee325b1b6517f153d183a7ddc8f086b7 --- /dev/null +++ b/typo3/sysext/sys_note/Documentation/Includes.rst.txt @@ -0,0 +1,34 @@ +.. More information about this file: + https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt + +.. ---------- +.. text roles +.. ---------- + +.. role:: aspect(emphasis) +.. role:: bash(code) +.. role:: html(code) +.. role:: js(code) +.. role:: php(code) +.. role:: rst(code) +.. role:: sep(strong) +.. role:: sql(code) + +.. role:: tsconfig(code) + :class: typoscript + +.. role:: typoscript(code) +.. role:: xml(code) + :class: html + +.. role:: yaml(code) + +.. default-role:: code + +.. --------- +.. highlight +.. --------- + +.. By default, code blocks use PHP syntax highlighting + +.. highlight:: php diff --git a/typo3/sysext/sys_note/Documentation/Index.rst b/typo3/sysext/sys_note/Documentation/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..384e136971f943859d2877ffd5f8f77a87e2b788 --- /dev/null +++ b/typo3/sysext/sys_note/Documentation/Index.rst @@ -0,0 +1,52 @@ +.. include:: /Includes.rst.txt + +====================== +TYPO3 CMS System Notes +====================== + +:Extension key: + sys_note + +:Package name: + typo3/cms-sys-note + +:Version: + |release| + +:Language: + en + +:Author: + TYPO3 contributors + +:License: + This document is published under the + `Open Content License <https://www.openhub.net/licenses/opl>`__. + +:Rendered: + |today| + +---- + +Records with messages which can be placed on any page +and contain instructions or other information related to a page or section. + +---- + +**Table of Contents:** + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + Introduction/Index + Editor/Index + Installation/Index + Integrator/Index + +.. Meta Menu + +.. toctree:: + :hidden: + + Sitemap diff --git a/typo3/sysext/sys_note/Documentation/Installation/Index.rst b/typo3/sysext/sys_note/Documentation/Installation/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..fda40b66699397919eb6cf9e69a6e426f53926ca --- /dev/null +++ b/typo3/sysext/sys_note/Documentation/Installation/Index.rst @@ -0,0 +1,48 @@ +.. include:: /Includes.rst.txt + +.. _installation: + +============ +Installation +============ + +Target group: **Administrators** + +This extension is part of the TYPO3 Core. + +Installation with Composer +========================== + +Check whether you are already using the extension: + +.. code-block:: bash + + composer show | grep sys-note + +This should either give you no result or something similar to: + +.. code-block:: text + + typo3/cms-sys-note v12.4.9 TYPO3 CMS System Notes + +If it is not installed, use the :bash:`composer require` command to install the +extension: + +.. code-block:: bash + + composer require typo3/cms-sys-note + +The version installed depends on which version of the TYPO3 Core you are using. + +Installation without Composer +============================= + +In an installation without Composer, the code of EXT:sys_note is already shipped. +You just have to activate the extension. Head over to the +:guilabel:`Admin Tools > Extensions` module and activate the extension. + +.. figure:: ../Images/em.png + :alt: Extension Manager with sys_note extension + :class: with-shadow + + Extension manager with :sql:`sys_note` extension diff --git a/typo3/sysext/sys_note/Documentation/Integrator/Index.rst b/typo3/sysext/sys_note/Documentation/Integrator/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..02f5f9de29e2782c36fc18dcaa3e1c3cfe068e1a --- /dev/null +++ b/typo3/sysext/sys_note/Documentation/Integrator/Index.rst @@ -0,0 +1,55 @@ +.. include:: /Includes.rst.txt + +.. _for-integrators: + +=============== +For integrators +=============== + +Properly configuring access permissions to the :sql:`sys_note` table is +essential to enable editors to effectively utilize this system extension. +Internal notes allow editors to document important information related to +specific pages, enhancing the overall usability and functionality of TYPO3 +for your organization. + +Administration / configuration +============================== + +To ensure smooth operation of the "Internal notes" extension, it is important +to configure the necessary access permissions for editors. Editors must have +read and/or write access to the :sql:`sys_note` table in TYPO3. Without the +appropriate access permissions, editors may encounter issues when trying to +create, view, or modify notes. + +Access configuration +-------------------- + +Access to the :sql:`sys_note` table can be configured through TYPO3's backend +user access settings. Here is how you can configure the necessary permissions: + +#. Log in to the TYPO3 backend as an administrator. + +#. In the backend, navigate to the :guilabel:`System > Backend Users` module. + +#. Create a new + :ref:`Backend user group <t3coreapi:access-users-groups-groups>`, + if you do not have one already. + +#. Activate the :guilabel:`Internal note` checkbox for both + :guilabel:`Tables (listing)` and :guilabel:`Tables (modify)`. + + .. figure:: /Images/sys_note_access.png + :alt: Access to the sys_note table + :class: with-shadow + + Giving access to the :sql:`sys_note` table + +#. Save the changes. + +By configuring access rights in this way, editors will have the necessary +permissions to create, edit, and view notes using the "Internal notes" extension. +This ensures that they can effectively use this feature to add context and +notes to pages within your TYPO3 installation. + +Remember to regularly review and update access permissions as needed to +maintain security and compliance with your organization's requirements. diff --git a/typo3/sysext/sys_note/Documentation/Introduction/Index.rst b/typo3/sysext/sys_note/Documentation/Introduction/Index.rst new file mode 100644 index 0000000000000000000000000000000000000000..8525b976a84824150ca01e0a30b24d5f460e590e --- /dev/null +++ b/typo3/sysext/sys_note/Documentation/Introduction/Index.rst @@ -0,0 +1,19 @@ +.. include:: /Includes.rst.txt + +.. _introduction: + +============ +Introduction +============ + +What does it do? +================ + +The goal of the sys_note extension is to keep the backend more organized. You +can add notes for yourself or for other backend users. + +The :sql:`sys_note` table in TYPO3 is a database table used for storing notes +or annotations related to records within your TYPO3 installation. +These notes can be added by administrators or users to provide additional +context or information about a specific record. + diff --git a/typo3/sysext/sys_note/Documentation/Settings.cfg b/typo3/sysext/sys_note/Documentation/Settings.cfg new file mode 100644 index 0000000000000000000000000000000000000000..0fca9747cd7b83219e2cc9e3609d093714b27300 --- /dev/null +++ b/typo3/sysext/sys_note/Documentation/Settings.cfg @@ -0,0 +1,66 @@ +# More information about this file: +# https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#settings-cfg + +[general] + +project = TYPO3 CMS System Notes +version = 12.4 +release = 12.4 +copyright = since 2023 by the TYPO3 contributors + +[html_theme_options] + +# "Edit on GitHub" button +github_repository = typo3/typo3 +github_branch = 12.4 +path_to_documentation_dir = typo3/sysext/sys_note/Documentation/ + +# Footer links +project_home = https://extensions.typo3.org/extension/sys_note/ +project_contact = https://typo3.slack.com/archives/C025BQLFA +project_repository = https://github.com/typo3/typo3 +project_issues = https://forge.typo3.org/projects/typo3cms-core/issues +project_discussions = + +use_opensearch = + +[intersphinx_mapping] + +# Official TYPO3 manuals +# h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/ +# t3content = https://docs.typo3.org/m/typo3/guide-contentandmarketing/main/en-us/ +# t3contribute = https://docs.typo3.org/m/typo3/guide-contributionworkflow/main/en-us/ +t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/12.4/en-us/ +# t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/12.4/en-us/ +# t3extexample = https://docs.typo3.org/m/typo3/guide-example-extension-manual/main/en-us/ +# t3home = https://docs.typo3.org/ +# t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/12.4/en-us/ +# t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/12.4/en-us/ +# t3tca = https://docs.typo3.org/m/typo3/reference-tca/12.4/en-us/ +# t3translate = https://docs.typo3.org/m/typo3/guide-frontendlocalization/12.4/en-us/ +# t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/12.4/en-us/ +# t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/12.4/en-us/ +# t3ts45 = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/12.4/en-us/ +# t3viewhelper = https://docs.typo3.org/other/typo3/view-helper-reference/12.4/en-us/ +# t3upgrade = https://docs.typo3.org/m/typo3/guide-installation/12.4/en-us/ + +# TYPO3 system extensions +# ext_adminpanel = https://docs.typo3.org/c/typo3/cms-adminpanel/12.4/en-us/ +# ext_core = https://docs.typo3.org/c/typo3/cms-core/main/en-us/ +# ext_dashboard = https://docs.typo3.org/c/typo3/cms-dashboard/12.4/en-us/ +# ext_felogin = https://docs.typo3.org/c/typo3/cms-felogin/12.4/en-us/ +# ext_form = https://docs.typo3.org/c/typo3/cms-form/12.4/en-us/ +# ext_fsc = https://docs.typo3.org/c/typo3/cms-fluid-styled-content/12.4/en-us/ +# ext_impexp = https://docs.typo3.org/c/typo3/cms-impexp/12.4/en-us/ +# ext_indexed_search = https://docs.typo3.org/c/typo3/cms-indexed-search/12.4/en-us/ +# ext_linkvalidator = https://docs.typo3.org/c/typo3/cms-linkvalidator/12.4/en-us/ +# ext_lowlevel = https://docs.typo3.org/c/typo3/cms-lowlevel/12.4/en-us/ +# ext_reactions = https://docs.typo3.org/c/typo3/cms-reactions/12.4/en-us/ +# ext_recycler = https://docs.typo3.org/c/typo3/cms-recycler/12.4/en-us/ +# ext_redirects = https://docs.typo3.org/c/typo3/cms-redirects/12.4/en-us/ +# ext_reports = https://docs.typo3.org/c/typo3/cms-reports/12.4/en-us/ +# ext_rte_ckeditor = https://docs.typo3.org/c/typo3/cms-rte-ckeditor/12.4/en-us/ +# ext_scheduler = https://docs.typo3.org/c/typo3/cms-scheduler/12.4/en-us/ +# ext_seo = https://docs.typo3.org/c/typo3/cms-seo/12.4/en-us/ +# ext_sys_note = https://docs.typo3.org/c/typo3/cms-sys-note/12.4/en-us/ +# ext_workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/12.4/en-us/ diff --git a/typo3/sysext/sys_note/Documentation/Sitemap.rst b/typo3/sysext/sys_note/Documentation/Sitemap.rst new file mode 100644 index 0000000000000000000000000000000000000000..09d3c6f56e97422d5e402797988ad9ab0b994777 --- /dev/null +++ b/typo3/sysext/sys_note/Documentation/Sitemap.rst @@ -0,0 +1,9 @@ +:template: sitemap.html + +.. include:: /Includes.rst.txt + +======= +Sitemap +======= + +.. The sitemap.html template will insert here the page tree automatically.