docs: Change tags to elements and fix some typos helpers/html_helper.rst#9153

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

Merged
kenjis merged 3 commits into from
Aug 27, 2024
Merged

docs: Change tags to elements and fix some typos helpers/html_helper.rst #9153

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
90513e3
docs: Change tags to elements and fix some typos helpers/html_helper.rst
obozdag Aug 27, 2024
6bd60da
Fix decleration to declaration in helpers/html_helper.rst
obozdag Aug 27, 2024
366f7d7
docs: Fix element names in helpes/html_helper.rst
obozdag Aug 27, 2024
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
57 changes: 28 additions & 29 deletions user_guide_src/source/helpers/html_helper.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,7 @@
HTML Helper
###########

The HTML Helper file contains functions that assist in working with
HTML.
The HTML Helper file contains functions that assist in working with HTML.

.. contents::
:local:
Expand DownExpand Up@@ -31,10 +30,10 @@ The following functions are available:
:param string|array $src: Image source URI, or array of attributes and values
:param bool $indexPage: Whether to treat ``$src`` as a routed URI string
:param mixed $attributes: Additional HTML attributes
:returns: HTML image tag
:returns: HTML image element
:rtype: string

Lets you create HTML ``<img />`` tags. The first parameter contains the
Lets you create HTML ``<img>`` elements. The first parameter contains the
image source. Example:

.. literalinclude:: html_helper/002.php
Expand DownExpand Up@@ -84,10 +83,10 @@ The following functions are available:
:param string $media: Media type
:param bool $indexPage: Whether to treat ``$src`` as a routed URI string
:param string $hreflang: Hreflang type
:returns: HTML link tag
:returns: An HTML link element
:rtype: string

Lets you create HTML ``<link />`` tags. This is useful for stylesheet links,
Lets you create HTML ``<link>`` elements. This is useful for stylesheet links,
as well as other links. The parameters are *href*, with optional *rel*,
*type*, *title*, *media* and *indexPage*.

Expand All@@ -111,10 +110,10 @@ The following functions are available:

:param array|string $src: The source name or URL of a JavaScript file, or an associative array specifying the attributes
:param bool $indexPage: Whether to treat ``$src`` as a routed URI string
:returns: HTML script tag
:returns: An HTML script element
:rtype: string

Lets you create HTML ``<script></script>`` tags. The parameters is *src*, with optional *indexPage*.
Lets you create HTML ``<script>`` elements. The parameters are *src* and optional *indexPage*.

*indexPage* is a boolean value that specifies if the *src* should have
the page specified by ``$config['indexPage']`` added to the address it creates.
Expand All@@ -132,11 +131,11 @@ The following functions are available:

:param array $list: List entries
:param array $attributes: HTML attributes
:returns: HTML-formatted unordered list
:returns: An HTML unordered list element
:rtype: string

Permits you to generate unordered HTML lists from simple or
multi-dimensional arrays. Example:
Permits you to generate an unordered HTML list from a simple or
multi-dimensional array. Example:

.. literalinclude:: html_helper/012.php

Expand DownExpand Up@@ -205,20 +204,20 @@ The following functions are available:

:param array $list: List entries
:param array $attributes: HTML attributes
:returns: HTML-formatted ordered list
:returns: An HTML ordered list element
:rtype: string

Identical to :php:func:`ul()`, only it produces the ``<ol>`` tag for
Identical to :php:func:`ul()`, only it produces ``<ol>`` element for
ordered lists instead of ``<ul>``.

.. php:function:: video($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]])

:param mixed $src: Either a source string or an array of sources. See :php:func:`source()` function
:param string $unsupportedMessage: The message to display if the media tag is not supported by the browser
:param string $unsupportedMessage: The message to display if the video element is not supported by the browser
:param string $attributes: HTML attributes
:param array $tracks: Use the track function inside an array. See :php:func:`track()` function
:param bool $indexPage:
:returns: HTML-formatted video element
:returns: An HTML video element
:rtype: string

Permits you to generate HTML video element from simple or
Expand DownExpand Up@@ -253,24 +252,24 @@ The following functions are available:
.. php:function:: audio($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]])

:param mixed $src: Either a source string or an array of sources. See :php:func:`source()` function
:param string $unsupportedMessage: The message to display if the media tag is not supported by the browser
:param string $unsupportedMessage: The message to display if the audio element is not supported by the browser
:param string $attributes:
:param array $tracks: Use the track function inside an array. See :php:func:`track()` function
:param bool $indexPage:
:returns: HTML-formatted audio element
:returns: An HTML audio element
:rtype: string

Identical to :php:func:`video()`, only it produces the ``<audio>`` tag instead of ``<video>``.
Identical to :php:func:`video()`, only it produces ``<audio>`` element instead of ``<video>``.

.. php:function:: source($src = ''[, $type = false[, $attributes = '']])

:param string $src: The path of the media resource
:param bool $type: The MIME-type of the resource with optional codecs parameters
:param array $attributes: HTML attributes
:returns: HTML source tag
:returns: An HTML source element
:rtype: string

Lets you create HTML ``<source />`` tags. The first parameter contains the
Lets you create HTML ``<source>`` elements. The first parameter contains the
source source. Example:

.. literalinclude:: html_helper/015.php
Expand All@@ -281,10 +280,10 @@ The following functions are available:
:param bool $type: MIME-type
:param array $attributes: HTML attributes
:param bool $indexPage:
:returns: HTML embed tag
:returns: An HTML embed element
:rtype: string

Lets you create HTML ``<embed />`` tags. The first parameter contains the
Lets you create HTML ``<embed>`` elements. The first parameter contains the
embed source. Example:

.. literalinclude:: html_helper/016.php
Expand All@@ -295,10 +294,10 @@ The following functions are available:
:param bool $type: Content-type of the resource
:param array $attributes: HTML attributes
:param array $params: Use the param function inside an array. See :php:func:`param()` function
:returns: HTML object tag
:returns: An HTML object element
:rtype: string

Lets you create HTML ``<object />`` tags. The first parameter contains the
Lets you create HTML ``<object>`` elements. The first parameter contains the
object data. Example:

.. literalinclude:: html_helper/017.php
Expand All@@ -319,10 +318,10 @@ The following functions are available:
:param string $name: The name of the parameter
:param string $value: The value of the parameter
:param array $attributes: HTML attributes
:returns: HTML param tag
:returns: An HTML param element
:rtype: string

Lets you create HTML ``<param />`` tags. The first parameter contains the
Lets you create HTML ``<param>`` elements. The first parameter contains the
param source. Example:

.. literalinclude:: html_helper/018.php
Expand All@@ -332,7 +331,7 @@ The following functions are available:
:param string $name: The name of the parameter
:param string $value: The value of the parameter
:param array $attributes: HTML attributes
:returns: HTML track tag
:returns: An HTML track element
:rtype: string

Generates a track element to specify timed tracks. The tracks are
Expand All@@ -343,10 +342,10 @@ The following functions are available:
.. php:function:: doctype([$type = 'html5'])

:param string $type: Doctype name
:returns: HTML DocType tag
:returns: An HTML DocType declaration
:rtype: string

