Skip to content

Home

Jump to bottom
Paul Beck edited this page Mar 30, 2023 · 18 revisions

tgm_copyright

What does it do?

This extension provides three different ways to represent the copyright of files.

You can add a subtitle to every image file reference in the frontend, showing them as a wole list in your imprint or generating a xml-sitemap. It's working like title- or description-fields (including a way to override from the file metadata).

It adds a field named "copyright" to every image file reference (imageOverlayPalette) to set it's copyright-text as shown in the picture below:

Installation:

  1. Download and install the extension from the TYPO3 Extension Repository (TER) or via extension manager in your backend.
  2. Include the static TypoScript to your preferred page (root-page is recommended).
  3. Configure specific values in the constant editor if you want (see below).
  4. Add a copyright to an image in each file reference or in the filelist.

Plugin settings:

With this extension, you can add every copyright as a list into your imprint. Simply add a new plugin ("Picture Copyright List") on a page where ever you want. That's all, nothing more to do.

It'll show the title (or name) of each picture with it's copyright-text and links it to the page where it's used (based on Extbase and Fluid).

If images are used multiple times on different pages you can disable to show each usage inside the Plugin Settings.

Since 3.2.2: "Display only copyright images of the current page?"-Checkbox allows you to only show pictures with a copyright which are on the same page as the plugin.

Configuration for other extensions like "news"

Since version 1.0.0 you can configure the extension to display and link copyright-images in list plugin and the sitemap correctly. Extension records must be configured under plugin.tx_tgmcopyright_main.settings.extensiontables.database_table_name_of_extension_record (example: tx_news_domain_model_news)

For examples, see the example configurations in setup.txt. There you can also find an example for using detailPid as cObject for quering a relation to sys_category which may be holding the desired detailPid.

For each table you have two configuration options:

  • "detailPid" (string / cObject) REQUIRED!
    • A comma seperated list of pageIds or a cObject. This option must be set - otherwise fileReferences of the records won't be displayed by the extension. For each resulting detailPid a link can be generated in the FLUID Template
  • "linkParam" (string) OPTIONAL!
    • Optional additionalParams for detail views of extensions. Leave empty if you don't need additional linkParams for records detailview. The parameter string must end with "=" - after this the UID of the current record will be added automatically. Example: &tx_news_pi1[controller]=News&tx_news_pi1[news]=

If you did update from older versions than 1.0.0, you may check out the latest Copyright/List.html template to checkout the proper templating in order to create links to different pageUids and detailpages.

TypoScript constants:

  • "plugin.tx_tgmcopyright_main.settings.rootlines"
    • Starting root page-ids to take the copyright references from. All values are comma-separated, empty is equal to all rootlines.
  • "plugin.tx_tgmcopyright_main.settings.showCopyright"
    • Whether the copyright should display below images or not.
  • "plugin.tx_tgmcopyright_main.settings.createSitemap"
    • Generate an image sitemap on "yourdomain.tld/?type=1458065166".

Templating:

You can provide your own templates for the output by changing the constants.

To change the copyright text below images (if enabled), just change the following line to your imaginations:

tt_content.image.20.rendering.singleNoCaption.singleStdWrap.append.dataWrap = <p class="copyright">© |</p>

In FLUID Templates you can access the copyright of images using {fileReference.properties.copyright} or {fileReference.originalResource.properties.copyright}

Google Image Sitemap XML:

By default, the extension will create an Image Sitemap on "yourdomain.tld/?type=1458065166". It contains all images (including files without a copyright) used on the given rootlines. Images with relations to the tables "pages" and "tt_content" are represent in the sitemap by default. For other extensions, please see the configuration for other extensions above.

You can disable the sitemap-feature in the constant editor.

Make the Copyright Field Required for Editors

Since Version 2.0.0 you can enable this function in the Extension-Settings (TYPO3 Settings Module for Extension Settings). This function is experimental at the moment and only available for TYPO3 9.5 LTS.

Issues and ToDo'S:

  • Adds an extension setting to make the copyright field required. (Solved since Version 2.0.0)
  • The extension won't display pictures from workspaces in the list-plugin.
  • When upgrading from older versions, you probably have to clear the cache in the "InstallTool" to enable the image sitemap page.

Changelog:

Full changelog is available here: https://github.com/teamgeist/tgm_copyright/commits/master

Clone this wiki locally