Initial commit - Typo3 11.5.41

typo3conf/ext/news/Documentation/Reference/ViewHelpers/ExcludeDisplayedNewsViewHelper.rst

@@ -0,0 +1,47 @@
+ExcludeDisplayedNewsViewHelper
+-----------------------------------
+
+ViewHelper to exclude news items in other plugins
+
+**Type:** Basic
+
+
+General properties
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. t3-field-list-table::
+ :header-rows: 1
+
+ - :Name: Name:
+   :Type: Type:
+   :Description: Description:
+   :Default value: Default value:
+
+ - :Name:
+         \* newsItem
+   :Type:
+         Tx\_News\_Domain\_Model\_News
+   :Description:
+         current news item
+   :Default value:
+
+
+
+
+Examples
+^^^^^^^^^^^^^
+
+Basic example
+""""""""""""""""""
+
+
+
+Code: ::
+
+    <n:excludeDisplayedNews newsItem="{newsItem}" />
+
+
+Output: ::
+
+    None
+

typo3conf/ext/news/Documentation/Reference/ViewHelpers/Format/NothingViewHelper.rst

@@ -0,0 +1,28 @@
+Format / NothingViewHelper
+-------------------------------
+
+ViewHelper to render children which don't print out any actual content
+
+**Type:** Basic
+
+
+Examples
+^^^^^^^^^^^^^
+
+Basic example
+""""""""""""""""""
+
+
+
+Code: ::
+
+    <n:format.nothing>
+   <n:titleTag>{newsItem.title}</n:titleTag>
+   Fobar
+    </n:format.nothing>
+
+
+Output: ::
+
+    nothing
+

typo3conf/ext/news/Documentation/Reference/ViewHelpers/HeaderDataViewHelper.rst

@@ -0,0 +1,30 @@
+HeaderDataViewHelper
+-------------------------
+
+ViewHelper to render data in <head> section of website
+
+**Type:** Basic
+
+
+Examples
+^^^^^^^^^^^^^
+
+Basic example
+""""""""""""""""""
+
+
+
+Code: ::
+
+    <n:headerData>
+          <link rel="alternate"
+             type="application/rss+xml"
+             title="RSS 2.0"
+             href="{f:uri.page(pageType: settings.list.rss.channel.typeNum)}" />
+    </n:headerData>
+
+
+Output: ::
+
+    Added to the header: <link rel="alternate" type="application/rss+xml" title="RSS 2.0" href="uri to this page and type 9818" />
+

typo3conf/ext/news/Documentation/Reference/ViewHelpers/IncludeFileViewHelper.rst

@@ -0,0 +1,56 @@
+IncludeFileViewHelper
+--------------------------
+
+ViewHelper to include a css/js file
+
+**Type:** Basic
+
+
+General properties
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. t3-field-list-table::
+ :header-rows: 1
+
+ - :Name: Name:
+   :Type: Type:
+   :Description: Description:
+   :Default value: Default value:
+
+ - :Name:
+         compress
+   :Type:
+         boolean
+   :Description:
+         Define if file should be compressed
+   :Default value:
+
+
+ - :Name:
+         \* path
+   :Type:
+         string
+   :Description:
+         Path to the CSS/JS file which should be included
+   :Default value:
+
+
+
+
+Examples
+^^^^^^^^^^^^^
+
+Basic example
+""""""""""""""""""
+
+
+
+Code: ::
+
+    <n:includeFile path="{settings.cssFile}" />
+
+
+Output: ::
+
+    This will include the file provided by {settings} in the header
+

typo3conf/ext/news/Documentation/Reference/ViewHelpers/Index.rst

