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.

Sign up for GitHub

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] Replace "t3-function-encapslines" with "confval" #1062

Merged
merged 1 commit into from
Feb 3, 2024
Merged

[TASK] Replace "t3-function-encapslines" with "confval" #1062

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
65 changes: 45 additions & 20 deletions Documentation/Functions/Encapslines.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. include:: /Includes.rst.txt
.. index::
Functions; encapsLines
encapsLines
.. _encapslines:
.. include:: /Includes.rst.txt
.. index::
Functions; encapsLines
encapsLines
.. _encapslines:

===========
encapsLines
Expand Down Expand Up @@ -36,12 +36,14 @@ like this:
Properties
==========

.. _encapslines-encapsTagList:

encapsTagList
-------------

.. t3-function-encapslines:: encapsTagList
.. confval:: encapsTagList

:Data type: list of strings
:Data type: list of :ref:`data-type-string`

List of tags which qualify as encapsulating tags. Must be lowercase.

Expand All @@ -65,10 +67,12 @@ encapsTagList
<B>Some text</B>


.. _encapslines-remapTag:

remapTag.[*tagname*]
--------------------

.. t3-function-encapslines:: remapTag
.. confval:: remapTag

:Data type: array of :ref:`data-type-string`

Expand All @@ -91,12 +95,15 @@ remapTag.[*tagname*]

([*tagname*] is in uppercase.)


.. _encapslines-addAttributes:

addAttributes.[*tagname*]
-------------------------

.. t3-function-encapslines:: addAttributes
.. confval:: addAttributes

:Data type: *(array of strings)*
:Data type: array of :ref:`data-type-string`
:Default: Always override/set the value of the attributes.

Attributes to set in the encapsulation tag.
Expand Down Expand Up @@ -125,10 +132,13 @@ addAttributes.[*tagname*]
align = center
}


.. _encapslines-removeWrapping:

removeWrapping
--------------

.. t3-function-encapslines:: removeWrapping
.. confval:: removeWrapping

:Data type: :ref:`data-type-boolean`

Expand All @@ -154,10 +164,13 @@ removeWrapping
Some text
<b>Some text</b>


.. _encapslines-wrapNonWrappedLines:

wrapNonWrappedLines
-------------------

.. t3-function-encapslines:: wrapNonWrappedLines
.. confval:: wrapNonWrappedLines

:Data type: :t3-function-stdwrap:`wrap`

Expand All @@ -184,42 +197,54 @@ wrapNonWrappedLines
<P>First line of text</P>
<p>Some text</p>


.. _encapslines-innerStdWrap-all:

innerStdWrap\_all
-----------------

.. t3-function-encapslines:: innerStdWrap_all
.. confval:: innerStdWrap_all

:Data type: :ref:`stdWrap`

Wraps the content inside all lines, whether they are encapsulated or
not.


.. _encapslines-encapsLinesStdWrap:

encapsLinesStdWrap.[*tagname*]
------------------------------

.. t3-function-encapslines:: encapsLinesStdWrap
.. confval:: encapsLinesStdWrap

:Data type: array of string / :ref:`stdWrap`
:Data type: array of :ref:`data-type-string` / :ref:`stdWrap`

Wraps the content inside all encapsulated lines.

([*tagname*] is in uppercase.)


.. _encapslines-defaultAlign:

defaultAlign
------------

.. t3-function-encapslines:: defaultAlign
.. confval:: defaultAlign

:Data type: :ref:`data-type-string` / :ref:`stdWrap`

If set, this value is set as the default "align" value of the wrapping
tags, both from :t3-function-encapslines:`encapsTagList` and
:t3-function-encapslines:`nonWrappedTag`
tags, both from :ref:`encapslines-encapsTagList` and
:ref:`encapslines-nonWrappedTag`


.. _encapslines-nonWrappedTag:

nonWrappedTag
-------------

.. t3-function-encapslines:: nonWrappedTag
.. confval:: nonWrappedTag

:Data type: :typoscript:`tagname`

Expand All @@ -231,7 +256,7 @@ nonWrappedTag
lines more easily.


.. _encapslines-examples:
.. _encapslines-examples:

Examples
========
Expand Down
1 change: 0 additions & 1 deletion Documentation/Settings.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ use_opensearch =

[sphinx_object_types_to_add]

t3-function-encapslines = t3-function-encapslines // t3-function-encapslines // Function encapsLines
t3-function-htmlparser = t3-function-htmlparser // t3-function-htmlparser // Function HTMLparser
t3-function-htmlparser-tags = t3-function-htmlparser-tags // t3-function-htmlparser-tags // Function HTMLparser_tags
t3-function-if = t3-function-if // t3-function-if // Function If
Expand Down
Loading