.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ================= EXT: Backend news ================= :Author: Kasper Skårhøj :Created: 2002-11-01T00:32:00 :Changed: 2007-01-10T08:52:14 :Author: HO Thi Ngoc Tu :Email: thi-ngoc-tu.ho@vd.ch :Info 3: :Info 4: .. _EXT-Backend-news: EXT: Backend news ================= Extension Key: **vd\_backendnews** Copyright 2006, HO Thi Ngoc Tu, This document is published under the Open Content License available from http://www.opencontent.org/opl.shtml The content of this document is related to TYPO3 \- a GNU/GPL CMS/Framework available from www.typo3.com .. _Table-of-Contents: Table of Contents ----------------- **EXT: Backend news 1** **Introduction 1** What does it do? 1 Screenshots 2 **User manual 2** Standard editor screen 2 Super editor screen 2 **Administration 4** Create a storage folder 4 Configure users and groups 5 Configure the extension 6 **Configuration 7** Reference 7 FAQ 7 **Tutorial 7** **To-Do list 7** **Changelog 7** Linking 7 .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ This sub-module of the taskcenter allows to write and publish internal news for Typo3 editors. This news can be searched by categories or dates. An edito allows to emphasize an special category of news. .. _Screenshots: Screenshots ^^^^^^^^^^^ Please have a look directly in the User manual. .. _User-manual: User manual ----------- .. _Standard-editor-view: Standard editor view ^^^^^^^^^^^^^^^^^^^^ The standard editor is the backend user which we want to communicate some news. Here is the standard editor view. |img-1| .. ### BEGIN~OF~TABLE ### .. _News-list: **News list** """"""""""""" .. container:: table-row a **News list** News are displayed here according to search criteria. Each news post has a title, a category and a publishing date. b **Search form** Category or date search .. ###### END~OF~TABLE ###### .. _Super-editor-view: Super editor view ^^^^^^^^^^^^^^^^^ The super editor is the backend user who is allows to add, edit and delete news posts. .. _See-news-view: See news view """"""""""""" |img-2| .. ### BEGIN~OF~TABLE ### .. _Menu: Menu ~~~~ .. container:: table-row a Menu b **News list** .. ### BEGIN~OF~TABLE ### .. container:: table-row a News to be published : its publishing date is in the future. This news is not visible by the standard editors. .. container:: table-row a Visible news. .. ###### END~OF~TABLE ###### Edit this news Delete this news |img-3| |img-4| c **Search form** Category or date search .. _Edito: **Edito** ~~~~~~~~~ .. container:: table-row a **Edito** |img-4| Edit or |img-3| Delete edito .. ###### END~OF~TABLE ###### .. _Add-news-view: Add news view """"""""""""" |img-5| - Title: News title (HTML allowed) - Text: You are allowed to write HTML code if you want a special display. - Category: News category to organize news and refine news search.Categories are defined in the Manage category menu.\*\*Editorial\*\* category is a special one: all news of this type will be displayed below the search form, in the edito part. - Publication date: Set the date when you want your post to be visible by standard editors. Only super editors can see all news. .. _Manage-category-view: Manage category view """""""""""""""""""" |img-6| - New category: create a new category. - Category modification: choose the existing category in the dropdown menu, write its new name in the input text on the right and click on Update. - Category deletion: to delete a category, no news must be attached to it. You need first to delete all news from the aimed category (or change their assigned category). .. _Administration: Administration -------------- Once you have downloaded and installed this extension with the Extension Manager (EM: in the backend Tools > Ext Manager), you need to go through the following steps in order to make the plugin ready to use for the users. .. _Create-a-storage-folder: Create a storage folder ^^^^^^^^^^^^^^^^^^^^^^^ Create a new page somewhere in your webtree. |img-7| Set the page type to SysFolder and give a meaningful name to it (News&categories for ex.) Do remember the ID of this new page (in our example, it's 8373). .. _Configure-users-and-groups: **Configure users and groups** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ To grant super editor privileges to a standard editor, follow the steps: |img-8| Create a new backend usergroup. Fill up the form with the following instructions: Set a grouptitle: Backend news (or whatever group name you want) Select the 'Include Access list' checkbox, this will edit the form and allow you to configure more necessary settings: Tables (listing): select - Taskcenter news categories - Taskcenter news posts Tables (modify): select - Taskcenter news categories - Taskcenter news posts Allowed exclude fields: select - Taskcenter news categories: Category name - Taskcenter news posts: News title - Taskcenter news posts: Publication time - Taskcenter news posts: Text - Taskcenter news posts: Category |img-9| Select the system folder you have previously created in DB Mounts: Add this line to TSconfig text area:VD\_BACKENDNEWS.edit = 1VD\_BACKENDNEWS.pid = [uid of system folder] Save the whole form and add this new group to the users that will have the privilege to edit the backend news. Change the system folder permissions for the group in Access > [your system folder] > Change permissions to: Show page [x], Edit content [x], Edit page [ ], Delete page [ ], New pages [ ] (in the Group line). |img-10| You can do a little check by switching to one of the backend news editors, and go to the Taskcenter: if everything is well configured, you will see an extended menu that allows you to edit news and categories. .. _Configure-the-extension: Configure the extension ^^^^^^^^^^^^^^^^^^^^^^^ Besides the mandatory TSconfig settings in the backend usergroup, you can add the following **optional** configuration for a usergroup that contains ALL your users. But if you want to do some fine tuning, you may also configure this group by group or even at the user level, as there is VD\_BACKENDNEWS.specialCategory = This setting is useful if you want to change the news that go to the right of the Taskcenter > Backend news panel.By default, the first created category will be assigned as the special category (it will be surrounded with stars in the different places where it appears in the edit forms). In our example, we have called it 'Editorial'. VD\_BACKENDNEWS.nbrSearchDays = 14This setting allows you to define the number of days in the past the search should do to retrieve the news. The 'Date from' text input field will hold the default value : today - nbr\_search\_days, and the news listed on the main part of the Backend news overview panel satisfy this search criteria. VD\_BACKENDNEWS.nbrItemsPerPage = 3This setting controls the number of news displayed per page in the Backend news overview panel. If there are more than the number set, a page numbering will appear and let the user browse through all searched news. .. _Configuration: Configuration ------------- .. _Reference: Reference ^^^^^^^^^ Here's the complete reference of the user or usergroup TSconfig for this module. .. ### BEGIN~OF~TABLE ### .. _edit: edit """" .. container:: table-row Property edit Data type int Description 1 if you want the user(group) to have the right to manage news and news categories. Default 0 .. _pid: pid """ .. container:: table-row Property pid Data type int Description Uid of the system folder that contains the news and their category. Default 0 .. _specialCategory: specialCategory """"""""""""""" .. container:: table-row Property specialCategory Data type int Description Uid of the special news category whose news are displayed on the right of the main news panel. Default 1 .. _nbrSearchDays: nbrSearchDays """"""""""""" .. container:: table-row Property nbrSearchDays Data type int Description Default number of days in the past for news searching. Default 14 .. _nbrItemsPerPage: nbrItemsPerPage """"""""""""""" .. container:: table-row Property nbrItemsPerPage Data type int Description Default number of news to display in one search result page. Default 3 .. ###### END~OF~TABLE ###### .. _FAQ: FAQ ^^^ Why can we not delete all categories?Because only categories which have no news associated yet can be deleted. .. _Tutorial: Tutorial -------- See User Manual in the present document. .. _To-Do-list: To-Do list ---------- \- Some refactoring will not harm .. _Changelog: Changelog --------- Version 0.1.0: first public release. .. _Linking: Linking ^^^^^^^ This extension is used in the backend of the website : http://www.vd.ch |img-11| EXT: Backend news - 7 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. :border: 0 .. :height: 292 .. :id: Image1 .. :name: Image1 .. :width: 669 .. |img-2| image:: img-2.png .. :align: left .. :border: 0 .. :height: 231 .. :id: Image2 .. :name: Image2 .. :width: 669 .. |img-3| image:: img-3.png .. :align: left .. :border: 0 .. :height: 15 .. :id: Image4 .. :name: Image4 .. :width: 15 .. |img-4| image:: img-4.png .. :align: left .. :border: 0 .. :height: 16 .. :id: Image3 .. :name: Image3 .. :width: 14 .. |img-5| image:: img-5.png .. :align: left .. :border: 0 .. :height: 337 .. :id: Image7 .. :name: Image7 .. :width: 651 .. |img-6| image:: img-6.png .. :align: left .. :border: 0 .. :height: 177 .. :id: Image8 .. :name: Image8 .. :width: 669 .. |img-7| image:: img-7.png .. :align: left .. :border: 0 .. :height: 241 .. :id: graphics2 .. :name: graphics2 .. :width: 267 .. |img-8| image:: img-8.png .. :align: left .. :border: 0 .. :height: 223 .. :id: graphics3 .. :name: graphics3 .. :width: 475 .. |img-9| image:: img-9.png .. :align: left .. :border: 0 .. :height: 178 .. :id: graphics4 .. :name: graphics4 .. :width: 530 .. |img-10| image:: img-10.png .. :align: left .. :border: 0 .. :height: 101 .. :id: graphics5 .. :name: graphics5 .. :width: 250 .. |img-11| image:: img-11.png .. :align: left .. :border: 0 .. :height: 32 .. :id: Graphic1 .. :name: Graphic1 .. :width: 102