Permalink
Browse files

Cleaning installation.

  • Loading branch information...
mitar committed Jun 4, 2012
1 parent efdd67b commit 977df7ab76dc9096bb2542f7aa5579533a1d2cc5
Showing with 715 additions and 112 deletions.
  1. +661 −0 COPYING
  2. +32 −0 LICENSE
  3. +3 −0 MANIFEST.in
  4. +12 −107 README.rst
  5. +0 −1 README.txt
  6. +7 −4 setup.py
View
661 COPYING

Large diffs are not rendered by default.

Oops, something went wrong.
View
32 LICENSE
@@ -0,0 +1,32 @@
+Copyright (C) 2012 wlan slovenija, open wireless network of Slovenia
+
+This program is free software: you can redistribute it and/or modify it under
+the terms of the GNU Affero General Public License as published by the Free
+Software Foundation, either version 3 of the License, or (at your option) any
+later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+details.
+
+You should have received a copy of the GNU Affero General Public License along
+with this program. If not, see <http://www.gnu.org/licenses/>.
+
+Together with the source code this program may contain also additional content.
+Unless specified otherwise, this content is available under Creative Commons
+Attribution-ShareAlike license, either version 3.0 of the license, or (at your
+option) any later version. You are free to copy, distribute, transmit, adapt
+and/or commercially use this content or part(s) of it, provided you publicly,
+clearly and visibly attribute wlan slovenija, open wireless network of
+Slovenia, and provide a link to its website <http://wlan-si.net/>, if
+applicable. If you alter, transform, or build upon this content or part(s) of
+it, you may distribute the results only under the same or similar license to
+this one.
+
+For more information about Creative Commons Attribution-ShareAlike license see
+<http://creativecommons.org/>.
+
+This program may contain, use, link to and/or distribute also parts under third
+party copyright with possibly different licensing conditions. Make sure you
+check and respect also those conditions.
View
@@ -0,0 +1,3 @@
+include COPYING
+include LICENSE
+include *.py *.txt *.rst
View
@@ -1,112 +1,17 @@
-############################################
Trac wiki engine integration with Django CMS
-############################################
+============================================
-A plugin for ``cmsplugin-markup`` which adds Trac wiki engine support to Django CMS.
-It enables you to have content in Trac wiki syntax. It also supports Trac macros and
-it is also integrated with ``django-filer`` and ``cmsplugin-blog``. You can easily
-(with GUI) add files and images to the content, or any other text-enabled plugin content.
+A plugin for `cmsplugin-markup`_ which adds Trac_ wiki engine support to Django
+CMS. It enables you to have content in Trac wiki syntax. It also supports Trac
+macros and it is also integrated with `django-filer`_ and `cmsplugin-blog`_.
+You can easily (with GUI) add files and images to the content, or any other
+text-enabled plugin content.
-************
-Installation
-************
+.. _cmsplugin-markup: https://bitbucket.org/mitar/cmsplugin-markup
+.. _Trac: http://trac.edgewall.org/
+.. _django-filer: https://github.com/stefanfoulis/django-filer
+.. _cmsplugin-blog: https://github.com/fivethreeo/cmsplugin-blog
-You should just install it somewhere Django can find it, add ``cmsplugin_markup`` to ``INSTALLED_APPS``
-and add ``cmsplugin_markup_tracwiki`` to ``CMS_MARKUP_OPTIONS``. You should of course also have
-Trac installed and an otherwise working Django CMS installation. Plugin was tested with 0.12 Trac
-version.
+Documentation is found at:
-You should include in your ``urls.py`` plugins URLs, for example::
-
- urlpatterns = patterns('',
- # ...
- url(r'^', include('cmsplugin_markup.urls')),
-
-***********
-Wiki Syntax
-***********
-
-You should check out the `wiki syntax documentation <http://trac.edgewall.org/wiki/WikiFormatting>`_
-for introducion to Trac wiki engine. As this integration uses this engine directly, everything
-supported there is also available in Django CMS. (If something is missing or not working properly,
-please let me know.)
-
-There are some differences:
-
-- not all known wiki macros are enabled by default (like ``Image``) as they are not needed or reasonable
-- wiki namespace is not available (as there is no wiki)
-
-There are three new namespaces available:
-
-- ``cms`` to access Django CMS pages (using optional reverse ID to identify them) or anything else
- in Django namespace, accessible by `reverse`
-- ``filer`` to access django-filer files (using original filename, current name, SHA-1 hash or stored file path)
-- ``blog`` to access cmsplugin-blog entries (using slug, and optionally language code)
-
-Examples::
-
- [cms:page-with-name Page with reverse ID name]
- [cms:admin:index Admin main page]
- [filer:original-filename.png File]
- [blog:my-first-entry First blog entry]
- [blog:en:my-first-entry First blog entry in English]
-
-There are two macros which bridges the gap to Django template tags:
-
-- ``url`` macro which wrapps Django's ``url`` template tag
-- ``now`` macro which wrapps Django's ``now`` template tag (an example of a dynamic macro)
-
-There is a special ``CMSPlugin`` macro which renders a Django CMS plugin which was inserted
-into the wiki markup. Probably you should not use it manually.
-
-Additional macros or other features can be added on request. Or you can just clone
-the repository and implement them yourself and send me a pull request.
-
-********
-Settings
-********
-
-There are the following Django settings.
-
-``CMS_MARKUP_TRAC_INTERTRAC`` configures Trac's `InterTrac <http://trac.edgewall.org/wiki/InterTrac>`_ links. For example::
-
- CMS_MARKUP_TRAC_INTERTRAC = {
- 'trac': {
- 'TITLE': 'The Trac Project',
- 'URL': 'http://trac.edgewall.org',
- },
- }
-
-allows you to link to the ticket #1234 in Trac's official installation with ``[trac:ticket:1234 #1234]``.
-
-Similar ``CMS_MARKUP_TRAC_INTERWIKI`` allows general `InterWiki <http://trac.edgewall.org/wiki/InterWiki>`_ links::
-
- CMS_MARKUP_TRAC_INTERWIKI = {
- 'wikipedia': {
- 'TITLE': 'Wikipedia',
- 'URL': 'http://en.wikipedia.org/wiki/',
- },
- }
-
-``CMS_MARKUP_TRAC_COMPONENTS`` configures which additional Trac plugins (components) should be enabled. They should of course be in Python path. And probably defined fully, like::
-
- CMS_MARKUP_TRAC_COMPONENTS = (
- 'tracdashessyntax.plugin.DashesSyntaxPlugin',
- 'footnotemacro.macro.FootNoteMacro',
- 'mathjax.api.MathJaxPlugin',
- 'tracmath.tracmath.TracMathPlugin',
- )
-
-``CMS_MARKUP_TRAC_CONFIGURATION`` allows definining any additional Trac configuration options, like::
-
- CMS_MARKUP_TRAC_CONFIGURATION = {
- 'tracmath': {
- 'cache_dir': os.path.join(PROJECT_PATH, 'tracwiki', 'cache'),
- }
- }
-
-And ``CMS_MARKUP_TRAC_TEMPLATES_DIR`` specifies directory with Trac templates. Example::
-
- CMS_MARKUP_TRAC_TEMPLATES_DIR = os.path.join(PROJECT_PATH, 'tracwiki', 'templates')
-
-``CMS_MARKUP_TRAC_HEADING_OFFSET`` configures the heading offset when rendering wiki syntax. Useful when you are including wiki content inside some other content with existing headings. Default is 1 which means that ``= Heading =`` becomes ``<h2>Heading</h2>``. Setting it to 0 disables this feature.
+http://cmsplugin-markup-tracwiki.readthedocs.org/
View
@@ -1 +0,0 @@
-A plugin for cmsplugin-markup which adds Trac wiki engine support to Django CMS. It enables you to have content in Trac wiki syntax. It also supports Trac macros and it is also integrated with django-filer and cmsplugin-blog. You can easily (with GUI) add files and images to the content, or any other text-enabled plugin content.
View
@@ -1,3 +1,5 @@
+#!/usr/bin/env python
+
import os
from setuptools import setup, find_packages
@@ -8,17 +10,18 @@
name = 'cmsplugin-markup-tracwiki',
version = VERSION,
description = 'Trac wiki engine integration with Django CMS as a plugin for cmsplugin-markup.',
- long_description = open(os.path.join(os.path.dirname(__file__), 'README.txt')).read(),
+ long_description = open(os.path.join(os.path.dirname(__file__), 'README.rst')).read(),
author = 'Mitar',
author_email = 'mitar.django@tnode.com',
url = 'https://bitbucket.org/mitar/cmsplugin-markup-tracwiki',
- license = 'GPLv3',
+ license = 'AGPLv3',
packages = find_packages(),
+ package_data = {},
classifiers = [
'Development Status :: 4 - Beta',
'Environment :: Web Environment',
'Intended Audience :: Developers',
- 'License :: OSI Approved :: GNU General Public License (GPL)',
+ 'License :: OSI Approved :: GNU Affero General Public License v3',
'Operating System :: OS Independent',
'Programming Language :: Python',
'Framework :: Django',
@@ -28,6 +31,6 @@
install_requires = [
'Django>=1.2',
'trac>=0.12',
- 'cmsplugin-markup>=0.1',
+ 'cmsplugin-markup>=0.2',
],
)

0 comments on commit 977df7a

Please sign in to comment.