orchestral / story Goto Github PK

View Code? Open in Web Editor NEW

14.0 5.0 7.0 817 KB

[Extension] Story CMS for Orchestra Platform

License: MIT License

JavaScript 2.89% CoffeeScript 0.59% CSS 7.84% PHP 88.68%

story's Introduction

Story CMS Extension

Content Management System for Orchestra Platform, based on Cello CMS and inspired by WardrobeCMS.

Installation

To install through composer, simply put the following in your composer.json file:

{
	"require": {
		"orchestra/story": "~3.0"
	}
}

And then run composer install to fetch the package.

Quick Installation

You could also simplify the above code by using the following command:

composer require "orchestra/story=~3.0"

Setup

To start using Story CMS, activate the extension from Orchestra Platform Administrator Interface.

Quick Guide

By default, Story CMS is using Markdown format for post and page, however you can customize this by adding your own prefered formatting parser.

Adding new Format

use Orchestra\Story\Facades\StoryFormat;

StoryFormat::extend('bbcode', function () {
    return new BBCodeParser();
});

class BBCodeParser extends Orchestra\Story\Parsers\Parser {}

You can add a new JavaScript text editor using:

Event::listen('orchestra.story.editor: bbcode', function () {
    // Add asset
});

License

The MIT License

Copyright (C) 2012 by Mior Muhammad Zaki <http://git.io/crynobone>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Credit to WardrobeCMS for the inspiration.

story's People

Contributors

Stargazers

Watchers

Forkers

meroje lckamal fhferreira woakes070048 ahmadshah benediktharter fztbyt

story's Issues

Resources shouldn't be available if user isn't logged in.

Call to undefined method Illuminate\Routing\Router::getCurrentRoute()

Regression bug from Laravel 4.1 routing refactor.

Update to latest lepture editor.

https://github.com/lepture/editor

Use Orchestra\Site to set page title.

Add Layouts and Partials tabs to Story

A page sits inside a template and both may contain zero or more partials. This is something LemonStand did really well and it's quite intuitive. The benefit of an approach like this is everything can be done from the CMS and there is no need to mess around with files on the server.

Here is an example workflow.

Create a layout 'Site'
Create a page 'About' and assign it the 'Site' layout
Create some partials for the layout and page to use

Example Site layout:

<!DOCTYPE html>
<html class="no-js">
    <head>
        <meta charset="utf-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <title>{{ page.title }}</title>
        <meta name="description" content="{{ page.meta_desc }}">
        <meta name="viewport" content="width=device-width, initial-scale=1">

        @partial('header_styles')
        @partial('header_scripts')
    </head>
    <body>
        <!--[if lt IE 8]>
            <p class="browsehappy">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> to improve your experience.</p>
        <![endif]-->

        <!-- Add your site or application content here -->
        @page()

        @partial('footer')
    </body>
</html>

Example header_styles partial:

<!-- Place favicon.ico and apple-touch-icon(s) in the root directory -->

<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/main.css">

Example footer partial:

<script src="//ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
<script>window.jQuery || document.write('<script src="js/vendor/jquery-1.10.2.min.js"><\/script>')</script>
<script src="js/plugins.js"></script>
<script src="js/main.js"></script>

<!-- Google Analytics: change UA-XXXXX-X to be your site's ID. -->
<script>
    (function(b,o,i,l,e,r){b.GoogleAnalyticsObject=l;b[l]||(b[l]=
    function(){(b[l].q=b[l].q||[]).push(arguments)});b[l].l=+new Date;
    e=o.createElement(i);r=o.getElementsByTagName(i)[0];
    e.src='//www.google-analytics.com/analytics.js';
    r.parentNode.insertBefore(e,r)}(window,document,'script','ga'));
    ga('create','UA-XXXXX-X');ga('send','pageview');
</script>

And example About page:

<h1>About Us</h1>
<p>Hello world! This is HTML5 Boilerplate.</p>

Hopefully the above made sense. It's a very simple concept that provides unlimited flexibility.

Replace Markdown parser with Parsedown

http://parsedown.org

Add support for {date}, {year}, {month}, {day} permalink option.

Add "web" middleware for frontend routing.

slug to be i18n?

like persian/arabic

ACL

Create Orchestra\Story\StoryMenuHandler

If user doesn't have access to write post, show a different dashboard.

Themes

Hi,

I've got a question concerning themes.
I'm seeing a theme.json file in the public/default folder, but nothing else. I also don't see this setting somewhere (to set a theme).

Is this feature already available or is there because it's under development ?

Thanks,

Should sort latest content to the top.

Dashboard Pane.

Setup morph class name for Content model.

Update parsedown constraint.

Orchestra\Story\Storyteller functionality.

URL Generator

Should be able to generate URL for posts, rss and individual page/post.

Argument 2 passed to Orchestra\Story\StoryMenuHandler::__construct() must implement interface Orchestra\Contracts\Auth\Guard, instance of Orchestra\Auth\AuthManager given

Add a Resource handler.

For #3 and #4.

Parameter 1 to Orchestra\Story\Listeners\AddValidationRules::handle() expected to be a reference, value given

Better display for pages and post.

Shouldn't be able to use rss or posts as slug.

Improve docblock

Handle URL / not overriding default Laravel landing page

Followed the instructions from Orchestra Platform Blog on how you can setup StoryCMS, however the "/" in Handle URL does not override Laravel main landing page.

https://cloudup.com/c47itydWsj1

Is there a missing step or StoryCMS has not been updated to meet new Laravel release?

Or is it a Nginx configuration issue?

Need to rework on configuration helpers.

Should support OpenGraph data.

InvalidArgumentException in FileViewFinder.php line 111: No hint path defined for [orchestra/story].

Route to /posts/

Trouble using sftp on moutain lion

I have Orchestra Platform 2 up and running, installed.

I've chmod'd the follow directories 777
app/storage
public/packages

both my custom app extension & the Control extension could be enabled without FTP, but none of my local FTP (and sftp) credentials dont work when attempting to enable Story extension.

I've used the following hosts:
localhost
127.0.0.1
192.168.0.x
::1

I've tested credentials with both ftp & sftp through my terminal, which work just fine.

Machine Stats:

Moutain Lion 10.8.5
Lighttpd
PHP 5.3+

Any ideas?

Ability to register and use different format.

Register A Format.

Orchestra\Story\FormatManager (alias StoryFormat) should extends Illuminate\Support\Manager.

StoryFormat::extend('markdown', function ()
{
    return new MarkdownParser();
});

class MarkdownParser extends Orchestra\Story\Parsers\Parser {}

Add an HTML/JS Editor

ApiPostController and ApiPageController should support a before filter that would run following event.

Event::listen('orchestra.story.editor: markdown', function ()
{
    // Add asset
});

Default format.

Should be able to choose default format using the extension configuration page.

Toggle Format

You should be able to change format on runtime using /resources/story.posts/2/edit?format=markdown to /resources/story.posts/2/edit?format=bbcode for example.

The requested package orchestra/story could not be found in any version, there may be a typo in the package name.

I have tried to set the preferred-install to dev, but no luck. I am confused, am I missing something?