Helps you generate document type declarations, or DTD's. HTML 5
Helps you generate document type declarations (DTD's). HTML 5
is used by default, but many doctypes are available.

Example:
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
docs: Change tags to elements and fix some typos helpers/html_helper.rst#9153

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

 Merged

kenjis
merged 3 commits into

from

Aug 27, 2024
 Merged


docs: Change tags to elements and fix some typos helpers/html_helper.rst
#9153
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
90513e3

docs: Change tags to elements and fix some typos helpers/html_helper.rst


obozdag Aug 27, 2024
6bd60da

Fix decleration to declaration in helpers/html_helper.rst


obozdag Aug 27, 2024
366f7d7

docs: Fix element names in helpes/html_helper.rst


obozdag Aug 27, 2024

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


57 changes: 28 additions & 29 deletions
user_guide_src/source/helpers/html_helper.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,7 @@
HTML Helper
###########

The HTML Helper file contains functions that assist in working with
HTML.
The HTML Helper file contains functions that assist in working with HTML.

.. contents::
 :local:
Expand DownExpand Up@@ -31,10 +30,10 @@ The following functions are available:
 :param string|array $src: Image source URI, or array of attributes and values
 :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
 :param mixed $attributes: Additional HTML attributes
 :returns: HTML image tag
 :returns: HTML image element
 :rtype: string

 Lets you create HTML ``<img />`` tags. The first parameter contains the
 Lets you create HTML ``<img>`` elements. The first parameter contains the
 image source. Example:

 .. literalinclude:: html_helper/002.php
Expand DownExpand Up@@ -84,10 +83,10 @@ The following functions are available:
 :param string $media: Media type
 :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
 :param string $hreflang: Hreflang type
 :returns: HTML link tag
 :returns: An HTML link element
 :rtype: string

 Lets you create HTML ``<link />`` tags. This is useful for stylesheet links,
 Lets you create HTML ``<link>`` elements. This is useful for stylesheet links,
 as well as other links. The parameters are *href*, with optional *rel*,
 *type*, *title*, *media* and *indexPage*.

Expand All@@ -111,10 +110,10 @@ The following functions are available:

 :param array|string $src: The source name or URL of a JavaScript file, or an associative array specifying the attributes
 :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
 :returns: HTML script tag
 :returns: An HTML script element
 :rtype: string

 Lets you create HTML ``<script></script>`` tags. The parameters is *src*, with optional *indexPage*.
 Lets you create HTML ``<script>`` elements. The parameters are *src* and optional *indexPage*.

 *indexPage* is a boolean value that specifies if the *src* should have
 the page specified by ``$config['indexPage']`` added to the address it creates.
Expand All@@ -132,11 +131,11 @@ The following functions are available:

 :param array $list: List entries
 :param array $attributes: HTML attributes
 :returns: HTML-formatted unordered list
 :returns: An HTML unordered list element
 :rtype: string

 Permits you to generate unordered HTML lists from simple or
 multi-dimensional arrays. Example:
 Permits you to generate an unordered HTML list from a simple or
 multi-dimensional array. Example:

 .. literalinclude:: html_helper/012.php

Expand DownExpand Up@@ -205,20 +204,20 @@ The following functions are available:

 :param array $list: List entries
 :param array $attributes: HTML attributes
 :returns: HTML-formatted ordered list
 :returns: An HTML ordered list element
 :rtype: string

 Identical to :php:func:`ul()`, only it produces the ``<ol>`` tag for
 Identical to :php:func:`ul()`, only it produces ``<ol>`` element for
 ordered lists instead of ``<ul>``.

.. php:function:: video($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]])

 :param mixed $src: Either a source string or an array of sources. See :php:func:`source()` function
 :param string $unsupportedMessage: The message to display if the media tag is not supported by the browser
 :param string $unsupportedMessage: The message to display if the video element is not supported by the browser
 :param string $attributes: HTML attributes
 :param array $tracks: Use the track function inside an array. See :php:func:`track()` function
 :param bool $indexPage:
 :returns: HTML-formatted video element
 :returns: An HTML video element
 :rtype: string

 Permits you to generate HTML video element from simple or
Expand DownExpand Up@@ -253,24 +252,24 @@ The following functions are available:
.. php:function:: audio($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]])

 :param mixed $src: Either a source string or an array of sources. See :php:func:`source()` function
 :param string $unsupportedMessage: The message to display if the media tag is not supported by the browser
 :param string $unsupportedMessage: The message to display if the audio element is not supported by the browser
 :param string $attributes:
 :param array $tracks: Use the track function inside an array. See :php:func:`track()` function
 :param bool $indexPage:
 :returns: HTML-formatted audio element
 :returns: An HTML audio element
 :rtype: string

 Identical to :php:func:`video()`, only it produces the ``<audio>`` tag instead of ``<video>``.
 Identical to :php:func:`video()`, only it produces ``<audio>`` element instead of ``<video>``.

.. php:function:: source($src = ''[, $type = false[, $attributes = '']])

 :param string $src: The path of the media resource
 :param bool $type: The MIME-type of the resource with optional codecs parameters
 :param array $attributes: HTML attributes
 :returns: HTML source tag
 :returns: An HTML source element
 :rtype: string

 Lets you create HTML ``<source />`` tags. The first parameter contains the
 Lets you create HTML ``<source>`` elements. The first parameter contains the
 source source. Example:

 .. literalinclude:: html_helper/015.php
Expand All@@ -281,10 +280,10 @@ The following functions are available:
 :param bool $type: MIME-type
 :param array $attributes: HTML attributes
 :param bool $indexPage:
 :returns: HTML embed tag
 :returns: An HTML embed element
 :rtype: string

 Lets you create HTML ``<embed />`` tags. The first parameter contains the
 Lets you create HTML ``<embed>`` elements. The first parameter contains the
 embed source. Example:

 .. literalinclude:: html_helper/016.php
Expand All@@ -295,10 +294,10 @@ The following functions are available:
 :param bool $type: Content-type of the resource
 :param array $attributes: HTML attributes
 :param array $params: Use the param function inside an array. See :php:func:`param()` function
 :returns: HTML object tag
 :returns: An HTML object element
 :rtype: string

 Lets you create HTML ``<object />`` tags. The first parameter contains the
 Lets you create HTML ``<object>`` elements. The first parameter contains the
 object data. Example:

 .. literalinclude:: html_helper/017.php
Expand All@@ -319,10 +318,10 @@ The following functions are available:
 :param string $name: The name of the parameter
 :param string $value: The value of the parameter
 :param array $attributes: HTML attributes
 :returns: HTML param tag
 :returns: An HTML param element
 :rtype: string

 Lets you create HTML ``<param />`` tags. The first parameter contains the
 Lets you create HTML ``<param>`` elements. The first parameter contains the
 param source. Example:

 .. literalinclude:: html_helper/018.php
Expand All@@ -332,7 +331,7 @@ The following functions are available:
 :param string $name: The name of the parameter
 :param string $value: The value of the parameter
 :param array $attributes: HTML attributes
 :returns: HTML track tag
 :returns: An HTML track element
 :rtype: string

 Generates a track element to specify timed tracks. The tracks are
