diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..087a863 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,3 @@ +[![Jazzband](https://jazzband.co/static/img/jazzband.svg)](https://jazzband.co/) + +This is a [Jazzband](https://jazzband.co/) project. By contributing you agree to abide by the [Contributor Code of Conduct](https://jazzband.co/docs/conduct) and follow the [guidelines](https://jazzband.co/docs/guidelines). diff --git a/MANIFEST.in b/MANIFEST.in index f7914c9..6f85549 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,4 @@ -include LICENSE AUTHORS README.rst MANIFEST.in tox.ini .coveragerc +include LICENSE AUTHORS README.rst MANIFEST.in tox.ini .coveragerc CONTRIBUTING.md recursive-include docs *.txt recursive-include dbtemplates/locale * recursive-include dbtemplates/static/dbtemplates *.css *.js diff --git a/docs/changelog.txt b/docs/changelog.txt index 1703b4c..46ba330 100644 --- a/docs/changelog.txt +++ b/docs/changelog.txt @@ -1,10 +1,14 @@ Changelog ========= -v2.0 (unreleased) +v2.0 (2016-09-29) ----------------- -* Moved to Jazzband: https://github.com/jazzband/django-dbtemplates +.. warning:: + + This is a backwards-incompatible release! + +* Moved maintenance to the `Jazzband `_ * Dropped support for Python 2.6 diff --git a/docs/overview.txt b/docs/overview.txt index 7991a10..99e430e 100644 --- a/docs/overview.txt +++ b/docs/overview.txt @@ -32,9 +32,9 @@ Setup TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', - 'DIRS': [ # your template dirs here + 'DIRS': [ # your template dirs here ], - 'APP_DIRS': False, + 'APP_DIRS': False, 'OPTIONS': { 'context_processors': [ 'django.contrib.auth.context_processors.auth', @@ -47,30 +47,31 @@ Setup 'django.template.context_processors.request', ], 'loaders': [ - 'django.template.loaders.filesystem.Loader', - 'django.template.loaders.app_directories.Loader', - 'dbtemplates.loader.Loader', + 'django.template.loaders.filesystem.Loader', + 'django.template.loaders.app_directories.Loader', + 'dbtemplates.loader.Loader', ], }, }, ] - Order of ``TEMPLATES.OPTIONS.loaders`` is important. In the former example, templates from database - will be used as a fallback (ie. when template does not exists in other locations). - If you want template from database to be used to override templates in other locations, - put ``dbtemplates.loader.Loader`` at beginning of ``loaders``. + The order of ``TEMPLATES.OPTIONS.loaders`` is important. In the former + example, templates from the database will be used as a fallback (ie. when + the template does not exists in other locations). If you want the template + from the database to be used to override templates in other locations, + put ``dbtemplates.loader.Loader`` at the beginning of ``loaders``. -4. Sync your database ``python manage.py syncdb`` +4. Sync your database ``python manage.py migrate`` 5. Restart your Django server -.. _Git repository: http://github.com/jazzband/django-dbtemplates/ +.. _Git repository: https://github.com/jazzband/django-dbtemplates/ Usage ===== Creating database templates is pretty simple: Just open the admin interface of your Django-based site in your browser and click on "Templates" in the -"Dbtemplates" section. +"Database templates" section. There you only need to fill in the ``name`` field with the identifier, Django is supposed to use while searching for templates, e.g. @@ -84,44 +85,3 @@ other template loaders. For example, if you have a template called contents in the database, you just need to leave the content field empty to automatically populate it. That's especially useful if you don't want to copy and paste its content manually to the textarea. - -Example -======= - -``dbtemplates`` comes with an example Django project that let's you try it -out. The example uses Django's own `flatpages app`_ to enable you to create -a simple page using ``dbtemplates``. Flat pages are a perfect fit to -dbtemplates since they come prepackaged and are simple to use. - -Here is how it works: - -1. Open your command line and change to the ``example`` directory in the - directory with the extracted source distribution. -2. Run ``python manage.py syncdb`` and follow the instructions. -3. Run ``python manage.py runserver`` and open your favorite browser with the - address http://127.0.0.1:8000/admin/. -4. Next add a new `Template` object in the ``dbtemplates`` section and use - ``flatpages/default.html`` as the value for the ``name`` field. For the - ``content`` field use this example:: - - - - - {{ flatpage.title }} - - - {{ flatpage.content }} - - - -5. Return to the home screen of the admin interface and add a new flat page. - Use ``/`` (yep, just a forward slash) and whatever ``title`` and - ``content`` you prefer. Please make sure you select the default site - ``example.com`` before you save the flat page. -6. Visit http://127.0.0.1:8000/ and see the flat page you just created - rendered with the ``flatpages/default.html`` template provided by - ``dbtemplates``. - -.. _flatpages app: http://docs.djangoproject.com/en/dev/ref/contrib/flatpages/ -