silverstripe-newsmodule

=======================

REQUEST

If you can translate the yaml files into your native language, would be great. If you can't/wont push/fork, you can e-mail me the translations. (Issue #25 )

Introduction

This is the Silverstripe 3 Newsmodule. It's separate from the SiteTree. Mainly to keep the SiteTree uncluttered.

If you expect to have a few hundred articles (like I do), your SiteTree becomes very unreadable. That's why I chose to make an alternative, using ModelAdmin.

It works. Pretty much. Has some missing features. Please read my comments on the functions and such. It should make everything clear. If you encounter any problems with the Master, please let me know! I can't bugfix without a ticket! If you use the development-branch, be aware that this is my untested area and therefor might contain bugs or just plain ruin your site with errors.

Ow, and the default template is based on HTML5 features and my own website. Functional frontend demo can also be found on my website. Casa Laguna

Strange code and undocumented features are probably due to my cat sleeping on the keyboard.

I strongly advice to read my inline comments. I've worked hard to make them both functional as funny. Feedback appreciated. And keep an eye on my issues, those are issues I want to fix or features I want to add. Feel free to add suggestions!

This project is always in development. I will always add features or fix bugs. Although it is always in development, I won't leave a bugged out version here. It always works. All new features or fixes are backwards compatible unless stated in the commit-message.

Maintainer Contacts

• Simon "Sphere" Erkelens simon[at]casa-laguna[dot]net

Requirements

• Silverstripe 3.x framework
• GridFieldBulkEditingTools
• SortableGridField
• GridfieldPaginatorWithShowAll

Optional

• Silverstripe Translatable

Note on which version of translatable, CMS and Framework you use! They might not be compatible.

This is a semi-tested translatable release. It does not break the current version, but I can't promise it works as required!

Features

• Handle news and impressions besides the news.
• Support for OG-data on some servers (some servers refuse for some reason). Check here for the OG-module: OpenGraph module
• History of URL-segments.
• Support for custom comments.
• Akismet support. Akismet class included in thirdparty dir. Remove it if you have it included already.
• Option to add an "Extra" titled field. If this field is not empty, the post is considered spam. In your CSS, position it absolute and very, very, very much outside the screen.
• Preferred anti-spam method is NOT using a Captcha.
• Globally available NewsArchive function.
• Geshi code-rendering support. use [code type=php]your code here[/code]
• Tweet rendering by Twitter. Include the twitter widget JS and in your content, just do [tweet id=tweetID]
• Configurable from the SiteConfig.
• GridField overview, less clutter in the SiteTree.
• RSS Feed, can be found under http://yoursite.com/yournewspage/rss (Note, it seems links in content are not parsed correctly by some versions of the HTTP class in the RSS-entry builder!)
• If you include and setup my Silverstripe Social you can make it auto-post new items to Twitter.
• Tagging of items, shown grouped under http://yoursite.com/yournewspage/tags or a specific tag: http://yoursite.com/tag/tag-urlsegment where tag-urlsegment is the urlsegment of the tag, ofcourse.
• Selectively disable comments on items, useful for when a commenting-war commences. Just disable for that specific item and you're set.
• Show random items below a post. Or not. Or related items. Or both. Or none. Have it your way!
• Set the publish-date. If, for example, you want to post after a three-date event, but update your item during the event. Note, you still have to check the Publish-checkbox and it won't auto-tweet (yet).
• The publish-date is the date on the frontpage. Sorting via PublishFrom is leveled above the Created, unless it's null. ** Publish-date is disabled due to errors caused. Will be fixed asap but low on priority-list.
• Slideshow option. Just add pictures and use [slideshow] in your $Content
• Posts per Page and Pagination. If set to 0, it won't paginate.
• Reports on comments, how much of them are marked by Akismet and how many are hidden.
• Report on the tag usage.

Demo of frontend

• General news overview
• Tagcloud
• Specific tag
• Redirect to urlsegment

Lacks

• History of changes in the items

(Indeed, that second bullet means it only lacks history, nothing else :P )

Installation

If you don't have a github account, just download:

1. Click on the big "ZIP" button at the top.
2. Extract the zip to your site-root
3. Run in your browser - www.example.com/dev/build to rebuild the database. A default page will be created if possible.

Other option is to clone the repo into your site-root:

1. In your site-root, do git clone https://github.com/Firesphere/silverstripe-newsmodule.git.
2. Run in your browser - www.example.com/dev/build to rebuild the database. A default page will be created if possible.

Although, I would like it if you forked and cloned, because if you do, you can help me by adding features and make pull-requests to improve this module!

1. Make a fork of this module.
2. In your site-root, do git clone https://{your username}@github.com/{your username}/silverstripe-newsmodule.git.
3. Run in your browser - www.example.com/dev/build to rebuild the database. A default page will be created if possible.

Note, forking is NOT REQUIRED, only handy if you want to help out.

Best Practices

• Write grammatically correct.
• If you have Akismet, add your Akismet API-key to the SiteConfig in News settings (It's in the Comments-section). It saves you from comment-spam

Configuration

• In the SiteConfig, set your wished configuration in the News-tab.
• To enable the OpenGraph features, include the og-module and uncomment the implementation on the News-class.
• To enable smilies, change in templates/Layout, the to-parse files. Add .Parse(BBCodeParser) To the items you want parsed. To enable smilies, in your config, set BBCodeParser::enable_smilies() (If I'm not mistaken)
• In _config, you can disable, edit or change parsers. Note, the parsers are GLOBAL, so $Content from pages will be parsed too!
• In javascript/newsmodule.js, you can configure the tagcloud. Which element it should trigger on, etc.
• Check the templates, Replace placeholder texts!
• Set optional extra anti-spam methods in your SiteConfig If you set optional extra anti-spam method, the commentform will contain a field with the ID "Extra", position it "on the other side of the street", e.g. a position absolute with in your css #Extra.field{ left: -9000; }

Plans

• Integrate Facebook OAuth to automagically post when a new item is created (FB OAuth is really crappy :( ).
• Add a "Fetch me a beer" function. Should be useful I think.

Known Issues

• No serious issues known at this point.

Requests

• Improvements.
• Translations.

Other

• This module is given "as is" and I am not responsible for any damage it might do to your brain, dog, cat, house, computer or website.
• Code Comments should not be taken too seriously, since I'm bad at writing serious code-comments.
• Please use the Issue-tracker, otherwise I get lost too.
• This ModelAdmin method is chosen to declutter the SiteTree.
• This is a port of a non-released SS2.4 newsmodule I wrote. It might not be entirely "up to code" yet.

Actual license

This module is published under BSD 2-clause license, although these are not in the actual classes, the license does apply:

http://www.opensource.org/licenses/BSD-2-Clause

Copyright (c) 2013, Simon "Sphere" Erkelens

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

(I shouldn't scream, should I? This is copy-paste from BSD-2 license...)