Expand All@@ -343,10 +342,10 @@ The following functions are available:
.. php:function:: doctype([$type = 'html5'])

 :param string $type: Doctype name
 :returns: HTML DocType tag
 :returns: An HTML DocType declaration
 :rtype: string

 Helps you generate document type declarations, or DTD's. HTML 5
 Helps you generate document type declarations (DTD's). HTML 5
 is used by default, but many doctypes are available.

 Example:
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs: Change tags to elements and fix some typos helpers/html_helper.rst#9153

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

 Merged

kenjis
merged 3 commits into

from

Aug 27, 2024
 Merged


docs: Change tags to elements and fix some typos helpers/html_helper.rst
#9153
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
90513e3

docs: Change tags to elements and fix some typos helpers/html_helper.rst


obozdag Aug 27, 2024
6bd60da

Fix decleration to declaration in helpers/html_helper.rst


obozdag Aug 27, 2024
366f7d7

docs: Fix element names in helpes/html_helper.rst


obozdag Aug 27, 2024

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


57 changes: 28 additions & 29 deletions
user_guide_src/source/helpers/html_helper.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,7 @@
HTML Helper
###########

The HTML Helper file contains functions that assist in working with
HTML.
The HTML Helper file contains functions that assist in working with HTML.

.. contents::
 :local:
Expand DownExpand Up@@ -31,10 +30,10 @@ The following functions are available:
 :param string|array $src: Image source URI, or array of attributes and values
 :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
 :param mixed $attributes: Additional HTML attributes
 :returns: HTML image tag
 :returns: HTML image element
 :rtype: string

 Lets you create HTML ``<img />`` tags. The first parameter contains the
 Lets you create HTML ``<img>`` elements. The first parameter contains the
 image source. Example:

 .. literalinclude:: html_helper/002.php
Expand DownExpand Up@@ -84,10 +83,10 @@ The following functions are available:
 :param string $media: Media type
 :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
 :param string $hreflang: Hreflang type
 :returns: HTML link tag
 :returns: An HTML link element
 :rtype: string

 Lets you create HTML ``<link />`` tags. This is useful for stylesheet links,
 Lets you create HTML ``<link>`` elements. This is useful for stylesheet links,
 as well as other links. The parameters are *href*, with optional *rel*,
 *type*, *title*, *media* and *indexPage*.

Expand All@@ -111,10 +110,10 @@ The following functions are available:

 :param array|string $src: The source name or URL of a JavaScript file, or an associative array specifying the attributes
 :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
 :returns: HTML script tag
 :returns: An HTML script element
 :rtype: string

 Lets you create HTML ``<script></script>`` tags. The parameters is *src*, with optional *indexPage*.
 Lets you create HTML ``<script>`` elements. The parameters are *src* and optional *indexPage*.

 *indexPage* is a boolean value that specifies if the *src* should have
 the page specified by ``$config['indexPage']`` added to the address it creates.
Expand All@@ -132,11 +131,11 @@ The following functions are available:

 :param array $list: List entries
 :param array $attributes: HTML attributes
 :returns: HTML-formatted unordered list
 :returns: An HTML unordered list element
 :rtype: string

 Permits you to generate unordered HTML lists from simple or
 multi-dimensional arrays. Example:
 Permits you to generate an unordered HTML list from a simple or
 multi-dimensional array. Example:

 .. literalinclude:: html_helper/012.php

Expand DownExpand Up@@ -205,20 +204,20 @@ The following functions are available:

 :param array $list: List entries
 :param array $attributes: HTML attributes
 :returns: HTML-formatted ordered list
 :returns: An HTML ordered list element
 :rtype: string

 Identical to :php:func:`ul()`, only it produces the ``<ol>`` tag for
 Identical to :php:func:`ul()`, only it produces ``<ol>`` element for
 ordered lists instead of ``<ul>``.

.. php:function:: video($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]])

 :param mixed $src: Either a source string or an array of sources. See :php:func:`source()` function
 :param string $unsupportedMessage: The message to display if the media tag is not supported by the browser
 :param string $unsupportedMessage: The message to display if the video element is not supported by the browser
 :param string $attributes: HTML attributes
 :param array $tracks: Use the track function inside an array. See :php:func:`track()` function
 :param bool $indexPage:
 :returns: HTML-formatted video element
 :returns: An HTML video element
 :rtype: string

 Permits you to generate HTML video element from simple or
Expand DownExpand Up@@ -253,24 +252,24 @@ The following functions are available:
.. php:function:: audio($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]])

 :param mixed $src: Either a source string or an array of sources. See :php:func:`source()` function
 :param string $unsupportedMessage: The message to display if the media tag is not supported by the browser
 :param string $unsupportedMessage: The message to display if the audio element is not supported by the browser
 :param string $attributes:
 :param array $tracks: Use the track function inside an array. See :php:func:`track()` function
 :param bool $indexPage:
 :returns: HTML-formatted audio element
 :returns: An HTML audio element
 :rtype: string

 Identical to :php:func:`video()`, only it produces the ``<audio>`` tag instead of ``<video>``.
 Identical to :php:func:`video()`, only it produces ``<audio>`` element instead of ``<video>``.

.. php:function:: source($src = ''[, $type = false[, $attributes = '']])

 :param string $src: The path of the media resource
 :param bool $type: The MIME-type of the resource with optional codecs parameters
 :param array $attributes: HTML attributes
 :returns: HTML source tag
 :returns: An HTML source element
 :rtype: string

 Lets you create HTML ``<source />`` tags. The first parameter contains the
 Lets you create HTML ``<source>`` elements. The first parameter contains the
 source source. Example:

 .. literalinclude:: html_helper/015.php
Expand All@@ -281,10 +280,10 @@ The following functions are available:
 :param bool $type: MIME-type
 :param array $attributes: HTML attributes
 :param bool $indexPage:
 :returns: HTML embed tag
 :returns: An HTML embed element
 :rtype: string

 Lets you create HTML ``<embed />`` tags. The first parameter contains the
 Lets you create HTML ``<embed>`` elements. The first parameter contains the
 embed source. Example:

 .. literalinclude:: html_helper/016.php
Expand All@@ -295,10 +294,10 @@ The following functions are available:
 :param bool $type: Content-type of the resource
 :param array $attributes: HTML attributes
 :param array $params: Use the param function inside an array. See :php:func:`param()` function
 :returns: HTML object tag
 :returns: An HTML object element
 :rtype: string

 Lets you create HTML ``<object />`` tags. The first parameter contains the
 Lets you create HTML ``<object>`` elements. The first parameter contains the
 object data. Example:

 .. literalinclude:: html_helper/017.php
Expand All@@ -319,10 +318,10 @@ The following functions are available:
 :param string $name: The name of the parameter
 :param string $value: The value of the parameter
 :param array $attributes: HTML attributes
 :returns: HTML param tag
 :returns: An HTML param element
 :rtype: string

 Lets you create HTML ``<param />`` tags. The first parameter contains the
 Lets you create HTML ``<param>`` elements. The first parameter contains the
 param source. Example:

 .. literalinclude:: html_helper/018.php
Expand All@@ -332,7 +331,7 @@ The following functions are available:
 :param string $name: The name of the parameter
 :param string $value: The value of the parameter
 :param array $attributes: HTML attributes
 :returns: HTML track tag
 :returns: An HTML track element
 :rtype: string

 Generates a track element to specify timed tracks. The tracks are
