Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/antonagestam/django-text

Intuitive text editing for humans using Django.
https://github.com/antonagestam/django-text

admin cms django django-cms wysiwyg

Last synced: 3 months ago
JSON representation

Intuitive text editing for humans using Django.

Host: GitHub
URL: https://github.com/antonagestam/django-text
Owner: antonagestam
License: other
Created: 2015-02-23T20:55:10.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2018-03-23T23:03:24.000Z (over 6 years ago)
Last Synced: 2024-07-05T12:00:51.057Z (4 months ago)
Topics: admin, cms, django, django-cms, wysiwyg
Language: Python
Homepage:
Size: 2.85 MB
Stars: 79
Watchers: 8
Forks: 5
Open Issues: 3
Metadata Files:
- Readme: README.rst
- License: LICENSE

Awesome Lists containing this project

README

        django-text

===========

|Join the chat at https://gitter.im/antonagestam/django-text|

|See latest build status at https://travis-ci.org/antonagestam/django-text|

|Coverage|

Intuitive text editing for humans using Django.

|The django-text toolbar|

This project is in early development, please test it out and report any bugs!

Installation

------------

Install the package with pip.

.. code:: shell

    $ pip install django-text

Add ``text`` to your installed packages.

.. code:: python

    # settings.py

    INSTALLED_APPS = (

        # ...

        'text',

    )

Add ``text.middleware.TextMiddleware`` and ``'text.middleware.ToolbarMiddleware'`` to your middleware classes.

.. code:: python

    # settings.py

    MIDDLEWARE_CLASSES = (

        # ...

        'text.middleware.TextMiddleware',

        'text.middleware.ToolbarMiddleware',

    )

Make sure these context processors are installed, they come with Django.

.. code:: python

    # settings.py

    TEMPLATE_CONTEXT_PROCESSORS = (

        # ...

        'django.contrib.auth.context_processors.auth',

        'django.core.context_processors.request',

    )

Append ``text.urls`` to your urlpatterns in ``urls.py``.

.. code:: python

    # urls.py

    from django.conf.urls import patterns, include, url

    from text.urls import urlpatterns as django_text_patterns

    

    

    urlpatterns = patterns('',

        url(r'^django_text/', include(django_text_patterns, namespace='django_text')),

    )

Run ``migrate``.

.. code:: shell

    $ python manage.py migrate

Usage

-----

The ``text`` tag

~~~~~~~~~~~~~~~~

Add ``editable`` tags to your templates.

.. code:: html

    {% load text %}

    
{% text "header" "My Header" %}


    


        {% text "text_body" %}

    


The ``text`` tag takes a default text as the second argument. If no

default text is passed, the name of the text node (i.e. the first

argument) will be used if there is no corresponding text node in the

database.

The ``blocktext`` tag

~~~~~~~~~~~~~~~~~~~~~

You can also use the ``blocktext`` tag that let's you wrap content

to use as the default text.

.. code:: html

    {% load text %}

    


        

            {% blocktext "header" %}

                Read My Awesome Text

            {% endblocktext %}

        

        

        {% blocktext "content" %}

            Put your default text here!

        {% endblocktext %}

    


The ``blocktext`` tags works with translation tags inside of it. So

if you already have a translated site, you can wrap your content with

this tag and only add text nodes for some of the languages that you

support.

Specifying content type

~~~~~~~~~~~~~~~~~~~~~~~

Both the ``text`` and the ``blocktext`` tags support specifying

the content type of its default text. The choices are `"html"`,

`"markdown"` and `"text"` which is the default.

.. code:: html

    {% text "html_node" "
Hello World!
" "html" %}

    {% blocktext "markdown_node" "markdown" %}

    # Hello there,

    I can have markdown in my templates!

    {% endblocktext %}

If content type is not provided both will default to text.

Disable instant updating

~~~~~~~~~~~~~~~~~~~~~~~~

By default the templatetags will wrap all text nodes with a span

element to enable "instant updating", if

``TEXT_TOOLBAR_INSTANT_UPDATE`` is set to ``True``. Sometimes this

can cause trouble, for instance when you want to have editable

texts inside ```` or ```` elements.

You can disable instant updating on per-node basis by setting the

templatetag keyword argument ``instant_update`` to  ``False``:

.. code:: html

    {% text "title" "Welcome!" instant_update=False %}

    

    

        {% blocktext "block_title" instant_update=False %}

        Welcome one, welcome all!

        {% endblocktext %}

    

Content editing

~~~~~~~~~~~~~~~

The toolbar allows you to edit texts directly on your pages if you're

signed in as staff and have the permission ``'text.change_text'`` or if

you're signed is as a superuser.

Missing text nodes will be added to the database automatically when

their template tags are rendered.

Settings

--------

**AUTOPOPULATE\_TEXT**

Default: ``True``

Set to false to disable django-text from adding missing text nodes to

the database.

**TEXT\_TOOLBAR\_ENABLED**

Default: ``True``

Set to false to disable the toolbar interface.

**TEXT\_TOOLBAR\_FORM\_PREFIX**

Default: ``'djtext_form'``

This is passed to the toolbar form and can be changed to avoid name

conflicts.

**TEXT\_TOOLBAR\_INSTANT\_UPDATE**

Default: ``True``

Set to false to disable instant updating of the DOM when saving texts in

the toolbar.

**TEXT\_INLINE\_WRAPPER**

Default: ``('', '')``

A tuple of two that gets wrapped around texts in the template to enable

instant updating.

**TEXT\_INLINE\_WRAPPER\_CLASS**

Default: ``'dj_text_inline_wrapper'``

Change this to change the class of the element that gets wrapped around

texts.

Contribution

------------

Contribution is very welcome. Use

`issues `__ to

report bugs and propose features. For pull requests to be accepted

they need to be well tested.

Running tests

~~~~~~~~~~~~~

Install test dependencies.

.. code:: shell

    $ brew install phantomjs

    $ pip install -r test-requirements.txt

Run tests.

.. code:: shell

    $ make test

Run tests with coverage.

.. code:: shell

    $ make test-coverage

License

-------

Copyright (c) 2015-2017 Anton Agestam. django-text is released under the MIT

license. See the LICENSE file for more information and licenses for

bundled code.

.. |Join the chat at https://gitter.im/antonagestam/django-text| image:: https://badges.gitter.im/Join%20Chat.svg

   :target: https://gitter.im/antonagestam/django-text?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

.. |See latest build status at https://travis-ci.org/antonagestam/django-text| image:: https://travis-ci.org/antonagestam/django-text.svg?branch=master

   :target: https://travis-ci.org/antonagestam/django-text

.. |The django-text toolbar| image:: /docs/django-text.gif

.. |Coverage| image:: https://coveralls.io/repos/antonagestam/django-text/badge.svg?branch=master&service=github

   :target: https://coveralls.io/r/antonagestam/django-text?branch=master

Ecosyste.ms: Awesome

https://github.com/antonagestam/django-text

Awesome Lists containing this project

README

{% text "header" "My Header" %}

{% blocktext "header" %} Read My Awesome Text {% endblocktext %}

Hello World!

{% blocktext "header" %}
Read My Awesome Text
{% endblocktext %}