Django Library Mycreole
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Dirk Alders 2adbd0da7d README filled with helpfull information 3 weeks ago
migrations Initial mycreole implementation 4 years ago
templates/mycreole Initial Attachment Management 3 years ago
templatetags Initial mycreole implementation 4 years ago
.gitignore Initial commit 4 years ago
LICENSE Initial commit 4 years ago
README.md README filled with helpfull information 3 weeks ago
__init__.py Added the possibility to pass a macro filter to the render methods 3 weeks ago
admin.py Initial mycreole implementation 4 years ago
apps.py Initial mycreole implementation 4 years ago
context.py Make mycreole independent from patt 3 weeks ago
help.py Make mycreole independent from patt 3 weeks ago
models.py Initial mycreole implementation 4 years ago
tests.py Initial mycreole implementation 4 years ago
urls.py Initial Attachment Management 3 years ago
views.py Initial Attachment Management 3 years ago

README.md

mycreole

With the django library mycreole, you are abel to use the creole language to create html output in your django application.

Integration

Clone the library in your django application.

Configurations in your settings.py

Add the following line to the list INSTALLED_APPS:

'mycreole.apps.MycreoleConfig',

Define the folder, where the attachments are stored with the following line:

MYCREOLE_ROOT = os.path.join(BASE_DIR, 'data', 'pages')

Define the methods to grant or deny the access to the attachments by:

MYCREOLE_ATTACHMENT_ACCESS = {
    'read': 'pages.access.read_attachment',
    'modify': 'pages.access.modify_attachment',
}

Define the methods to extend the navigationbar and menubar by this statement:

MYCREOLE_BAR = {
    'navibar': 'pages.context.navigationbar',
    'menubar': 'pages.context.menubar',
}

Usage

Creole help page

In this example, you see a method in views.py which returns a creole help page:

from django.conf import settings
from django.http import HttpResponse
import mycreole
import os


def help_on_creole(request):
    attachment_path = os.path.join(settings.MYCREOLE_ROOT, 'creole_help_page')
    html = mycreole.render(request, creole.help.MYCREOLE_HELP, self.attachment_path)

Usage of next_achor

TBD

Usage of macros

You can give a dictonary as macros parameter to the render method, to define your own macros. Here an example of such a dict: ``` macros={

'mymacro': method_to_be_called,

}