Expand All@@ -343,10 +342,10 @@ The following functions are available:
.. php:function:: doctype([$type = 'html5'])

 :param string $type: Doctype name
 :returns: HTML DocType tag
 :returns: An HTML DocType declaration
 :rtype: string

 Helps you generate document type declarations, or DTD's. HTML 5
 Helps you generate document type declarations (DTD's). HTML 5
 is used by default, but many doctypes are available.

 Example:
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs: Change tags to elements and fix some typos helpers/html_helper.rst#9153

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

 Merged

kenjis
merged 3 commits into

from

Aug 27, 2024
 Merged


docs: Change tags to elements and fix some typos helpers/html_helper.rst
#9153
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
90513e3

docs: Change tags to elements and fix some typos helpers/html_helper.rst


obozdag Aug 27, 2024
6bd60da

Fix decleration to declaration in helpers/html_helper.rst


obozdag Aug 27, 2024
366f7d7

docs: Fix element names in helpes/html_helper.rst


obozdag Aug 27, 2024

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


57 changes: 28 additions & 29 deletions
user_guide_src/source/helpers/html_helper.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,7 @@
HTML Helper
###########

The HTML Helper file contains functions that assist in working with
HTML.
The HTML Helper file contains functions that assist in working with HTML.

.. contents::
 :local:
Expand DownExpand Up@@ -31,10 +30,10 @@ The following functions are available:
 :param string|array $src: Image source URI, or array of attributes and values
 :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
 :param mixed $attributes: Additional HTML attributes
 :returns: HTML image tag
 :returns: HTML image element
 :rtype: string

 Lets you create HTML ``<img />`` tags. The first parameter contains the
 Lets you create HTML ``<img>`` elements. The first parameter contains the
 image source. Example:

 .. literalinclude:: html_helper/002.php
Expand DownExpand Up@@ -84,10 +83,10 @@ The following functions are available:
 :param string $media: Media type
 :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
 :param string $hreflang: Hreflang type
 :returns: HTML link tag
 :returns: An HTML link element
 :rtype: string

 Lets you create HTML ``<link />`` tags. This is useful for stylesheet links,
 Lets you create HTML ``<link>`` elements. This is useful for stylesheet links,
 as well as other links. The parameters are *href*, with optional *rel*,
 *type*, *title*, *media* and *indexPage*.

Expand All@@ -111,10 +110,10 @@ The following functions are available:

 :param array|string $src: The source name or URL of a JavaScript file, or an associative array specifying the attributes
 :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
 :returns: HTML script tag
 :returns: An HTML script element
 :rtype: string

 Lets you create HTML ``<script></script>`` tags. The parameters is *src*, with optional *indexPage*.
 Lets you create HTML ``<script>`` elements. The parameters are *src* and optional *indexPage*.

 *indexPage* is a boolean value that specifies if the *src* should have
 the page specified by ``$config['indexPage']`` added to the address it creates.
Expand All@@ -132,11 +131,11 @@ The following functions are available:

 :param array $list: List entries
 :param array $attributes: HTML attributes
 :returns: HTML-formatted unordered list
 :returns: An HTML unordered list element
 :rtype: string

 Permits you to generate unordered HTML lists from simple or
 multi-dimensional arrays. Example:
 Permits you to generate an unordered HTML list from a simple or
 multi-dimensional array. Example:

 .. literalinclude:: html_helper/012.php

Expand DownExpand Up@@ -205,20 +204,20 @@ The following functions are available:

 :param array $list: List entries
 :param array $attributes: HTML attributes
 :returns: HTML-formatted ordered list
 :returns: An HTML ordered list element
 :rtype: string

 Identical to :php:func:`ul()`, only it produces the ``<ol>`` tag for
 Identical to :php:func:`ul()`, only it produces ``<ol>`` element for
 ordered lists instead of ``<ul>``.

.. php:function:: video($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]])

 :param mixed $src: Either a source string or an array of sources. See :php:func:`source()` function
 :param string $unsupportedMessage: The message to display if the media tag is not supported by the browser
 :param string $unsupportedMessage: The message to display if the video element is not supported by the browser
 :param string $attributes: HTML attributes
 :param array $tracks: Use the track function inside an array. See :php:func:`track()` function
 :param bool $indexPage:
 :returns: HTML-formatted video element
 :returns: An HTML video element
 :rtype: string

 Permits you to generate HTML video element from simple or
Expand DownExpand Up@@ -253,24 +252,24 @@ The following functions are available:
.. php:function:: audio($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]])

 :param mixed $src: Either a source string or an array of sources. See :php:func:`source()` function
 :param string $unsupportedMessage: The message to display if the media tag is not supported by the browser
 :param string $unsupportedMessage: The message to display if the audio element is not supported by the browser
 :param string $attributes:
 :param array $tracks: Use the track function inside an array. See :php:func:`track()` function
 :param bool $indexPage:
 :returns: HTML-formatted audio element
 :returns: An HTML audio element
 :rtype: string

 Identical to :php:func:`video()`, only it produces the ``<audio>`` tag instead of ``<video>``.
 Identical to :php:func:`video()`, only it produces ``<audio>`` element instead of ``<video>``.

.. php:function:: source($src = ''[, $type = false[, $attributes = '']])

 :param string $src: The path of the media resource
 :param bool $type: The MIME-type of the resource with optional codecs parameters
 :param array $attributes: HTML attributes
 :returns: HTML source tag
 :returns: An HTML source element
 :rtype: string

 Lets you create HTML ``<source />`` tags. The first parameter contains the
 Lets you create HTML ``<source>`` elements. The first parameter contains the
 source source. Example:

 .. literalinclude:: html_helper/015.php
Expand All@@ -281,10 +280,10 @@ The following functions are available:
 :param bool $type: MIME-type
 :param array $attributes: HTML attributes
 :param bool $indexPage:
 :returns: HTML embed tag
 :returns: An HTML embed element
 :rtype: string

 Lets you create HTML ``<embed />`` tags. The first parameter contains the
 Lets you create HTML ``<embed>`` elements. The first parameter contains the
 embed source. Example:

 .. literalinclude:: html_helper/016.php
Expand All@@ -295,10 +294,10 @@ The following functions are available:
 :param bool $type: Content-type of the resource
 :param array $attributes: HTML attributes
 :param array $params: Use the param function inside an array. See :php:func:`param()` function
 :returns: HTML object tag
 :returns: An HTML object element
 :rtype: string

 Lets you create HTML ``<object />`` tags. The first parameter contains the
 Lets you create HTML ``<object>`` elements. The first parameter contains the
 object data. Example:

 .. literalinclude:: html_helper/017.php
Expand All@@ -319,10 +318,10 @@ The following functions are available:
 :param string $name: The name of the parameter
 :param string $value: The value of the parameter
 :param array $attributes: HTML attributes
 :returns: HTML param tag
 :returns: An HTML param element
 :rtype: string

 Lets you create HTML ``<param />`` tags. The first parameter contains the
 Lets you create HTML ``<param>`` elements. The first parameter contains the
 param source. Example:

 .. literalinclude:: html_helper/018.php
Expand All@@ -332,7 +331,7 @@ The following functions are available:
 :param string $name: The name of the parameter
 :param string $value: The value of the parameter
 :param array $attributes: HTML attributes
 :returns: HTML track tag
 :returns: An HTML track element
 :rtype: string

 Generates a track element to specify timed tracks. The tracks are
