Skip to main content

Category Extractor

This extractor retrieves links from the description and the image from the options tab.

 

Custom Fields

Enable Custom fields

Whether to enable extracting and replacing links for custom fields at all.

Custom Fields: 'type'

There are many different types of custom fields. Only a few might contain links.

  • In a default configuration, the 'Editor' type and the 'URL' types may contain links.
    • 'Editor' is parsed as HTML,
    • 'URL' as plain text link.
  • 'Textarea' and 'Text' might contain HTML with links, depending on your sites' configuration.
    • For the 'Text' field it is more likely that these fields contain plain text links. See the setting Treat fields as Link (ids)
  • The 'Media' fields contain plain text links.

Disabling extracting for specific types has a small performance benefit.

With the Replace button, you enable one click replacement of links, ensure you have a backup or rollback option before enabling link replacements.

Treat fields as Link (ids)

If enabled, 'Text' fields are treated as HTML. However, they might be used as plain text links.

In this list, you can select which 'Text' and 'Textarea' fields should be treated as plain text.

Due to the limitation of the Joomla form-system, you will always see 'Text' and 'Textarea' fields from all components. So in the Article extractor you will see fields for Categories.

Custom Fields: subforms

Subforms are traversed, and the fields are threaded as above.

SQL fields

The returned values of a SQL type field might change over time, for example, if the query returns a list of published articles:

SELECT id AS value, title AS text from #__content where state = 1 ORDER BY value=0 desc, text ASC

If a selected value (article) is unpublished or deleted, the stored value in the SQL field is not valid anymore.

Joomla itself does not validate values during display. 

This option allows to check/validate custom fields values against the query set in the field definition.

To perform this task, the field values are extracted on stored and displayed as a kind of links: sqlfield:://<id>/<data>

Purge obsolete fields

Joomla does not delete field values if a field is deleted, unpublished or not applicable anymore (for example if the categories don't match).

Preserving the values might be handy if you move articles and fields between categories, it also clutters the database.

This option will remove obsolete values when the container is parsed.

This option does not extract or check data. It will show a message if any field values are purged.

Advanced

Link replacements

This option allows to enable/disable link replacements on a per-plugin basis.

Set the global option to Off and specific plugins to On to allow link replacement for only those plugins.

Set the global option to On and specific plugins to Off to prevent link replacement for only those plugins.

'One-click-link-replacement' is a convenient way to quickly update links. However, manually updating the link and the 'surrounding' content is often a better way to ensure the information is still consistent. 

Only extract from public visible content

Extract only links from items that have Public Access.

See the Auto login plugin for more information on checking content with access restrictions

Only extract from published content

Extract only links from items that have Published State and today is between the Publish Up and Publish Down dates, if present.

Trashed containers are never extracted.

When Saved

Whenever an item is saved the content must be scanned for links again. This can be done:

  • immediately : Re-extract links
  • on the next parse be deleting the extracted data: Delete extracted data - Links are not visible anymore in Links Menu
  • on the next parse using the modified date: Do Nothing - Links are visible in Links Menu until next extract.

Some containers like modules do not have a modified date. Use Re-extract or Delete .

When Deleted

When an item is trashed the extracted data must be removed.

  • immediately : Delete extracted data - Links are not visible anymore in the Links Menu
  • on the next parse: Do Nothing - Links are visible in Links Menu until next extract
Delete extracted data on plugin save

Plugin settings might impact the extracted data. This option allows to purge all data for a plugin whenever the plugin settings change.