{"id":20877611,"url":"https://github.com/gergo85/oc-news","last_synced_at":"2025-05-12T16:30:51.465Z","repository":{"id":33079055,"uuid":"36716182","full_name":"gergo85/oc-news","owner":"gergo85","description":"This is the simple news and newsletter plugin for October CMS and Winter CMS.","archived":false,"fork":false,"pushed_at":"2022-12-01T14:20:40.000Z","size":581,"stargazers_count":40,"open_issues_count":23,"forks_count":28,"subscribers_count":8,"default_branch":"master","last_synced_at":"2023-04-04T02:01:57.126Z","etag":null,"topics":["octobercms","octobercms-plugin","wintercms","wintercms-plugin"],"latest_commit_sha":null,"homepage":"http://octobercms.com/plugin/indikator-news","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gergo85.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-06-02T07:33:19.000Z","updated_at":"2023-04-04T02:01:57.127Z","dependencies_parsed_at":"2023-01-14T23:16:52.544Z","dependency_job_id":null,"html_url":"https://github.com/gergo85/oc-news","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gergo85%2Foc-news","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gergo85%2Foc-news/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gergo85%2Foc-news/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gergo85%2Foc-news/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gergo85","download_url":"https://codeload.github.com/gergo85/oc-news/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225141812,"owners_count":17427362,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["octobercms","octobercms-plugin","wintercms","wintercms-plugin"],"created_at":"2024-11-18T06:57:35.898Z","updated_at":"2024-11-18T06:57:36.774Z","avatar_url":"https://github.com/gergo85.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# News \u0026 Newsletter plugin\nPlugin can be used for publishing news simply on the website. In contrary of blog, writing comments is not possible, but visitors can subscribe on a newsletter system. During publishing news posts are available not just on the website but you can send them via email to subscribed users.\n\nPlugin is same like put together a blog and a newsletter plugin. The main difference is that it is simpler and contains only the most necessary functions. So this makes easier uploading new contents and inform visitors.\n\n- [Main features](#main_features)\n- [Statistics and graphs](#statistics)\n- [Advanced SEO support](#seo_support)\n- [Automatic statistics](#autostat)\n- [Preview feature](#preview)\n- [Quick navigation](#quick_navigation)\n- [Available widgets](#available_widgets)\n- [Available components](#available_components)\n- [HTML template variables](#html_template)\n- [Mail template variables](#mail_template)\n- [Useful extensions](#eseful_extensions)\n- [Supported plugins](#supported_plugins)\n- [Available languages](#available_languages)\n- [Requirements](#requirements)\n- [Installation](#installation)\n- [Add back-end widgets](#backend_widgets)\n- [Credits](#credits)\n\n\u003ca name=\"main_features\"\u003e\u003c/a\u003e\n## Main features\n* Managing posts\n* Managing nested categories\n* Managing subscribers\n* Support the SEO\n* Support the GDPR\n* Export \u0026 Import data\n* Statistics and graphs\n* Send newsletter\n* Detailed mail logs\n* Front-end forms\n* Back-end widgets\n* Available extensions\n* Innovative solutions\n\n\u003ca name=\"statistics\"\u003e\u003c/a\u003e\n## Statistics and graphs\n* Graph - Posts in this year\n* Graph - Posts in last year\n* List - TOP 20 view posts\n* List - TOP 10 longest posts\n* List - TOP 10 shortest posts\n* Graph - Mail events\n* Graph - Mail summary\n\n\u003ca name=\"seo_support\"\u003e\u003c/a\u003e\n## Advanced SEO support\nYou can enable this feature on the __Settings \u003e CMS \u003e News \u0026 Newsletter__ page. If you use it, you should replace the title and meta description tags with the following lines:\n```\n\u003ctitle\u003e{% if post.seo_title %}{{ post.seo_title }}{% elseif this.page.meta_title %}{{ this.page.meta_title }}{% else %}{{ this.page.title }}{% endif %}\u003c/title\u003e\n\u003cmeta name=\"description\" content=\"{% if post.seo_desc %}{{ post.seo_desc }}{% elseif this.page.meta_description %}{{ this.page.meta_description }}{% else %}{{ this.page.description }}{% endif %}\"\u003e\n{% if post.seo_image %}\u003cmeta property=\"og:image\" content=\"{{ post.seo_image|media }}\"\u003e{% endif %}\n```\n\n### Additional SEO Configuration\n\nAdditionally, the following has been introduced for better SEO\n- A canonical URL specification tag\n- The use of the default post image as the seo image\n- A list of meta keywords made up of from post category and tags, the user adds to their post.\n\nAlong side the snippet above, you can add the following code the head of your theme files.\n\n```\n \u003clink rel=\"canonical\" href=\"{{ this.page.meta_canonical }}\"\u003e\n \u003clink rel=\"image_src\" href=\"{{ this.page.meta_image_src|media }}\"\u003e\n \u003cmeta name=\"keywords\" content=\"{{ this.page.meta_keywords }}\"\u003e \n```\n\nYou should include the `meta_image_src` only you don't use the post seo image to avoid confusion.\n\n\u003ca name=\"autostat\"\u003e\u003c/a\u003e\n## Automatic statistics\nYou just add the \"Post content\" front-end component to the page, where the post appears. If you are logged in as administrator, the counter will not grow. It works any cases, when the visitors open the post details.\n\n\u003ca name=\"preview\"\u003e\u003c/a\u003e\n## Preview feature\nYou just add the \"Post content\" front-end component to the current page. If you modify a news, the \"Preview\" link appears along the left of the delete icon. If you are logged in as administrator, you can read the hidden and draft news too.\n\n\u003ca name=\"quick_navigation\"\u003e\u003c/a\u003e\n## Quick navigation\nIf you modify any content, one or two arrows appear along the right of the delete icon. There are the navigation links. You can simply go to the previous or next content.\n\n\u003ca name=\"available_widgets\"\u003e\u003c/a\u003e\n## Available widgets\nYou can use the following widgets on the back-end Dashboard:\n* Post statistics\n* Subscriber statistics\n* List of TOP posts\n* List of new posts\n\n\u003ca name=\"available_components\"\u003e\u003c/a\u003e\n## Available components\nUse the __Components \u003e News__ panel in CMS menu. At this moment there are the following components:\n* Display posts\n* Post content\n* List categories\n* Subscriber form\n* Unsubscribe form\n\n\u003ca name=\"html_template\"\u003e\u003c/a\u003e\n## HTML template variables\n__For post__\n* {{ posts }} - List of posts in array\n* {{ posts.render|raw }} - Build-in pagination\n* {{ post.title }} - Title of post\n* {{ post.slug }} - Slug of post\n* {{ post.image|media }} - Full url of post image\n* {{ post.introductory|raw }} - Summary of post\n* {{ post.content|raw }} - Content of post\n* {{ post.published_at }} - Published date of post\n* {{ post.categories }} - Categories of post\n* {{ post.tags }} - List of tags in array\n* {{ post.seo_title }} - SEO title\n* {{ post.seo_keywords }} - SEO keywords\n* {{ post.seo_desc }} - SEO description\n* {{ post.seo_image|media }} - Full url of image\n* {{ post.status }} - Status of post (1: published, 2: hide, 3: draft)\n* {{ post.featured }} - Is post featured? (1: yes, 2: no)\n* {{ post.next() }} - First post after current post\n* {{ post.prev() }} - Last post before current post\n\n__For category__\n* {{ categories }} - List of categories in array\n* {{ category.name }} - Name of category\n* {{ category.slug }} - Slug of category\n* {{ category.image|media }} - Full url of category image\n* {{ category.content|raw }} - Content of category\n* {{ category.status }} - Status of post (1: published, 2: hide)\n* {{ category.hidden }} - Is category hidden? (1: yes, 2: no)\n\n__For user (Backend User)__\nAll attributes and methods available in `Backend\\Models\\User` are accesible via {{ post.user }}. Examples:\n\n* {{ post.user.first_name }} - Post author first name (attribute)\n* {{ post.user.email }} - Post author email (attribute)\n* {{ post.user.getFullNameAttribute }} - Post author full name (method)\n* {{ post.user.getAvatarThumb }} - Public path to author avatar (method)\n\nCheckout the `Backend\\Models\\User` interface and attributes for all possibilities.\n\n\u003ca name=\"mail_template\"\u003e\u003c/a\u003e\n## Mail template variables\n* {{ name }} - Name of subscriber\n* {{ email }} - E-mail of subscriber\n* {{ title }} - Title of post\n* {{ slug }} - Slug of post\n* {{ introductory }} - Introductory of post\n* {{ summary }} - Alias of introductory\n* {{ plaintext }} - Introductory without HTML elements\n* {{ content }} - Content of post\n* {{ image }} - Relative path of post image\n\nYou can customize the layout of emails in the __Settings \u003e Mail \u003e Mail templates__ page.\n\n\u003ca name=\"eseful_extensions\"\u003e\u003c/a\u003e\n## Useful extensions\n* [FennCS Page Views](https://octobercms.com/plugin/fenncs-newspageviews)\n* [TimFoerster NewsPdf](https://octobercms.com/plugin/timfoerster-newspdf)\n* [ReaZzon Gutenberg](https://octobercms.com/plugin/reazzon-gutenberg)\n\n\u003ca name=\"supported_plugins\"\u003e\u003c/a\u003e\n## Supported plugins\n* [RainLab Translate](https://octobercms.com/plugin/rainlab-translate)\n* [RainLab Sitemap](https://octobercms.com/plugin/rainlab-sitemap)\n* [Offline SiteSearch](https://octobercms.com/plugin/offline-sitesearch)\n* [Indikator Popup](https://octobercms.com/plugin/indikator-popup)\n\n\u003ca name=\"available_languages\"\u003e\u003c/a\u003e\n## Available languages\n* en - English\n* de - Deutsch\n* ru - Pу́сский\n* hu - Magyar\n* pl - Polski\n* pt - Português\n* vn - Vietnamese\n* zh-TW - Taiwanese, Traditional Chinese\n\n\u003ca name=\"requirements\"\u003e\u003c/a\u003e\n## Requirements\n* October CMS v1.0.420 or newer version.\n* [AJAX Framework](https://octobercms.com/docs/ajax) is needed for the subscription form to work.\n\n\u003ca name=\"installation\"\u003e\u003c/a\u003e\n## Installation\n1. Go to the __Settings \u003e Updates \u0026 Plugins__ page in the Backend.\n1. Click on the __Install plugins__ button.\n1. Type the __News \u0026 Newsletter__ text in the search field.\n\n\u003ca name=\"backend_widgets\"\u003e\u003c/a\u003e\n## Add back-end widgets\n1. Go to the __Dashboard__ page in the Backend.\n1. Click on the __Manage widgets \u003e Add widget__ button.\n1. Select the any __News widgets__ from the list.\n\n\u003ca name=\"credits\"\u003e\u003c/a\u003e\n## Credits\n* Special thanks to [TimFoerster](https://github.com/TimFoerster)\n* Good-looking chart: [Morris.js](http://morrisjs.github.io/morris.js)\n* Graphics library: [Raphaël JS](http://dmitrybaranovskiy.github.io/raphael)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgergo85%2Foc-news","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgergo85%2Foc-news","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgergo85%2Foc-news/lists"}