Expand All@@ -343,10 +342,10 @@ The following functions are available:
.. php:function:: doctype([$type = 'html5'])

 :param string $type: Doctype name
 :returns: HTML DocType tag
 :returns: An HTML DocType declaration
 :rtype: string

 Helps you generate document type declarations, or DTD's. HTML 5
 Helps you generate document type declarations (DTD's). HTML 5
 is used by default, but many doctypes are available.

 Example:
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
docs: Change tags to elements and fix some typos helpers/html_helper.rst#9153

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

 Merged

kenjis
merged 3 commits into

from

Aug 27, 2024
 Merged


docs: Change tags to elements and fix some typos helpers/html_helper.rst
#9153
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
90513e3

docs: Change tags to elements and fix some typos helpers/html_helper.rst


obozdag Aug 27, 2024
6bd60da

Fix decleration to declaration in helpers/html_helper.rst


obozdag Aug 27, 2024
366f7d7

docs: Fix element names in helpes/html_helper.rst


obozdag Aug 27, 2024

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


57 changes: 28 additions & 29 deletions
user_guide_src/source/helpers/html_helper.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,7 @@
HTML Helper
###########

The HTML Helper file contains functions that assist in working with
HTML.
The HTML Helper file contains functions that assist in working with HTML.

.. contents::
 :local:
Expand DownExpand Up@@ -31,10 +30,10 @@ The following functions are available:
 :param string|array $src: Image source URI, or array of attributes and values
 :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
 :param mixed $attributes: Additional HTML attributes
 :returns: HTML image tag
 :returns: HTML image element
 :rtype: string

 Lets you create HTML ``<img />`` tags. The first parameter contains the
 Lets you create HTML ``<img>`` elements. The first parameter contains the
 image source. Example:

 .. literalinclude:: html_helper/002.php
Expand DownExpand Up@@ -84,10 +83,10 @@ The following functions are available:
 :param string $media: Media type
 :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
 :param string $hreflang: Hreflang type
 :returns: HTML link tag
 :returns: An HTML link element
 :rtype: string

 Lets you create HTML ``<link />`` tags. This is useful for stylesheet links,
 Lets you create HTML ``<link>`` elements. This is useful for stylesheet links,
 as well as other links. The parameters are *href*, with optional *rel*,
 *type*, *title*, *media* and *indexPage*.

Expand All@@ -111,10 +110,10 @@ The following functions are available:

 :param array|string $src: The source name or URL of a JavaScript file, or an associative array specifying the attributes
 :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
 :returns: HTML script tag
 :returns: An HTML script element
 :rtype: string

 Lets you create HTML ``<script></script>`` tags. The parameters is *src*, with optional *indexPage*.
 Lets you create HTML ``<script>`` elements. The parameters are *src* and optional *indexPage*.

 *indexPage* is a boolean value that specifies if the *src* should have
 the page specified by ``$config['indexPage']`` added to the address it creates.
Expand All@@ -132,11 +131,11 @@ The following functions are available:

 :param array $list: List entries
 :param array $attributes: HTML attributes
 :returns: HTML-formatted unordered list
 :returns: An HTML unordered list element
 :rtype: string

 Permits you to generate unordered HTML lists from simple or
 multi-dimensional arrays. Example:
 Permits you to generate an unordered HTML list from a simple or
 multi-dimensional array. Example:

 .. literalinclude:: html_helper/012.php

Expand DownExpand Up@@ -205,20 +204,20 @@ The following functions are available:

 :param array $list: List entries
 :param array $attributes: HTML attributes
 :returns: HTML-formatted ordered list
 :returns: An HTML ordered list element
 :rtype: string

 Identical to :php:func:`ul()`, only it produces the ``<ol>`` tag for
 Identical to :php:func:`ul()`, only it produces ``<ol>`` element for
 ordered lists instead of ``<ul>``.

.. php:function:: video($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]])

 :param mixed $src: Either a source string or an array of sources. See :php:func:`source()` function
 :param string $unsupportedMessage: The message to display if the media tag is not supported by the browser
 :param string $unsupportedMessage: The message to display if the video element is not supported by the browser
 :param string $attributes: HTML attributes
 :param array $tracks: Use the track function inside an array. See :php:func:`track()` function
 :param bool $indexPage:
 :returns: HTML-formatted video element
 :returns: An HTML video element
 :rtype: string

 Permits you to generate HTML video element from simple or
Expand DownExpand Up@@ -253,24 +252,24 @@ The following functions are available:
.. php:function:: audio($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]])

 :param mixed $src: Either a source string or an array of sources. See :php:func:`source()` function
 :param string $unsupportedMessage: The message to display if the media tag is not supported by the browser
 :param string $unsupportedMessage: The message to display if the audio element is not supported by the browser
 :param string $attributes:
 :param array $tracks: Use the track function inside an array. See :php:func:`track()` function
 :param bool $indexPage:
 :returns: HTML-formatted audio element
 :returns: An HTML audio element
 :rtype: string

 Identical to :php:func:`video()`, only it produces the ``<audio>`` tag instead of ``<video>``.
 Identical to :php:func:`video()`, only it produces ``<audio>`` element instead of ``<video>``.

.. php:function:: source($src = ''[, $type = false[, $attributes = '']])

 :param string $src: The path of the media resource
 :param bool $type: The MIME-type of the resource with optional codecs parameters
 :param array $attributes: HTML attributes
 :returns: HTML source tag
 :returns: An HTML source element
 :rtype: string

 Lets you create HTML ``<source />`` tags. The first parameter contains the
 Lets you create HTML ``<source>`` elements. The first parameter contains the
 source source. Example:

 .. literalinclude:: html_helper/015.php
Expand All@@ -281,10 +280,10 @@ The following functions are available:
 :param bool $type: MIME-type
 :param array $attributes: HTML attributes
 :param bool $indexPage:
 :returns: HTML embed tag
 :returns: An HTML embed element
 :rtype: string

 Lets you create HTML ``<embed />`` tags. The first parameter contains the
 Lets you create HTML ``<embed>`` elements. The first parameter contains the
 embed source. Example:

 .. literalinclude:: html_helper/016.php
Expand All@@ -295,10 +294,10 @@ The following functions are available:
 :param bool $type: Content-type of the resource
 :param array $attributes: HTML attributes
 :param array $params: Use the param function inside an array. See :php:func:`param()` function
 :returns: HTML object tag
 :returns: An HTML object element
 :rtype: string

 Lets you create HTML ``<object />`` tags. The first parameter contains the
 Lets you create HTML ``<object>`` elements. The first parameter contains the
 object data. Example:

 .. literalinclude:: html_helper/017.php
Expand All@@ -319,10 +318,10 @@ The following functions are available:
 :param string $name: The name of the parameter
 :param string $value: The value of the parameter
 :param array $attributes: HTML attributes
 :returns: HTML param tag
 :returns: An HTML param element
 :rtype: string

 Lets you create HTML ``<param />`` tags. The first parameter contains the
 Lets you create HTML ``<param>`` elements. The first parameter contains the
 param source. Example:

 .. literalinclude:: html_helper/018.php
Expand All@@ -332,7 +331,7 @@ The following functions are available:
 :param string $name: The name of the parameter
 :param string $value: The value of the parameter
 :param array $attributes: HTML attributes
 :returns: HTML track tag
 :returns: An HTML track element
 :rtype: string

 Generates a track element to specify timed tracks. The tracks are
