From b9922da87e1ca4dea10d8bc480883a844eb78838 Mon Sep 17 00:00:00 2001
From: Torsten Oppermann <torsten@sgalinski.de>
Date: Sun, 18 Jun 2017 21:32:03 +0200
Subject: [PATCH] [TASK] Update Documentation
---
README.md | 50 ++++++++++++++++++++++++++------------------------
1 file changed, 26 insertions(+), 24 deletions(-)
diff --git a/README.md b/README.md
index c3018b5..b5a8617 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,7 @@ TYPO3 version: >7.6
## About
-Integrates a powerful News-System. News and Categories can be created like normal TYPO3 pages. Newspages have several
+Integrates a powerful News system. News and Categories can be created like normal TYPO3 pages. Newspages have several
additional meta information.
@@ -110,7 +110,7 @@ In addition to categories, multiple tags can be created and specified for each n
Tags can be created by adding sys_category records to the root page of the news block (blog).
In order to differentiate each block's tags from the others,
-the PageTS value of **TCEFORM.pages.tx_sgnews_tags.PAGE_TSCONFIG_ID**
+the PageTS value of **TCEFORM.pages.tx_sgnews_tags.PAGE_TSCONFIG_ID**
can be set for each of the blocks containing the pid value for the selectable tags.
To make sure that only the correct tags are displayed in the FE, the **plugin.tx_sgnews.settings.tagPid**
@@ -128,29 +128,31 @@ On these pages you can use all your usual content elements to visualize your new
### Plugins
General settings for the plugins can be found in the **Frontend/setup.txt** and **Frontend/constants.txt** TypoScript file:
- # setup.txt
- settings {
- # Name of your site - required for the news.xml
- siteName =
+*setup.txt*
- # Your rootpage id - required for the news.xml to retrieve the base path
- rootpageId = 1
-
- # News limit (can be usually set also inside the flexforms)
- newsLimitPerPage = {$plugin.tx_sgnews.settings.newsLimitPerPage}
-
- # Uid of the page containing sys_category records used as tags
- tagPid = {$plugin.tx_sgnews.settings.tagPid}
-
- # How to sort the news in general (date, positionInTree)
- sortBy = date
- }
+ settings {
+ # Name of your site - required for the news.xml
+ siteName =
+
+ # Your rootpage id - required for the news.xml to retrieve the base path
+ rootpageId = 1
+
+ # News limit (can be usually set also inside the flexforms)
+ newsLimitPerPage = {$plugin.tx_sgnews.settings.newsLimitPerPage}
+
+ # Uid of the page containing sys_category records used as tags
+ tagPid = {$plugin.tx_sgnews.settings.tagPid}
+
+ # How to sort the news in general (date, positionInTree)
+ sortBy = date
+ }
- #constants.txt
- settings {
- newsLimitPerPage = 12
- tagPid =
- }
+*constants.txt*
+
+ settings {
+ newsLimitPerPage = 12
+ tagPid =
+ }
This extension comes with several plugins to display and categorize news:
@@ -235,5 +237,5 @@ You find the settings in the **Fontend/constants.txt** configuration file:
###### addLike
Automatically adds an AJAX like button to each single news entry.
-Make sure, that the extension sg_ajax is installed, otherwise this feature will be disabled.
+Make sure, that the extension **sg_ajax** is installed, otherwise this feature will be disabled.
If it should be like this, then make sure to remove this button from the sg_news default templates.
--
GitLab