{ "info": { "author": "Pascal Chambon", "author_email": "pythoniks@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable" ], "description": "#############\r\ncmsplugin_rst\r\n#############\r\n\r\nA plugin for `Django CMS`_, which renders restructured text into html, using docutils.\r\n\r\n\r\n************\r\nInstallation\r\n************\r\n\r\nInstall ``cmsplugin_rst`` using pip or your favorite method, using a virtualenv or not.\r\n\r\n $ pip install cmsplugin_rst\r\n\r\nAdd ``'cmsplugin_rst'`` to your ``INSTALLED_APPS``, in your django settings.\r\n\r\nAnd then migrate the DB:\r\n\r\n $ python manage.py migrate\r\n \r\nBeware, if you upgrade from **cmsplugin_rst v0.1.1**, \r\nwhich didn't use django migrations but South, \r\nyou may have to skip the initial migration (eg. if you get the \r\n\"OperationalError: table \"cmsplugin_rst_rstpluginmodel\" already exists\" error):\r\n\r\n $ python manage.py migrate --fake-initial cmsplugin_rst\r\n\r\nTo speed up the (potentially heavy) rendering of cmsplugin_rst plugins, \r\nconsider using the cache framework of django.\r\n\r\n\r\n***************\r\nConfiguration\r\n***************\r\n\r\nThe behaviour of cmsplugin_rst can be tweaked with these Django settings (all are optional).\r\n\r\n**The plugin disallows, by default, insecure features like *file insertions* \r\nand *raw* directive, in the restructured text renderer.**\r\n\r\n\r\nCMSPLUGIN_RST_WRITER_NAME\r\n Name of the docutils writer to be used for rendering HTML (default: \"html4css1\")\r\n\r\nCMSPLUGIN_RST_CONTENT_PREFIX\r\n A restructuredtext string wich will be prepended to all your RST plugin contents, before rendering.\r\n Useful to define replacement blocks, custom roles, etc.\r\n \r\nCMSPLUGIN_RST_CONTENT_SUFFIX\r\n A restructuredtext string wich will be appended to all your RST plugin contents, before rendering.\r\n\r\nCMSPLUGIN_RST_SETTINGS_OVERRIDES\r\n A dict of settings which will be merged over plugin defaults, and passed to the docutils renderer. \r\n See docutils ``publish_parts()`` and its ``settings_overrides`` parameter (http://docutils.sourceforge.net/docs/user/config.html#html4css1-writer).\r\n Amongst interesting settings are \"initial_header_level\" and \"report_level\".\r\n\r\nCMSPLUGIN_RST_POSTPROCESSORS\r\n If and only if ``BeautifulSoup`` is installed, these postprocessors are applied \r\n to the rendered HTML before displaying it.\r\n It must be a list of qualified function names, eg. [\"mymodule.mysubmodule.myfunction\"].\r\n Each of these functions must expect a beautifulsoup tree as unique argument, \r\n and modify it in-place.\r\n\r\n \r\n***********************************\r\nSpecific Roles and Replacements\r\n***********************************\r\n\r\nThe restructured text is not evaluated by the django template engine, \r\nso you can't use django/djangocms tags and filters.\r\n\r\nBut some specific replacements take place:\r\n\r\n- {{ MEDIA_URL }} and {{ STATIC_URL }} tags are replaced, *before* html rendering, \r\n by corresponding django settings.\r\n- {{ BR }} and {{ NBSP }} are replaced, *after* html rendering, by corresponding html\r\n tags/entities.\r\n\r\nAdditionally, you can create links to other CMS pages with \r\nthe custom \"cmspage\" role provided, using the \"reverse IDs\" \r\nthat you'll have set previously in advanced page parameters:\r\n\r\n::\r\n\r\n :cmspage:`My-Reverse-Id` // the menu title will be use as the link name\r\n \r\n :cmspage:`My Link Name ` // here the link name is embedded in role\r\n\r\nReverse IDs must exist and be unique in the djangocms DB, else the rendering of the link fails.\r\n\r\n \r\n*************\r\nTest Project\r\n*************\r\n\r\nA demo project with a sqlite DB is included in repository, \r\nas a git submodule (https://git-scm.com/docs/git-submodule).\r\n\r\nIts django admin credentials are test/test.\r\n\r\n\r\n.. _Django CMS: https://www.django-cms.org", "description_content_type": null, "docs_url": null, "download_url": "https://opensource.org/licenses/BSD-3-Clause", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/pakal/cmsplugin-rst", "keywords": "", "license": "BSD 3-clauses", "maintainer": "", "maintainer_email": "", "name": "cmsplugin-rst", "package_url": "https://pypi.org/project/cmsplugin-rst/", "platform": "any", "project_url": "https://pypi.org/project/cmsplugin-rst/", "project_urls": { "Download": "https://opensource.org/licenses/BSD-3-Clause", "Homepage": "https://github.com/pakal/cmsplugin-rst" }, "release_url": "https://pypi.org/project/cmsplugin-rst/0.2/", "requires_dist": null, "requires_python": null, "summary": "Restructured Text plugin for Django CMS.", "version": "0.2" }, "last_serial": 2200713, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "e8aed874893b71dcb102846bf9ee5a60", "sha256": "f616e9e4cb1ab0562a130197f84fb1ec11a3bd054fe2dc38425b8d7a7c79926d" }, "downloads": -1, "filename": "cmsplugin-rst-0.1.0.tar.gz", "has_sig": false, "md5_digest": "e8aed874893b71dcb102846bf9ee5a60", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2727, "upload_time": "2011-02-28T15:49:58", "url": "https://files.pythonhosted.org/packages/b1/01/50438681cc3c7974852d59a1f7413d9374b2267dcf3fba39affefe18df58/cmsplugin-rst-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "e0816eaf3be2068ee523b44f2c162253", "sha256": "f32ec8acd0bad7811472e1a7b21dd37725b0bb38f2c43285f4f29c97e32e8a2b" }, "downloads": -1, "filename": "cmsplugin-rst-0.1.1.tar.gz", "has_sig": false, "md5_digest": "e0816eaf3be2068ee523b44f2c162253", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2717, "upload_time": "2011-03-01T10:12:07", "url": "https://files.pythonhosted.org/packages/8c/f5/9139fa9f6fee248fef83ecb2519c06314db19e0c1769e08b6b0cbe641547/cmsplugin-rst-0.1.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "3a6898cc7cd567ad54a33e3e7ddbc599", "sha256": "6c88cfeac786b9150903d5ba80768b57e71566f6da01d080c0ce04caf79681ff" }, "downloads": -1, "filename": "cmsplugin-rst-0.2.tar.gz", "has_sig": false, "md5_digest": "3a6898cc7cd567ad54a33e3e7ddbc599", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7095, "upload_time": "2016-07-03T17:48:57", "url": "https://files.pythonhosted.org/packages/0f/f2/4a9ffc93f107e01ebff2998f0b96627cf74c550be9878bb1ccdb267655a1/cmsplugin-rst-0.2.tar.gz" }, { "comment_text": "", "digests": { "md5": "0cd81b96296a0b4b2f3abc3ffb10a451", "sha256": "00ad30665b4e38ea915f9c2f98df21a7f754c184cd52387911fcd0ed7f17e546" }, "downloads": -1, "filename": "cmsplugin-rst-0.2.zip", "has_sig": false, "md5_digest": "0cd81b96296a0b4b2f3abc3ffb10a451", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11628, "upload_time": "2016-07-03T17:48:52", "url": "https://files.pythonhosted.org/packages/0d/b3/07a6e220e9c5b8c8c59ac582e361ad9d7def2845f7903474c44897bd639c/cmsplugin-rst-0.2.zip" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "3a6898cc7cd567ad54a33e3e7ddbc599", "sha256": "6c88cfeac786b9150903d5ba80768b57e71566f6da01d080c0ce04caf79681ff" }, "downloads": -1, "filename": "cmsplugin-rst-0.2.tar.gz", "has_sig": false, "md5_digest": "3a6898cc7cd567ad54a33e3e7ddbc599", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7095, "upload_time": "2016-07-03T17:48:57", "url": "https://files.pythonhosted.org/packages/0f/f2/4a9ffc93f107e01ebff2998f0b96627cf74c550be9878bb1ccdb267655a1/cmsplugin-rst-0.2.tar.gz" }, { "comment_text": "", "digests": { "md5": "0cd81b96296a0b4b2f3abc3ffb10a451", "sha256": "00ad30665b4e38ea915f9c2f98df21a7f754c184cd52387911fcd0ed7f17e546" }, "downloads": -1, "filename": "cmsplugin-rst-0.2.zip", "has_sig": false, "md5_digest": "0cd81b96296a0b4b2f3abc3ffb10a451", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11628, "upload_time": "2016-07-03T17:48:52", "url": "https://files.pythonhosted.org/packages/0d/b3/07a6e220e9c5b8c8c59ac582e361ad9d7def2845f7903474c44897bd639c/cmsplugin-rst-0.2.zip" } ] }