@@ -0,0 +1,47 @@
+.. include:: /Includes.rst.txt
+
+.. highlight:: html
+
+.. _viewHelpersReference:
+
+=====================
+ViewHelpers reference
+=====================
+
+In order to use the ViewHelpers provided by this extension, you need to include
+them in the :html:`<html>` tag of your template or partial:
+
+.. code-block:: html
+
+   <html xmlns:n="http://typo3.org/ns/GeorgRinger/News/ViewHelpers"
+         xmlns:f="http://typo3.org/ns/TYPO3/CMS/Fluid/ViewHelpers"
+         data-namespace-typo3-fluid="true">
+
+You can find all available ViewHelpers in the folder
+:file:`EXT:news/Classes/ViewHelpers`.
+
+.. todo: Automatically document the ViewHelpers
+
+
+All ViewHelpers
+===============
+
+.. toctree::
+   :maxdepth: 5
+   :titlesonly:
+   :glob:
+
+   ExcludeDisplayedNewsViewHelper
+   HeaderDataViewHelper
+   IncludeFileViewHelper
+   LinkViewHelper
+   MediaFactoryViewHelper
+   MetaTagViewHelper
+   PaginateBodytextViewHelper
+   TargetLinkViewHelper
+   TitleTagViewHelper
+
+   Format/NothingViewHelper
+
+   Widget/PaginateViewHelper
+

typo3conf/ext/news/Documentation/Reference/ViewHelpers/LinkViewHelper.rst

