Skip to content

Commit c42061e

Browse files
linawolffroemken
andauthored
[TASK] Mention Internal Notes in help section (#215)
* [TASK] Changes after code review releases: main, 13.4 * [TASK] Changes after code review releases: main, 13.4 * Apply suggestions from code review * Update Documentation/HelpInside/InternalNotes/Index.rst Co-authored-by: Stefan Frömken <froemken@gmail.com> --------- Co-authored-by: Stefan Frömken <froemken@gmail.com>
1 parent 86aaf9f commit c42061e

File tree

4 files changed

+41
-3
lines changed

4 files changed

+41
-3
lines changed

Documentation/HelpInside/Index.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,8 @@ help guide you when using the TYPO3.
1414
outdated and not maintained. Refer to the
1515
:ref:`typo3-online-documentation` instead.
1616

17-
Topics
18-
======
19-
2017
.. toctree::
18+
:caption: Topics
2119
:titlesonly:
2220
:glob:
2321

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
:navigation-title: Internal Notes
2+
3+
.. include:: /Includes.rst.txt
4+
.. _internal-notes:
5+
6+
===================================
7+
Internal notes in the TYPO3 backend
8+
===================================
9+
10+
.. note::
11+
These are only available if :composer:`typo3/cms-sys-note` is installed
12+
and your administrator granted you the necessary user rights.
13+
14+
Internal notes, also called system notes, are small text notes that are
15+
displayed in the `Page module <https://docs.typo3.org/permalink/t3editors:content-creating>`_
16+
and `List module <https://docs.typo3.org/permalink/t3editors:using-the-list-module-effectively>`_.
17+
18+
You can use them to write notes to yourself or other editors. Administrators
19+
can use them to write notes to you as well.
20+
21+
They look like this:
22+
23+
.. figure:: /Images/ManualScreenshots/Page/PageWithSysNote.png
24+
:alt: Screenshot of a TODO note on the top of the "Page" backend module
25+
26+
If you have sufficient permissions you can also edit or delete the note.
27+
28+
The following image shows a detailed view of the TYPO3 backend toolbar, specifically in
29+
the context of the "Page" or "List" module. On the right side of the toolbar are a number
30+
of buttons, each providing different functionality. The button highlighted in this screenshot
31+
is which allows the user to create a new internal note.
32+
33+
.. figure:: /Images/ManualScreenshots/Page/sys_note_create.png
34+
:alt: Screenshot demonstrating the location of the "Create internal note" button in the module header of the Page module
35+
36+
The button to create a system note is located on the top right of the "Page" and "List" modules
37+
38+
.. seealso::
39+
For a detailed description on how to use the internal notes see
40+
`System notes manual, for Editors <https://docs.typo3.org/permalink/typo3/cms-sys-note:for-editors>`_.
17.4 KB
Loading
9.83 KB
Loading

0 commit comments

Comments
 (0)