Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Fixing bundle standards #30

Merged
merged 3 commits into from
Aug 3, 2013
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 42 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,54 @@
[WIP] Symfony Cmf Blog Bundle
=============================
# Symfony CMF Blog Bundle

This is part of the Symfony Cmf: <https://github.com/symfony-cmf/symfony-cmf>
[![Build Status](https://travis-ci.org/symfony-cmf/BlogBundle.png?branch=master)](https://travis-ci.org/symfony-cmf/BlogBundle)
[![Latest Stable Version](https://poser.pugx.org/symfony-cmf/blog-bundle/v/stable.png)](https://packagist.org/packages/symfony-cmf/blog-bundle)
[![Total Downloads](https://poser.pugx.org/symfony-cmf/blog-bundle/downloads.png)](https://packagist.org/packages/symfony-cmf/blog-bundle)

## About
This bundle is part of the [Symfony Content Management Framework (CMF)](http://cmf.symfony.com/)
and licensed under the [MIT License](LICENSE).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be wise to include this caveat or something like it. This bundle IS an incomplete solution, it is blocked pending missing CMF bundles, notably TaxonomyBundle.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lets re-add such a warning and then merge.

The blog bundle is a very much "work in progress" and will only be complete
when all the necessary pieces of the CMF are available.
This bundle aims to provide everything you need to create a full blog or
blog-like system. It also includes in-built support for the Sonata Admin
bundle to help you get up-and-running quickly.

The missing pieces:
Current features:

* **TaxonomyBundle**: for tagging
* **phpcr-odm/something-else**: Way to automatically order nodes when saving
(ensure next / previous posts are indeed the next and previous posts
according to date)
* Host multiple blogs within a single website;
* Place blogs anywhere within your route hierarchy;
* Sonata Admin integration.

Currently implemented:
Pending features:

* **PublishWorkFlowChecker**: The PWFC from the CoreBundle handles the
publication status of blog posts.
* Full tag support;
* Frontend pagination (using knp-paginator);
* RSS/ATOM feed;
* Comments;
* User support (FOSUserBundle).

## Links

- GitHub: <https://github.com/symfony-cmf/symfony-cmf>
- Sandbox: <https://github.com/symfony-cmf/cmf-sandbox>
- Web: <http://cmf.symfony.com/>
- Wiki: <http://github.com/symfony-cmf/symfony-cmf/wiki>
- Issue Tracker: <http://cmf.symfony-project.org/redmine/>
- IRC: irc://freenode/#symfony-cmf
- Users mailing list: <http://groups.google.com/group/symfony-cmf-users>
- Devs mailing list: <http://groups.google.com/group/symfony-cmf-devs>
## Requirements

* Symfony 2.2.x
* [CoreBundle](https://github.com/symfony-cmf/CoreBundle)
* [RoutingAutoBundle](https://github.com/symfony-cmf/RoutingAutoBundle)


## Documentation

http://symfony.com/doc/master/cmf/bundles/blog.html
For the install guide and reference, see:

* [BlogBundle documentation](http://symfony.com/doc/master/cmf/bundles/blog.html)

See also:

* [All Symfony CMF documentation](http://symfony.com/doc/master/cmf/index.html) - complete Symfony CMF reference
* [Symfony CMF Website](http://cmf.symfony.com/) - introduction, live demo, support and community links


## Contributing

Pull requests are welcome. Please see our [CONTRIBUTING](https://github.com/symfony-cmf/BlogBundle/blob/master/CONTRIBUTING.md) guide.

Unit and/or functional tests exist for this bundle. See the [Testing documentation](http://symfony.com/doc/master/cmf/components/testing.html) for a guide to running the tests.

Thanks to [everyone who has contributed](https://github.com/symfony-cmf/BlogBundle/contributors) already.
142 changes: 142 additions & 0 deletions Resources/translations/CmfBlogBundle.en.xliff
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
<?xml version="1.0"?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" version="1.2">
<file source-language="en" target-language="en" datatype="plaintext" original="file.ext">
<body>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made the attribute "original" to the name of the file for the en version.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIK, that's wrong (that's why I didn't include that in my script).

The original attribute refers to the file in which this translation was used. So if you have a dashboard.html.twig in which you have a dashboard.label_body label, the original attribute is dashboard.html.twig. If you have another translation message, let's say homepage.welcome inside home.html.twig, you should create a new file element and give it the attribute home.html.twig.

Because these files aren't really known in Symfony and because you are able to use it on different files, Symfony decided give it the value file.ext. This is also wrong, but less wrong.

To handle to original (source) locale, the source-language is used.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, good to know :-)

<trans-unit id="breadcrumb.link_blog_list">
<source>breadcrumb.link_blog_list</source>
<target>Blogs</target>
</trans-unit>

<trans-unit id="breadcrumb.link_blog_create">
<source>breadcrumb.link_blog_create</source>
<target>Create</target>
</trans-unit>

<trans-unit id="breadcrumb.link_blog_edit">
<source>breadcrumb.link_blog_edit</source>
<target>Edit</target>
</trans-unit>

<trans-unit id="breadcrumb.link_blog_delete">
<source>breadcrumb.link_blog_delete</source>
<target>Delete</target>
</trans-unit>

<trans-unit id="breadcrumb.link_post_list">
<source>breadcrumb.link_post_list</source>
<target>Posts</target>
</trans-unit>

<trans-unit id="breadcrumb.link_post_create">
<source>breadcrumb.link_post_create</source>
<target>Create</target>
</trans-unit>

<trans-unit id="breadcrumb.link_post_edit">
<source>breadcrumb.link_post_edit</source>
<target>Edit</target>
</trans-unit>

<trans-unit id="breadcrumb.link_post_delete">
<source>breadcrumb.link_post_delete</source>
<target>Delete</target>
</trans-unit>

<trans-unit id="list.label_blog">
<source>list.label_blog</source>
<target>Blog</target>
</trans-unit>

<trans-unit id="list.label_date">
<source>list.label_date</source>
<target>Date</target>
</trans-unit>

<trans-unit id="list.label_id">
<source>list.label_id</source>
<target>Id</target>
</trans-unit>

<trans-unit id="list.label_name">
<source>list.label_name</source>
<target>Name</target>
</trans-unit>

<trans-unit id="list.label_status">
<source>list.label_status</source>
<target>Status</target>
</trans-unit>

<trans-unit id="list.label_tags">
<source>list.label_tags</source>
<target>Tags</target>
</trans-unit>

<trans-unit id="list.label_title">
<source>list.label_title</source>
<target>Title</target>
</trans-unit>

<trans-unit id="form.group_general">
<source>form.group_general</source>
<target>General</target>
</trans-unit>

<trans-unit id="form.label_blog">
<source>form.label_blog</source>
<target>Blog</target>
</trans-unit>

<trans-unit id="form.label_body">
<source>form.label_body</source>
<target>Content</target>
</trans-unit>

<trans-unit id="form.label_date">
<source>form.label_date</source>
<target>Date</target>
</trans-unit>

<trans-unit id="form.label_id">
<source>form.label_id</source>
<target>Id</target>
</trans-unit>

<trans-unit id="form.label_name">
<source>form.label_name</source>
<target>Name</target>
</trans-unit>

<trans-unit id="form.label_parent">
<source>form.label_parent</source>
<target>Parent</target>
</trans-unit>

<trans-unit id="form.label_status">
<source>form.label_status</source>
<target>Status</target>
</trans-unit>

<trans-unit id="form.label_tags">
<source>form.label_tags</source>
<target>Tags</target>
</trans-unit>

<trans-unit id="form.label_title">
<source>form.label_title</source>
<target>Title</target>
</trans-unit>

<trans-unit id="dashboard.label_post">
<source>dashboard.label_post</source>
<target>Post</target>
</trans-unit>

<trans-unit id="dashboard.label_blog">
<source>dashboard.label_blog</source>
<target>Blog</target>
</trans-unit>

</body>
</file>
</xliff>
35 changes: 0 additions & 35 deletions Resources/translations/CmfBlogBundle.en.yml

This file was deleted.

Loading