Skip to content

Commit

Permalink
Doc updated
Browse files Browse the repository at this point in the history
  • Loading branch information
ellmetha committed Mar 21, 2015
1 parent c99348c commit d5f16f8
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,29 @@ General
Default: ``'Machina'``

The forum name.

``MACHINA_MARKUP_LANGUAGE``
---------------------------

Default: ``('django_markdown.utils.markdown', {})``

This setting defines how posts content is translated into HTML on the forum. It must be a two-tuple. The first element should be a string corresponding to the Python dotted path to a function returning HTML from a content expressed in a markup language. The second element of the tuple is a dictionary of keyword arguments to pass to the latest function (the dictionary should be empty if the function does not require any argument).

*Django-machina* uses Markdown as the default syntax for forum messages.

``MACHINA_MARKUP_WIDGET``
-------------------------

Default: ``'django_markdown.widgets.MarkdownWidget'``

This setting defines the widget used inside topic and post forms. It should be a Python dotted path to a Django form widget.

Forum
*****

``MACHINA_FORUM_IMAGE_UPLOAD_TO``
---------------------------------

Default: ``'machina/forum_images'``

The media subdirectory where forum images should be uploaded.

0 comments on commit d5f16f8

Please sign in to comment.