Expand All@@ -343,10 +342,10 @@ The following functions are available:
.. php:function:: doctype([$type = 'html5'])

 :param string $type: Doctype name
 :returns: HTML DocType tag
 :returns: An HTML DocType declaration
 :rtype: string

 Helps you generate document type declarations, or DTD's. HTML 5
 Helps you generate document type declarations (DTD's). HTML 5
 is used by default, but many doctypes are available.

 Example:
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs: Change tags to elements and fix some typos helpers/html_helper.rst#9153

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

 Merged

kenjis
merged 3 commits into

from

Aug 27, 2024
 Merged


docs: Change tags to elements and fix some typos helpers/html_helper.rst
#9153
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
90513e3

docs: Change tags to elements and fix some typos helpers/html_helper.rst


obozdag Aug 27, 2024
6bd60da

Fix decleration to declaration in helpers/html_helper.rst


obozdag Aug 27, 2024
366f7d7

docs: Fix element names in helpes/html_helper.rst


obozdag Aug 27, 2024

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


57 changes: 28 additions & 29 deletions
user_guide_src/source/helpers/html_helper.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,7 @@
HTML Helper
###########

The HTML Helper file contains functions that assist in working with
HTML.
The HTML Helper file contains functions that assist in working with HTML.

.. contents::
 :local:
Expand DownExpand Up@@ -31,10 +30,10 @@ The following functions are available:
 :param string|array $src: Image source URI, or array of attributes and values
 :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
 :param mixed $attributes: Additional HTML attributes
 :returns: HTML image tag
 :returns: HTML image element
 :rtype: string

 Lets you create HTML ``<img />`` tags. The first parameter contains the
 Lets you create HTML ``<img>`` elements. The first parameter contains the
 image source. Example:

 .. literalinclude:: html_helper/002.php
Expand DownExpand Up@@ -84,10 +83,10 @@ The following functions are available:
 :param string $media: Media type
 :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
 :param string $hreflang: Hreflang type
 :returns: HTML link tag
 :returns: An HTML link element
 :rtype: string

 Lets you create HTML ``<link />`` tags. This is useful for stylesheet links,
 Lets you create HTML ``<link>`` elements. This is useful for stylesheet links,
 as well as other links. The parameters are *href*, with optional *rel*,
 *type*, *title*, *media* and *indexPage*.

Expand All@@ -111,10 +110,10 @@ The following functions are available:

 :param array|string $src: The source name or URL of a JavaScript file, or an associative array specifying the attributes
 :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
 :returns: HTML script tag
 :returns: An HTML script element
 :rtype: string

 Lets you create HTML ``<script></script>`` tags. The parameters is *src*, with optional *indexPage*.
 Lets you create HTML ``<script>`` elements. The parameters are *src* and optional *indexPage*.

 *indexPage* is a boolean value that specifies if the *src* should have
 the page specified by ``$config['indexPage']`` added to the address it creates.
Expand All@@ -132,11 +131,11 @@ The following functions are available:

 :param array $list: List entries
 :param array $attributes: HTML attributes
 :returns: HTML-formatted unordered list
 :returns: An HTML unordered list element
 :rtype: string

 Permits you to generate unordered HTML lists from simple or
 multi-dimensional arrays. Example:
 Permits you to generate an unordered HTML list from a simple or
 multi-dimensional array. Example:

 .. literalinclude:: html_helper/012.php

Expand DownExpand Up@@ -205,20 +204,20 @@ The following functions are available:

 :param array $list: List entries
 :param array $attributes: HTML attributes
 :returns: HTML-formatted ordered list
 :returns: An HTML ordered list element
 :rtype: string

 Identical to :php:func:`ul()`, only it produces the ``<ol>`` tag for
 Identical to :php:func:`ul()`, only it produces ``<ol>`` element for
 ordered lists instead of ``<ul>``.

.. php:function:: video($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]])

 :param mixed $src: Either a source string or an array of sources. See :php:func:`source()` function
 :param string $unsupportedMessage: The message to display if the media tag is not supported by the browser
 :param string $unsupportedMessage: The message to display if the video element is not supported by the browser
 :param string $attributes: HTML attributes
 :param array $tracks: Use the track function inside an array. See :php:func:`track()` function
 :param bool $indexPage:
 :returns: HTML-formatted video element
 :returns: An HTML video element
 :rtype: string

 Permits you to generate HTML video element from simple or
Expand DownExpand Up@@ -253,24 +252,24 @@ The following functions are available:
.. php:function:: audio($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]])

 :param mixed $src: Either a source string or an array of sources. See :php:func:`source()` function
 :param string $unsupportedMessage: The message to display if the media tag is not supported by the browser
 :param string $unsupportedMessage: The message to display if the audio element is not supported by the browser
 :param string $attributes:
 :param array $tracks: Use the track function inside an array. See :php:func:`track()` function
 :param bool $indexPage:
 :returns: HTML-formatted audio element
 :returns: An HTML audio element
 :rtype: string

 Identical to :php:func:`video()`, only it produces the ``<audio>`` tag instead of ``<video>``.
 Identical to :php:func:`video()`, only it produces ``<audio>`` element instead of ``<video>``.

.. php:function:: source($src = ''[, $type = false[, $attributes = '']])

 :param string $src: The path of the media resource
 :param bool $type: The MIME-type of the resource with optional codecs parameters
 :param array $attributes: HTML attributes
 :returns: HTML source tag
 :returns: An HTML source element
 :rtype: string

 Lets you create HTML ``<source />`` tags. The first parameter contains the
 Lets you create HTML ``<source>`` elements. The first parameter contains the
 source source. Example:

 .. literalinclude:: html_helper/015.php
Expand All@@ -281,10 +280,10 @@ The following functions are available:
 :param bool $type: MIME-type
 :param array $attributes: HTML attributes
 :param bool $indexPage:
 :returns: HTML embed tag
 :returns: An HTML embed element
 :rtype: string

 Lets you create HTML ``<embed />`` tags. The first parameter contains the
 Lets you create HTML ``<embed>`` elements. The first parameter contains the
 embed source. Example:

 .. literalinclude:: html_helper/016.php
Expand All@@ -295,10 +294,10 @@ The following functions are available:
 :param bool $type: Content-type of the resource
 :param array $attributes: HTML attributes
 :param array $params: Use the param function inside an array. See :php:func:`param()` function
 :returns: HTML object tag
 :returns: An HTML object element
 :rtype: string

 Lets you create HTML ``<object />`` tags. The first parameter contains the
 Lets you create HTML ``<object>`` elements. The first parameter contains the
 object data. Example:

 .. literalinclude:: html_helper/017.php
Expand All@@ -319,10 +318,10 @@ The following functions are available:
 :param string $name: The name of the parameter
 :param string $value: The value of the parameter
 :param array $attributes: HTML attributes
 :returns: HTML param tag
 :returns: An HTML param element
 :rtype: string

 Lets you create HTML ``<param />`` tags. The first parameter contains the
 Lets you create HTML ``<param>`` elements. The first parameter contains the
 param source. Example:

 .. literalinclude:: html_helper/018.php
Expand All@@ -332,7 +331,7 @@ The following functions are available:
 :param string $name: The name of the parameter
 :param string $value: The value of the parameter
 :param array $attributes: HTML attributes
 :returns: HTML track tag
 :returns: An HTML track element
 :rtype: string

 Generates a track element to specify timed tracks. The tracks are