@@ -0,0 +1,219 @@
+.. include:: /Includes.rst.txt
+
+.. _viewHelperLink:
+
+LinkViewHelper
+-------------------
+
+ViewHelper to render links from news records to detail view or page
+
+**Type:** Tag Based
+
+
+General properties
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. t3-field-list-table::
+ :header-rows: 1
+
+ - :Name: Name:
+   :Type: Type:
+   :Description: Description:
+   :Default value: Default value:
+
+ - :Name:
+         accesskey
+   :Type:
+         string
+   :Description:
+         Keyboard shortcut to access this element
+   :Default value:
+
+
+ - :Name:
+         additionalAttributes
+   :Type:
+         array
+   :Description:
+         Additional tag attributes. They will be added directly to the resulting HTML tag.
+   :Default value:
+
+
+ - :Name:
+         class
+   :Type:
+         string
+   :Description:
+         CSS class(es) for this element
+   :Default value:
+
+
+ - :Name:
+         configuration
+   :Type:
+         array
+   :Description:
+         optional typolink configuration
+   :Default value:
+         Array
+
+ - :Name:
+         dir
+   :Type:
+         string
+   :Description:
+         Text direction for this HTML element. Allowed strings\: "ltr" (left to right), "rtl" (right to left)
+   :Default value:
+
+
+ - :Name:
+         id
+   :Type:
+         string
+   :Description:
+         Unique (in this file) identifier for this HTML element.
+   :Default value:
+
+
+ - :Name:
+         lang
+   :Type:
+         string
+   :Description:
+         Language for this element. Use short names specified in RFC 1766
+   :Default value:
+
+
+ - :Name:
+         \* newsItem
+   :Type:
+         Tx\_News\_Domain\_Model\_News
+   :Description:
+         current news object
+   :Default value:
+
+
+ - :Name:
+         onclick
+   :Type:
+         string
+   :Description:
+         JavaScript evaluated for the onclick event
+   :Default value:
+
+
+ - :Name:
+         settings
+   :Type:
+         array
+   :Description:
+
+   :Default value:
+         Array
+
+ - :Name:
+         style
+   :Type:
+         string
+   :Description:
+         Individual CSS styles for this element
+   :Default value:
+
+
+ - :Name:
+         tabindex
+   :Type:
+         integer
+   :Description:
+         Specifies the tab order of this element
+   :Default value:
+
+
+ - :Name:
+         title
+   :Type:
+         string
+   :Description:
+         Tooltip text of element
+   :Default value:
+
+
+ - :Name:
+         uriOnly
+   :Type:
+         boolean
+   :Description:
+         return only the url without the a-tag
+   :Default value:
+
+
+
+
+Examples
+^^^^^^^^^^^^^
+
+Basic link
+"""""""""""""""
+
+
+
+Code: ::
+
+    <n:link newsItem="{newsItem}" settings="{settings}">
+       {newsItem.title}
+    </n:link>
+
+
+Output: ::
+
+    A link to the given news record using the news title as link text
+
+
+
+Set an additional attribute
+""""""""""""""""""""""""""""""""
+
+Available: class, dir, id, lang, style, title, accesskey, tabindex, onclick
+
+Code: ::
+
+    <n:link newsItem="{newsItem}" settings="{settings}" class="a-link-class">fo</n:link>
+
+
+Output: ::
+
+    <a href="link" class="a-link-class">fo</n:link>
+
+
+
+Return the link only
+"""""""""""""""""""""""""
+
+
+
+Code: ::
+
+    <n:link newsItem="{newsItem}" settings="{settings}" uriOnly="1" />
+
+
+Output: ::
+
+    The uri is returned
+
+
+
+Add additional parameters to the url
+""""""""""""""""""""""""""""""""""""
+
+
+
+Code: ::
+
+    <n:link newsItem="{newsItem}" settings="{settings}" configuration="{additionalParams:'&tx_news_pi1[category]=111'}">fo</n:link>
+
+
+Output: ::
+
+    <a href="link&tx_news_pi1[category]=111">fo</n:link>
+
+

typo3conf/ext/news/Documentation/Reference/ViewHelpers/MediaFactoryViewHelper.rst

@@ -0,0 +1,54 @@
+MediaFactoryViewHelper
+---------------------------
+
+ViewHelper to show videos
+
+**Type:** Basic
+
+
+General properties
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. t3-field-list-table::
+ :header-rows: 1
+
+ - :Name: Name:
+   :Type: Type:
+   :Description: Description:
+   :Default value: Default value:
+
+ - :Name:
+         \* classes
+   :Type:
+         string
+   :Description:
+         list of classes which are used to render the media object
+   :Default value:
+         
+
+ - :Name:
+         \* element
+   :Type:
+         Tx\_News\_Domain\_Model\_Media
+   :Description:
+         Current media object
+   :Default value:
+         
+
+ - :Name:
+         \* height
+   :Type:
+         integer
+   :Description:
+         height
+   :Default value:
+         
+
+ - :Name:
+         \* width
+   :Type:
+         integer
+   :Description:
+         width
+   :Default value:
+

typo3conf/ext/news/Documentation/Reference/ViewHelpers/MetaTagViewHelper.rst

@@ -0,0 +1,108 @@
+MetaTagViewHelper
+----------------------
+
+ViewHelper to render meta tags
+
+**Type:** Tag Based
+
+
+General properties
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. t3-field-list-table::
+ :header-rows: 1
+
+ - :Name: Name:
+   :Type: Type:
+   :Description: Description:
+   :Default value: Default value:
+
+ - :Name:
+         additionalAttributes
+   :Type:
+         array
+   :Description:
+         Additional tag attributes. They will be added directly to the resulting HTML tag.
+   :Default value:
+
+
+ - :Name:
+         content
+   :Type:
+         string
+   :Description:
+         Content of meta tag
+   :Default value:
+
+
+ - :Name:
+         forceAbsoluteUrl
+   :Type:
+         boolean
+   :Description:
+         If set, absolute url is forced
+   :Default value:
+
+
+ - :Name:
+         property
+   :Type:
+         string
+   :Description:
+         Property of meta tag
+   :Default value:
+
+
+ - :Name:
+         useCurrentDomain
+   :Type:
+         boolean
+   :Description:
+         If set, current domain is used
+   :Default value:
+
+
+ - :Name:
+         name
+   :Type:
+         string
+   :Description:
+         If set, the meta tag is built by using the attribute name="" instead of property
+   :Default value:
+
+
+
+
+Examples
+^^^^^^^^^^^^^
+
+Basic Example: News title as og:title meta tag
+"""""""""""""""""""""""""""""""""""""""""""""""""""
+
+
+
+Code: ::
+
+    <n:metaTag property="og:title" content="{newsItem.title}" />
+
+
+Output: ::
+
+    <meta property="og:title" content="TYPO3 is awesome" />
+
+
+
+Force the attribute "name"
+"""""""""""""""""""""""""""""""
+
+
+
+Code: ::
+
+    <n:metaTag name="keywords" content="{newsItem.keywords}" />
+
+
+Output: ::
+
+    <meta name="keywords" content="news 1, news 2" />
+

