Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TASK] Align with new TYPO3 documentation standards #52

Merged
merged 6 commits into from
Apr 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
root = true

[{*.rst,*.rst.txt}]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 3
max_line_length = 80

# MD-Files
[*.md]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 4
max_line_length = 80
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/Documentation-GENERATED-temp/
7 changes: 0 additions & 7 deletions Documentation/.gitignore

This file was deleted.

7 changes: 1 addition & 6 deletions Documentation/Configuration/AnchorAccessibility/Index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../../Includes.txt
.. include:: /Includes.rst.txt



Expand Down
7 changes: 1 addition & 6 deletions Documentation/Configuration/Clickenlarge/Index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../../Includes.txt
.. include:: /Includes.rst.txt



Expand Down
7 changes: 1 addition & 6 deletions Documentation/Configuration/CustomTags/Index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../../Includes.txt
.. include:: /Includes.rst.txt



Expand Down
7 changes: 1 addition & 6 deletions Documentation/Configuration/DefaultWebsiteLanguage/Index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../../Includes.txt
.. include:: /Includes.rst.txt



Expand Down
7 changes: 1 addition & 6 deletions Documentation/Configuration/ExtensionConfiguration/Index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../../Includes.txt
.. include:: /Includes.rst.txt



Expand Down
7 changes: 1 addition & 6 deletions Documentation/Configuration/FrontEndPlugins/Index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../../Includes.txt
.. include:: /Includes.rst.txt



Expand Down
7 changes: 1 addition & 6 deletions Documentation/Configuration/Index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../Includes.txt
.. include:: /Includes.rst.txt



Expand Down
7 changes: 1 addition & 6 deletions Documentation/Configuration/InstallingMultipleRtes/Index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../../Includes.txt
.. include:: /Includes.rst.txt



Expand Down
7 changes: 1 addition & 6 deletions Documentation/Configuration/PageTsconfig/Index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../../Includes.txt
.. include:: /Includes.rst.txt



Expand Down
39 changes: 17 additions & 22 deletions Documentation/Configuration/PageTsconfig/classes/Index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../../../Includes.txt
.. include:: /Includes.rst.txt



Expand All @@ -24,29 +19,29 @@ classes.[ *classname* ]

Property
classes.[ *classname* ]

Description
Defines the classes available in the RTE. *classname* is the actual
name of the style-class you are configuring. Notice you must
specifically assign the classes to the various facilities also. See
later.

Properties:

::

.name = label of the class (may be a reference to an entry in a localization file of the form LLL:EXT:[fileref]:[labelkey])
.value = the style for the class
.noShow = boolean; if set, the style of the class is not used to render it in the pop-up selector.
.selectable = boolean; if set to 0, the class is not selectable in the style selectors;
.selectable = boolean; if set to 0, the class is not selectable in the style selectors;
if the property is omitted, or set to 1, the class is selectable in the style selectors.
.requires = list of class names; list of classes that are required by the class;
if this property, in combination with others, produces a circular relationship, it is ignored;
when a class is added on an element, the classes it requires are also added, possibly recursively;
when a class is removed from an element, any non-selectable class that is not required by any of the classes remaining on the element is also removed.

# specification of alternating classes for rows and/or columns of a table
.alternating {
.alternating {
rows {
startAt = int+ (default = 1)
oddClass = class-name
Expand All @@ -62,7 +57,7 @@ classes.[ *classname* ]
evenHeaderClass = class-name
}
}

# specification of counting classes for rows and/or columns of a table
.counting {
rows {
Expand All @@ -82,16 +77,16 @@ classes.[ *classname* ]
}

Example:

::

# Hidding an allowed class in the class selector dropped downlist
RTE.classes.class-name.value = display: none;

Example:

::

# Configuration of an alternating and counting class
RTE.classes.countingtable {
name = Counting class
Expand Down Expand Up @@ -128,11 +123,11 @@ classes.[ *classname* ]
}
}
}

Example:

::

# Hidding an allowed counting class in the class selector dropped downlist
# Note the ending hyphen « - »
# The class name string should be as specified in the counting property
Expand Down
27 changes: 11 additions & 16 deletions Documentation/Configuration/PageTsconfig/classesAnchor/Index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../../../Includes.txt
.. include:: /Includes.rst.txt


.. _classesanchor:
Expand All @@ -24,45 +19,45 @@ classesAnchor.[ *id-string* ]

Property
classesAnchor.[ *id-string* ]

Description
Attaches special properties to the classes available in the
Insert/Modify link dialog.

Properties:

.class = CSS-class-name: the name of the CSS class to which the
properties are attached

.type = page, url, file, mail or spec: specifies that the class
applies to anchors for internal pages, external URL's, files, email
addresses or special user-defined links respectively; the class will
be presented only in the corresponding tab of the 'Insert/Modify link'
dialogue

.image = URL of an icon file that will prefix or postfix the content
of the anchor when the class is applied to an anchor; the TYPO3 syntax
EXT:extension-key/sub-directory/image-file-name may be used

.addIconAfterLink = boolean: if set, the content of the link is
postfixed with the icon; default is to prefix the content of the link
with the icon

.altText = the text that will be used as altText for the image when
the class is applied to an anchor; may be language-splitted; the TYPO3
syntax LLL:EXT:extension-key/sub-directory/locallang.xlf:label-index
may also be used in order for the text to be localized to the language
of the content using the specified language file and label index

.titleText = the text that will be used as title for the anchor when
the class is applied to an anchor; may be language-splitted;the TYPO3
syntax LLL:EXT:extension-key/sub-directory/locallang.xlf:label-index
may also be used in order for the text to be localized to the language
of the content using the specified language file and label index

.target = string; if set, this is the default value to be assigned to
the target attribute of the link when the class is applied to the link

See the Demo default configuration for a complete example.


Expand Down
21 changes: 8 additions & 13 deletions Documentation/Configuration/PageTsconfig/fontSizes/Index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../../../Includes.txt
.. include:: /Includes.rst.txt


.. _fontsizes:
Expand All @@ -23,21 +18,21 @@ fontSizes.[ *id-string* ]

Property
fontSizes.[ *id-string* ]

Description
Defines the font sizes available in the RTE.

Properties:

::

.name = Label of the font size in menu (may be a reference to an entry in a localization file of the form LLL:EXT:[fileref]:[labelkey])
.value = The font size value

Example:

::

# General configuration of the available font sizes:
RTE.fontSizes {
size1 {
Expand Down
23 changes: 9 additions & 14 deletions Documentation/Configuration/PageTsconfig/fonts/Index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../../../Includes.txt
.. include:: /Includes.rst.txt


.. _fonts:
Expand All @@ -23,21 +18,21 @@ fonts.[ *id-string* ]

Property
fonts.[ *id-string* ]

Description
Defines the fonts available in the RTE.

Properties:

::

.name = Label of the font in menu (may be a reference to an entry in a localization file of the form LLL:EXT:[fileref]:[labelkey])
.value = The font face value (comma-separated list of font-family names; if a font-family name contains spaces, it should be quoted with single quotes)

Example:

::

# General configuration of the available fonts:
RTE.fonts {
face1 {
Expand All @@ -50,7 +45,7 @@ fonts.[ *id-string* ]
}
noFace {
name = No font
value =
value =
}
}
# Specific setting for the fontstyle selector:
Expand Down
Loading