Expand All@@ -343,10 +342,10 @@ The following functions are available:
.. php:function:: doctype([$type = 'html5'])

 :param string $type: Doctype name
 :returns: HTML DocType tag
 :returns: An HTML DocType declaration
 :rtype: string

 Helps you generate document type declarations, or DTD's. HTML 5
 Helps you generate document type declarations (DTD's). HTML 5
 is used by default, but many doctypes are available.

 Example:
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs: Change tags to elements and fix some typos helpers/html_helper.rst#9153

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

 Merged

kenjis
merged 3 commits into

from

Aug 27, 2024
 Merged


docs: Change tags to elements and fix some typos helpers/html_helper.rst
#9153
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
90513e3

docs: Change tags to elements and fix some typos helpers/html_helper.rst


obozdag Aug 27, 2024
6bd60da

Fix decleration to declaration in helpers/html_helper.rst


obozdag Aug 27, 2024
366f7d7

docs: Fix element names in helpes/html_helper.rst


obozdag Aug 27, 2024

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


57 changes: 28 additions & 29 deletions
user_guide_src/source/helpers/html_helper.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,7 @@
HTML Helper
###########

The HTML Helper file contains functions that assist in working with
HTML.
The HTML Helper file contains functions that assist in working with HTML.

.. contents::
 :local:
Expand DownExpand Up@@ -31,10 +30,10 @@ The following functions are available:
 :param string|array $src: Image source URI, or array of attributes and values
 :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
 :param mixed $attributes: Additional HTML attributes
 :returns: HTML image tag
 :returns: HTML image element
 :rtype: string

 Lets you create HTML ``<img />`` tags. The first parameter contains the
 Lets you create HTML ``<img>`` elements. The first parameter contains the
 image source. Example:

 .. literalinclude:: html_helper/002.php
Expand DownExpand Up@@ -84,10 +83,10 @@ The following functions are available:
 :param string $media: Media type
 :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
 :param string $hreflang: Hreflang type
 :returns: HTML link tag
 :returns: An HTML link element
 :rtype: string

 Lets you create HTML ``<link />`` tags. This is useful for stylesheet links,
 Lets you create HTML ``<link>`` elements. This is useful for stylesheet links,
 as well as other links. The parameters are *href*, with optional *rel*,
 *type*, *title*, *media* and *indexPage*.

Expand All@@ -111,10 +110,10 @@ The following functions are available:

 :param array|string $src: The source name or URL of a JavaScript file, or an associative array specifying the attributes
 :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
 :returns: HTML script tag
 :returns: An HTML script element
 :rtype: string

 Lets you create HTML ``<script></script>`` tags. The parameters is *src*, with optional *indexPage*.
 Lets you create HTML ``<script>`` elements. The parameters are *src* and optional *indexPage*.

 *indexPage* is a boolean value that specifies if the *src* should have
 the page specified by ``$config['indexPage']`` added to the address it creates.
Expand All@@ -132,11 +131,11 @@ The following functions are available:

 :param array $list: List entries
 :param array $attributes: HTML attributes
 :returns: HTML-formatted unordered list
 :returns: An HTML unordered list element
 :rtype: string

 Permits you to generate unordered HTML lists from simple or
 multi-dimensional arrays. Example:
 Permits you to generate an unordered HTML list from a simple or
 multi-dimensional array. Example:

 .. literalinclude:: html_helper/012.php

Expand DownExpand Up@@ -205,20 +204,20 @@ The following functions are available:

 :param array $list: List entries
 :param array $attributes: HTML attributes
 :returns: HTML-formatted ordered list
 :returns: An HTML ordered list element
 :rtype: string

 Identical to :php:func:`ul()`, only it produces the ``<ol>`` tag for
 Identical to :php:func:`ul()`, only it produces ``<ol>`` element for
 ordered lists instead of ``<ul>``.

.. php:function:: video($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]])

 :param mixed $src: Either a source string or an array of sources. See :php:func:`source()` function
 :param string $unsupportedMessage: The message to display if the media tag is not supported by the browser
 :param string $unsupportedMessage: The message to display if the video element is not supported by the browser
 :param string $attributes: HTML attributes
 :param array $tracks: Use the track function inside an array. See :php:func:`track()` function
 :param bool $indexPage:
 :returns: HTML-formatted video element
 :returns: An HTML video element
 :rtype: string

 Permits you to generate HTML video element from simple or
Expand DownExpand Up@@ -253,24 +252,24 @@ The following functions are available:
.. php:function:: audio($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]])

 :param mixed $src: Either a source string or an array of sources. See :php:func:`source()` function
 :param string $unsupportedMessage: The message to display if the media tag is not supported by the browser
 :param string $unsupportedMessage: The message to display if the audio element is not supported by the browser
 :param string $attributes:
 :param array $tracks: Use the track function inside an array. See :php:func:`track()` function
 :param bool $indexPage:
 :returns: HTML-formatted audio element
 :returns: An HTML audio element
 :rtype: string

 Identical to :php:func:`video()`, only it produces the ``<audio>`` tag instead of ``<video>``.
 Identical to :php:func:`video()`, only it produces ``<audio>`` element instead of ``<video>``.

.. php:function:: source($src = ''[, $type = false[, $attributes = '']])

 :param string $src: The path of the media resource
 :param bool $type: The MIME-type of the resource with optional codecs parameters
 :param array $attributes: HTML attributes
 :returns: HTML source tag
 :returns: An HTML source element
 :rtype: string

 Lets you create HTML ``<source />`` tags. The first parameter contains the
 Lets you create HTML ``<source>`` elements. The first parameter contains the
 source source. Example:

 .. literalinclude:: html_helper/015.php
Expand All@@ -281,10 +280,10 @@ The following functions are available:
 :param bool $type: MIME-type
 :param array $attributes: HTML attributes
 :param bool $indexPage:
 :returns: HTML embed tag
 :returns: An HTML embed element
 :rtype: string

 Lets you create HTML ``<embed />`` tags. The first parameter contains the
 Lets you create HTML ``<embed>`` elements. The first parameter contains the
 embed source. Example:

 .. literalinclude:: html_helper/016.php
Expand All@@ -295,10 +294,10 @@ The following functions are available:
 :param bool $type: Content-type of the resource
 :param array $attributes: HTML attributes
 :param array $params: Use the param function inside an array. See :php:func:`param()` function
 :returns: HTML object tag
 :returns: An HTML object element
 :rtype: string

 Lets you create HTML ``<object />`` tags. The first parameter contains the
 Lets you create HTML ``<object>`` elements. The first parameter contains the
 object data. Example:

 .. literalinclude:: html_helper/017.php
Expand All@@ -319,10 +318,10 @@ The following functions are available:
 :param string $name: The name of the parameter
 :param string $value: The value of the parameter
 :param array $attributes: HTML attributes
 :returns: HTML param tag
 :returns: An HTML param element
 :rtype: string

 Lets you create HTML ``<param />`` tags. The first parameter contains the
 Lets you create HTML ``<param>`` elements. The first parameter contains the
 param source. Example:

 .. literalinclude:: html_helper/018.php
Expand All@@ -332,7 +331,7 @@ The following functions are available:
 :param string $name: The name of the parameter
 :param string $value: The value of the parameter
 :param array $attributes: HTML attributes
 :returns: HTML track tag
 :returns: An HTML track element
 :rtype: string

 Generates a track element to specify timed tracks. The tracks are