typo3conf/ext/news/Documentation/Reference/ViewHelpers/PaginateBodytextViewHelper.rst

@@ -0,0 +1,55 @@
+PaginateBodytextViewHelper
+-------------------------------
+
+Paginate the bodytext which is very useful for longer texts or to increase
+
+**Type:** Basic
+
+
+General properties
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. t3-field-list-table::
+ :header-rows: 1
+
+ - :Name: Name:
+   :Type: Type:
+   :Description: Description:
+   :Default value: Default value:
+
+ - :Name:
+         \* as
+   :Type:
+         string
+   :Description:
+         name of property which holds the text
+   :Default value:
+         
+
+ - :Name:
+         \* currentPage
+   :Type:
+         integer
+   :Description:
+         Selected page
+   :Default value:
+         
+
+ - :Name:
+         \* object
+   :Type:
+         Tx\_News\_Domain\_Model\_News
+   :Description:
+         current news object
+   :Default value:
+         
+
+ - :Name:
+         token
+   :Type:
+         string
+   :Description:
+         Token used to split the text
+   :Default value:
+         ###more###
+

typo3conf/ext/news/Documentation/Reference/ViewHelpers/TargetLinkViewHelper.rst

@@ -0,0 +1,47 @@
+TargetLinkViewHelper
+-------------------------
+
+ViewHelper to get the target out of the typolink
+
+**Type:** Basic
+
+
+General properties
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. t3-field-list-table::
+ :header-rows: 1
+
+ - :Name: Name:
+   :Type: Type:
+   :Description: Description:
+   :Default value: Default value:
+
+ - :Name:
+         \* link
+   :Type:
+         string
+   :Description:
+
+   :Default value:
+
+
+
+
+Examples
+^^^^^^^^^^^^^
+
+Basic Example
+""""""""""""""""""
+
+{relatedLink.uri} is defined as "123 _blank"
+
+Code: ::
+
+    <f:link.page pageUid="{relatedLink.uri}" target="{n:targetLink(link:relatedLink.uri)}">Link</Link>
+
+
+Output: ::
+
+    A link to the page with uid 123 and target set to "_blank"
+

typo3conf/ext/news/Documentation/Reference/ViewHelpers/TitleTagViewHelper.rst

@@ -0,0 +1,25 @@
+TitleTagViewHelper
+-----------------------
+
+ViewHelper to render the page title
+
+**Type:** Basic
+
+
+Examples
+^^^^^^^^^^^^^
+
+Basic Example
+""""""""""""""""""
+
+Render the content of the VH as page title
+
+Code: ::
+
+   <n:titleTag>{newsItem.title}</n:titleTag>
+
+
+Output: ::
+
+   <title>TYPO3 is awesome</title>
+

typo3conf/ext/news/Documentation/Reference/ViewHelpers/Widget/PaginateViewHelper.rst

@@ -0,0 +1,45 @@
+Widget / PaginateViewHelper
+--------------------------------
+
+This ViewHelper renders a Pagination of objects.
+
+**Type:** Widget
+
+
+General properties
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. t3-field-list-table::
+ :header-rows: 1
+
+ - :Name: Name
+   :Type: Type
+   :Description: Description
+   :Default value: Default value
+
+ - :Name:
+         \* as
+   :Type:
+         string
+   :Description:
+
+   :Default value:
+
+
+ - :Name:
+         configuration
+   :Type:
+         mixed
+   :Description:
+
+   :Default value:
+         Array
+
+ - :Name:
+         \* objects
+   :Type:
+         TYPO3\\CMS\\Extbase\\Persistence\\QueryResultInterface
+   :Description:
+
+   :Default value:
+