[RELEASE] Release of version 3.0.0

Yoast · Jul 25, 2018 · 0dc36cd · 0dc36cd
1 parent bd88d60
commit 0dc36cd
Show file tree

Hide file tree

Showing 13 changed files with 259 additions and 157 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,32 @@ This changelog is according to [Keep a Changelog](http://keepachangelog.com).
 All notable changes to this project will be documented in this file.
 We will follow [Semantic Versioning](http://semver.org/).
 
+## 3.0.0 July 25, 2018
+### Breaking changes
+* We removed the configuration for EXT:news and EXT:cal. It worked for people with these extension installed, but for
+several other people it was giving errors and warnings. If you are using EXT:news or EXT:cal, please see our manual to
+get info on how to configure EXT:news or EXT:cal to use Yoast SEO for TYPO3.
+
+### Added
+* A feature a lot of people been waiting for: a sitemap.xml feature. Please check the manual how to configure it for your situation.
+* For older TYPO3 versions, we added a PNG icon for the extension.
+* We filter out script and style tags in the content for the snippet preview so you won't see any inline JavaScript or CSS anymore in your snippet preview.
+
+### Changed
+* Updated YoastSEO.js to version 1.35.5
+* We did some cleanups in the TypoScript configuration
+* Added some template for issue and pull request creation on GitHub
+* Updated license with additional terms
+
+### Fixed
+* It is now possible to have quotes in your title or description without getting warnings.
+* When you have a multi language site, the preview URL of your translation will now be determined correctly.
+* When you configure Yoast SEO for TYPO3 on your own records, it is now possible (but not recommended) to have the title field on another tab as the snippet preview.
+* A stupid mistake: the overview of pages without description was actually checking if a SEO title was filled. We fixed that!
+* We added some database fields to prevent errors in the database migration tool.
+* Also for translated pages the og:image and twitter:image is working correctly now.
+* The module icons are now also working correctly in Internet Explorer
+
 ## 2.1.0 March 9, 2018
 ### Added
 * You can now mark a page as cornerstone content. Cornerstone content have more strict analysis because it are the most important pages on your website.

diff --git a/Documentation/Administrator/Index.rst b/Documentation/Administrator/Index.rst
diff --git a/Documentation/Configuration/Index.rst b/Documentation/Configuration/Index.rst
@@ -0,0 +1,27 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../Includes.txt
+
+
+.. _configuration:
+
+Configuration
+=============
+
+There is no need for configuration although it is recommended to remove all other SEO related plugins creating metatags in frontend.
+
+However, a few things can still be configured using an extension that overwrites the `EXTCONF` of `yoast_seo` or by TypoScript.
+
+.. toctree::
+	:maxdepth: 5
+	:titlesonly:
+
+    	Permissions/Index
+    	Rendering/Index
+    	SnippetPreview/Index
+    	Social/Index
+    	TCA/Index
+    	OtherPlugins/Index
diff --git a/Documentation/Integrator/Index.rst → ...tion/Configuration/OtherPlugins/Index.rst b/Documentation/Integrator/Index.rst → ...tion/Configuration/OtherPlugins/Index.rst
@@ -3,19 +3,18 @@
 .. --------------------------------------------------
 .. -*- coding: utf-8 -*- with BOM.
 
-.. include:: ../Includes.txt
+.. include:: ../../Includes.txt
 
 
-.. _integrator-manual:
+.. _otherplugins:
 
-Integrator Manual
-=================
+Other plugins
+=============
 
 How to integrate in other plugins
 ---------------------------------
-From version 2.0 of Yoast SEO for TYPO3, the snippet preview and content- and SEO-analysis are TCA fields. The plugin
-already integrated the preview and analysis within page records but also in EXT:news records. If you want more type of
-records to use the SEO functions from Yoast SEO you have to add some fields to the TCA.
+From version 2.0 of Yoast SEO for TYPO3, the snippet preview and content- and SEO-analysis are TCA fields. By default the
+SEO analysis is only done on pages. If you want more type of records to use the SEO functions from Yoast SEO you have to add some fields to the TCA.
 
 .. code-block:: php
 
@@ -86,7 +85,7 @@ How to use the snippet preview in other plugins
 -----------------------------------------------
 One important thing to know is that the snippet preview of records other than pages, only works when you have set a
 proper preview link. The only thing you need to do is set some PageTsconfig. More information about the configuration of
-the preview links can be found in the `documentation <https://docs.typo3.org/typo3cms/TSconfigReference/PageTsconfig/TceMain.html#preview>`__.\
+the preview links can be found in the `documentation <https://docs.typo3.org/typo3cms/TSconfigReference/PageTsconfig/TceMain.html#preview>`__.
 
 An example configuration of the preview links for EXT:news records is:
 

diff --git a/Documentation/Configuration/Permissions/Index.rst b/Documentation/Configuration/Permissions/Index.rst
@@ -0,0 +1,18 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+.. _permissions:
+
+Permissions
+===========
+
+Access rights
+-------------
+Since version 2 of Yoast SEO for TYPO3, you can set permissions by setting the permissions to fields and backend modules
+in the backend group permissions. All fields are exclude fields and all modules can be turned on or of separately.
+You don't need specific configuration anymore.
diff --git a/Documentation/Configuration/Rendering/Index.rst b/Documentation/Configuration/Rendering/Index.rst
@@ -0,0 +1,18 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+.. _rendering:
+
+Disable rendering Yoast SEO meta tags
+=====================================
+
+If you use a specific page type for something like a print-only template you can disable the rendering of additional markup.
+
+.. code-block:: typoscript
+
+    printPage.config.yoast_seo.enabled = 0
diff --git a/Documentation/Configuration/SnippetPreview/Index.rst b/Documentation/Configuration/SnippetPreview/Index.rst
@@ -0,0 +1,41 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+.. _snippetpreview:
+
+Snippet Preview
+===============
+
+Enable snippet preview on specific page types
+---------------------------------------------
+By default, the snippet preview is only shown on pages with doktype 1 (Standard page) and 6 (Backend user section). You can
+add your own doktypes like the example below.
+
+.. code-block:: typoscript
+
+    module.tx_yoastseo {
+        settings {
+            allowedDoktypes {
+                blog = 137
+            }
+        }
+    }
+
+Disable snippet preview with PageTs
+-----------------------------------
+Sometimes only a check on doktype isn't enough for disabling the snippet preview. For example if you want to hide the
+snippet preview on detail pages of for example a news item, you need more than a check on a doktype. That is why you can
+also disable the snippet preview based on PageTs. Below an example to hide page if it is a subpage of page with id 4.
+
+.. code-block:: typoscript
+
+    [PIDupinRootline = 4]
+        mod.web_SeoPlugin {
+            disableSnippetPreview = 1
+        }
+    [global]
diff --git a/Documentation/Configuration/Social/Index.rst b/Documentation/Configuration/Social/Index.rst
@@ -0,0 +1,55 @@
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. include:: ../../Includes.txt
+
+
+.. _social:
+
+Social media settings
+=====================
+
+Open Graph / Twitter cards
+--------------------------
+
+If you select an image for Open Graph or Twitter Cards <meta /> tags you can specify the dimensions of the
+image shared. You can change the width and height by TypoScript.
+
+.. code-block:: typoscript
+
+    plugin.tx_yoastseo {
+        settings {
+            og.image.width = 640c
+            og.image.height = 480c
+            twitter.image.width = 640c
+            twitter.image.height = 480c
+        }
+    }
+
+Set different fallback images for each site
+-------------------------------------------
+There is a settings panel which you can use to set fallback images for opengraph and Twitter. These will then be used for
+your site. If you have multiple sites however, there is a need to set different fallback images for each site. This is
+possible by using the opengraph and Twitter image fields on the root page of each respective site. You can then use the
+following TypoScript to use those images as fallback images:
+
+.. code-block:: typoscript
+
+    lib.yoastSEO {
+        og {
+            fallBackImages {
+                references {
+                    fieldName = og_image
+                }
+            }
+        }
+        twitter {
+            fallBackImages {
+                references {
+                    fieldName = twitter_image
+                }
+            }
+        }
+    }