Skip to content
Browse files

adds some basic install instructions and info to README.rst

  • Loading branch information...
1 parent a38b78a commit 0b641eff6166a96e612bc60c960d02bf72c62ee4 @stefanfoulis stefanfoulis committed
Showing with 35 additions and 0 deletions.
  1. +35 −0 README.rst
View
35 README.rst
@@ -5,4 +5,39 @@ djangocms-stacks
Stacks: re-usable content blocks
+To put it in terms of django CMS: This is re-usable Placeholder. It can used in any template as a named entity::
+
+ {% load stacks_tags %}
+ {% stack 'my_footer' %}
+
+This will create a ``Stack`` with the ``my_footer`` identifier. It can be edited in admin.
+
+``Stacks`` can also be used inside regular placeholders. Suppose you have some content that you want to re-use in
+multiple places: Make a stack and insert that stack with the ``StackLinkPlugin`` wherever you need it.
+
+Stacks is multilingual (using the multilinguality of cms-plugins. So make sure your stack is translated into the
+language of the page you place it on.
+
+There is currently no validation in place to prevent infinite loops... so please don't put a ``StackLinkPlugin``
+inside a Stack with a link to itself.
+
+
+Installation and Configuration
+==============================
+
+ pip install djangocms-stacks
+
+in ``settings``::
+
+ INSTALLED_APPS = (
+ [...]
+ 'stacks',
+ [...]
+ )
+
+create the database tables::
+
+ python manage.py migrate stacks
+
+
Idea based on https://github.com/divio/django-contentblock .

0 comments on commit 0b641ef

Please sign in to comment.
Something went wrong with that request. Please try again.