Skip to content

Commit

Permalink
[TASK] Move SEO informations for editors from EXT:seo manual
Browse files Browse the repository at this point in the history
See also https://forge.typo3.org/issues/105886

releases: main, 13.4
  • Loading branch information
linawolf committed Jan 6, 2025
1 parent 08e0b7d commit 1aa0d0f
Show file tree
Hide file tree
Showing 6 changed files with 307 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions Documentation/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ the `Official Introduction Package <https://extensions.typo3.org/extension/intro
ListModule/Index
FileModule/Index
Languages/Index
SearchEngineOptimization/Index
AccessControl/Index
DeepLinking/Index
HelpInside/Index
Expand Down
63 changes: 63 additions & 0 deletions Documentation/SearchEngineOptimization/DashboardWidgets.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
:navigation-title: Dashboard
.. include:: /Includes.rst.txt
.. _dashboard-widgets:

===============================================================
Dashboard widgets for Search engine optimization (SEO) in TYPO3
===============================================================

The following dashboard widgets are available to editors if your integrator
installed the system extension :composer:`typo3/cms-seo` and if you have been
granted the permissions to use them.

.. _dashboard-widgets-missing-description:

"Missing Meta Description" widget
=================================

To make it more convenient for TYPO3 editors to optimize their website for search
engines, :composer:`typo3/cms-seo` offers a dashboard widget that shows pages without
a meta description.

The description field is important for SEO purposes. This field is used to
instruct search engines to use this text to show as a teaser of your page in
the search result snippets. With this description, you can give the user a
clear overview of the topic of this page:

.. _dashboard-widgets-missing-description-add:

Adding the "Missing Meta Description" widget to your personal Dashboard
-----------------------------------------------------------------------

If you have the access rights to the Dashboard module and are granted access to
the "Missing Meta Description" widget you can add it yourself to your Dashboard:

.. figure:: /Images/ManualScreenshots/SearchEngineOptimization/add-widget.png
:alt: Screenshot of the backend, showing the widget "Pages missing Meta Description" in category "SEO"

Adding the widget "Pages missing Meta Description"

#. Open the Dashboard module
#. Click on the plus button to add a widget
#. Go to category "SEO"
#. Choose widget "Pages missing Meta Description"


.. _dashboard-widgets-missing-description-use:

Using the "Missing Meta Description" widget to improve SEO results
------------------------------------------------------------------

Therefore this widget lists pages without a description in their meta data:

.. figure:: /Images/ManualScreenshots/SearchEngineOptimization/pages-missing-description.png
:alt: Screenshot a widget listing pages without description

Pages without description listed in the Dashboard

You can now click on the pencil icon to add a description to the page:

.. figure:: /Images/ManualScreenshots/SearchEngineOptimization/addDescription.png
:alt: Screenshot of an edit form showing just the description field

Add a description to the page
243 changes: 243 additions & 0 deletions Documentation/SearchEngineOptimization/Index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,243 @@
:navigation-title: SEO
.. include:: /Includes.rst.txt

.. _seo:

==================================================
Search engine optimization (SEO) for TYPO3 editors
==================================================

Welcome to our small SEO introduction.
We will explain the basic fields the TYPO3 core provides and introduce the SEO
tools this way.

All the following fields are part of the page record.

You can reach it by:

* Open the :guilabel:`Web > Page` module
* Use the pen (`Edit page properties`) in the top bar icon to edit the
page record.

An alternative way is to use the context menu.

* Open :guilabel:`Web > Page` module
* Right click the page you want to edit in the page tree
* Select the Edit action

.. toctree::
:hidden:
:glob:

*

.. _seo-page-properties-general:

General tab
===========

.. figure:: ../Images/tab-general.png
:class: with-shadow
:alt: General Tab in the TYPO3 Backend

`General` Tab in the TYPO3 Backend

.. _seo-page-properties-general-title:

Page Title
----------

The page title field is used for several purposes. From a SEO perspective
it is mainly used to define the default URL segment and as a fallback title,
if you do not set a specific SEO title. More information about the usage of
the title fields can be found at :ref:`title-for-search-engines`.

.. _seo-page-properties-general-url-segment:

URL Segment (slug)
------------------

The URL segment is the part of the URL the user enters to access your page.
Depending on your use case URLs have to fulfill certain criteria.

By default the URL segment is based on the page tree and page title, but you
can override this and set it yourself.

If you want to optimize your page for search engines, it is recommended to
have at least the keyword you want to be found on in your URL segment.
Please make sure to check other best practices with your SEO specialist.

.. _seo-page-properties-seo:

SEO Tab
=======

.. _title-for-search-engines:

Title for search engines
------------------------

The :guilabel:`Title for search engines` field is used for the
`<title>...</title>` tag of your web page. This title is used in the
search results of search engines. There are some best practices for
the value of this field.

* Use a speaking title, which targets your audience
* If possible, use the keywords you want to be found on in the title
* Please make sure your title fits in a Google Snippet. You can use
third party extensions to help you with this.

When no value for the :guilabel:`Title for search engines` field is defined,
it will have a fallback to the field :guilabel:`Page title`. It will show the
page title in the search results in that case.

The title can have the name of the site as a prefix or suffix. The behaviour
of this can be defined by an integrator.

By default the title will have the name of the site as a suffix,
separated by a dash.

.. _seo-page-properties-description:

Description
-----------

The description field is important for SEO purposes. This field is used to
instruct search engines to use this text to show as a teaser of your page in
the search result snippets. With this description, you can give the user a
clear overview of the topic of this page.

.. hint::

It is best practice to use at least the keywords you want to be found on in this description. Make sure the
description is not too long, so it fits in the search result snippets.

.. seealso::
You can use the :ref:`dashboard-widgets-missing-description` to get an
overview of all pages without a description and edit them directly.

.. _seo-page-properties-index-page:

Index this page
---------------

Defines whether the page should be indexed by a search engine or not.
Disabling indexing also removes the page from the XML sitemap.

.. _seo-page-properties-follow-page:

Follow this page
----------------

Defines whether search engines should follow the links on this page.

.. _seo-page-properties-canonical:

Canonical link
--------------

You want to avoid duplicate content because your ranking can suffer from this.
If you have duplicate content, you have to link to the origin of the content.
This can be an internal page or an external page. You can use the default link
wizard of TYPO3 to select the destination. If you don't set a canonical
link yourself, TYPO3 will generate a link to the current page.

.. hint::

Avoid duplicate content warnings by supplying the original source of this content.

.. _seo-page-properties-frequency:

Change frequency
----------------

This field is used in the XML sitemap and will give search engines a hint
how often the content of your page is likely to change.

For example: News in an archive are “never” updated, while your home page
might get “weekly” updates.

.. hint::

Please be aware that this just gives a hint to search engines and
search engines can also ignore this information if they have better
information regarding the change frequency.

.. _seo-page-properties-priority:

Priority
--------

The priority is also used in the XML sitemap. Priority allows you to define
how important the page is compared to other pages on your site. The priority
is stated in a value from 0 to 1. Your most important pages can get an higher
priority as other pages. This value does not affect how important your pages
are compared to pages of other websites. All pages and records get a priority
of 0.5 by default.

.. hint::

Please be aware that this just gives a hint to search engines and search
engines can also ignore this information if they think they have better
information regarding the change frequency.

.. _seo-page-properties-social-media:

Social media
============

The `social media` tab contains information which is used to enrich the snippet
that is shown when visitors share your URLs in social networks, modern browsers
etc.

TYPO3 offers to have different content for OpenGraph (used for example by
Facebook and LinkedIn) and X (formerly Twitter) Cards.

Both implementations allow you to set a title, a description and to provide an
image. When this information is not set manually, the social network will
decide itself what to show. Most probably it will use the information from
:ref:`title-for-search-engines` and :ref:`seo-page-properties-social-media-description`.

.. _seo-page-properties-social-media-title:

Title
-----

This title can be specified to be shown as the title of the snippet preview
when your page is shared on the social network. You only have to fill this
field when you want a different title as in the search results.

.. _seo-page-properties-social-media-description:

Description
-----------

Used to adjust the description of the preview snippet when your page is shared
at a social network. You only have to fill this field when you want a different
description as the description in the search results.

.. _seo-page-properties-social-media-image:

Image
-----

You can specify the image that should be shown when your page is shared on a
social network. Please be aware that the different social networks need specific
dimensions for an image. TYPO3 ships with the most used dimension. If you want
to have more dimensions, please let your integrator add more dimensions.

.. hint::

It is best practice to add an image for social networks so your result
will stand out and will be easily recognizable.

.. _seo-page-properties-metadata:

Metadata Tab
============

The `Metadata` tab contains a list of elements like `Abstract`, `Keywords`
and editorial information.

Some site packages may utilize this for embedding within your frontend. They
are not output by default

0 comments on commit 1aa0d0f

Please sign in to comment.