Expand All@@ -343,10 +342,10 @@ The following functions are available:
.. php:function:: doctype([$type = 'html5'])

 :param string $type: Doctype name
 :returns: HTML DocType tag
 :returns: An HTML DocType declaration
 :rtype: string

 Helps you generate document type declarations, or DTD's. HTML 5
 Helps you generate document type declarations (DTD's). HTML 5
 is used by default, but many doctypes are available.

 Example:
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
docs: Change tags to elements and fix some typos helpers/html_helper.rst#9153

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

 Merged

kenjis
merged 3 commits into

from

Aug 27, 2024
 Merged


docs: Change tags to elements and fix some typos helpers/html_helper.rst
#9153
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
90513e3

docs: Change tags to elements and fix some typos helpers/html_helper.rst


obozdag Aug 27, 2024
6bd60da

Fix decleration to declaration in helpers/html_helper.rst


obozdag Aug 27, 2024
366f7d7

docs: Fix element names in helpes/html_helper.rst


obozdag Aug 27, 2024

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


57 changes: 28 additions & 29 deletions
user_guide_src/source/helpers/html_helper.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,7 @@
HTML Helper
###########

The HTML Helper file contains functions that assist in working with
HTML.
The HTML Helper file contains functions that assist in working with HTML.

.. contents::
 :local:
Expand DownExpand Up@@ -31,10 +30,10 @@ The following functions are available:
 :param string|array $src: Image source URI, or array of attributes and values
 :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
 :param mixed $attributes: Additional HTML attributes
 :returns: HTML image tag
 :returns: HTML image element
 :rtype: string

 Lets you create HTML ``<img />`` tags. The first parameter contains the
 Lets you create HTML ``<img>`` elements. The first parameter contains the
 image source. Example:

 .. literalinclude:: html_helper/002.php
Expand DownExpand Up@@ -84,10 +83,10 @@ The following functions are available:
 :param string $media: Media type
 :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
 :param string $hreflang: Hreflang type
 :returns: HTML link tag
 :returns: An HTML link element
 :rtype: string

 Lets you create HTML ``<link />`` tags. This is useful for stylesheet links,
 Lets you create HTML ``<link>`` elements. This is useful for stylesheet links,
 as well as other links. The parameters are *href*, with optional *rel*,
 *type*, *title*, *media* and *indexPage*.

Expand All@@ -111,10 +110,10 @@ The following functions are available:

 :param array|string $src: The source name or URL of a JavaScript file, or an associative array specifying the attributes
 :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
 :returns: HTML script tag
 :returns: An HTML script element
 :rtype: string

 Lets you create HTML ``<script></script>`` tags. The parameters is *src*, with optional *indexPage*.
 Lets you create HTML ``<script>`` elements. The parameters are *src* and optional *indexPage*.

 *indexPage* is a boolean value that specifies if the *src* should have
 the page specified by ``$config['indexPage']`` added to the address it creates.
Expand All@@ -132,11 +131,11 @@ The following functions are available:

 :param array $list: List entries
 :param array $attributes: HTML attributes
 :returns: HTML-formatted unordered list
 :returns: An HTML unordered list element
 :rtype: string

 Permits you to generate unordered HTML lists from simple or
 multi-dimensional arrays. Example:
 Permits you to generate an unordered HTML list from a simple or
 multi-dimensional array. Example:

 .. literalinclude:: html_helper/012.php

Expand DownExpand Up@@ -205,20 +204,20 @@ The following functions are available:

 :param array $list: List entries
 :param array $attributes: HTML attributes
 :returns: HTML-formatted ordered list
 :returns: An HTML ordered list element
 :rtype: string

 Identical to :php:func:`ul()`, only it produces the ``<ol>`` tag for
 Identical to :php:func:`ul()`, only it produces ``<ol>`` element for
 ordered lists instead of ``<ul>``.

.. php:function:: video($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]])

 :param mixed $src: Either a source string or an array of sources. See :php:func:`source()` function
 :param string $unsupportedMessage: The message to display if the media tag is not supported by the browser
 :param string $unsupportedMessage: The message to display if the video element is not supported by the browser
 :param string $attributes: HTML attributes
 :param array $tracks: Use the track function inside an array. See :php:func:`track()` function
 :param bool $indexPage:
 :returns: HTML-formatted video element
 :returns: An HTML video element
 :rtype: string

 Permits you to generate HTML video element from simple or
Expand DownExpand Up@@ -253,24 +252,24 @@ The following functions are available:
.. php:function:: audio($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]])

 :param mixed $src: Either a source string or an array of sources. See :php:func:`source()` function
 :param string $unsupportedMessage: The message to display if the media tag is not supported by the browser
 :param string $unsupportedMessage: The message to display if the audio element is not supported by the browser
 :param string $attributes:
 :param array $tracks: Use the track function inside an array. See :php:func:`track()` function
 :param bool $indexPage:
 :returns: HTML-formatted audio element
 :returns: An HTML audio element
 :rtype: string

 Identical to :php:func:`video()`, only it produces the ``<audio>`` tag instead of ``<video>``.
 Identical to :php:func:`video()`, only it produces ``<audio>`` element instead of ``<video>``.

.. php:function:: source($src = ''[, $type = false[, $attributes = '']])

 :param string $src: The path of the media resource
 :param bool $type: The MIME-type of the resource with optional codecs parameters
 :param array $attributes: HTML attributes
 :returns: HTML source tag
 :returns: An HTML source element
 :rtype: string

 Lets you create HTML ``<source />`` tags. The first parameter contains the
 Lets you create HTML ``<source>`` elements. The first parameter contains the
 source source. Example:

 .. literalinclude:: html_helper/015.php
Expand All@@ -281,10 +280,10 @@ The following functions are available:
 :param bool $type: MIME-type
 :param array $attributes: HTML attributes
 :param bool $indexPage:
 :returns: HTML embed tag
 :returns: An HTML embed element
 :rtype: string

 Lets you create HTML ``<embed />`` tags. The first parameter contains the
 Lets you create HTML ``<embed>`` elements. The first parameter contains the
 embed source. Example:

 .. literalinclude:: html_helper/016.php
Expand All@@ -295,10 +294,10 @@ The following functions are available:
 :param bool $type: Content-type of the resource
 :param array $attributes: HTML attributes
 :param array $params: Use the param function inside an array. See :php:func:`param()` function
 :returns: HTML object tag
 :returns: An HTML object element
 :rtype: string

 Lets you create HTML ``<object />`` tags. The first parameter contains the
 Lets you create HTML ``<object>`` elements. The first parameter contains the
 object data. Example:

 .. literalinclude:: html_helper/017.php
Expand All@@ -319,10 +318,10 @@ The following functions are available:
 :param string $name: The name of the parameter
 :param string $value: The value of the parameter
 :param array $attributes: HTML attributes
 :returns: HTML param tag
 :returns: An HTML param element
 :rtype: string

 Lets you create HTML ``<param />`` tags. The first parameter contains the
 Lets you create HTML ``<param>`` elements. The first parameter contains the
 param source. Example:

 .. literalinclude:: html_helper/018.php
Expand All@@ -332,7 +331,7 @@ The following functions are available:
 :param string $name: The name of the parameter
 :param string $value: The value of the parameter
 :param array $attributes: HTML attributes
 :returns: HTML track tag
 :returns: An HTML track element
 :rtype: string

 Generates a track element to specify timed tracks. The tracks are
Expand All@@ -343,10 +342,10 @@ The following functions are available:
.. php:function:: doctype([$type = 'html5'])

 :param string $type: Doctype name
 :returns: HTML DocType tag
 :returns: An HTML DocType declaration
 :rtype: string

 Helps you generate document type declarations, or DTD's. HTML 5
 Helps you generate document type declarations (DTD's). HTML 5
 is used by default, but many doctypes are available.

 Example:
Expand Down