[DOC] update for new features of last version

clickstorm · Jan 6, 2021 · d07ad15 · d07ad15
1 parent a3fe759
commit d07ad15
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 6 deletions.
diff --git a/Configuration/Yaml/news.yaml b/Configuration/Yaml/news.yaml
@@ -1,22 +1,29 @@
 # This is an example how to extend news records, use it via imports:
 # imports:
 #   - { resource: "EXT:cs_seo/Configuration/Yaml/news.yaml" }
-
 records:
+
   # new index and table name of the model
   tx_news_domain_model_news:
+
     # getText. Returns news uid. If set, news meta tags are shown.
     enable: 'GP:tx_news_pi1|news'
 
+
     # if the model already has fields like title etc. define them as fallback
     fallback:
+
       # cs_seo title field fallback = news title field
       title: title
+
       # cs_seo description field fallback = news description field
-      description: description
+      # also more fields possible within curly brackets, e.g. description: {teaser} - {author}
+      description: teaser
+
 
     # enable evaluation for news
     evaluation:
+
       # additional params to initialize the detail view, the pipe will be replaced by the uid
       getParams: >-
         &tx_news_pi1[controller]=News&tx_news_pi1[action]=detail&tx_news_pi1[news]=|

diff --git a/Documentation/Administrator/ExtensionManagerConf/Index.rst b/Documentation/Administrator/ExtensionManagerConf/Index.rst
@@ -26,6 +26,7 @@ Properties
 	`basic.useAdditionalCanonicalizedUrlParametersOnly`_    :ref:`t3tsref:data-type-boolean`      false
 	`page.maxTitle`_                                        :ref:`t3tsref:data-type-integer`      57
 	`page.maxDescription`_                                  :ref:`t3tsref:data-type-integer`      156
+	`page.cropDescription`_                                 :ref:`t3tsref:data-type-boolean`      false
 	`page.maxNavTitle`_                                     :ref:`t3tsref:data-type-integer`      50
 	`evaluation.inPageModule`_                              :ref:`t3tsref:data-type-integer`      0
 	`evaluation.evaluationDoktypes`_                        :ref:`t3tsref:data-type-string`       1
@@ -89,6 +90,22 @@ Max characters of description
    Description
          The recommended maximum number of characters for the meta description tag.
 
+
+.. _page.cropDescription:
+
+Crop description
+""""""""""""""""
+
+.. container:: table-row
+
+   Property
+         cropDescription
+   Data type
+         :ref:`t3tsref:data-type-boolean`
+   Description
+         Crop description for extended tables, if it exceeds "Max characters of description".
+
+
 .. _page.maxNavTitle:
 
 Max characters of nav title

diff --git a/Documentation/Developer/ExtendExistingModel/Index.rst b/Documentation/Developer/ExtendExistingModel/Index.rst
@@ -40,11 +40,12 @@ Add the following yaml content to a file EXT:myext/Configuration/CsSeo/config.ya
          # if the model already has fields like title etc. define them as fallback
          fallback:
 
-         # cs_seo title field fallback = mymod title field
-         title: title
+            # cs_seo title field fallback = mymod title field
+            title: title
 
-         # cs_seo description field fallback = mymod description field
-         description: description
+            # cs_seo description field fallback = mymod description field
+            # also more fields possible within curly brackets, e.g. description: {teaser} - {company}
+            description: description
 
          # enable evaluation for mymod
          evaluation: